mirrors/garage
1
0
Fork 0
mirror of https://git.deuxfleurs.fr/Deuxfleurs/garage.git synced 2024-11-25 17:41:01 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add operationId to entrypoints

Browse source
This commit is contained in:
Quentin Dufour 2022-09-13 16:09:51 +02:00
parent 5f0928f89c
commit 3024405a65
No known key found for this signature in database
GPG key ID: E9602264D639FF68
1 changed files with 16 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -10,7 +10,8 @@ paths:
/status: /status:
get: get:
tags: tags:
- Membership - Nodes
operationId: "GetNodes"
summary: "Status of this node and other nodes in the cluster" summary: "Status of this node and other nodes in the cluster"
description: | description: |
Returns the cluster's current status, including: Returns the cluster's current status, including:
@ -62,7 +63,8 @@ paths:
/connect: /connect:
post: post:
tags: tags:
- Membership - Nodes
operationId: "AddNode"
summary: "Connect target node to other Garage nodes" summary: "Connect target node to other Garage nodes"
description: | description: |
Instructs this Garage node to connect to other Garage nodes at specified `<node_id>@<net_address>`. `node_id` is generated automatically on node start. Instructs this Garage node to connect to other Garage nodes at specified `<node_id>@<net_address>`. `node_id` is generated automatically on node start.
@ -110,6 +112,7 @@ paths:
get: get:
tags: tags:
- Layout - Layout
operationId: "GetLayout"
summary: "Details on the current and staged layout" summary: "Details on the current and staged layout"
description: | description: |
Returns the cluster's current layout, including: Returns the cluster's current layout, including:
@ -134,6 +137,7 @@ paths:
post: post:
tags: tags:
- Layout - Layout
operationId: "AddLayout"
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.
@ -169,6 +173,7 @@ paths:
post: post:
tags: tags:
- Layout - Layout
operationId: "ApplyLayout"
summary: "Apply staged layout" summary: "Apply staged layout"
description: | description: |
Applies to the cluster the layout changes currently registered as staged layout changes. Applies to the cluster the layout changes currently registered as staged layout changes.
@ -192,6 +197,7 @@ paths:
post: post:
tags: tags:
- Layout - Layout
operationId: "RevertLayout"
summary: "Clear staged layout" summary: "Clear staged layout"
description: | description: |
Clears all of the staged layout changes. Clears all of the staged layout changes.
@ -243,6 +249,7 @@ paths:
post: post:
tags: tags:
- Key - Key
operationId: "AddKey"
summary: "Create a new API key" summary: "Create a new API key"
description: | description: |
Creates a new API access key. Creates a new API access key.
@ -273,6 +280,7 @@ paths:
get: get:
tags: tags:
- Key - Key
operationId: "GetKey"
summary: "Get key information" summary: "Get key information"
description: | description: |
Return information about a specific key and return its information Return information about a specific key and return its information
@ -298,8 +306,10 @@ paths:
delete: delete:
tags: tags:
- Key - Key
operationId: "DeleteKey"
summary: "Delete a key" summary: "Delete a key"
description: |
Delete a key from the cluster. Its access will be removed from all the buckets. Buckets are not automatically deleted and can be dangling. You should manually delete them before.
parameters: parameters:
- name: access_key - name: access_key
in: path in: path
@ -318,6 +328,7 @@ paths:
post: post:
tags: tags:
- Key - Key
operationId: "UpdateKey"
summary: "Update a key" summary: "Update a key"
description: | description: |
Updates information about the specified API access key. Updates information about the specified API access key.
@ -371,6 +382,7 @@ paths:
get: get:
tags: tags:
- Key - Key
operationId: "SearchKey"
summary: "Select key by pattern" summary: "Select key by pattern"
description: | description: |
Find the first key matching the given pattern based on its identifier aor friendly name and return its information. Find the first key matching the given pattern based on its identifier aor friendly name and return its information.
@ -397,6 +409,7 @@ paths:
post: post:
tags: tags:
- Key - Key
operationId: "ImportKey"
summary: "Import an existing key" summary: "Import an existing key"
description: | description: |
Imports an existing API key. This feature must only be used for migrations and backup restore. Imports an existing API key. This feature must only be used for migrations and backup restore.