diff --git a/openapi/paths/polls@{poll-id}.yaml b/openapi/paths/polls@{poll-id}.yaml index 2e575d0..0133dfb 100644 --- a/openapi/paths/polls@{poll-id}.yaml +++ b/openapi/paths/polls@{poll-id}.yaml @@ -7,7 +7,7 @@ parameters: format: int64 get: operationId: get-poll - summary: Gets a poll by ID + summary: Gets a poll by ID. responses: '200': description: OK @@ -19,7 +19,7 @@ get: $ref: ../components/responses/poll-not-found.yaml patch: operationId: update-poll - summary: Updates a poll + summary: Updates a poll. requestBody: required: true content: @@ -31,19 +31,23 @@ patch: - pollAuth: [] responses: '200': - description: OK + description: Poll was updated. content: application/json: schema: - type: array - items: - $ref: ../components/schemas/poll.yaml + $ref: ../components/schemas/poll.yaml + '404': + $ref: ../components/responses/poll-not-found.yaml delete: operationId: delete-poll - summary: Deletes a poll + summary: Deletes a poll. + description: > + All the Poll data will be permanently erased. + This includes all the corollary models (Tally, Ballots, …) + Only the Poll's author may delete it. (and wild admins) responses: '200': - description: OK + description: Poll was deleted. '404': $ref: ../components/responses/poll-not-found.yaml security: