[Draft] OpenAPI 3.0 spec documentation of endpoints #3
Conversation
This file contains hidden or 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
… as example, fixed a couple typos
…r for all endpoints with optional id, fixed small diferences with API routes.
…mprove understanding
…le with Docusaurus core beta15 and up. By strictly pinning all docusaurus packages to v14, this can be resolved. This issue is also present in main branch, this commit will fix that too after merge.
…t it all contains
Cellaryllis
requested changes
Jul 12, 2022
Contributor
Cellaryllis
left a comment
Cellaryllis
left a comment
There was a problem hiding this comment.
Overall looks good! I appreciate the effort. Just a few corrections on what a member/systemid actually is formatted like and usage American English vs British English
SimplyPluralApi.yml
Outdated
| properties: | ||
| uid: | ||
| type: string | ||
| description: uid of the system this member belongs to (12 byte BSON ObjectId as string) |
Contributor
There was a problem hiding this comment.
Same as above, format is Firebase User ID
SimplyPluralApi.yml
Outdated
| type: string | ||
| required: true | ||
| description: String Id of the system | ||
| description: String Id of the system (12 byte BSON ObjectId as string) |
| text/plain: | ||
| schema: | ||
| type: string | ||
| description: String Id of the newly added member (12 byte BSON ObjectId as string) |
| schema: | ||
| type: string | ||
| required: true | ||
| description: String Id of the member (12 byte BSON ObjectId as string) |
| type: string | ||
| required: true | ||
| description: String Id of the system | ||
| description: String Id of the member (12 byte BSON ObjectId as string) |
| type: string | ||
| required: true | ||
| description: String Id of the group | ||
| description: String Id of the system (12 byte BSON ObjectId as string) |
| description: String Id of the system | ||
| get: | ||
| description: 'Get a group by Id' | ||
| description: String Id of the group (12 byte BSON ObjectId as string) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This is a repost of #1
This PR is not yet ready for merging. Current progress of endpoint documentation, this will show ongoing documentation. Several more commits will be added while this stays in draft state.
While this PR is still not ready for merging, the live version of the documentation has been running this branch since April 2022. When the API went public, old branches/forks of the private repositories were deleted, which caused this branch to go missing as well. I've pushed our local changes from the old fork/branch, and manually added the last commit that we didn't have local from the previous PR (9cb6cb2)