Skip to content

Create New Participation Key Interface REST endpoints #2671

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
winder merged 2 commits into from
Aug 3, 2021
Merged

Create New Participation Key Interface REST endpoints #2671

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
fed48ed
Finalized forms
AlgoStephenAkiki Jul 30, 2021
4666e91
PR changes
AlgoStephenAkiki 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
272 changes: 272 additions & 0 deletions daemon/algod/api/algod.oas2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,6 +462,229 @@
}
}
},
"/v2/participation": {

"get": {

"tags": [
"private"
],

"description": "Return a list of participation keys",
"produces": [
"application/json"
],
"schemes": [
"http"
],
"summary": "Return a list of participation keys",
"operationId": "GetParticipationKeys",
"responses": {
"200": {
"description": "OK",
"$ref": "#/responses/ParticipationKeysResponse"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"401": {
"description": "Invalid API Token",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"404": {
"description": "Application Not Found",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"500": {
"description": "Internal Error",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"default": {
"description": "Unknown Error"
}
}
},


"post": {

"tags": [
"private"
],

"consumes": [
"application/msgpack"
],
"produces": [
"application/json"
],
"schemes": [
"http"
],
"summary": "Add a participation key to the node",
"operationId": "AddParticipationKey",
"parameters": [
{
"description": "The participation key to add to the node",
"name": "participationkey",
"in": "body",
"required": true,
"schema": {
"type": "string",
"format": "binary"
}
}
],

"responses": {
"200": {
"$ref": "#/responses/PostParticipationResponse"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"401": {
"description": "Invalid API Token",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"500": {
"description": "Internal Error",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"503": {
"description": "Service Temporarily Unavailable",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"default": {
"description": "Unknown Error"
}
}

}

},
"/v2/participation/{participation-id}": {
"delete": {

"tags": [
"private"
],

"description": "Delete a given participation key by id",
"produces": [
"application/json"
],

"schemes": [
"http"
],
"summary": "Delete a given participation key by id",
"operationId": "DeleteParticipationKeyByID",
"responses": {
"200": {
"$ref": "#/responses/DeleteParticipationIdResponse"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"401": {
"description": "Invalid API Token",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"500": {
"description": "Internal Error",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"default": {
"description": "Unknown Error"
}
}

},

"get": {

"tags": [
"private"
],

"description": "Given a participation id, return information about that participation key",
"produces": [
"application/json"
],
"schemes": [
"http"
],
"summary": "Get participation key info by id",
"operationId": "GetParticipationKeyByID",
"responses": {
"200": {
"description": "OK",
"$ref": "#/responses/ParticipationKeyResponse"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"401": {
"description": "Invalid API Token",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"404": {
"description": "Application Not Found",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"500": {
"description": "Internal Error",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"default": {
"description": "Unknown Error"
}
}
},
"parameters": [
{
"type": "string",
"name": "participation-id",
"in": "path",
"required": true
}
]
},
"/v2/register-participation-keys/{address}": {
"post": {
"description": "Generate (or renew) and register participation keys on the node for a given account address.",
Expand Down Expand Up @@ -1493,6 +1716,10 @@
}
}
},
"ParticipationKey": {
"description": "Represents a participation key used by the node.",
"type": "object"
},
"TealKeyValueStore": {
"description": "Represents a key-value store for use in an application.",
"type": "array",
Expand Down Expand Up @@ -2340,6 +2567,51 @@
}
}
},

"ParticipationKeysResponse": {
"description": "A list of participation keys",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ParticipationKey"
}
}
},
"ParticipationKeyResponse": {
"description": "A detailed description of a participation id",
"schema": {
"type": "object",
"required": [
"participationKey"
],
"properties": {
"participationKey": {
"description": "Detailed description of a participation key",
"type": "string"
}
}
}
},
"DeleteParticipationIdResponse" : {
"description": "Participation key got deleted by ID"
},
"PostParticipationResponse" : {
"description": "Participation ID of the submission",
"schema": {
"type": "object",
"required": [
"partId"
],
"properties": {
"partId": {
"description": "encoding of the participation id.",
"type": "string"
}
}
}

},

"PostTransactionsResponse": {
"description": "Transaction ID of the submission.",
"schema": {
Expand Down
Loading