Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Display API Documentation (Swagger UI) #124

Merged
merged 10 commits into from
Jul 2, 2024
Merged

Display API Documentation (Swagger UI) #124

merged 10 commits into from
Jul 2, 2024

Conversation

brunobuddy
Copy link
Contributor

@brunobuddy brunobuddy commented Jun 19, 2024

image

Description

This PR adds the API Documentation feature to Manifest.

How can it be tested?

  • Go to packages/core/manifest
  • Run npm run start:dev
  • You should see the link to the API doc in the console
  • Click on the link to see it and play around with the different endpoints.

run tests manually

npm run test
npm run test:e2e

⚠️ @SebConejo to add style to the Api doc you can go edit packages/core/manifest/src/main.ts line 59 for custom css.

Check list before submitting

The doc will be updated after publish

  • I have performed a self-review of my code (no debugs, no commented code, good naming, etc.)
  • I wrote the relative tests
  • I updated the documentation if necessary
  • This PR is wrote in a clear language and correctly labeled

@brunobuddy brunobuddy added enhancement New feature or request api API issues labels Jun 19, 2024
@brunobuddy brunobuddy added this to the Manifest MVP milestone Jun 19, 2024
@brunobuddy brunobuddy changed the title Feature/api doc Display API Documentation (Swagger UI) Jun 19, 2024
@brunobuddy brunobuddy merged commit 9ad64d8 into develop Jul 2, 2024
3 checks passed
@brunobuddy brunobuddy deleted the feature/api-doc branch July 2, 2024 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api API issues enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants