{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/shepherd-vet/json-schema/shepherd-vet-open-api-breed-controller-breed-filter-model-schema.json",
  "title": "OpenApiBreedController.BreedFilterModel",
  "description": "Breed Filter REST model",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/shepherd-vet-breed-api-openapi.yml#/components/schemas/OpenApiBreedController.BreedFilterModel",
  "type": "object",
  "properties": {
    "getBreedsByClinicId": {
      "description": "Flag that filters breeds by the specific clinic. Defaults to null, which shows all breeds. If set to true, only breeds of clinic patients identified by x-clinic-id will be returned.",
      "type": "boolean"
    },
    "getBreedsByGroupId": {
      "description": "Flag that filters breeds by the clinic's group. Defaults to null, which shows all breeds. If set to true, only breeds of clinic patients in group where the specified clinic is (x-clinic-id) will be returned. This is shown by example response.",
      "type": "boolean"
    },
    "isDeleted": {
      "description": "Filters by deleted status. Defaults to null (fetches both deleted and non-deleted entities).",
      "type": "boolean"
    },
    "isLegacy": {
      "description": "Filters breeds by whether it is legacy or not.",
      "type": "boolean"
    },
    "searchQuery": {
      "description": "Filters by breed name. (e.g \"Frog\")",
      "type": "string"
    },
    "speciesId": {
      "format": "uuid",
      "description": "Unique identifier of the Species entity you wish to filter by.",
      "type": "string"
    },
    "dateCreatedFrom": {
      "format": "date-time",
      "description": "Sets the start of the date range filter on the entity creation date. Must not be later than DateCreatedTo, or\nthe request returns 400. Defaults to null.",
      "type": "string"
    },
    "dateCreatedTo": {
      "format": "date-time",
      "description": "The end of the date range filter on the entity creation date. Defaults to null.",
      "type": "string"
    },
    "dateUpdatedFrom": {
      "format": "date-time",
      "description": "The start of the date range filter on the entity last update date. Must not be later than DateUpdatedTo, or the\nrequest returns 400. Defaults to null.",
      "type": "string"
    },
    "dateUpdatedTo": {
      "format": "date-time",
      "description": "The end of the date range filter on the entity last update date. Defaults to null.",
      "type": "string"
    },
    "embed": {
      "description": "Comma-separated list of embedded properties to fetch. Nested fetches can be specified using dot notation (e.g., \"client.clientPhones\"). Defaults to null.",
      "type": "string"
    },
    "excludeIds": {
      "description": "Comma-separated list of IDs representing entities that you wish to exclude from your search. Defaults to null.",
      "type": "string"
    },
    "ids": {
      "description": "Comma-separated list of IDs representing entities that you wish to include in your search. Defaults to null.",
      "type": "string"
    },
    "page": {
      "format": "int32",
      "description": "The page number. Defaults to 1.",
      "type": "integer"
    },
    "rpp": {
      "format": "int32",
      "description": "The number of items to return per page. The max is 1000. Defaults to 10.",
      "type": "integer"
    },
    "sort": {
      "description": "Which field to sort by. Needs to be in \"field|order\" format, where order is either \"asc\" or \"desc\". The default sort field depends on the endpoint, typically \"id|asc\"",
      "type": "string"
    }
  }
}