openapi: 3.0.0
info:
  description: lakeFS HTTP API
  title: lakeFS actions config API
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
servers:
- url: /api/v1
  description: lakeFS server endpoint
security:
- jwt_token: []
- basic_auth: []
- cookie_auth: []
- oidc_auth: []
- saml_auth: []
tags:
- name: config
paths:
  /config:
    get:
      tags:
      - config
      operationId: getConfig
      description: retrieve lakeFS configuration
      responses:
        200:
          description: lakeFS configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Config'
        401:
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    CapabilitiesConfig:
      type: object
      properties: {}
    Config:
      type: object
      properties:
        version_config:
          $ref: '#/components/schemas/VersionConfig'
        storage_config:
          $ref: '#/components/schemas/StorageConfig'
        storage_config_list:
          $ref: '#/components/schemas/StorageConfigList'
        ui_config:
          $ref: '#/components/schemas/UIConfig'
        capabilities_config:
          $ref: '#/components/schemas/CapabilitiesConfig'
    UIConfig:
      type: object
      properties:
        custom_viewers:
          type: array
          items:
            $ref: '#/components/schemas/CustomViewer'
    StorageConfig:
      type: object
      required:
      - blockstore_type
      - blockstore_namespace_example
      - blockstore_namespace_ValidityRegex
      - pre_sign_support
      - pre_sign_support_ui
      - import_support
      - import_validity_regex
      properties:
        blockstore_type:
          type: string
        blockstore_namespace_example:
          type: string
        blockstore_namespace_ValidityRegex:
          type: string
        default_namespace_prefix:
          type: string
        pre_sign_support:
          type: boolean
        pre_sign_support_ui:
          type: boolean
        import_support:
          type: boolean
        import_validity_regex:
          type: string
        pre_sign_multipart_upload:
          type: boolean
        blockstore_id:
          type: string
        blockstore_description:
          type: string
    VersionConfig:
      type: object
      properties:
        version:
          type: string
        version_context:
          type: string
        latest_version:
          type: string
        upgrade_recommended:
          type: boolean
        upgrade_url:
          type: string
    StorageConfigList:
      type: array
      items:
        $ref: '#/components/schemas/StorageConfig'
    Error:
      type: object
      required:
      - message
      properties:
        message:
          description: short message explaining the error
          type: string
    CustomViewer:
      type: object
      required:
      - name
      - url
      properties:
        name:
          type: string
        url:
          type: string
        extensions:
          type: array
          items:
            type: string
        content_types:
          type: array
          items:
            type: string
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basic_auth:
      type: http
      scheme: basic
    jwt_token:
      type: http
      scheme: bearer
      bearerFormat: JWT
    cookie_auth:
      type: apiKey
      in: cookie
      name: internal_auth_session
    oidc_auth:
      type: apiKey
      in: cookie
      name: oidc_auth_session
    saml_auth:
      type: apiKey
      in: cookie
      name: saml_auth_session