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

Swagger docs are unclear about required fields #1133

Closed
jdaigneau5 opened this issue Nov 1, 2023 · 0 comments
Closed

Swagger docs are unclear about required fields #1133

jdaigneau5 opened this issue Nov 1, 2023 · 0 comments

Comments

@jdaigneau5
Copy link
Collaborator

Summary

On the Test environment, the updates to the Swagger docs changed the POST body example for the POST/PUT cve/{id}/cna to contain more than the minimum required fields. The docs convey required fields through the schema tab, which is less clear than before. Docs need to be cleaned up to ensure usability.

Definition of Done

  • Clean up schema tabs on Swagger docs, show less info if possible
  • Show which fields are required from Example Value view
@jdaigneau5 jdaigneau5 moved this to To do in Sprint 44 Jul 2, 2024
@jdaigneau5 jdaigneau5 moved this from To do to In progress in Sprint 44 Jul 5, 2024
@jdaigneau5 jdaigneau5 moved this from In progress to In review in Sprint 44 Jul 5, 2024
@jdaigneau5 jdaigneau5 moved this from In review to Done in Sprint 44 Jul 8, 2024
@jdaigneau5 jdaigneau5 moved this from Done to In review in Sprint 44 Jul 9, 2024
@jdaigneau5 jdaigneau5 moved this from In review to Done in Sprint 44 Jul 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

1 participant