Weaviate .well Known API

openapi: 3.0.3
info:
  title: Weaviate REST authz .well Known API
  description: '# Introduction<br/> Weaviate is an open source, AI-native vector database that helps developers create intuitive and reliable AI-powered applications. <br/> ### Base Path <br/>The base path for the Weaviate server is structured as `[YOUR-WEAVIATE-HOST]:[PORT]/v1`. As an example, if you wish to access the `schema` endpoint on a local instance, you would navigate to `http://localhost:8080/v1/schema`. Ensure you replace `[YOUR-WEAVIATE-HOST]` and `[PORT]` with your actual server host and port number respectively. <br/> ### Questions? <br/>If you have any comments or questions, please feel free to reach out to us at the community forum [https://forum.weaviate.io/](https://forum.weaviate.io/). <br/>### Issues? <br/>If you find a bug or want to file a feature request, please open an issue on our GitHub repository for [Weaviate](https://github.com/weaviate/weaviate). <br/>### Need more documentation? <br/>For a quickstart, code examples, concepts and more, please visit our [documentation page](https://docs.weaviate.io/weaviate).'
  version: 1.38.0-dev
servers:
- url: http://localhost:8080
  description: Local Weaviate instance
security:
- ApiKeyAuth: []
- BearerAuth: []
tags:
- name: .well Known
paths:
  /.well-known/live:
    get:
      summary: Weaviate Check Application Liveness
      description: Indicates if the Weaviate instance is running and responsive to basic HTTP requests. Primarily used for health checks, such as Kubernetes liveness probes.
      operationId: weaviate.wellknown.liveness
      responses:
        '200':
          description: The application is alive and responding to HTTP requests.
      x-microcks-operation:
        delay: 100
      tags:
      - .well Known
  /.well-known/ready:
    get:
      summary: Weaviate Check Application Readiness
      description: Indicates if the Weaviate instance has completed its startup routines and is prepared to accept user traffic (data import, queries, etc.). Used for readiness checks, such as Kubernetes readiness probes.
      operationId: weaviate.wellknown.readiness
      responses:
        '200':
          description: The application is ready to serve traffic.
        '503':
          description: The application is not ready to serve traffic. Traffic should be directed to other available replicas if applicable.
      x-microcks-operation:
        delay: 100
      tags:
      - .well Known
  /.well-known/openid-configuration:
    get:
      summary: Weaviate Get OIDC Configuration
      description: Provides OpenID Connect (OIDC) discovery information if OIDC authentication is configured for Weaviate. Returns details like the token issuer URL, client ID, and required scopes.
      tags:
      - .well Known
      responses:
        '200':
          description: OIDC configuration details returned successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  href:
                    type: string
                    description: The OIDC issuer URL to redirect to for authentication.
                  clientId:
                    type: string
                    description: The OAuth Client ID configured for Weaviate.
                  scopes:
                    type: array
                    description: The required OAuth scopes for authentication.
                    items:
                      type: string
        '404':
          description: OIDC provider is not configured for this Weaviate instance.
        '500':
          description: An internal server error occurred while retrieving OIDC configuration. Check the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
components:
  schemas:
    ErrorResponse:
      type: object
      description: An error response returned by Weaviate endpoints.
      properties:
        error:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key authentication
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OIDC/JWT bearer authentication