Fix Request Bodies in API Documentation #4066
Merged
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.
Description
As raised in #4058 and #3983, we are documenting all our
POST
/PUT
/PATCH
API endpoints wrongly.We need to wrap the JSON of the request body with the object name that we are trying to create/edit. This is a example of the correct format, that we will have after this PR is merged:
But we are currently documenting all the endpoints to be used as:
Enpoints Fixed:
How to test this PR's result:
Create a new project in Stoplight Studio, copy/paste the resulting oas.yml file, which should be available here and watch the preview for the result.
Checklist: