docs: /paras{/leases/current, /auctions/current} #507
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
|
@joepetrowski this might be a good time to take a peek at how the api is developing. You can see the response interfaces at |
TarikGul
reviewed
Apr 9, 2021
docs/src/openapi-v1.yaml
Outdated
| [Experimental subject to breaking change] Get the status of the current | ||
| auction. | ||
| description: | | ||
| Returns an overview of the current of the current auction. There is only |
There was a problem hiding this comment.
Suggested change
| Returns an overview of the current of the current auction. There is only | |
| Returns an overview of the current auction. There is only |
TarikGul
reviewed
Apr 9, 2021
docs/src/openapi-v1.yaml
Outdated
| format: unsignedInteger or $hex | ||
| - name: fundInfo | ||
| in: query | ||
| description: Wehther or not to include the `fundInfo` of each crowdlaon |
There was a problem hiding this comment.
Suggested change
| description: Wehther or not to include the `fundInfo` of each crowdlaon | |
| description: Optional parameter to include the `fundInfo` of each crowdlaon |
TarikGul
reviewed
Apr 9, 2021
docs/src/openapi-v1.yaml
Outdated
| parameters: | ||
| - name: paraId | ||
| in: path | ||
| description: paraId to query crowdloan information of. |
There was a problem hiding this comment.
This sounds a little weird. It might just be the of at the end.
TarikGul
reviewed
Apr 9, 2021
docs/src/openapi-v1.yaml
Outdated
| - paras | ||
| summary: | | ||
| [Experimental subject to breaking change] Get current and future lease | ||
| info + lifecycle stage for a given `paraId. |
There was a problem hiding this comment.
Suggested change
| info + lifecycle stage for a given `paraId. | |
| info as well as the lifecycle stage for a given `paraId. |
Optional suggestion. Not sure if having symbols is conventional for docs.
TarikGul
reviewed
Apr 9, 2021
docs/src/openapi-v1.yaml
Outdated
| parameters: | ||
| - name: paraId | ||
| in: path | ||
| description: paraId to query crowdloan information of. |
There was a problem hiding this comment.
Same thing as above with the of.
TarikGul
reviewed
Apr 9, 2021
docs/src/openapi-v1.yaml
Outdated
| type: string | ||
| format: unsignedInteger | ||
| description: | | ||
| A currently win bid and the set of lease periods the bid is for. The |
There was a problem hiding this comment.
Suggested change
| A currently win bid and the set of lease periods the bid is for. The | |
| A currently won bid and the set of lease periods the bid is for. The |
TarikGul
reviewed
Apr 9, 2021
docs/src/openapi-v1.yaml
Outdated
| type: string | ||
| format: unisgnedInteger or $null | ||
| description: | | ||
| Fist block of the auction ending phase. `null` if no ongoing auction. |
There was a problem hiding this comment.
Suggested change
| Fist block of the auction ending phase. `null` if no ongoing auction. | |
| Fist block of the auction ending phase. Returns `null` if there is no ongoing auction. |
TarikGul
reviewed
Apr 9, 2021
docs/src/openapi-v1.yaml
Outdated
| type: string | ||
| format: unisgnedInteger or $null | ||
| description: | | ||
| Last block of the auction ending phase. `null` if no ongoing auction. |
There was a problem hiding this comment.
Suggested change
| Last block of the auction ending phase. `null` if no ongoing auction. | |
| Last block of the auction ending phase. Returns `null` if there is no ongoing auction. |
TarikGul
reviewed
Apr 9, 2021
docs/src/openapi-v1.yaml
Outdated
| - opening | ||
| - ending | ||
| description: | | ||
| Wether the auction is in the `opening` or `ending` phase. The |
There was a problem hiding this comment.
Suggested change
| Wether the auction is in the `opening` or `ending` phase. The | |
| Whether the auction is in the `opening` or `ending` phase. The |
TarikGul
reviewed
Apr 9, 2021
docs/src/openapi-v1.yaml
Outdated
| description: | | ||
| Wether the auction is in the `opening` or `ending` phase. The | ||
| `ending` phase is where the eventual winners are retroactively | ||
| picked from. `null` if no ongoing auction. |
There was a problem hiding this comment.
Suggested change
| picked from. `null` if no ongoing auction. | |
| picked from. Returns `null` if there is no ongoing auction. |
TarikGul
reviewed
Apr 9, 2021
docs/src/openapi-v1.yaml
Outdated
| type: string | ||
| format: unsignedInteger | ||
| description: | | ||
| Lease period indexes that may be bid on in this auction. `null` if no |
There was a problem hiding this comment.
Suggested change
| Lease period indexes that may be bid on in this auction. `null` if no | |
| Lease period indexes that may be bid on in this auction. Returns `null` if there is no |
TarikGul
reviewed
Apr 9, 2021
docs/src/openapi-v1.yaml
Outdated
| fundInfo: | ||
| $ref: '#/components/schemas/FundInfo' | ||
| description: | | ||
| List of paras that have crowdloans. Note `fundInfo` is only included when query |
There was a problem hiding this comment.
Suggested change
| List of paras that have crowdloans. Note `fundInfo` is only included when query | |
| List of paras that have crowdloans. Note `fundInfo` is only included when the query |
TarikGul
approved these changes
Apr 9, 2021
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.
adds docs for
/paras/paras/leases/current/paras/auctions/current/paras/crowdloans/paras/{paraId}/crowdloan-info/paras/{paraId}/lease-infochanges
AuctionPhase::Startinginstead of (AuctionPhase::PreEnding) andAuctionPhase::Ending.future prs