BatchGetMirrorsRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/canonical/main/json-schema/canonical-batch-get-mirrors-request-schema.json",
  "title": "BatchGetMirrorsRequest",
  "description": "The request message for retrieving a batch of mirrors.",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/canonical-mirrorservice-api-openapi.yml#/components/schemas/BatchGetMirrorsRequest",
  "required": [
    "names"
  ],
  "type": "object",
  "properties": {
    "names": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The names of the mirrors to retrieve.\n A maximum of 100 mirrors can be retrieved in a batch.\n Format: mirrors/{mirror}"
    },
    "returnPartialSuccess": {
      "type": "boolean",
      "description": "Setting this field to `true` will opt the request into returning the\n mirrors that are reachable, and into including the names of those that\n were unreachable in the [BatchGetMirrorsResponse.unreachable] field."
    }
  }
}