Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(ChainType): fix docs for chaintype return value #626

Merged
merged 2 commits into from
Aug 2, 2021
Merged

docs(ChainType): fix docs for chaintype return value #626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a026d9b
docs(ChainType): fix docs for chaintype return value
TarikGul Jul 31, 2021
8c82209
docs: change chaintype enum variants to type string
TarikGul Aug 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/dist/app.bundle.js
View file
Open in desktop

Large diffs are not rendered by default.

26 changes: 20 additions & 6 deletions docs/src/openapi-v1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1639,6 +1639,25 @@ components:
type: array
items:
$ref: '#/components/schemas/Operation'
ChainType:
type: object
description: Type of the chain. It will return one of the following enum variants as a key. Live, Development, Local, or Custom. Each variant will have a value as null except when the ChainType is Custom, it will return a string.
properties:
live:
type: string
nullable: true
default: null
development:
type: string
nullable: true
default: null
local:
type: string
nullable: true
default: null
custom:
type: string
example: "{\"live\": null}"
DigestItem:
type: object
properties:
Expand Down Expand Up @@ -2259,12 +2278,7 @@ components:
description: The version of the authorship interface. An authoring node
will not attempt to author blocks unless this is equal to its native runtime.
chainType:
type: string
description: Type of the chain.
enum:
- Development
- Local
- Live
$ref: '#/components/schemas/ChainType'
implVersion:
type: string
description: Version of the implementation specification. Non-consensus-breaking
Expand Down