rename grade to mention

pull/13/head
Nathanaël Jourdane 4 years ago committed by guhur
parent dc48687a42
commit e84ddc5d82

@ -273,11 +273,11 @@ components:
description: A unique identifier description: A unique identifier
example: 4 example: 4
readOnly: true readOnly: true
grade: mention:
type: integer type: integer
description: >- description: >-
The grade item, according to the grades array defined when creating The mention item, according to the mentions array defined when
the poll. creating the poll.
example: 2 example: 2
candidate: candidate:
type: object type: object
@ -296,7 +296,7 @@ components:
description: The ballots received by this candidate. description: The ballots received by this candidate.
items: items:
$ref: '#/components/schemas/ballot' $ref: '#/components/schemas/ballot'
grade: mention:
type: object type: object
properties: properties:
id: id:
@ -306,7 +306,9 @@ components:
readOnly: true readOnly: true
name: name:
type: string 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 example: Excellent
participant: participant:
type: object type: object
@ -351,13 +353,13 @@ components:
maxItems: 20 maxItems: 20
items: items:
$ref: '#/components/schemas/candidate' $ref: '#/components/schemas/candidate'
grades: mentions:
type: array type: array
description: The grades on which one vote to a candidate. description: The mentions on which one vote to a candidate.
minItems: 2 minItems: 2
maxItems: 10 maxItems: 10
items: items:
$ref: '#/components/schemas/grade' $ref: '#/components/schemas/mention'
participants: participants:
type: array type: array
description: The participants that are allowed to participate to the election. description: The participants that are allowed to participate to the election.
@ -389,9 +391,9 @@ components:
ranking: ranking:
type: array type: array
description: >- description: >-
An array representing grades level for each candidate, according to An array representing mentions level for each candidate, according
the grades list, following the order of the candidates array defined to the mentions list, following the order of the candidates array
when the related poll has been created. defined when the related poll has been created.
example: example:
- 0 - 0
- 6 - 6

@ -5,7 +5,7 @@ properties:
description: A unique identifier description: A unique identifier
example: 4 example: 4
readOnly: true readOnly: true
grade: mention:
type: integer 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 example: 2

@ -7,5 +7,5 @@ properties:
readOnly: true readOnly: true
name: name:
type: string 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 example: Excellent

@ -16,13 +16,13 @@ properties:
maxItems: 20 maxItems: 20
items: items:
$ref: ./candidate.yaml $ref: ./candidate.yaml
grades: mentions:
type: array 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 minItems: 2
maxItems: 10 maxItems: 10
items: items:
$ref: ./grade.yaml $ref: ./mention.yaml
participants: participants:
type: array type: array
description: The participants that are allowed to participate to the election. description: The participants that are allowed to participate to the election.

@ -4,8 +4,8 @@ properties:
$ref: ./poll.yaml $ref: ./poll.yaml
ranking: ranking:
type: array type: array
description: An array representing grades level for each candidate, description: An array representing mentions level for each candidate,
according to the grades list, following the order of the candidates array according to the mentions list, following the order of the candidates array
defined when the related poll has been created. defined when the related poll has been created.
example: [0, 6, 3, 2, 2] example: [0, 6, 3, 2, 2]
minItems: 2 minItems: 2

Loading…
Cancel
Save