Deuxfleurs/garage
41
56
Fork 73
Code Issues 102 Pull requests 14 Releases 30 Wiki Activity

OpenAPI spec for admin API #379

Merged
lx merged 15 commits from ecosystem/openapi into main 2022-11-16 10:51:05 +00:00
Conversation 2 Commits 15 Files changed 31 +2
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 72a0f90070 - Show all commits

2
doc/api/garage-admin-v0.yml
View file

@ -144,6 +144,7 @@ paths:
summary: "Send modifications to the cluster layout" summary: "Send modifications to the cluster layout"
description: | description: |
Send modifications to the cluster layout. These modifications will be included in the staged role changes, visible in subsequent calls of `GET /layout`. Once the set of staged changes is satisfactory, the user may call `POST /layout/apply` to apply the changed changes, or `POST /layout/revert` to clear all of the staged changes in the layout. Send modifications to the cluster layout. These modifications will be included in the staged role changes, visible in subsequent calls of `GET /layout`. Once the set of staged changes is satisfactory, the user may call `POST /layout/apply` to apply the changed changes, or `POST /layout/revert` to clear all of the staged changes in the layout.
Note that setting the capacity to `null` will configure the node as a gateway.
requestBody: requestBody:
description: | description: |
To add a new node to the layout or to change the configuration of an existing node, simply set the values you want. To add a new node to the layout or to change the configuration of an existing node, simply set the values you want.
@ -487,6 +488,7 @@ components:
example: dc1 example: dc1
capacity: capacity:
type: integer type: integer
nullable: true
example: 4 example: 4
tags: tags:
type: array type: array