Skip to content

Conversation

@l-dufour
Copy link
Collaborator

Refactored Swagger documentation for API key authentication

  • Removed Basic Auth from Swagger security schemes and endpoint annotations
  • Updated all public endpoints to use API Key authentication only
  • Added "(public)" to the summary of API key-accessible endpoints
  • Marked obsolete endpoints as deprecated and hid them via CSS (still visible in docs)
  • Added a visual note at the top of the Swagger UI explaining authentication requirements
  • Restricted available HTTP methods to GET only in Swagger UI using the supportedSubmitMethods option, to prevent interaction with non-public endpoints.

LDFOUR\luisd added 4 commits March 28, 2025 15:49
Refactored Swagger documentation for API key authentication

- Removed Basic Auth from Swagger security schemes and endpoint annotations
- Updated all public endpoints to use API Key authentication only
- Added "(public)" to the summary of API key-accessible endpoints
- Marked obsolete endpoints as deprecated and hid them via CSS (still visible in docs)
- Added a visual note at the top of the Swagger UI explaining authentication requirements
@l-dufour l-dufour requested a review from joseganora March 28, 2025 19:03
@l-dufour l-dufour merged commit 9c54694 into develop Mar 28, 2025
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.

3 participants