docs: review the poll

pull/17/head
Dominique Merle 4 years ago
parent 1c165637c6
commit 42b81d5e91

@ -3,19 +3,23 @@ description:
$ref: 'poll.md'
properties:
id:
type: string
description: A unique identifier.
example: 1jDe1e5eF_IkaYPuoIYX
readOnly: true
uuid:
type: string
format: uuid
# pattern is defined for implementations that don't understand format: uuid
pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'
description: >
A Universally Unique IDentifier for the poll. (version 4)
example: bb788552-727d-470b-827e-d7796248d293
readOnly: true
description: |
A unique identifier for the poll.
That identifier has a fixed length of 20 alphanumerical characters,
including some special characters like `_`.
pattern: '[0-9a-fA-F_]{20}'
example: 1jDe1e5eF_IkaYPuoIYX
# uuid:
# readOnly: true
# type: string
# format: uuid
# # pattern is defined for implementations that don't understand format: uuid
# pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'
# description: >
# A Universally Unique IDentifier for the poll. (version 4)
# example: bb788552-727d-470b-827e-d7796248d293
title:
type: string
description: The title of the poll.
@ -40,14 +44,32 @@ properties:
$ref: ./proposal.yaml
grades:
type: array
description: The grades on which one participant vote to a proposal.
description: |
The grades that participants may give to each proposal.
The grades should be **non-ambiguously ordinal**,
ie. their ranking should be obvious to everyone.
#### Good examples
- DISAPPROVED, APPROVED
- TO REJECT, POOR, PASSABLE, GOOD, VERY GOOD, EXCELLENT
- BORING, ENTERTAINING, FUN, AMAZING (to be discussed)
#### Bad examples
- LOUSY, MEDIOCRE, OKAY, GOOD, FINE, PEACHY
- BORING, BEAUTIFUL, FUN, MAGNIFICIENT
minItems: 2
maxItems: 10
items:
$ref: ./grade.yaml
participants:
type: array
description: The participants that are allowed to participate to the election.
description: |
The participants that are allowed to participate in the poll.
That property is ignored if `restrict_participants` is `false`.
---
Or should this be the list of the participants of the poll?
items:
$ref: ./participant.yaml
user-id:

Loading…
Cancel
Save