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

Devex 1100 swagger doc housekeeping #2696

Merged

Conversation

jasonfu9966
Copy link
Contributor

@jasonfu9966 jasonfu9966 commented Oct 21, 2022

just cleaning up this swagger doc:

  • combining "get" and "post" for /cases into one block
  • adding an "items" block wherever "array" is specified as the type
  • disable "try it out" button (swaggerLambda)
  • formatting

known issues: swagger UI is unable to properly display nested schemas. the schema in the JSON file is correct; the schema on SwaggerUI is not.

@jasonfu9966 jasonfu9966 marked this pull request as ready for review October 21, 2022 20:46
@@ -16,7 +16,8 @@ exports.swaggerLambda = () => {
<script>
SwaggerUIBundle({
dom_id: '#swagger',
url: '/api/swagger.json'
url: '/api/swagger.json',
supportedSubmitMethods: []
Copy link
Contributor Author

Choose a reason for hiding this comment

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

removes the "try it out!" button from the docs.

"CognitoUserPool": []
}
]
},
Copy link
Contributor Author

Choose a reason for hiding this comment

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

relocation. combined two separate "/cases" blocks.

}
},
"required": ["showCaseNotes", "filters", "formattedCases", "formattedTrialSession", "sort", "userHeading"]
"$ref": "#/definitions/printableWorkingCopyData"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

moved this schema from here into its own definition at the bottom of the file.

Copy link
Contributor Author

@jasonfu9966 jasonfu9966 left a comment

Choose a reason for hiding this comment

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

see comments for explanation.

@jimlerza jimlerza merged commit 44df266 into ustaxcourt:staging Oct 25, 2022
@jimlerza jimlerza mentioned this pull request Nov 1, 2022
2 tasks
@rachelschneiderman rachelschneiderman deleted the devex-1100-swagger-doc-generation branch March 20, 2023 15:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants