Skip to content

Commit

Permalink
Merge branch 'bug_20262/missing_documentation_for_relay_to_node_demot…
Browse files Browse the repository at this point in the history
…e_api_pr' into branches/rudder/7.0
  • Loading branch information
Jenkins CI committed Nov 17, 2021
2 parents f0ed401 + c70ace1 commit 2fdc1a0
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
2 changes: 2 additions & 0 deletions webapp/sources/api-doc/openapi.src.yml
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,8 @@ paths:
$ref: paths/usermanagement/add.yml
"/scaleoutrelay/promote/{nodeId}":
$ref: paths/scale-out-relay/promote.yml
"/scaleoutrelay/demote/{nodeId}":
$ref: paths/scale-out-relay/demote.yml
"/changeRequests/{changeRequestId}/accept":
$ref: paths/change-requests/accept.yml
"/changeRequests/{changeRequestId}":
Expand Down
41 changes: 41 additions & 0 deletions webapp/sources/api-doc/paths/scale-out-relay/demote.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# SPDX-License-Identifier: CC-BY-SA-2.0
# SPDX-FileCopyrightText: 2013-2020 Normation SAS
post:
summary: Demote a relay to simple node
description: Demote a relay to a simple node.
operationId: demoteToNode
parameters:
- $ref: ../../components/parameters/node-id.yml
responses:
"200":
description: Demote to node response
content:
application/json:
schema:
type: object
required:
- action
- result
- data
properties:
action:
type: string
description: The id of the action
enum:
- demoteToNode
result:
type: string
description: Result of the request
enum:
- success
- error
data:
type: string
description: Success or error message
example: 17dadf50-6056-4c8b-a935-6b97d14b89a7
tags:
- 🧩 Scale out Relay
x-code-samples:
- lang: curl
source:
$ref: ../../code_samples/curl/scale-out-relay/promote.sh

0 comments on commit 2fdc1a0

Please sign in to comment.