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

734 fix swagger tags #735

Merged
merged 8 commits into from
Jan 2, 2025
Merged

734 fix swagger tags #735

merged 8 commits into from
Jan 2, 2025

Conversation

Matthew-Grayson
Copy link
Contributor

@Matthew-Grayson Matthew-Grayson commented Dec 8, 2024

🗣 Description

Update endpoint tags in views.py for consistency.
Alphabetize endpoints by tag.

💭 Motivation and context

Organizes endpoints in swagger documentation into neat categories and fixes duplication of listed endpoints.
Closes issue #734

🧪 Testing

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • All future TODOs are captured in issues, which are referenced
    in code comments.
  • All relevant type-of-change labels have been added.
  • I have read the CONTRIBUTING document.
  • These code changes follow cisagov code standards.
  • All relevant repo and/or project documentation has been updated
    to reflect the changes in this PR.
  • Tests have been added and/or modified to cover the changes in this PR.
  • All new and existing tests pass.

✅ Pre-merge checklist

  • Revert dependencies to default branches.
  • Finalize version.

✅ Post-merge checklist

  • Create a release.

Add missing brackets to vulnerbilities tags
Change cpes endpoint tags to CPEs
Change cves endpoint tags to CVEs
Change domain endpoint tags to Domains
Change vulnerabilities endpoint tags to Vulnerabilities
Change api-keys endpoint tags to API Keys
Change auth endpoint tags to Auth
Change saved-searches endpoint tags to Saved Searches
Change notifications endpoint tags to Notifications
Change stats endpoint tags to Stats
@Matthew-Grayson Matthew-Grayson linked an issue Dec 8, 2024 that may be closed by this pull request
@Matthew-Grayson Matthew-Grayson changed the base branch from develop to integration December 8, 2024 19:22
@Matthew-Grayson Matthew-Grayson self-assigned this Dec 8, 2024
@Matthew-Grayson
Copy link
Contributor Author

@aloftus23 I re-requested your review. I reordered the endpoints so the tags are alphabetized on the swagger docs page.

Add missing brackets to vulnerbilities tags
Change cpes endpoint tags to CPEs
Change cves endpoint tags to CVEs
Change domain endpoint tags to Domains
Change vulnerabilities endpoint tags to Vulnerabilities
Change api-keys endpoint tags to API Keys
Change auth endpoint tags to Auth
Change saved-searches endpoint tags to Saved Searches
Change notifications endpoint tags to Notifications
Change stats endpoint tags to Stats
@Matthew-Grayson Matthew-Grayson marked this pull request as ready for review December 19, 2024 16:17

Returns:
JSONResponse: The result of the update.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What are we doing for exceptions, since we are removing the exceptions?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see what happened. The exception is still there on line 1181. Reordering the endpoints created some weirdness with the commit.

@aloftus23 aloftus23 merged commit 908e556 into integration Jan 2, 2025
7 of 14 checks passed
@aloftus23 aloftus23 deleted the 734-fix-swagger-tags branch January 2, 2025 15:43
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.

Swagger Docs are Disorganized
3 participants