diff --git a/.redocly.yaml b/.redocly.yaml index 4c24af2..988455c 100644 --- a/.redocly.yaml +++ b/.redocly.yaml @@ -17,7 +17,7 @@ lint: license-url: off no-extra-fields: off operation-description: off - operation-operationId: off + operation-operationId: on operation-tags: off provide-contact: off servers-no-trailing-slash: off diff --git a/mv-openapi.yaml b/mv-openapi.yaml index 2724e9f..9e623e6 100644 --- a/mv-openapi.yaml +++ b/mv-openapi.yaml @@ -15,6 +15,7 @@ servers: paths: /polls: get: + operationId: get-polls summary: Gets all polls. responses: '200': @@ -26,6 +27,7 @@ paths: items: $ref: '#/components/schemas/Poll' post: + operationId: create-poll summary: Creates a poll. requestBody: required: true @@ -66,6 +68,7 @@ paths: type: integer format: int64 get: + operationId: get-poll summary: Gets a poll by ID responses: '200': @@ -77,6 +80,7 @@ paths: '404': $ref: '#/components/responses/PollNotFound' patch: + operationId: update-poll summary: Updates a poll requestBody: required: true @@ -97,6 +101,7 @@ paths: items: $ref: '#/components/schemas/Poll' delete: + operationId: delete-poll summary: Deletes a poll responses: '200': @@ -113,6 +118,7 @@ paths: schema: type: string post: + operationId: add-judge-to-poll description: Add a judge to a poll requestBody: content: @@ -136,6 +142,7 @@ paths: schema: type: string get: + operationId: get-poll-results description: Get results of a poll responses: '200': @@ -154,6 +161,7 @@ paths: schema: type: string post: + operationId: create-poll-judgment summary: Creates a judgment requestBody: required: true @@ -188,6 +196,7 @@ paths: schema: type: string get: + operationId: get-poll-judgment summary: Gets a judgment by ID responses: '200': @@ -197,6 +206,7 @@ paths: schema: $ref: '#/components/schemas/Judgment' delete: + operationId: delete-poll-judgment summary: Deletes a judgment responses: '200': @@ -213,6 +223,7 @@ paths: schema: type: string get: + operationId: get-poll-judge summary: Get a judge from a poll responses: '200': @@ -227,6 +238,7 @@ paths: - {} - pollAuth: [] delete: + operationId: delete-poll-judge summary: Delete a judge from a poll responses: '200': @@ -344,49 +356,49 @@ components: format: int16 links: GetPollByPollId: - operationRef: '#/paths/~1polls/~1{poll-id}/get' + operationRef: get-poll parameters: pollId: $response.body#/id description: > The `id` value returned in the response can be used as the `poll-id` parameter in GET /polls/{poll-id}. SetPollByPollId: - operationRef: '#/paths/~1polls/~1{poll-id}/patch' + operationRef: update-poll parameters: pollId: $response.body#/id description: > The `id` value returned in the response can be used as the `poll-id` parameter in PATCH /polls/{poll-id}. DelPollByPollId: - operationRef: '#/paths/~1polls/~1{poll-id}/delete' + operationRef: delete-poll parameters: pollId: $response.body#/id description: > The `id` value returned in the response can be used as the `poll-id` parameter in DELETE /polls/{poll-id}. JudgeByPollId: - operationRef: '#/paths/~1judges/~1{poll-id}/post' + operationRef: create-poll-judgment parameters: userId: $response.body#/id description: > The `id` value returned in the response can be used as the `poll-id` parameter in GET /judgments/{poll-id}. ResultsByPollId: - operationRef: '#/paths/~1polls/~1{poll-id}/results/get' + operationRef: get-poll-results parameters: pollId: $response.body#/id description: > The `id` value returned in the response can be used as the `poll-id` parameter in GET /results/{result-id}. GetJudgmentByJudgmentId: - operationRef: '#/paths/~1judgments/~1{judgment-id}/get' + operationRef: get-judgment parameters: judgmentId: $response.body#/id description: > The `id` value returned in the response can be used as the `judgment-id` parameter in GET /judgments/{judgment-id}. DelJudgmentByJudgmentId: - operationRef: '#/paths/~1judgments/~1{judgment-id}/delete' + operationId: delete-poll-judgment parameters: judgmentId: $response.body#/id description: > diff --git a/openapi/components/links/DelJudgmentByJudgmentId.yaml b/openapi/components/links/DelJudgmentByJudgmentId.yaml index f8d60b4..d3cca96 100644 --- a/openapi/components/links/DelJudgmentByJudgmentId.yaml +++ b/openapi/components/links/DelJudgmentByJudgmentId.yaml @@ -1,4 +1,4 @@ -operationRef: '#/paths/~1judgments/~1{judgment-id}/delete' +operationId: 'delete-poll-judgment' parameters: judgmentId: $response.body#/id description: > diff --git a/openapi/components/links/DelPollByPollId.yaml b/openapi/components/links/DelPollByPollId.yaml index 377cd5f..3e4f44b 100644 --- a/openapi/components/links/DelPollByPollId.yaml +++ b/openapi/components/links/DelPollByPollId.yaml @@ -1,4 +1,4 @@ -operationRef: '#/paths/~1polls/~1{poll-id}/delete' +operationRef: 'delete-poll' parameters: pollId: $response.body#/id description: > diff --git a/openapi/components/links/GetJudgmentByJudgmentId.yaml b/openapi/components/links/GetJudgmentByJudgmentId.yaml index bd5888d..8db1025 100644 --- a/openapi/components/links/GetJudgmentByJudgmentId.yaml +++ b/openapi/components/links/GetJudgmentByJudgmentId.yaml @@ -1,4 +1,4 @@ -operationRef: '#/paths/~1judgments/~1{judgment-id}/get' +operationRef: 'get-judgment' parameters: judgmentId: $response.body#/id description: > diff --git a/openapi/components/links/GetPollByPollId.yaml b/openapi/components/links/GetPollByPollId.yaml index 125dc06..3fc6fa2 100644 --- a/openapi/components/links/GetPollByPollId.yaml +++ b/openapi/components/links/GetPollByPollId.yaml @@ -1,4 +1,4 @@ -operationRef: '#/paths/~1polls/~1{poll-id}/get' +operationRef: 'get-poll' parameters: pollId: $response.body#/id description: > diff --git a/openapi/components/links/InviteByPollId.yaml b/openapi/components/links/InviteByPollId.yaml index 08f07a7..b15498f 100644 --- a/openapi/components/links/InviteByPollId.yaml +++ b/openapi/components/links/InviteByPollId.yaml @@ -1,4 +1,4 @@ -operationRef: '#/paths/~1polls/~1{poll-id}/judges/post' +operationRef: 'add-judge-to-poll' parameters: userId: $response.body#/id description: > diff --git a/openapi/components/links/JudgeByPollId.yaml b/openapi/components/links/JudgeByPollId.yaml index bf76496..0b48f72 100644 --- a/openapi/components/links/JudgeByPollId.yaml +++ b/openapi/components/links/JudgeByPollId.yaml @@ -1,4 +1,4 @@ -operationRef: '#/paths/~1judges/~1{poll-id}/post' +operationRef: 'create-poll-judgment' parameters: userId: $response.body#/id description: > diff --git a/openapi/components/links/ResultsByPollId.yaml b/openapi/components/links/ResultsByPollId.yaml index a314386..231b5d1 100644 --- a/openapi/components/links/ResultsByPollId.yaml +++ b/openapi/components/links/ResultsByPollId.yaml @@ -1,4 +1,4 @@ -operationRef: '#/paths/~1polls/~1{poll-id}/results/get' +operationRef: 'get-poll-results' parameters: pollId: $response.body#/id description: > diff --git a/openapi/components/links/SetPollByPollId.yaml b/openapi/components/links/SetPollByPollId.yaml index 21d1869..5fa4781 100644 --- a/openapi/components/links/SetPollByPollId.yaml +++ b/openapi/components/links/SetPollByPollId.yaml @@ -1,4 +1,4 @@ -operationRef: '#/paths/~1polls/~1{poll-id}/patch' +operationRef: 'update-poll' parameters: pollId: $response.body#/id description: > diff --git a/openapi/paths/judgments@{judgment-id}.yaml b/openapi/paths/judgments@{judgment-id}.yaml index e2f25f3..5b0e44a 100644 --- a/openapi/paths/judgments@{judgment-id}.yaml +++ b/openapi/paths/judgments@{judgment-id}.yaml @@ -5,6 +5,7 @@ parameters: schema: type: string get: + operationId: get-poll-judgment summary: Gets a judgment by ID responses: '200': @@ -14,6 +15,7 @@ get: schema: $ref: ../components/schemas/Judgment.yaml delete: + operationId: delete-poll-judgment summary: Deletes a judgment responses: '200': diff --git a/openapi/paths/polls.yaml b/openapi/paths/polls.yaml index b23583b..8727bb1 100644 --- a/openapi/paths/polls.yaml +++ b/openapi/paths/polls.yaml @@ -1,4 +1,5 @@ get: + operationId: get-polls summary: Gets all polls. responses: '200': @@ -10,6 +11,7 @@ get: items: $ref: ../components/schemas/Poll.yaml post: + operationId: create-poll summary: Creates a poll. requestBody: required: true diff --git a/openapi/paths/polls@{poll-id}.yaml b/openapi/paths/polls@{poll-id}.yaml index 8c2cd56..6812685 100644 --- a/openapi/paths/polls@{poll-id}.yaml +++ b/openapi/paths/polls@{poll-id}.yaml @@ -6,6 +6,7 @@ parameters: type: integer format: int64 get: + operationId: get-poll summary: Gets a poll by ID responses: '200': @@ -17,6 +18,7 @@ get: '404': $ref: ../components/responses/PollNotFound.yaml patch: + operationId: update-poll summary: Updates a poll requestBody: required: true @@ -37,6 +39,7 @@ patch: items: $ref: ../components/schemas/Poll.yaml delete: + operationId: delete-poll summary: Deletes a poll responses: '200': diff --git a/openapi/paths/polls@{poll-id}@judges.yaml b/openapi/paths/polls@{poll-id}@judges.yaml index 486f4db..4038117 100644 --- a/openapi/paths/polls@{poll-id}@judges.yaml +++ b/openapi/paths/polls@{poll-id}@judges.yaml @@ -5,6 +5,7 @@ parameters: schema: type: string post: + operationId: add-judge-to-poll description: Add a judge to a poll requestBody: content: diff --git a/openapi/paths/polls@{poll-id}@judges@{judge-id}@.yaml b/openapi/paths/polls@{poll-id}@judges@{judge-id}@.yaml index 3666269..3d10291 100644 --- a/openapi/paths/polls@{poll-id}@judges@{judge-id}@.yaml +++ b/openapi/paths/polls@{poll-id}@judges@{judge-id}@.yaml @@ -5,6 +5,7 @@ parameters: schema: type: string get: + operationId: get-poll-judge summary: Get a judge from a poll responses: '200': @@ -19,6 +20,7 @@ get: - {} - pollAuth: [] delete: + operationId: delete-poll-judge summary: Delete a judge from a poll responses: '200': diff --git a/openapi/paths/polls@{poll-id}@judgments.yaml b/openapi/paths/polls@{poll-id}@judgments.yaml index 6743c27..188c7d9 100644 --- a/openapi/paths/polls@{poll-id}@judgments.yaml +++ b/openapi/paths/polls@{poll-id}@judgments.yaml @@ -5,6 +5,7 @@ parameters: schema: type: string post: + operationId: create-poll-judgment summary: Creates a judgment requestBody: required: true diff --git a/openapi/paths/polls@{poll-id}@results.yaml b/openapi/paths/polls@{poll-id}@results.yaml index 895dd6b..33a467e 100644 --- a/openapi/paths/polls@{poll-id}@results.yaml +++ b/openapi/paths/polls@{poll-id}@results.yaml @@ -5,6 +5,7 @@ parameters: schema: type: string get: + operationId: get-poll-results description: Get results of a poll responses: '200':