refactor: grade --> grade (1/2)

Rationale: `grade` comes from a frencophone bias.
pull/17/head
Dominique Merle 4 years ago
parent f0690c7b1e
commit 5d58bc6bf2

@ -5,7 +5,10 @@ properties:
description: A unique identifier description: A unique identifier
example: 4 example: 4
readOnly: true readOnly: true
mention: grade:
type: integer type: integer
description: The mention item, according to the mentions array defined when creating the poll. description: >
One grade of the grading defined when creating the poll.
Zero (0) means the worst grade, and it goes upwards from there,
up to the size of the grading, minus one.
example: 2 example: 2

@ -2,16 +2,19 @@ type: object
properties: properties:
id: id:
type: integer type: integer
description: A unique identifier description: >
Unique identifier of the grade in its grading.
Zero (0) is the worst grade, and it goes upwards.
example: 0 example: 0
readOnly: true readOnly: true
name: name:
type: string type: string
description: Unique but short name of the mention, like *Excellent* or *To reject*. description: >
example: Excellent Unique but short name of the grade, like "Excellent" or "To reject".
example: Good
description: description:
type: string type: string
description: An optional description of the mention description: An optional description of the grade.
example: In this poll, the mention *To reject* disqualifies the proposal. example: In this poll, the grade "To reject" disqualifies the proposal.
required: required:
- name - name

@ -2,7 +2,7 @@ type: object
properties: properties:
id: id:
type: string type: string
description: A unique identifier description: A unique identifier.
example: 1jDe1e5eF_IkaYPuoIYX example: 1jDe1e5eF_IkaYPuoIYX
readOnly: true readOnly: true
title: title:
@ -12,7 +12,7 @@ properties:
description: description:
type: string type: string
description: A description of the poll description: A description of the poll
example: example:
proposals: proposals:
type: array type: array
description: The proposals being voted in a poll. description: The proposals being voted in a poll.
@ -20,13 +20,13 @@ properties:
maxItems: 20 maxItems: 20
items: items:
$ref: ./proposal.yaml $ref: ./proposal.yaml
mentions: grades:
type: array type: array
description: The mentions on which one participant vote to a proposal. description: The grades on which one participant vote to a proposal.
minItems: 2 minItems: 2
maxItems: 10 maxItems: 10
items: items:
$ref: ./mention.yaml $ref: ./grade.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.
@ -37,7 +37,7 @@ properties:
description: Organizer id. If not given, a dummy user is created. description: Organizer id. If not given, a dummy user is created.
restrict-participants: restrict-participants:
type: boolean type: boolean
description: True if anyone can participate to this poll, False otherwise. description: True if anyone can participate in this poll, False otherwise.
example: false example: false
required: required:
- title - title

@ -4,8 +4,8 @@ properties:
$ref: ./poll.yaml $ref: ./poll.yaml
ranking: ranking:
type: array type: array
description: An array representing mentions level for each proposal, description: An array representing grades level for each proposal,
according to the mentions list, following the order of the proposals array according to the grades list, following the order of the proposals 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