docs: Add responses to the GCBM docs #184
Merged
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
Adds response codes to the GCBM curl documentation. Also changes the format of the document to be more navigable. Signed-off-by: Amit <amitkulkarni2028@gmail.com>
|
@Namyalg PTAL :) |
|
LGTM, merging this |
Namyalg
approved these changes
Sep 17, 2022
Freeman-kuch
pushed a commit
to Freeman-kuch/FLINT.Cloud
that referenced
this pull request
Oct 20, 2022
docs: Add expected response codes on sucess to the GCBM docs Adds response codes to the GCBM curl documentation. Also changes the format of the document to be more navigable. Signed-off-by: Amit <amitkulkarni2028@gmail.com> Signed-off-by: Amit <amitkulkarni2028@gmail.com> Co-authored-by: Namya LG <53875297+Namyalg@users.noreply.github.com> Signed-off-by: Freeman <freemanoparaocha@gmail.com>
Freeman-kuch
pushed a commit
to Freeman-kuch/FLINT.Cloud
that referenced
this pull request
Oct 20, 2022
docs: Add expected response codes on sucess to the GCBM docs Adds response codes to the GCBM curl documentation. Also changes the format of the document to be more navigable. Signed-off-by: Amit <amitkulkarni2028@gmail.com> Signed-off-by: Amit <amitkulkarni2028@gmail.com> Co-authored-by: Namya LG <53875297+Namyalg@users.noreply.github.com> Signed-off-by: Freeman <freemanoparaocha@gmail.com>
Freeman-kuch
pushed a commit
to Freeman-kuch/FLINT.Cloud
that referenced
this pull request
Oct 28, 2022
docs: Add expected response codes on sucess to the GCBM docs Adds response codes to the GCBM curl documentation. Also changes the format of the document to be more navigable. Signed-off-by: Amit <amitkulkarni2028@gmail.com> Signed-off-by: Amit <amitkulkarni2028@gmail.com> Co-authored-by: Namya LG <53875297+Namyalg@users.noreply.github.com> Signed-off-by: Freeman <freemanoparaocha@gmail.com>
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.
Description
Fixes #183.
This PR adds expected JSON responses that the user should get when an endpoint returns a successful response.
Since it was kind of hard to fit in everything with in the existing format - I've experimented with a new format for documenting HTTP request methods, response codes, endpoints and expected response. The aim is to make the document more navigable and readable. Let me know what you folks think! :)
Type of change
Additional Context
You can preview my changes at my fork here:
https://github.com/Crystalsage/FLINT.Cloud/blob/docs/gcbm-endpoint-status/local/rest_api_gcbm/curl.md
Checklist: