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/poll.yaml

45 lines
1.1 KiB

type: object
properties:
id:
type: string
description: A unique identifier
example: 1jDe1e5eF_IkaYPuoIYX
readOnly: true
title:
type: string
example: What project should our neighbourhood invest in for the next year?
description: The title of the poll
description:
type: string
description: A description of the poll
example:
proposals:
type: array
description: The proposals being voted in a poll.
minItems: 2
maxItems: 20
items:
$ref: ./proposal.yaml
mentions:
type: array
description: The mentions on which one participant vote to a proposal.
minItems: 2
maxItems: 10
items:
$ref: ./mention.yaml
participants:
type: array
description: The participants that are allowed to participate to the election.
items:
$ref: ./participant.yaml
user-id:
type: string
description: Organizer id. If not given, a dummy user is created.
restrict-participants:
type: boolean
description: True if anyone can participate to this poll, False otherwise.
example: false
required:
- title
- proposals