{
  "swagger": "2.0",
  "info": {
    "title": "Microsoft.Bookshelf service",
    "version": "2026-02-01-preview",
    "x-typespec-generated": [
      {
        "emitter": "@azure-tools/typespec-autorest"
      }
    ]
  },
  "schemes": [
    "https"
  ],
  "x-ms-parameterized-host": {
    "hostTemplate": "{endpoint}",
    "useSchemePrefix": false,
    "parameters": [
      {
        "name": "endpoint",
        "in": "path",
        "description": "Supported Microsoft Bookshelf Services endpoints (protocol and hostname, for example: https://{bookshelfName}.discovery.azure.com).",
        "required": true,
        "type": "string",
        "format": "uri",
        "x-ms-skip-url-encoding": true
      }
    ]
  },
  "produces": [
    "application/json"
  ],
  "consumes": [
    "application/json"
  ],
  "security": [
    {
      "OAuth2Auth": [
        "https://discovery.azure.com/.default"
      ]
    }
  ],
  "securityDefinitions": {
    "OAuth2Auth": {
      "type": "oauth2",
      "flow": "implicit",
      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize",
      "scopes": {
        "https://discovery.azure.com/.default": ""
      }
    }
  },
  "tags": [],
  "paths": {
    "/knowledgeBases": {
      "get": {
        "operationId": "KnowledgeBases_List",
        "description": "List KnowledgeBase resources",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/PagedKnowledgeBase"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "KnowledgeBases_List_MaximumSet": {
            "$ref": "./examples/KnowledgeBases_List_MaximumSet_Gen.json"
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        }
      }
    },
    "/knowledgeBases/{knowledgeBaseName}/versions": {
      "get": {
        "operationId": "KnowledgeBaseVersions_List",
        "description": "List KnowledgeBaseVersion resources",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "knowledgeBaseName",
            "in": "path",
            "description": "The knowledgeBase name.",
            "required": true,
            "type": "string",
            "maxLength": 24,
            "pattern": "^[a-zA-Z0-9-]{1,24}$"
          },
          {
            "name": "createdSince",
            "in": "query",
            "description": "The oldest creation timestamp to keep",
            "required": false,
            "type": "string",
            "format": "date-time"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/PagedKnowledgeBaseVersion"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "KnowledgeBaseVersions_List_MaximumSet": {
            "$ref": "./examples/KnowledgeBaseVersions_List_MaximumSet_Gen.json"
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        }
      }
    },
    "/knowledgeBases/{knowledgeBaseName}/versions/{versionName}": {
      "get": {
        "operationId": "KnowledgeBaseVersions_Get",
        "description": "Fetch a KnowledgeBaseVersion by name.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "knowledgeBaseName",
            "in": "path",
            "description": "The knowledgeBase name.",
            "required": true,
            "type": "string",
            "maxLength": 24,
            "pattern": "^[a-zA-Z0-9-]{1,24}$"
          },
          {
            "name": "versionName",
            "in": "path",
            "description": "The version name.",
            "required": true,
            "type": "string",
            "maxLength": 24,
            "pattern": "^[a-zA-Z0-9-]{1,24}$"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/KnowledgeBaseVersion"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "KnowledgeBaseVersions_Get_MaximumSet": {
            "$ref": "./examples/KnowledgeBaseVersions_Get_MaximumSet_Gen.json"
          }
        }
      },
      "patch": {
        "operationId": "KnowledgeBaseVersions_CreateOrUpdate",
        "description": "Creates or updates a KnowledgeBaseVersion.",
        "consumes": [
          "application/merge-patch+json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "knowledgeBaseName",
            "in": "path",
            "description": "The knowledgeBase name.",
            "required": true,
            "type": "string",
            "maxLength": 24,
            "pattern": "^[a-zA-Z0-9-]{1,24}$"
          },
          {
            "name": "versionName",
            "in": "path",
            "description": "The version name.",
            "required": true,
            "type": "string",
            "maxLength": 24,
            "pattern": "^[a-zA-Z0-9-]{1,24}$"
          },
          {
            "name": "resource",
            "in": "body",
            "description": "The resource instance.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/KnowledgeBaseVersionCreateOrUpdate"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/KnowledgeBaseVersion"
            }
          },
          "201": {
            "description": "The request has succeeded and a new resource has been created as a result.",
            "schema": {
              "$ref": "#/definitions/KnowledgeBaseVersion"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "KnowledgeBaseVersions_CreateOrUpdate_MaximumSet": {
            "$ref": "./examples/KnowledgeBaseVersions_CreateOrUpdate_MaximumSet_Gen.json"
          }
        }
      },
      "delete": {
        "operationId": "KnowledgeBaseVersions_Delete",
        "description": "Delete a KnowledgeBaseVersion.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "knowledgeBaseName",
            "in": "path",
            "description": "The knowledgeBase name.",
            "required": true,
            "type": "string",
            "maxLength": 24,
            "pattern": "^[a-zA-Z0-9-]{1,24}$"
          },
          {
            "name": "versionName",
            "in": "path",
            "description": "The version name.",
            "required": true,
            "type": "string",
            "maxLength": 24,
            "pattern": "^[a-zA-Z0-9-]{1,24}$"
          }
        ],
        "responses": {
          "202": {
            "description": "The request has been accepted for processing, but processing has not yet completed.",
            "schema": {
              "type": "object",
              "description": "Provides status details for long running operations.",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The unique ID of the operation."
                },
                "status": {
                  "$ref": "#/definitions/Azure.Core.Foundations.OperationState",
                  "description": "The status of the operation"
                },
                "error": {
                  "$ref": "#/definitions/Azure.Core.Foundations.Error",
                  "description": "Error object that describes the error when status is \"Failed\"."
                }
              },
              "required": [
                "id",
                "status"
              ]
            },
            "headers": {
              "Operation-Location": {
                "type": "string",
                "format": "uri",
                "description": "The location for monitoring the operation state."
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "KnowledgeBaseVersions_Delete_MaximumSet": {
            "$ref": "./examples/KnowledgeBaseVersions_Delete_MaximumSet_Gen.json"
          }
        },
        "x-ms-long-running-operation": true
      }
    },
    "/knowledgeBases/{knowledgeBaseName}/versions/{versionName}:startIndexing": {
      "post": {
        "operationId": "KnowledgeBaseVersions_StartIndexing",
        "description": "Start indexing.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "knowledgeBaseName",
            "in": "path",
            "description": "The knowledgeBase name.",
            "required": true,
            "type": "string",
            "maxLength": 24,
            "pattern": "^[a-zA-Z0-9-]{1,24}$"
          },
          {
            "name": "versionName",
            "in": "path",
            "description": "The version name.",
            "required": true,
            "type": "string",
            "maxLength": 24,
            "pattern": "^[a-zA-Z0-9-]{1,24}$"
          },
          {
            "$ref": "#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId"
          },
          {
            "$ref": "#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent"
          },
          {
            "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
          },
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/IndexingRequest"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "The request has been accepted for processing, but processing has not yet completed.",
            "schema": {
              "type": "object",
              "description": "Provides status details for long running operations.",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The unique ID of the operation."
                },
                "status": {
                  "$ref": "#/definitions/Azure.Core.Foundations.OperationState",
                  "description": "The status of the operation"
                },
                "error": {
                  "$ref": "#/definitions/Azure.Core.Foundations.Error",
                  "description": "Error object that describes the error when status is \"Failed\"."
                },
                "result": {
                  "$ref": "#/definitions/IndexingResponse",
                  "description": "The result of the operation."
                }
              },
              "required": [
                "id",
                "status"
              ]
            },
            "headers": {
              "Operation-Location": {
                "type": "string",
                "format": "uri",
                "description": "The location for monitoring the operation state."
              },
              "Repeatability-Result": {
                "type": "string",
                "description": "Indicates whether the repeatable request was accepted or rejected.",
                "enum": [
                  "accepted",
                  "rejected"
                ],
                "x-ms-enum": {
                  "name": "RepeatabilityResult",
                  "modelAsString": false,
                  "values": [
                    {
                      "name": "accepted",
                      "value": "accepted",
                      "description": "If the request was accepted and the server guarantees that the server state reflects a single execution of the operation."
                    },
                    {
                      "name": "rejected",
                      "value": "rejected",
                      "description": "If the request was rejected because the combination of Repeatability-First-Sent and Repeatability-Request-ID were invalid\nor because the Repeatability-First-Sent value was outside the range of values held by the server."
                    }
                  ]
                }
              },
              "x-ms-client-request-id": {
                "type": "string",
                "format": "uuid",
                "description": "An opaque, globally-unique, client-generated string identifier for the request."
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "KnowledgeBaseVersions_StartIndexing_MaximumSet": {
            "$ref": "./examples/KnowledgeBaseVersions_StartIndexing_MaximumSet_Gen.json"
          }
        },
        "x-ms-long-running-operation": true
      }
    },
    "/knowledgeBases/{knowledgeBaseName}/versions/{versionName}:cancelIndexing": {
      "post": {
        "operationId": "KnowledgeBaseVersions_CancelIndexing",
        "description": "Cancel indexing.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "knowledgeBaseName",
            "in": "path",
            "description": "The knowledgeBase name.",
            "required": true,
            "type": "string",
            "maxLength": 24,
            "pattern": "^[a-zA-Z0-9-]{1,24}$"
          },
          {
            "name": "versionName",
            "in": "path",
            "description": "The version name.",
            "required": true,
            "type": "string",
            "maxLength": 24,
            "pattern": "^[a-zA-Z0-9-]{1,24}$"
          },
          {
            "$ref": "#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId"
          },
          {
            "$ref": "#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent"
          },
          {
            "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
          },
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/IndexingRequest"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "The request has been accepted for processing, but processing has not yet completed.",
            "schema": {
              "type": "object",
              "description": "Provides status details for long running operations.",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The unique ID of the operation."
                },
                "status": {
                  "$ref": "#/definitions/Azure.Core.Foundations.OperationState",
                  "description": "The status of the operation"
                },
                "error": {
                  "$ref": "#/definitions/Azure.Core.Foundations.Error",
                  "description": "Error object that describes the error when status is \"Failed\"."
                },
                "result": {
                  "$ref": "#/definitions/IndexingResponse",
                  "description": "The result of the operation."
                }
              },
              "required": [
                "id",
                "status"
              ]
            },
            "headers": {
              "Operation-Location": {
                "type": "string",
                "format": "uri",
                "description": "The location for monitoring the operation state."
              },
              "Repeatability-Result": {
                "type": "string",
                "description": "Indicates whether the repeatable request was accepted or rejected.",
                "enum": [
                  "accepted",
                  "rejected"
                ],
                "x-ms-enum": {
                  "name": "RepeatabilityResult",
                  "modelAsString": false,
                  "values": [
                    {
                      "name": "accepted",
                      "value": "accepted",
                      "description": "If the request was accepted and the server guarantees that the server state reflects a single execution of the operation."
                    },
                    {
                      "name": "rejected",
                      "value": "rejected",
                      "description": "If the request was rejected because the combination of Repeatability-First-Sent and Repeatability-Request-ID were invalid\nor because the Repeatability-First-Sent value was outside the range of values held by the server."
                    }
                  ]
                }
              },
              "x-ms-client-request-id": {
                "type": "string",
                "format": "uuid",
                "description": "An opaque, globally-unique, client-generated string identifier for the request."
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "KnowledgeBaseVersions_CancelIndexing_MaximumSet": {
            "$ref": "./examples/KnowledgeBaseVersions_CancelIndexing_MaximumSet_Gen.json"
          }
        },
        "x-ms-long-running-operation": true
      }
    },
    "/knowledgeBases/{knowledgeBaseName}/versions/{versionName}/operations/{operationId}": {
      "get": {
        "operationId": "KnowledgeBaseVersions_GetOperationStatus",
        "description": "Get the status of a long-running operation.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "knowledgeBaseName",
            "in": "path",
            "description": "The knowledgeBase name.",
            "required": true,
            "type": "string",
            "maxLength": 24,
            "pattern": "^[a-zA-Z0-9-]{1,24}$"
          },
          {
            "name": "versionName",
            "in": "path",
            "description": "The version name.",
            "required": true,
            "type": "string",
            "maxLength": 24,
            "pattern": "^[a-zA-Z0-9-]{1,24}$"
          },
          {
            "name": "operationId",
            "in": "path",
            "description": "The unique ID of the operation.",
            "required": true,
            "type": "string",
            "maxLength": 38
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/KnowledgeBaseOperationStatus"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "KnowledgeBaseVersions_GetOperationStatus_MaximumSet": {
            "$ref": "./examples/KnowledgeBaseVersions_GetOperationStatus_MaximumSet_Gen.json"
          }
        }
      }
    },
    "/knowledgeBases/{knowledgeBaseName}/versions/@latest": {
      "get": {
        "operationId": "KnowledgeBaseVersions_GetLatestVersion",
        "description": "Get the most recent version of KnowledgeBase.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "knowledgeBaseName",
            "in": "path",
            "description": "Name of the KnowledgeBase",
            "required": true,
            "type": "string",
            "maxLength": 24,
            "pattern": "^[a-zA-Z0-9-]{1,24}$"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/KnowledgeBaseVersion"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "KnowledgeBaseVersions_GetLatestVersion_MaximumSet": {
            "$ref": "./examples/KnowledgeBaseVersions_GetLatestVersion_MaximumSet_Gen.json"
          }
        }
      },
      "delete": {
        "operationId": "KnowledgeBaseVersions_DeleteLatestVersion",
        "description": "Delete the most recent version of KnowledgeBase.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "knowledgeBaseName",
            "in": "path",
            "description": "Name of the KnowledgeBase",
            "required": true,
            "type": "string",
            "maxLength": 24,
            "pattern": "^[a-zA-Z0-9-]{1,24}$"
          }
        ],
        "responses": {
          "202": {
            "description": "The request has been accepted for processing, but processing has not yet completed.",
            "schema": {
              "$ref": "#/definitions/KnowledgeBaseDeleteResponse"
            },
            "headers": {
              "Operation-Location": {
                "type": "string",
                "format": "uri",
                "description": "The location of an instance of KnowledgeBaseVersion"
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "KnowledgeBaseVersions_DeleteLatestVersion_MaximumSet": {
            "$ref": "./examples/KnowledgeBaseVersions_DeleteLatestVersion_MaximumSet_Gen.json"
          }
        },
        "x-ms-long-running-operation": true
      }
    }
  },
  "definitions": {
    "Azure.Core.Foundations.Error": {
      "type": "object",
      "description": "The error object.",
      "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."
        },
        "details": {
          "type": "array",
          "description": "An array of details about specific errors that led to this reported error.",
          "items": {
            "$ref": "#/definitions/Azure.Core.Foundations.Error"
          }
        },
        "innererror": {
          "$ref": "#/definitions/Azure.Core.Foundations.InnerError",
          "description": "An object containing more specific information than the current object about the error."
        }
      },
      "required": [
        "code",
        "message"
      ]
    },
    "Azure.Core.Foundations.ErrorResponse": {
      "type": "object",
      "description": "A response containing error details.",
      "properties": {
        "error": {
          "$ref": "#/definitions/Azure.Core.Foundations.Error",
          "description": "The error object."
        }
      },
      "required": [
        "error"
      ]
    },
    "Azure.Core.Foundations.InnerError": {
      "type": "object",
      "description": "An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.",
      "properties": {
        "code": {
          "type": "string",
          "description": "One of a server-defined set of error codes."
        },
        "innererror": {
          "$ref": "#/definitions/Azure.Core.Foundations.InnerError",
          "description": "Inner error."
        }
      }
    },
    "Azure.Core.Foundations.OperationState": {
      "type": "string",
      "description": "Enum describing allowed operation states.",
      "enum": [
        "NotStarted",
        "Running",
        "Succeeded",
        "Failed",
        "Canceled"
      ],
      "x-ms-enum": {
        "name": "OperationState",
        "modelAsString": true,
        "values": [
          {
            "name": "NotStarted",
            "value": "NotStarted",
            "description": "The operation has not started."
          },
          {
            "name": "Running",
            "value": "Running",
            "description": "The operation is in progress."
          },
          {
            "name": "Succeeded",
            "value": "Succeeded",
            "description": "The operation has completed successfully."
          },
          {
            "name": "Failed",
            "value": "Failed",
            "description": "The operation has failed."
          },
          {
            "name": "Canceled",
            "value": "Canceled",
            "description": "The operation has been canceled by the user."
          }
        ]
      }
    },
    "IndexingRequest": {
      "type": "object",
      "description": "Resources for indexing operation",
      "properties": {
        "nodePoolId": {
          "type": "string",
          "description": "Node pool ID"
        },
        "projectId": {
          "type": "string",
          "description": "Project ID"
        }
      },
      "required": [
        "nodePoolId"
      ]
    },
    "IndexingResponse": {
      "type": "object",
      "description": "Supercomputer run ID",
      "properties": {
        "runId": {
          "type": "string",
          "description": "Run ID"
        }
      },
      "required": [
        "runId"
      ]
    },
    "IndexingStatus": {
      "type": "string",
      "description": "Enum for IndexingStatus",
      "enum": [
        "NotStarted",
        "Running",
        "Succeeded",
        "Canceled",
        "Failed"
      ],
      "x-ms-enum": {
        "name": "IndexingStatus",
        "modelAsString": true,
        "values": [
          {
            "name": "NotStarted",
            "value": "NotStarted",
            "description": "Indexing Not started"
          },
          {
            "name": "Running",
            "value": "Running",
            "description": "Running"
          },
          {
            "name": "Succeeded",
            "value": "Succeeded",
            "description": "Succeeded"
          },
          {
            "name": "Canceled",
            "value": "Canceled",
            "description": "Canceled"
          },
          {
            "name": "Failed",
            "value": "Failed",
            "description": "Failed"
          }
        ]
      }
    },
    "KnowledgeBase": {
      "type": "object",
      "description": "A knowledgeBase.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The knowledgeBase name.",
          "maxLength": 24,
          "pattern": "^[a-zA-Z0-9-]{1,24}$",
          "readOnly": true
        },
        "id": {
          "type": "string",
          "description": "The ID for the resource.",
          "readOnly": true
        },
        "version": {
          "type": "string",
          "description": "Version.",
          "readOnly": true
        },
        "bookshelfName": {
          "type": "string",
          "description": "The name of the associated Bookshelf tracked resource.",
          "readOnly": true
        },
        "storageAssetReferences": {
          "type": "array",
          "description": "Storage asset references to index.",
          "items": {
            "$ref": "#/definitions/StorageAssetReference"
          },
          "x-ms-mutability": [
            "read",
            "update",
            "create"
          ]
        },
        "knowledgeBaseUrl": {
          "type": "string",
          "description": "URL to access the knowledge base.",
          "readOnly": true
        },
        "provisioningState": {
          "$ref": "#/definitions/Microsoft.Discovery.Common.ProvisioningState",
          "description": "Provisioning state.",
          "readOnly": true
        },
        "createdAt": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp when the resource was created",
          "readOnly": true
        },
        "createdBy": {
          "type": "string",
          "description": "The ID of the user who created this resource.",
          "readOnly": true
        },
        "createdByType": {
          "$ref": "#/definitions/Microsoft.Discovery.Common.ByType",
          "description": "The type of user who created this resource.",
          "readOnly": true
        },
        "lastModifiedAt": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp when the resource was last updated",
          "readOnly": true
        },
        "lastModifiedBy": {
          "type": "string",
          "description": "The ID of the user who updated this resource.",
          "readOnly": true
        },
        "lastModifiedByType": {
          "$ref": "#/definitions/Microsoft.Discovery.Common.ByType",
          "description": "The type of user who updated this resource.",
          "readOnly": true
        },
        "tags": {
          "type": "array",
          "description": "The tags",
          "items": {
            "$ref": "#/definitions/Microsoft.Discovery.Common.Tag"
          },
          "x-ms-mutability": [
            "read",
            "update",
            "create"
          ]
        },
        "description": {
          "type": "string",
          "description": "The description",
          "x-ms-mutability": [
            "read",
            "update",
            "create"
          ]
        },
        "copilotInstruction": {
          "type": "string",
          "description": "The copilot instruction",
          "x-ms-mutability": [
            "read",
            "update",
            "create"
          ]
        },
        "status": {
          "$ref": "#/definitions/IndexingStatus",
          "description": "The status",
          "readOnly": true
        }
      },
      "required": [
        "name",
        "version",
        "bookshelfName",
        "description",
        "copilotInstruction"
      ]
    },
    "KnowledgeBaseDeleteResponse": {
      "type": "object",
      "description": "Response body for a long-running delete operation.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique ID of the operation."
        },
        "status": {
          "$ref": "#/definitions/Azure.Core.Foundations.OperationState",
          "description": "The status of the operation"
        },
        "error": {
          "$ref": "#/definitions/Azure.Core.Foundations.Error",
          "description": "Error object that describes the error when status is 'Failed'."
        }
      },
      "required": [
        "id",
        "status"
      ]
    },
    "KnowledgeBaseOperationStatus": {
      "type": "object",
      "description": "Status of a KnowledgeBase operation",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique ID of the operation."
        },
        "status": {
          "$ref": "#/definitions/Azure.Core.Foundations.OperationState",
          "description": "The status of the operation"
        },
        "error": {
          "$ref": "#/definitions/Azure.Core.Foundations.Error",
          "description": "Error object that describes the error when status is 'Failed'."
        },
        "result": {
          "$ref": "#/definitions/KnowledgeBaseVersion",
          "description": "The KnowledgeBaseVersion result of the operation."
        }
      },
      "required": [
        "id",
        "status"
      ]
    },
    "KnowledgeBaseVersion": {
      "type": "object",
      "description": "A version.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The version name.",
          "maxLength": 24,
          "pattern": "^[a-zA-Z0-9-]{1,24}$",
          "readOnly": true
        },
        "id": {
          "type": "string",
          "description": "The ID for the resource.",
          "readOnly": true
        },
        "version": {
          "type": "string",
          "description": "Version.",
          "readOnly": true
        },
        "bookshelfName": {
          "type": "string",
          "description": "The name of the associated Bookshelf tracked resource.",
          "readOnly": true
        },
        "storageAssetReferences": {
          "type": "array",
          "description": "Storage asset references to index.",
          "items": {
            "$ref": "#/definitions/StorageAssetReference"
          },
          "x-ms-mutability": [
            "read",
            "update",
            "create"
          ]
        },
        "knowledgeBaseUrl": {
          "type": "string",
          "description": "URL to access the knowledge base.",
          "readOnly": true
        },
        "provisioningState": {
          "$ref": "#/definitions/Microsoft.Discovery.Common.ProvisioningState",
          "description": "Provisioning state.",
          "readOnly": true
        },
        "createdAt": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp when the resource was created",
          "readOnly": true
        },
        "createdBy": {
          "type": "string",
          "description": "The ID of the user who created this resource.",
          "readOnly": true
        },
        "createdByType": {
          "$ref": "#/definitions/Microsoft.Discovery.Common.ByType",
          "description": "The type of user who created this resource.",
          "readOnly": true
        },
        "lastModifiedAt": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp when the resource was last updated",
          "readOnly": true
        },
        "lastModifiedBy": {
          "type": "string",
          "description": "The ID of the user who updated this resource.",
          "readOnly": true
        },
        "lastModifiedByType": {
          "$ref": "#/definitions/Microsoft.Discovery.Common.ByType",
          "description": "The type of user who updated this resource.",
          "readOnly": true
        },
        "tags": {
          "type": "array",
          "description": "The tags",
          "items": {
            "$ref": "#/definitions/Microsoft.Discovery.Common.Tag"
          },
          "x-ms-mutability": [
            "read",
            "update",
            "create"
          ]
        },
        "description": {
          "type": "string",
          "description": "The description",
          "x-ms-mutability": [
            "read",
            "update",
            "create"
          ]
        },
        "copilotInstruction": {
          "type": "string",
          "description": "The copilot instruction",
          "x-ms-mutability": [
            "read",
            "update",
            "create"
          ]
        },
        "status": {
          "$ref": "#/definitions/IndexingStatus",
          "description": "The status",
          "readOnly": true
        }
      },
      "required": [
        "name",
        "version",
        "bookshelfName",
        "description",
        "copilotInstruction"
      ]
    },
    "KnowledgeBaseVersionCreateOrUpdate": {
      "type": "object",
      "description": "A version.",
      "properties": {
        "storageAssetReferences": {
          "type": "array",
          "description": "Storage asset references to index.",
          "items": {
            "$ref": "#/definitions/StorageAssetReference"
          },
          "x-ms-mutability": [
            "read",
            "update",
            "create"
          ]
        },
        "tags": {
          "type": "array",
          "description": "The tags",
          "items": {
            "$ref": "#/definitions/Microsoft.Discovery.Common.Tag"
          },
          "x-ms-mutability": [
            "read",
            "update",
            "create"
          ]
        },
        "description": {
          "type": "string",
          "description": "The description",
          "x-ms-mutability": [
            "read",
            "update",
            "create"
          ]
        },
        "copilotInstruction": {
          "type": "string",
          "description": "The copilot instruction",
          "x-ms-mutability": [
            "read",
            "update",
            "create"
          ]
        }
      }
    },
    "Microsoft.Discovery.Common.ByType": {
      "type": "string",
      "description": "Enum for entity type",
      "enum": [
        "User",
        "Application",
        "System"
      ],
      "x-ms-enum": {
        "name": "ByType",
        "modelAsString": true,
        "values": [
          {
            "name": "User",
            "value": "User",
            "description": "A human user."
          },
          {
            "name": "Application",
            "value": "Application",
            "description": "Application"
          },
          {
            "name": "System",
            "value": "System",
            "description": "The backend system."
          }
        ]
      }
    },
    "Microsoft.Discovery.Common.ProvisioningState": {
      "type": "string",
      "description": "The resource provisioning state.",
      "enum": [
        "Succeeded",
        "Failed",
        "Canceled",
        "Accepted",
        "Provisioning",
        "Updating",
        "Deleting"
      ],
      "x-ms-enum": {
        "name": "ProvisioningState",
        "modelAsString": true,
        "values": [
          {
            "name": "Succeeded",
            "value": "Succeeded",
            "description": "Resource has been created."
          },
          {
            "name": "Failed",
            "value": "Failed",
            "description": "Resource creation failed."
          },
          {
            "name": "Canceled",
            "value": "Canceled",
            "description": "Resource creation was canceled."
          },
          {
            "name": "Accepted",
            "value": "Accepted",
            "description": "The resource create request has been accepted"
          },
          {
            "name": "Provisioning",
            "value": "Provisioning",
            "description": "The resource is being provisioned"
          },
          {
            "name": "Updating",
            "value": "Updating",
            "description": "The resource is updating"
          },
          {
            "name": "Deleting",
            "value": "Deleting",
            "description": "The resource is being deleted"
          }
        ]
      }
    },
    "Microsoft.Discovery.Common.Tag": {
      "type": "object",
      "description": "Definition of Tag",
      "properties": {
        "key": {
          "type": "string",
          "description": "Property key"
        },
        "value": {
          "type": "string",
          "description": "Property value"
        }
      }
    },
    "PagedKnowledgeBase": {
      "type": "object",
      "description": "Paged collection of KnowledgeBase items",
      "properties": {
        "value": {
          "type": "array",
          "description": "The KnowledgeBase items on this page",
          "items": {
            "$ref": "#/definitions/KnowledgeBase"
          }
        },
        "nextLink": {
          "type": "string",
          "format": "uri",
          "description": "The link to the next page of items"
        }
      },
      "required": [
        "value"
      ]
    },
    "PagedKnowledgeBaseVersion": {
      "type": "object",
      "description": "Paged collection of KnowledgeBaseVersion items",
      "properties": {
        "value": {
          "type": "array",
          "description": "The KnowledgeBaseVersion items on this page",
          "items": {
            "$ref": "#/definitions/KnowledgeBaseVersion"
          }
        },
        "nextLink": {
          "type": "string",
          "format": "uri",
          "description": "The link to the next page of items"
        }
      },
      "required": [
        "value"
      ]
    },
    "StorageAssetReference": {
      "type": "object",
      "description": "Reference to a storage asset with identity information.",
      "properties": {
        "id": {
          "type": "string",
          "format": "arm-id",
          "description": "The ARM resource ID of the storage asset.",
          "x-ms-arm-id-details": {
            "allowedResources": [
              {
                "type": "Microsoft.Discovery/StorageContainers/StorageAssets"
              }
            ]
          }
        },
        "userAssignedIdentity": {
          "type": "string",
          "format": "arm-id",
          "description": "The ARM resource ID of the User Assigned Managed Identity to access the storage asset.",
          "x-ms-arm-id-details": {
            "allowedResources": [
              {
                "type": "Microsoft.ManagedIdentity/userAssignedIdentities"
              }
            ]
          }
        }
      },
      "required": [
        "id"
      ]
    }
  },
  "parameters": {
    "Azure.Core.ClientRequestIdHeader": {
      "name": "x-ms-client-request-id",
      "in": "header",
      "description": "An opaque, globally-unique, client-generated string identifier for the request.",
      "required": false,
      "type": "string",
      "format": "uuid",
      "x-ms-parameter-location": "method",
      "x-ms-client-name": "clientRequestId"
    },
    "Azure.Core.Foundations.ApiVersionParameter": {
      "name": "api-version",
      "in": "query",
      "description": "The API version to use for this operation.",
      "required": true,
      "type": "string",
      "minLength": 1,
      "x-ms-parameter-location": "method",
      "x-ms-client-name": "apiVersion"
    },
    "Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent": {
      "name": "Repeatability-First-Sent",
      "in": "header",
      "description": "Specifies the date and time at which the request was first created.",
      "required": false,
      "type": "string",
      "format": "date-time",
      "x-ms-parameter-location": "method",
      "x-ms-client-name": "repeatabilityFirstSent"
    },
    "Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId": {
      "name": "Repeatability-Request-ID",
      "in": "header",
      "description": "An opaque, globally-unique, client-generated string identifier for the request.",
      "required": false,
      "type": "string",
      "x-ms-parameter-location": "method",
      "x-ms-client-name": "repeatabilityRequestId"
    }
  }
}