Document the API #426
Merged
Document the API #426
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pricem14pc
reviewed
Aug 2, 2024
LJBabbage
reviewed
Aug 2, 2024
There was a problem hiding this comment.
I think you might have missed /respondents/<respondent_id>/password-verification-token/ DELETE
First pass, but the openapi looks good, just some minor adjustments. Lots of potential 500 and key errors in there, which I haven't highlighted all and don't think we need to capture. The countless 404 checks for the same things (or lack of in some instance) in multiple different places is a pain, but again not for this card to sort
LJBabbage
approved these changes
Aug 6, 2024
pricem14pc
approved these changes
Aug 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What and why?
The Party API is poorly documented and we need to do work on it. This creates an OpenAPI document as well as an (extensive) list of known issues with the API
How to test?
Copy/paste the API document into https://editor.swagger.io/
Known issue
The editor will complain about there being a requestBody on GET /respondents/email. It's right to complain, but that is how the API is written and I've gone for accuracy rather than correctness. This is noted in the attached known-api-issues.md
Jira
RAS-1182