[api] Rest api docs #3774
Merged
[api] Rest api docs #3774
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
banool
previously requested changes
Sep 2, 2022
Now all objects have documentation in the OpenAPI spec, along with in the website that gives information accordingly
gregnazario
force-pushed
the
rest-api-docs
branch
from
73a56a5 to
b3c5ce1
Compare
|
@banool can you take a look? |
banool
reviewed
Sep 7, 2022
| @@ -30,7 +33,11 @@ impl BlocksApi { | |||
| async fn get_block_by_height( | |||
| &self, | |||
| accept_type: AcceptType, | |||
| /// Block height to lookup. Starts at 0 | |||
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
I went through and added documentation to every single object. I did do it late at night, so it might not be the most comprehensive, but it does give some better documentation accordingly.
(If you guys need to see the site, I can always bring it up for you)
Test Plan
Tested locally with my browser and a local testnet node
This change is