Add descriptions on OpenAPI
This commit is contained in:
@@ -844,6 +844,7 @@ paths:
|
|||||||
|
|
||||||
/workgroups:
|
/workgroups:
|
||||||
get:
|
get:
|
||||||
|
summary: Get all Workgroup (Paginated)
|
||||||
security:
|
security:
|
||||||
- {}
|
- {}
|
||||||
- JWTAuth: []
|
- JWTAuth: []
|
||||||
@@ -864,6 +865,7 @@ paths:
|
|||||||
items:
|
items:
|
||||||
$ref: '#/components/schemas/WorkgroupSimple'
|
$ref: '#/components/schemas/WorkgroupSimple'
|
||||||
post:
|
post:
|
||||||
|
summary: Create new Workgroup
|
||||||
security:
|
security:
|
||||||
- JWTAuth: []
|
- JWTAuth: []
|
||||||
tags:
|
tags:
|
||||||
@@ -925,6 +927,7 @@ paths:
|
|||||||
parameters:
|
parameters:
|
||||||
- $ref: '#/components/parameters/workgroup'
|
- $ref: '#/components/parameters/workgroup'
|
||||||
get:
|
get:
|
||||||
|
summary: Get one workgroup by ID
|
||||||
security:
|
security:
|
||||||
- {}
|
- {}
|
||||||
- JWTAuth: []
|
- JWTAuth: []
|
||||||
@@ -939,6 +942,7 @@ paths:
|
|||||||
allOf:
|
allOf:
|
||||||
- $ref: '#/components/schemas/Workgroup'
|
- $ref: '#/components/schemas/Workgroup'
|
||||||
put:
|
put:
|
||||||
|
summary: Edit one workgroup
|
||||||
security:
|
security:
|
||||||
- JWTAuth: []
|
- JWTAuth: []
|
||||||
tags:
|
tags:
|
||||||
@@ -993,6 +997,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
format: uuid
|
format: uuid
|
||||||
delete:
|
delete:
|
||||||
|
summary: Delete one workgroup
|
||||||
security:
|
security:
|
||||||
- JWTAuth: []
|
- JWTAuth: []
|
||||||
tags:
|
tags:
|
||||||
@@ -1004,6 +1009,7 @@ paths:
|
|||||||
parameters:
|
parameters:
|
||||||
- $ref: '#/components/parameters/workgroup'
|
- $ref: '#/components/parameters/workgroup'
|
||||||
post:
|
post:
|
||||||
|
summary: Add members to the workgroup
|
||||||
security:
|
security:
|
||||||
- JWTAuth: []
|
- JWTAuth: []
|
||||||
tags:
|
tags:
|
||||||
@@ -1021,6 +1027,7 @@ paths:
|
|||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/MembersResponse'
|
$ref: '#/components/schemas/MembersResponse'
|
||||||
put:
|
put:
|
||||||
|
summary: Updates ALL members. PLEASE NOTE this removes all members who are not in request!
|
||||||
security:
|
security:
|
||||||
- JWTAuth: []
|
- JWTAuth: []
|
||||||
tags:
|
tags:
|
||||||
@@ -1038,6 +1045,7 @@ paths:
|
|||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/MembersResponse'
|
$ref: '#/components/schemas/MembersResponse'
|
||||||
delete:
|
delete:
|
||||||
|
summary: Delete members of workgroup
|
||||||
security:
|
security:
|
||||||
- JWTAuth: []
|
- JWTAuth: []
|
||||||
tags:
|
tags:
|
||||||
|
|||||||
Reference in New Issue
Block a user