diff --git a/mv-openapi.yaml b/mv-openapi.yaml index 6137e60..7c779c8 100644 --- a/mv-openapi.yaml +++ b/mv-openapi.yaml @@ -273,11 +273,11 @@ components: description: A unique identifier example: 4 readOnly: true - grade: + mention: type: integer description: >- - The grade item, according to the grades array defined when creating - the poll. + The mention item, according to the mentions array defined when + creating the poll. example: 2 candidate: type: object @@ -296,7 +296,7 @@ components: description: The ballots received by this candidate. items: $ref: '#/components/schemas/ballot' - grade: + mention: type: object properties: id: @@ -306,7 +306,9 @@ components: readOnly: true name: type: string - description: 'Unique but short name of the grade, like "Excellent" or "To reject".' + description: >- + Unique but short name of the mention, like "Excellent" or "To + reject". example: Excellent participant: type: object @@ -351,13 +353,13 @@ components: maxItems: 20 items: $ref: '#/components/schemas/candidate' - grades: + mentions: type: array - description: The grades on which one vote to a candidate. + description: The mentions on which one vote to a candidate. minItems: 2 maxItems: 10 items: - $ref: '#/components/schemas/grade' + $ref: '#/components/schemas/mention' participants: type: array description: The participants that are allowed to participate to the election. @@ -389,9 +391,9 @@ components: ranking: type: array description: >- - An array representing grades level for each candidate, according to - the grades list, following the order of the candidates array defined - when the related poll has been created. + An array representing mentions level for each candidate, according + to the mentions list, following the order of the candidates array + defined when the related poll has been created. example: - 0 - 6 diff --git a/openapi/components/schemas/ballot.yaml b/openapi/components/schemas/ballot.yaml index 2c73a19..efb0644 100644 --- a/openapi/components/schemas/ballot.yaml +++ b/openapi/components/schemas/ballot.yaml @@ -5,7 +5,7 @@ properties: description: A unique identifier example: 4 readOnly: true - grade: + mention: type: integer - description: The grade item, according to the grades array defined when creating the poll. + description: The mention item, according to the mentions array defined when creating the poll. example: 2 diff --git a/openapi/components/schemas/grade.yaml b/openapi/components/schemas/mention.yaml similarity index 65% rename from openapi/components/schemas/grade.yaml rename to openapi/components/schemas/mention.yaml index da55977..bee9229 100644 --- a/openapi/components/schemas/grade.yaml +++ b/openapi/components/schemas/mention.yaml @@ -7,5 +7,5 @@ properties: readOnly: true name: type: string - description: Unique but short name of the grade, like "Excellent" or "To reject". + description: Unique but short name of the mention, like "Excellent" or "To reject". example: Excellent diff --git a/openapi/components/schemas/poll.yaml b/openapi/components/schemas/poll.yaml index 1148386..8ec3803 100644 --- a/openapi/components/schemas/poll.yaml +++ b/openapi/components/schemas/poll.yaml @@ -16,13 +16,13 @@ properties: maxItems: 20 items: $ref: ./candidate.yaml - grades: + mentions: type: array - description: The grades on which one vote to a candidate. + description: The mentions on which one participant vote to a candidate. minItems: 2 maxItems: 10 items: - $ref: ./grade.yaml + $ref: ./mention.yaml participants: type: array description: The participants that are allowed to participate to the election. diff --git a/openapi/components/schemas/result.yaml b/openapi/components/schemas/result.yaml index 469e7b8..2d186f3 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 grades level for each candidate, - according to the grades list, following the order of the candidates array + description: An array representing mentions level for each candidate, + according to the mentions list, following the order of the candidates array defined when the related poll has been created. example: [0, 6, 3, 2, 2] minItems: 2