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

Update Swagger documentation and add BasicAuth #82

Merged
merged 1 commit into from
Oct 1, 2024

Conversation

AmineAfia
Copy link
Collaborator

@AmineAfia AmineAfia commented Oct 1, 2024

TL;DR

Updated API documentation and added basic authentication.

What changed?

  • Removed unnecessary contact information and terms of service from API documentation
  • Added license information to Swagger documentation
  • Updated host and base path in Swagger configuration
  • Implemented basic authentication for API endpoints
  • Updated Swagger info with version, title, and description

How to test?

  1. Run the API server
  2. Access the Swagger documentation at /swagger/index.html
  3. Verify that the updated information is displayed correctly
  4. Test API endpoints using basic authentication

Why make this change?

This change improves the API documentation by removing unnecessary information and adding important details like licensing. It also enhances security by implementing basic authentication for API endpoints, ensuring that only authorized users can access the API.

Copy link
Collaborator Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @AmineAfia and the rest of your teammates on Graphite Graphite

@AmineAfia AmineAfia changed the title Add auth and metadata to swagger docs Update Swagger documentation and add BasicAuth Oct 1, 2024
@AmineAfia AmineAfia requested a review from iuwqyir October 1, 2024 18:32
@AmineAfia AmineAfia marked this pull request as ready for review October 1, 2024 18:32
@AmineAfia AmineAfia merged commit 7042a03 into main Oct 1, 2024
4 checks passed
@AmineAfia AmineAfia deleted the 10-01-add_auth_and_metadata_to_swagger_docs branch October 1, 2024 19:14
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.

2 participants