{
    "type": "object",
    "properties": {
        "repositories": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/iTwin-repository"
            }
        }
    },
    "required": [
        "repositories"
    ],
    "additionalProperties": false
}

{
    "type": "string",
    "title": "iTwin Repository Class",
    "description": "The class of the iTwin repository.",
    "enum": [
        "RealityData",
        "iModels",
        "Storage",
        "Forms",
        "Construction",
        "GeographicInformationSystem",
        "CesiumCuratedContent",
        "SensorData",
        "Subsurface",
        "GeospatialFeatures",
        "PdfPlansets",
        "IndexedMedia"
    ]
}

{
    "type": "string",
    "title": "iTwin Repository SubClass",
    "description": "The subclass of the iTwin repository.",
    "enum": [
        "WebMapService",
        "WebMapTileService",
        "ArcGIS",
        "UrlTemplate",
        "OgcApiFeatures",
        "Performance",
        "EvoWorkspace"
    ]
}

{
    "type": "string",
    "title": "iTwin Repository Authentication Type",
    "description": "This value determines how to process the authentication information returned from the API.",
    "enum": [
        "Header",
        "QueryParameter",
        "Basic",
        "OAuth2AuthorizationCodePKCE"
    ]
}

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "The iTwin repository id."
        },
        "class": {
            "$ref": "#/components/schemas/iTwinRepositoryClass",
            "description": "The repository class."
        },
        "subClass": {
            "$ref": "#/components/schemas/iTwinRepositorySubClass",
            "description": "The repository subclass."
        },
        "displayName": {
            "type": "string",
            "description": "The repository name that can be displayed to the user."
        },
        "uri": {
            "type": "string",
            "description": "The uri for the repository."
        },
        "capabilities": {
            "type": "object",
            "required": [
                "resources"
            ],
            "properties": {
                "resources": {
                    "$ref": "#/components/schemas/ResourcesCapability"
                }
            },
            "description": "Links to additional capabiblies provided by the repository. Currently, only the [resources](https://developer.bentley.com/apis/itwins/operations/get-repository-resources/) capability is suported. It is a read only value returned for certain classes.",
            "additionalProperties": false
        },
        "authentication": {
            "oneOf": [
                {
                    "$ref": "#/components/schemas/ApiKey-Authentication"
                },
                {
                    "$ref": "#/components/schemas/Basic-Authentication"
                },
                {
                    "$ref": "#/components/schemas/OAuth2AuthCodePKCE-Authentication"
                }
            ],
            "description": "Some repositories require authentication. If authentication details are provided, inspect the `authentication.type` property to determine the required method. You may need to add an Api Key (header or query parameter), use basic authentication, or implement OAuth2 authorization code flow."
        },
        "options": {
            "oneOf": [
                {
                    "$ref": "#/components/schemas/GIS-General-Options"
                },
                {
                    "$ref": "#/components/schemas/GIS-UrlTemplate-Options"
                }
            ],
            "description": "Additional options that are needed when requesting data from the repository."
        }
    },
    "additionalProperties": false
}

{
    "type": "object",
    "properties": {
        "queryParameters": {
            "type": "object",
            "additionalProperties": {
                "type": "string"
            },
            "description": "Query parameters that should be added to the uri when making a request."
        }
    },
    "required": [
        "queryParameters"
    ],
    "description": "Options that may be needed to query or display data from the repository.",
    "additionalProperties": false
}

{
    "type": "object",
    "properties": {
        "queryParameters": {
            "type": "object",
            "additionalProperties": {
                "type": "string"
            },
            "description": "Query parameters that should be added to the uri when making a request."
        },
        "minimumLevel": {
            "type": "integer",
            "description": "Minimum level-of-detail that can be requested."
        },
        "maximumLevel": {
            "type": "integer",
            "description": "Maximum level-of-detail that can be requested."
        }
    },
    "required": [
        "minimumLevel",
        "maximumLevel"
    ],
    "description": "Options that can be used in the construtor of the [UrlTemplateImageryProvider](https://cesium.com/learn/cesiumjs/ref-doc/UrlTemplateImageryProvider.html). Also includes the general options that allow you to specify query parameters if needed.",
    "additionalProperties": false
}

{
    "type": "object",
    "properties": {
        "uri": {
            "type": "string",
            "description": "A uri containing the endpoint that will return the list of resources in the repository."
        }
    },
    "additionalProperties": false
}

{
    "type": "object",
    "description": "Contains the information needed to authenticate to the specified API using an api key. ",
    "properties": {
        "type": {
            "$ref": "#/components/schemas/iTwinRepositoryAuthType"
        },
        "key": {
            "type": "string",
            "description": "The key to use for Header or QueryParameter auth types."
        },
        "value": {
            "type": "string",
            "description": "The value to use for Header or QueryParameter auth types."
        }
    },
    "required": [
        "type",
        "key",
        "value"
    ],
    "additionalProperties": false
}

{
    "type": "object",
    "description": "Contains the information needed to authenticate to the specified API using Basic authentication.",
    "properties": {
        "type": {
            "$ref": "#/components/schemas/iTwinRepositoryAuthType"
        },
        "username": {
            "type": "string",
            "description": "The username to use for Basic auth type."
        },
        "password": {
            "type": "string",
            "description": "The password to use for Basic auth type."
        }
    },
    "required": [
        "type",
        "username",
        "password"
    ],
    "additionalProperties": false
}

{
    "type": "object",
    "description": "Contains the information needed to authenticate to the specified API using OAuth2 authentication.",
    "properties": {
        "type": {
            "$ref": "#/components/schemas/iTwinRepositoryAuthType"
        },
        "clientId": {
            "type": "string",
            "description": "The OAuth2 client identifier registered with the authorization server."
        },
        "scopes": {
            "type": "string",
            "description": "A space-separated list of permissions (scopes) your app is requesting."
        },
        "authorizationEndpoint": {
            "type": "string",
            "description": "The URL where the user is redirected to start the OAuth2 authorization process."
        },
        "tokenEndpoint": {
            "type": "string",
            "description": "The URL used to exchange the authorization code for access and refresh tokens."
        },
        "redirectUri": {
            "type": "string",
            "description": "The URI where the authorization server will redirect the user after authorization is complete."
        }
    },
    "required": [
        "type",
        "clientId",
        "scopes",
        "authorizationEndpoint",
        "tokenEndpoint",
        "redirectUri"
    ],
    "additionalProperties": false
}

{
    "type": "object",
    "description": "Contains error information.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "required": [
        "code",
        "message"
    ],
    "additionalProperties": true
}

{
    "type": "object",
    "title": "Error Response",
    "description": "Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}