mirror of
https://github.com/maubot/maubot.git
synced 2024-10-01 01:06:10 -04:00
Fix minor things in management API spec
This commit is contained in:
parent
6001b66044
commit
aefdcd9447
@ -59,9 +59,9 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
format: binary
|
format: binary
|
||||||
example: The plugin maubot archive (.mbp)
|
example: The plugin maubot archive (.mbp)
|
||||||
'/plugin/{type}':
|
'/plugin/{id}':
|
||||||
parameters:
|
parameters:
|
||||||
- name: type
|
- name: id
|
||||||
in: path
|
in: path
|
||||||
description: The ID of the plugin to get
|
description: The ID of the plugin to get
|
||||||
required: true
|
required: true
|
||||||
@ -94,15 +94,26 @@ paths:
|
|||||||
404:
|
404:
|
||||||
description: Plugin not found
|
description: Plugin not found
|
||||||
412:
|
412:
|
||||||
description: Instances of the uploaded plugin type exists, so the plugin can't be deleted
|
description: One or more plugin instances of this type exist
|
||||||
'/instance/{type}/{id}':
|
|
||||||
parameters:
|
/instances:
|
||||||
- name: type
|
get:
|
||||||
in: path
|
operationId: get_instances
|
||||||
description: The ID of the plugin whose instance to get
|
summary: Get all plugin instances
|
||||||
required: true
|
tags: [Plugin instances]
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: The list of instances
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/PluginInstance'
|
||||||
|
401:
|
||||||
|
$ref: '#/components/responses/Unauthorized'
|
||||||
|
'/instance/{id}':
|
||||||
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
in: path
|
in: path
|
||||||
description: The ID of the instance to get
|
description: The ID of the instance to get
|
||||||
@ -137,7 +148,7 @@ paths:
|
|||||||
description: Plugin or instance not found
|
description: Plugin or instance not found
|
||||||
put:
|
put:
|
||||||
operationId: update_instance
|
operationId: update_instance
|
||||||
summary: Edit the details of a plugin instance
|
summary: Create a plugin instance or edit the details of an existing plugin instance
|
||||||
tags: [Plugin instances]
|
tags: [Plugin instances]
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
@ -188,7 +199,7 @@ paths:
|
|||||||
description: Client not found
|
description: Client not found
|
||||||
put:
|
put:
|
||||||
operationId: update_client
|
operationId: update_client
|
||||||
summary: Update a Matrix client
|
summary: Create or update a Matrix client
|
||||||
tags: [Client]
|
tags: [Client]
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
@ -218,6 +229,8 @@ paths:
|
|||||||
$ref: '#/components/responses/Unauthorized'
|
$ref: '#/components/responses/Unauthorized'
|
||||||
404:
|
404:
|
||||||
description: Client not found
|
description: Client not found
|
||||||
|
412:
|
||||||
|
description: One or more plugin instances with this as their primary client exist
|
||||||
|
|
||||||
components:
|
components:
|
||||||
responses:
|
responses:
|
||||||
|
Loading…
Reference in New Issue
Block a user