Schemas
BreedingOffspring
Response and request schema
Schema
object
Foal with at most three offspring generations below its dam. Repeated dams have no nested offspring.
Additional properties: false.
| Field | Type | Description |
|---|---|---|
approved_for | array of PedigreeStudbookRef · required | |
birth_year | BirthYear or null · required | Four-digit year derived from the recorded birth date. Null when no year is available; an exact month and day are never exposed. Minimum: |
colour | string or null · required | |
id | integer (int64) · required | Minimum: |
is_subject | boolean · required | |
name | string · required | Minimum length: |
offspring | array of BreedingOffspring · required | Maximum items: |
repeated_dam | boolean · required | |
sex | string or null · required | |
sire_name | string or null · required | Recorded name of this horse's sire, or null when none is recorded. It is a name only, without a horse ID. Minimum length: |
studbook | NullablePedigreeStudbookRef or null · required | Additional properties: |
Related schemas: PedigreeStudbookRef, BirthYear, BreedingOffspring, NullablePedigreeStudbookRef
Complete OpenAPI definition
{
"additionalProperties": false,
"description": "Foal with at most three offspring generations below its dam. Repeated dams have no nested offspring.",
"properties": {
"approved_for": {
"items": {
"$ref": "#/components/schemas/PedigreeStudbookRef"
},
"type": "array"
},
"birth_year": {
"$ref": "#/components/schemas/BirthYear"
},
"colour": {
"nullable": true,
"type": "string"
},
"id": {
"format": "int64",
"minimum": 1,
"type": "integer"
},
"is_subject": {
"type": "boolean"
},
"name": {
"minLength": 1,
"type": "string"
},
"offspring": {
"items": {
"$ref": "#/components/schemas/BreedingOffspring"
},
"maxItems": 500,
"type": "array"
},
"repeated_dam": {
"type": "boolean"
},
"sex": {
"nullable": true,
"type": "string"
},
"sire_name": {
"description": "Recorded name of this horse's sire, or null when none is recorded. It is a name only, without a horse ID.",
"minLength": 1,
"nullable": true,
"type": "string"
},
"studbook": {
"$ref": "#/components/schemas/NullablePedigreeStudbookRef"
}
},
"required": [
"id",
"name",
"birth_year",
"sex",
"colour",
"studbook",
"approved_for",
"sire_name",
"is_subject",
"repeated_dam",
"offspring"
],
"type": "object"
}