Skip to content

PetCreateDto

Endpoints · All schemas

FieldRequiredDescription
birthDateNoPet date of birth
featuredAssetIdNoAsset used as the pet thumbnail
isFavoriteNoMark as favorite
isHiddenNoPet visibility (hidden)
nameNoPet name
speciesNoSee definition below

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: PetSpecies

{
  "properties": {
    "birthDate": {
      "description": "Pet date of birth",
      "format": "date",
      "nullable": true,
      "type": "string"
    },
    "featuredAssetId": {
      "description": "Asset used as the pet thumbnail",
      "format": "uuid",
      "nullable": true,
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "isFavorite": {
      "description": "Mark as favorite",
      "type": "boolean"
    },
    "isHidden": {
      "description": "Pet visibility (hidden)",
      "type": "boolean"
    },
    "name": {
      "description": "Pet name",
      "maxLength": 100,
      "type": "string"
    },
    "species": {
      "$ref": "#/components/schemas/PetSpecies",
      "default": "other"
    }
  },
  "type": "object"
}