feat: tag more paths

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

@ -5,6 +5,7 @@ properties:
description: > description: >
Unique identifier of the grade in its grading. Unique identifier of the grade in its grading.
Zero (0) is the worst grade, and it goes upwards. Zero (0) is the worst grade, and it goes upwards.
TBD - WIP
example: 0 example: 0
readOnly: true readOnly: true
name: name:

@ -33,17 +33,24 @@ paths:
'/users/{user-id}': '/users/{user-id}':
$ref: 'paths/users@{user-id}.yaml' $ref: 'paths/users@{user-id}.yaml'
tags: tags:
- name: Poll Indexation
description: >
Paths about indexing (public) polls.
- name: Poll Organization - name: Poll Organization
description: > description: >
Paths about the organization of polls. Paths about organizing a poll.
- name: Poll Participation - name: Poll Participation
description: > description: >
Paths about participating to a poll. Paths about participating to a poll.
- name: Poll Deliberation
description: >
Paths about deliberating using a poll.
components: components:
securitySchemes: securitySchemes:
participantAuth: participantAuth:
type: http type: http
scheme: bearer scheme: bearer
# organizerAuth
pollAuth: pollAuth:
type: http type: http
scheme: bearer scheme: bearer

@ -2,6 +2,7 @@ get:
operationId: get-polls operationId: get-polls
summary: Gets all polls summary: Gets all polls
tags: tags:
- Poll Indexation
- Poll Organization - Poll Organization
- Poll Participation - Poll Participation
responses: responses:

@ -7,6 +7,8 @@ parameters:
post: post:
operationId: create-ballot operationId: create-ballot
summary: Creates a ballot summary: Creates a ballot
tags:
- Poll Participation
requestBody: requestBody:
required: true required: true
content: content:
@ -26,7 +28,7 @@ post:
properties: properties:
id: id:
type: string type: string
description: Id of the created ballot. description: Identifier of the created ballot.
links: links:
get-ballot: get-ballot:
$ref: ../components/links/get-ballot.yaml $ref: ../components/links/get-ballot.yaml

@ -12,6 +12,9 @@ parameters:
get: get:
operationId: get-ballot operationId: get-ballot
summary: Gets a ballot by ID summary: Gets a ballot by ID
tags:
- Poll Participation
- Poll Deliberation
responses: responses:
'200': '200':
description: A ballot object description: A ballot object
@ -22,6 +25,8 @@ get:
delete: delete:
operationId: delete-ballot operationId: delete-ballot
summary: Deletes a ballot summary: Deletes a ballot
tags:
- Poll Participation
responses: responses:
'200': '200':
description: OK description: OK

@ -7,6 +7,8 @@ parameters:
get: get:
operationId: get-poll-results operationId: get-poll-results
summary: Gets the results of a poll summary: Gets the results of a poll
tags:
- Poll Deliberation
responses: responses:
'200': '200':
description: OK description: OK

Loading…
Cancel
Save