diff --git a/mv-openapi.yaml b/mv-openapi.yaml index 7c779c8..c105a73 100644 --- a/mv-openapi.yaml +++ b/mv-openapi.yaml @@ -59,7 +59,7 @@ paths: list-poll-results: $ref: '#/components/links/list-poll-results' '400': - description: Bad Request. Expect at least 2 candidates and a title. + description: Bad Request. Expect at least 2 proposals and a title. '/polls/{poll-id}': parameters: - in: path @@ -279,7 +279,7 @@ components: The mention item, according to the mentions array defined when creating the poll. example: 2 - candidate: + proposal: type: object properties: id: @@ -289,11 +289,11 @@ components: example: 4 name: type: string - description: Unique but short name of the candidate. + description: Unique but short name of the proposal. example: A new school ballots: type: array - description: The ballots received by this candidate. + description: The ballots received by this proposal. items: $ref: '#/components/schemas/ballot' mention: @@ -346,16 +346,16 @@ components: type: string example: What project should our neighbourhood invest in for the next year? description: The title of the poll - candidates: + proposals: type: array - description: The candidates being voted in a poll. + description: The proposals being voted in a poll. minItems: 2 maxItems: 20 items: - $ref: '#/components/schemas/candidate' + $ref: '#/components/schemas/proposal' mentions: type: array - description: The mentions on which one vote to a candidate. + description: The mentions on which one participant vote to a proposal. minItems: 2 maxItems: 10 items: @@ -391,8 +391,8 @@ components: ranking: type: array description: >- - An array representing mentions level for each candidate, according - to the mentions list, following the order of the candidates array + An array representing mentions level for each proposal, according to + the mentions list, following the order of the proposals array defined when the related poll has been created. example: - 0 diff --git a/openapi/components/schemas/poll.yaml b/openapi/components/schemas/poll.yaml index 8ec3803..1a5b805 100644 --- a/openapi/components/schemas/poll.yaml +++ b/openapi/components/schemas/poll.yaml @@ -9,16 +9,16 @@ properties: type: string example: 'What project should our neighbourhood invest in for the next year?' description: 'The title of the poll' - candidates: + proposals: type: array - description: The candidates being voted in a poll. + description: The proposals being voted in a poll. minItems: 2 maxItems: 20 items: - $ref: ./candidate.yaml + $ref: ./proposal.yaml mentions: type: array - description: The mentions on which one participant vote to a candidate. + description: The mentions on which one participant vote to a proposal. minItems: 2 maxItems: 10 items: diff --git a/openapi/components/schemas/candidate.yaml b/openapi/components/schemas/proposal.yaml similarity index 67% rename from openapi/components/schemas/candidate.yaml rename to openapi/components/schemas/proposal.yaml index 4f5f78b..65fb4a5 100644 --- a/openapi/components/schemas/candidate.yaml +++ b/openapi/components/schemas/proposal.yaml @@ -7,10 +7,10 @@ properties: example: 4 name: type: string - description: Unique but short name of the candidate. + description: Unique but short name of the proposal. example: A new school ballots: type: array - description: The ballots received by this candidate. + description: The ballots received by this proposal. items: $ref: ./ballot.yaml diff --git a/openapi/components/schemas/result.yaml b/openapi/components/schemas/result.yaml index 2d186f3..1e02b53 100644 --- a/openapi/components/schemas/result.yaml +++ b/openapi/components/schemas/result.yaml @@ -4,8 +4,8 @@ properties: $ref: ./poll.yaml ranking: type: array - description: An array representing mentions level for each candidate, - according to the mentions list, following the order of the candidates array + description: An array representing mentions level for each proposal, + according to the mentions list, following the order of the proposals array defined when the related poll has been created. example: [0, 6, 3, 2, 2] minItems: 2 diff --git a/openapi/paths/polls.yaml b/openapi/paths/polls.yaml index 83c0663..cbd1523 100644 --- a/openapi/paths/polls.yaml +++ b/openapi/paths/polls.yaml @@ -42,4 +42,4 @@ post: list-poll-results: $ref: ../components/links/list-poll-results.yaml '400': - description: Bad Request. Expect at least 2 candidates and a title. + description: Bad Request. Expect at least 2 proposals and a title.