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

Change OpenAPI resource location #1329

Merged
merged 2 commits into from
Mar 19, 2024
Merged

Change OpenAPI resource location #1329

merged 2 commits into from
Mar 19, 2024

Conversation

fmrsabino
Copy link
Collaborator

Summary

  • By serving the Swagger UI via index.html we removed the PetStore demo Swagger interface that was also being served under the same location. See 94ee10d.
  • However, the OpenAPI schema (JSON format) stopped being served with that change (previously available under /-json)

Changes

  • Therefore, we now serve the Swagger UI under /api. The redirect from / was adjusted to redirect to /api.
    • Additionally, the PetStore is not served under index.html.
    • index.html now returns a 404 – as there is no resource under that path.
    • The Open API JSON schema can now be found in /api-json.

- By serving the Swagger UI via `index.html` we removed the PetStore demo Swagger interface that was also being served under the same location. See 94ee10d.
- However, the OpenAPI schema (JSON format) stopped being served with that change (previously available under `/-json`)
- Therefore, we now serve the Swagger UI under `/api`. The redirect from `/` was adjusted to redirect to `/api`.
  * Additionally, the `PetStore` is not served under `index.html`.
  * `index.html` now returns a 404 – as there is no resource under that path.
  * The Open API JSON schema can now be found in `/api-json`.
@fmrsabino fmrsabino self-assigned this Mar 19, 2024
@fmrsabino fmrsabino requested a review from a team as a code owner March 19, 2024 15:41
@coveralls
Copy link

coveralls commented Mar 19, 2024

Pull Request Test Coverage Report for Build 8346073141

Details

  • 3 of 3 (100.0%) changed or added relevant lines in 2 files are covered.
  • 3 unchanged lines in 2 files lost coverage.
  • Overall coverage increased (+0.01%) to 93.693%

Files with Coverage Reduction New Missed Lines %
src/domain/safe/safe.repository.ts 1 99.12%
src/domain/tokens/token.repository.ts 2 75.0%
Totals Coverage Status
Change from base Build 8340802452: 0.01%
Covered Lines: 6506
Relevant Lines: 6712

💛 - Coveralls

@fmrsabino fmrsabino merged commit 7f751be into main Mar 19, 2024
16 checks passed
@fmrsabino fmrsabino deleted the open-api-schema-location branch March 19, 2024 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants