Schemas
Edition
Response and request schema
Schema
object
Edition of a competition. Only editions with a start date and at least one class are public hierarchy nodes.
| Field | Type | Description |
|---|---|---|
competition_id | integer (int64) · required | Public ID of the parent competition. |
date_from | string (date) · required | Edition start date. Never null on a public edition. |
date_to | string (date) or null · required | Edition end date. |
id | integer (int64) · required | Public edition ID. |
international | boolean · required | |
name | string · required | |
star_level | integer or null · required | Star rating as a nullable integer; expected values are 1 through 5, and absence is null, never zero. |
Complete OpenAPI definition
{
"description": "Edition of a competition. Only editions with a start date and at least one class are public hierarchy nodes.",
"properties": {
"competition_id": {
"description": "Public ID of the parent competition.",
"format": "int64",
"type": "integer"
},
"date_from": {
"description": "Edition start date. Never null on a public edition.",
"format": "date",
"type": "string"
},
"date_to": {
"description": "Edition end date.",
"format": "date",
"nullable": true,
"type": "string"
},
"id": {
"description": "Public edition ID.",
"format": "int64",
"type": "integer"
},
"international": {
"type": "boolean"
},
"name": {
"type": "string"
},
"star_level": {
"description": "Star rating as a nullable integer; expected values are 1 through 5, and absence is null, never zero.",
"nullable": true,
"type": "integer"
}
},
"required": [
"id",
"competition_id",
"name",
"date_from",
"date_to",
"international",
"star_level"
],
"type": "object"
}