Skip to content

REST API: genesis endpoint schema definition #6157

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

Merged
gmalouf merged 9 commits into from
Apr 30, 2025
Merged

REST API: genesis endpoint schema definition #6157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ce8f53d
fix: genesis oas2 definition
PhearZero Oct 28, 2024
9ed9887
build: build route files
PhearZero Oct 28, 2024
bcc6b30
Merge remote-tracking branch 'upstream/master' into fix/get-genesis-s…
cce Jan 17, 2025
a2e4674
regenerate server/v2 types
cce Jan 17, 2025
b85fd7f
add TestGenesisTypeCompatibility and fix failures
cce Jan 18, 2025
570397e
Merge branch 'master' into fix/get-genesis-schema
PhearZero Apr 16, 2025
d6bb61d
regenerate server/v2 types
PhearZero Apr 16, 2025
14facc7
resolve lint errors in the genesis test and adds a copyright header
PhearZero Apr 29, 2025
d3562f2
generated artifacts for server routes
PhearZero Apr 29, 2025
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
96 changes: 95 additions & 1 deletion daemon/algod/api/algod.oas2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@
"200": {
"description": "The genesis file in json.",
"schema": {
"type": "string"
"$ref": "#/definitions/Genesis"
}
},
"default": {
Expand Down Expand Up @@ -3078,6 +3078,100 @@
}
},
"definitions": {
"GenesisAllocation":{
"title": "Allocations for Genesis File",
"type": "object",
"properties": {
"addr": {
"type": "string"
},
"comment": {
"type": "string"
},
"state": {
"type": "object",
"properties": {
"algo": {
"type": "number"
},
"onl": {
"type": "number"
},
"sel": {
"type": "string"
},
"stprf": {
"type": "string"
},
"vote": {
"type": "string"
},
"voteKD": {
"type": "number"
},
"voteFst": {
"type": "number"
},
"voteLst": {
"type": "number"
}
},
"required": [
"algo"
]
}
},
"required": [
"addr",
"comment",
"state"
]
},
"Genesis":{
"title": "Genesis File in JSON",
"type": "object",
"properties": {
"alloc": {
"type": "array",
"items": {
"$ref": "#/definitions/GenesisAllocation"
}
},
"comment": {
"type": "string"
},
"devmode": {
"type": "boolean"
},
"fees": {
"type": "string"
},
"id": {
"type": "string"
},
"network": {
"type": "string"
},
"proto": {
"type": "string"
},
"rwd": {
"type": "string"
},
"timestamp": {
"type": "number"
}
},
"required": [
"alloc",
"fees",
"id",
"network",
"proto",
"rwd",
"timestamp"
]
},
"LedgerStateDelta": {
"description": "Ledger StateDelta object",
"type": "object",
Expand Down
96 changes: 95 additions & 1 deletion daemon/algod/api/algod.oas3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2053,6 +2053,100 @@
],
"type": "object"
},
"Genesis": {
"properties": {
"alloc": {
"items": {
"$ref": "#/components/schemas/GenesisAllocation"
},
"type": "array"
},
"comment": {
"type": "string"
},
"devmode": {
"type": "boolean"
},
"fees": {
"type": "string"
},
"id": {
"type": "string"
},
"network": {
"type": "string"
},
"proto": {
"type": "string"
},
"rwd": {
"type": "string"
},
"timestamp": {
"type": "number"
}
},
"required": [
"alloc",
"fees",
"id",
"network",
"proto",
"rwd",
"timestamp"
],
"title": "Genesis File in JSON",
"type": "object"
},
"GenesisAllocation": {
"properties": {
"addr": {
"type": "string"
},
"comment": {
"type": "string"
},
"state": {
"properties": {
"algo": {
"type": "number"
},
"onl": {
"type": "number"
},
"sel": {
"type": "string"
},
"stprf": {
"type": "string"
},
"vote": {
"type": "string"
},
"voteFst": {
"type": "number"
},
"voteKD": {
"type": "number"
},
"voteLst": {
"type": "number"
}
},
"required": [
"algo"
],
"type": "object"
}
},
"required": [
"addr",
"comment",
"state"
],
"title": "Allocations for Genesis File",
"type": "object"
},
"LedgerStateDelta": {
"description": "Ledger StateDelta object",
"type": "object",
Expand Down Expand Up @@ -2838,7 +2932,7 @@
"content": {
"application/json": {
"schema": {
"type": "string"
"$ref": "#/components/schemas/Genesis"
}
}
},
Expand Down
Loading
Loading