You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
mv-api-spec/openapi/components/schemas/proposal.yaml

41 lines
1.0 KiB

# Thing unto which the participants pass judgments.
# Also known as Candidate.
type: object
properties:
id:
readOnly: true
type: integer
description: >
A unique identifier for the proposal, in the context of the poll.
This is not a globally unique identifier.
example: 4
uuid:
readOnly: true
type: string
format: uuid
description: >
A Universally Unique IDentifier for the proposal. (UUIDv4)
example: fa888652-727e-470b-817e-d77862a8d112
name:
type: string
description: >
Unique but short name of the proposal.
No markup is allowed.
example: A new school
description:
type: string
description: >
An optional, multiline description of the proposal.
Commonmark markdown is allowed.
example: This school would welcome 500 pupils.
ballots:
type: array
description: >
The ballots received by this proposal.
Each participant may emit one ballot (one judgment) per proposal.
items:
$ref: ./ballot.yaml
required:
- name