Altimate AI DBT_CONFIG API

The DBT_CONFIG API from Altimate AI — 8 operation(s) for dbt_config.

OpenAPI Specification

altimate-ai-dbt-config-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Fast ACCOUNT_COSTS DBT_CONFIG API
  version: 0.1.0
tags:
- name: DBT_CONFIG
paths:
  /dbtconfig/:
    get:
      tags:
      - DBT_CONFIG
      summary: Dbt Configs Get
      operationId: dbt_configs_get_dbtconfig__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: sort_key
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: created_on
          title: Sort Key
      - name: sort_order
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: desc
          title: Sort Order
      - name: name
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Name
      - name: created_by
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: integer
          - type: 'null'
          title: Created By
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: Page number
          default: 1
          title: Page
        description: Page number
      - name: size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Page size
          default: 50
          title: Size
        description: Page size
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_DBTConfigResponse_'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Dbt Configs Get Dbtconfig  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Dbt Configs Get Dbtconfig  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - DBT_CONFIG
      summary: Dbt Config Add
      operationId: dbt_config_add_dbtconfig__post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DBTConfigRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Dbt Config Add Dbtconfig  Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Dbt Config Add Dbtconfig  Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /dbtconfig/{config_id}:
    get:
      tags:
      - DBT_CONFIG
      summary: Dbt Configs Get
      operationId: dbt_configs_get_dbtconfig__config_id__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: config_id
        in: path
        required: true
        schema:
          type: string
          title: Config Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DBTConfigResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Dbt Configs Get Dbtconfig  Config Id  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Dbt Configs Get Dbtconfig  Config Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - DBT_CONFIG
      summary: Dbt Config Update
      operationId: dbt_config_update_dbtconfig__config_id__patch
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: config_id
        in: path
        required: true
        schema:
          type: integer
          title: Config Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DBTConfigRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Dbt Config Update Dbtconfig  Config Id  Patch
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Dbt Config Update Dbtconfig  Config Id  Patch
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - DBT_CONFIG
      summary: Dbt Config Delete
      operationId: dbt_config_delete_dbtconfig__config_id__delete
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: config_id
        in: path
        required: true
        schema:
          type: integer
          title: Config Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Dbt Config Delete Dbtconfig  Config Id  Delete
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Dbt Config Delete Dbtconfig  Config Id  Delete
        '404':
          description: DBT config not found
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 404 Dbt Config Delete Dbtconfig  Config Id  Delete
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /dbtconfig/filters/list:
    get:
      tags:
      - DBT_CONFIG
      summary: Dbt Config Get Filters
      operationId: dbt_config_get_filters_dbtconfig_filters_list_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DBTConfigFilterResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 400 Dbt Config Get Filters Dbtconfig Filters List Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 403 Dbt Config Get Filters Dbtconfig Filters List Get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
  /dbtconfig/checks/list:
    get:
      tags:
      - DBT_CONFIG
      summary: Dbt Config Get Checks
      operationId: dbt_config_get_checks_dbtconfig_checks_list_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: name
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Name
      - name: files_required
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Files Required
      - name: check_type
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Check Type
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DBTConfigChecks'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Dbt Config Get Checks Dbtconfig Checks List Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Dbt Config Get Checks Dbtconfig Checks List Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /dbtconfig/checks/filters:
    get:
      tags:
      - DBT_CONFIG
      summary: Dbt Config Get Filters
      operationId: dbt_config_get_filters_dbtconfig_checks_filters_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DBTConfigCheckResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 400 Dbt Config Get Filters Dbtconfig Checks Filters Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 403 Dbt Config Get Filters Dbtconfig Checks Filters Get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
  /dbtconfig/{config_id}/download:
    get:
      tags:
      - DBT_CONFIG
      summary: Dbt Configs Get
      operationId: dbt_configs_get_dbtconfig__config_id__download_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: config_id
        in: path
        required: true
        schema:
          type: string
          title: Config Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DBTConfigResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Dbt Configs Get Dbtconfig  Config Id  Download Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Dbt Configs Get Dbtconfig  Config Id  Download Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /dbtconfig/extension/start_scan:
    get:
      tags:
      - DBT_CONFIG
      summary: Dbt Configs Start Scan
      operationId: dbt_configs_start_scan_dbtconfig_extension_start_scan_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Dbt Configs Start Scan Dbtconfig Extension Start Scan Get
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 400 Dbt Configs Start Scan Dbtconfig Extension Start Scan Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 403 Dbt Configs Start Scan Dbtconfig Extension Start Scan Get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
  /dbtconfig/datapilot_version/{extension_version}:
    get:
      tags:
      - DBT_CONFIG
      summary: Dbt Configs Get
      operationId: dbt_configs_get_dbtconfig_datapilot_version__extension_version__get
      security:
      - HTTPBearer: []
      parameters:
      - name: extension_version
        in: path
        required: true
        schema:
          type: string
          title: Extension Version
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Dbt Configs Get Dbtconfig Datapilot Version  Extension Version  Get
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Dbt Configs Get Dbtconfig Datapilot Version  Extension Version  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Dbt Configs Get Dbtconfig Datapilot Version  Extension Version  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    DBTConfigCheck:
      properties:
        name:
          type: string
          title: Name
        alias:
          type: string
          title: Alias
        type:
          type: string
          title: Type
        description:
          type: string
          title: Description
        files_required:
          items:
            type: string
          type: array
          title: Files Required
        config:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Config
      type: object
      required:
      - name
      - alias
      - type
      - description
      - files_required
      title: DBTConfigCheck
    DBTConfigFilterResponse:
      properties:
        config_names:
          items:
            type: string
          type: array
          title: Config Names
        users:
          items:
            $ref: '#/components/schemas/UserIndexResponse'
          type: array
          title: Users
      type: object
      required:
      - config_names
      - users
      title: DBTConfigFilterResponse
    Page_DBTConfigResponse_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/DBTConfigResponse'
          type: array
          title: Items
        total:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Total
        page:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Page
        size:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Size
        pages:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Pages
      type: object
      required:
      - items
      - total
      - page
      - size
      title: Page[DBTConfigResponse]
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    StandardResponse:
      properties:
        ok:
          type: boolean
          title: Ok
      type: object
      required:
      - ok
      title: StandardResponse
    DBTConfigResponse:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
        config:
          additionalProperties: true
          type: object
          title: Config
        config_schema:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Config Schema
        created_on:
          type: string
          title: Created On
        user:
          $ref: '#/components/schemas/UserIndexResponse'
      type: object
      required:
      - id
      - name
      - description
      - config
      - config_schema
      - created_on
      - user
      title: DBTConfigResponse
    DBTConfigCheckResponse:
      properties:
        names:
          items:
            type: string
          type: array
          title: Names
        check_types:
          items:
            type: string
          type: array
          title: Check Types
        files_required:
          items:
            type: string
          type: array
          title: Files Required
      type: object
      required:
      - names
      - check_types
      - files_required
      title: DBTConfigCheckResponse
    DBTConfigChecks:
      properties:
        checks:
          items:
            $ref: '#/components/schemas/DBTConfigCheck'
          type: array
          title: Checks
      type: object
      required:
      - checks
      title: DBTConfigChecks
    UserIndexResponse:
      properties:
        id:
          type: integer
          title: Id
        uuid:
          type: string
          format: uuid
          title: Uuid
        first_name:
          anyOf:
          - type: string
          - type: 'null'
          title: First Name
        last_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Name
        email:
          type: string
          title: Email
        phone:
          anyOf:
          - type: string
          - type: 'null'
          title: Phone
        is_active:
          type: boolean
          title: Is Active
        is_verified:
          type: boolean
          title: Is Verified
        is_invited:
          type: boolean
          title: Is Invited
        is_onboarded:
          type: boolean
          title: Is Onboarded
        created_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At
        role_title:
          anyOf:
          - type: string
          - type: 'null'
          title: Role Title
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
        attributes:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Attributes
        deleted_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Deleted At
        last_login_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Login At
        role_source:
          anyOf:
          - type: string
          - type: 'null'
          title: Role Source
        has_role_conflict:
          type: boolean
          title: Has Role Conflict
          default: false
        sso_resolved_role_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Sso Resolved Role Id
        sso_resolved_role_title:
          anyOf:
          - type: string
          - type: 'null'
          title: Sso Resolved Role Title
      type: object
      required:
      - id
      - uuid
      - email
      - is_active
      - is_verified
      - is_invited
      - is_onboarded
      - created_at
      title: UserIndexResponse
    DBTConfigRequest:
      properties:
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
        config:
          additionalProperties: true
          type: object
          title: Config
        config_schema:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Config Schema
      type: object
      required:
      - name
      - description
      - config
      - config_schema
      title: DBTConfigRequest
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer