mirror of
https://github.com/gosticks/octoprint-open-api.git
synced 2025-10-16 11:45:38 +00:00
WIP: group management
This commit is contained in:
parent
f0a7d7f2a3
commit
e363a9151b
8
TODO.md
8
TODO.md
@ -95,10 +95,10 @@
|
||||
Groups
|
||||
|
||||
- [x] Get group list
|
||||
- [ ] Add a new group
|
||||
- [ ] Retrieve a group
|
||||
- [ ] Update a group
|
||||
- [ ] Delete a group
|
||||
- [x] Add a new group
|
||||
- [x] Retrieve a group
|
||||
- [x] Update a group
|
||||
- [x] Delete a group
|
||||
|
||||
Users
|
||||
|
||||
|
||||
@ -96,3 +96,10 @@ paths:
|
||||
$ref: paths/access/groups/get.yaml
|
||||
post:
|
||||
$ref: paths/access/groups/post.yaml
|
||||
/access/groups/{key}:
|
||||
get:
|
||||
$ref: paths/access/groups/{key}-get.yaml
|
||||
put:
|
||||
$ref: paths/access/groups/{key}-put.yaml
|
||||
delete:
|
||||
$ref: paths/access/groups/{key}-delete.yaml
|
||||
|
||||
24
openapi/paths/access/groups/{key}-delete.yaml
Normal file
24
openapi/paths/access/groups/{key}-delete.yaml
Normal file
@ -0,0 +1,24 @@
|
||||
summary: Delete a group
|
||||
operationId: deleteGroup
|
||||
description: >-
|
||||
Deletes a group by its identifier.
|
||||
parameters:
|
||||
- in: path
|
||||
name: key
|
||||
description: >-
|
||||
The group’s identifier
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../../components/schemas/access/GroupUpdate.yaml
|
||||
responses:
|
||||
"200":
|
||||
description: >-
|
||||
Group was deleted. A list of all available groups will be returned.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../../components/schemas/access/GroupList.yaml
|
||||
19
openapi/paths/access/groups/{key}-get.yaml
Normal file
19
openapi/paths/access/groups/{key}-get.yaml
Normal file
@ -0,0 +1,19 @@
|
||||
summary: Retrieve a group
|
||||
operationId: getGroup
|
||||
description: >-
|
||||
Retrieves an individual group record.
|
||||
parameters:
|
||||
- in: path
|
||||
name: key
|
||||
description: >-
|
||||
The group’s identifier
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
"200":
|
||||
description: >-
|
||||
Group record
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../../components/schemas/access/GroupRecord.yaml
|
||||
27
openapi/paths/access/groups/{key}-put.yaml
Normal file
27
openapi/paths/access/groups/{key}-put.yaml
Normal file
@ -0,0 +1,27 @@
|
||||
summary: Update a group
|
||||
operationId: updateGroup
|
||||
description: >-
|
||||
Updates an existing group.
|
||||
parameters:
|
||||
- in: path
|
||||
name: key
|
||||
description: >-
|
||||
The group’s identifier
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../../components/schemas/access/GroupUpdate.yaml
|
||||
responses:
|
||||
"200":
|
||||
description: >-
|
||||
Group records
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../../components/schemas/access/GroupList.yaml
|
||||
"400":
|
||||
description: >-
|
||||
If any of the mandatory fields is missing or the request is otherwise invalid
|
||||
Loading…
Reference in New Issue
Block a user