PetResponseDto

Endpoints · All schemas

Field	Required	Description
assetCount	Yes	Number of assets with a confirmed observation of this pet
birthDate	Yes	Pet date of birth
createdAt	Yes	Creation date
featuredAssetId	Yes	Asset used as the pet thumbnail
id	Yes	Pet ID
isFavorite	Yes	Is favorite
isHidden	Yes	Is hidden
name	Yes	Pet name
species	Yes	See definition below
updatedAt	Yes	Last update date

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": {
    "assetCount": {
      "description": "Number of assets with a confirmed observation of this pet",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "birthDate": {
      "description": "Pet date of birth",
      "format": "date",
      "nullable": true,
      "type": "string"
    },
    "createdAt": {
      "description": "Creation date",
      "format": "date-time",
      "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"
    },
    "id": {
      "description": "Pet ID",
      "format": "uuid",
      "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": "Is favorite",
      "type": "boolean"
    },
    "isHidden": {
      "description": "Is hidden",
      "type": "boolean"
    },
    "name": {
      "description": "Pet name",
      "type": "string"
    },
    "species": {
      "$ref": "#/components/schemas/PetSpecies"
    },
    "updatedAt": {
      "description": "Last update date",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "assetCount",
    "birthDate",
    "createdAt",
    "featuredAssetId",
    "id",
    "isFavorite",
    "isHidden",
    "name",
    "species",
    "updatedAt"
  ],
  "type": "object"
}