Skip to content

Improve swagger documentation #244

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Feb 26, 2025
Merged

Improve swagger documentation #244

merged 4 commits into from
Feb 26, 2025

Conversation

mcucchi9
Copy link
Collaborator

@mcucchi9 mcucchi9 commented Feb 19, 2025 •
edited
Loading

This PR improves API Swagger documentation, by:

  • setting a (configurable) API title;
  • setting a (configurable) API description;
  • hiding from endpoints' documentation internal parameters (such as the X-CADS-PORTAL header);
  • adding (ATM non-configurable) endpoints' parameters description.

Needs:

@mcucchi9 mcucchi9 requested a review from keul February 19, 2025 16:37
@mcucchi9 mcucchi9 self-assigned this Feb 19, 2025
@mcucchi9 mcucchi9 mentioned this pull request Feb 19, 2025
Merged
@mcucchi9 mcucchi9 merged commit b3b9881 into main Feb 26, 2025
9 checks passed
@mcucchi9 mcucchi9 deleted the COPDS-2395-improve-swagger-doc branch February 26, 2025 09:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@keul keul keul approved these changes

Assignees

@mcucchi9 mcucchi9

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mcucchi9 @keul