Skip to content

Commit 6e33578

Browse files
Merge pull request #6706 from hstove-stacks/fix/openapi-rpc-auth
fix: add 401 response and `rpcAuth` to openapi spec
2 parents 62fe5cb + 3f637ed commit 6e33578

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

docs/rpc/openapi.yaml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ components:
4343
name: authorization
4444
description: |
4545
Plain-text secret value that must exactly equal the node's
46-
configured password.
46+
configured password, which is set as `connection_options.auth_token`
47+
in the node's configuration file.
4748
responses:
4849
Unauthorized:
4950
description: Unauthorized. Invalid or missing authentication token.
@@ -449,6 +450,8 @@ paths:
449450
externalValue: "./components/examples/read-only-function-failure.example.json"
450451
"400":
451452
$ref: "#/components/responses/BadRequest"
453+
"401":
454+
$ref: "#/components/responses/Unauthorized"
452455
"404":
453456
$ref: "#/components/responses/NotFound"
454457
"408":
@@ -2205,7 +2208,8 @@ paths:
22052208
summary: Replay mining of a block and returns its content
22062209
tags:
22072210
- Blocks
2208-
security: []
2211+
security:
2212+
- rpcAuth: []
22092213
operationId: blockReplay
22102214
description: |
22112215
Replay the mining of a block (no data is written in the MARF) and returns its content.
@@ -2228,6 +2232,8 @@ paths:
22282232
$ref: "./components/examples/block-replay.example.json"
22292233
"400":
22302234
$ref: "#/components/responses/BadRequest"
2235+
"401":
2236+
$ref: "#/components/responses/Unauthorized"
22312237
"404":
22322238
$ref: "#/components/responses/NotFound"
22332239
"500":

0 commit comments

Comments
 (0)