This repository has been archived by the owner on Jun 11, 2024. It is now read-only.
Add swagger yaml for API documentation - Closes #5459 #5462
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
shuse2
changed the title
shuse2
force-pushed
the
5494-add_swagger_yaml_docs
branch
from
6cde97e
to
4cfb29b
Compare
nazarhussain
suggested changes
Jun 24, 2020
There was a problem hiding this comment.
Few overall changes:
- Whenever you refer unix timestamp must mention it as unix timestamp in seconds
- All collections endpoints must return collection response
- All endpoints must have a
metaobject, for collection it will contain pagination information, for rest, it will be an empty object. - I also have seen in few other APIs to use
resultkey instead ofdata. If you feel feasible please change that as well.
| description: | | ||
| Current block height of the node. | ||
| Represents the current number of blocks in the chain on the node. | ||
| chainMaxHeightFinalized: |
There was a problem hiding this comment.
finalized height will always refer to the highest value, so it can be just used as finalizedHeight.
Suggested change
| chainMaxHeightFinalized: | |
| finalizedHeight: |
There was a problem hiding this comment.
I think this was the conclusion of what we called this value in the endpoint.
There was a problem hiding this comment.
Conclusion where? I don't remember any discussion around this topic.
There was a problem hiding this comment.
the name is exactly the same as in LIP https://github.com/LiskHQ/lips/blob/master/proposals/lip-0014.md#computing-prevotes-and-precommits.
and when this property was added, it was discussed at that time if I remember correctly
ManuGowda
approved these changes
Jun 24, 2020
nazarhussain
approved these changes
Jun 25, 2020
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 was the problem?
This PR resolves #5459
How was it solved?
/delegatesand/forgersare not generic enough at the moment.This might require further change depending on the direction
How was it tested?
Copy paste the yaml file into https://editor.swagger.io/ and check the definition