feat: tag user paths

pull/17/head
Dominique Merle 4 years ago
parent ed8607066c
commit dcc0d48a20

@ -33,6 +33,13 @@ paths:
'/users/{user-id}': '/users/{user-id}':
$ref: 'paths/users@{user-id}.yaml' $ref: 'paths/users@{user-id}.yaml'
tags: tags:
- name: User Management
description: |
All the paths for:
- user creation
- authentication
- security
- trust levels
- name: Poll Indexation - name: Poll Indexation
description: > description: >
Paths about indexing (public) polls. Paths about indexing (public) polls.
@ -60,3 +67,6 @@ components:
userAuth: userAuth:
type: http type: http
scheme: bearer scheme: bearer
adminAuth:
type: http
scheme: bearer

@ -13,8 +13,8 @@ get:
operationId: get-ballot operationId: get-ballot
summary: Gets a ballot by ID summary: Gets a ballot by ID
tags: tags:
- Poll Participation
- Poll Deliberation - Poll Deliberation
- Poll Participation
responses: responses:
'200': '200':
description: A ballot object description: A ballot object

@ -1,6 +1,9 @@
#
get: get:
operationId: get-users operationId: get-users
summary: Gets all users. summary: Gets all users
tags:
- User Management
responses: responses:
'200': '200':
description: OK description: OK
@ -10,9 +13,13 @@ get:
type: array type: array
items: items:
$ref: ../components/schemas/user.yaml $ref: ../components/schemas/user.yaml
security:
- adminAuth: []
post: post:
operationId: create-user operationId: create-user
summary: Creates an user summary: Creates an user
tags:
- User Management
requestBody: requestBody:
required: true required: true
content: content:

@ -8,6 +8,8 @@ parameters:
get: get:
operationId: get-user operationId: get-user
summary: Gets a user by ID summary: Gets a user by ID
tags:
- User Management
responses: responses:
'200': '200':
description: OK description: OK
@ -20,6 +22,8 @@ get:
patch: patch:
operationId: update-user operationId: update-user
summary: Updates a user summary: Updates a user
tags:
- User Management
requestBody: requestBody:
required: true required: true
content: content:
@ -41,6 +45,8 @@ patch:
delete: delete:
operationId: delete-user operationId: delete-user
summary: Deletes a user summary: Deletes a user
tags:
- User Management
responses: responses:
'200': '200':
description: OK description: OK

Loading…
Cancel
Save