PageOfProviders

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/blacksky/json-schema/blacksky-page-of-providers-schema.json",
  "title": "PageOfProviders",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/blacksky-glossary-api-openapi.yml#/components/schemas/PageOfProviders",
  "allOf": [
    {
      "$ref": "#/$defs/PageableResponse"
    },
    {
      "type": "object",
      "properties": {
        "content": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ProviderWithRoles"
          }
        }
      }
    }
  ],
  "$defs": {
    "PageableObject": {
      "type": "object",
      "properties": {
        "pageNumber": {
          "type": "integer",
          "format": "int32"
        },
        "pageSize": {
          "type": "integer",
          "format": "int32"
        },
        "sort": {
          "$ref": "#/$defs/Sort"
        },
        "offset": {
          "type": "integer",
          "format": "int64"
        },
        "paged": {
          "type": "boolean"
        },
        "unpaged": {
          "type": "boolean"
        }
      }
    },
    "PageableResponse": {
      "type": "object",
      "properties": {
        "pageable": {
          "$ref": "#/$defs/PageableObject"
        },
        "last": {
          "type": "boolean"
        },
        "totalElements": {
          "type": "integer",
          "format": "int64"
        },
        "totalPages": {
          "type": "integer",
          "format": "int32"
        },
        "size": {
          "type": "integer",
          "format": "int32"
        },
        "number": {
          "type": "integer",
          "format": "int32"
        },
        "sort": {
          "$ref": "#/$defs/Sort"
        },
        "numberOfElements": {
          "type": "integer",
          "format": "int32"
        },
        "first": {
          "type": "boolean"
        },
        "empty": {
          "type": "boolean"
        }
      }
    },
    "Provider": {
      "required": [
        "description",
        "name",
        "title"
      ],
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the provider.\n"
        },
        "title": {
          "type": "string",
          "description": "The title of the provider.\n"
        },
        "description": {
          "type": "string",
          "description": "The description of the provider.\n"
        }
      }
    },
    "ProviderRole": {
      "type": "string",
      "enum": [
        "PRODUCER",
        "HOST"
      ]
    },
    "ProviderRolesArray": {
      "required": [
        "roles"
      ],
      "type": "object",
      "properties": {
        "roles": {
          "type": "array",
          "description": "Provider roles:\n  - `PRODUCER`: a producer is a provider that initially acquired and processed the source data. Data acquired by a producer can be distributed to various hosts.\n  - `HOST`: a host is a provider that offers access to data acquired by a producer.\n",
          "items": {
            "$ref": "#/$defs/ProviderRole"
          }
        }
      }
    },
    "ProviderWithRoles": {
      "allOf": [
        {
          "$ref": "#/$defs/ProviderRolesArray"
        },
        {
          "$ref": "#/$defs/Provider"
        }
      ]
    },
    "Sort": {
      "type": "object",
      "properties": {
        "empty": {
          "type": "boolean"
        },
        "sorted": {
          "type": "boolean"
        },
        "unsorted": {
          "type": "boolean"
        }
      }
    }
  }
}