redash-spec.yaml

openapi: 3.0.3
info:
  title: redash
  version: 0.0.1
paths:
  /ping:
    get:
      responses:
        '200':
          description: OK
          content:
            text/html:
              schema:
                type: string
                example: PONG.
  /status.json:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  dashboards_count:
                    type: integer
                  database_metrics:
                    type: object
                    properties:
                      metrics:
                        type: array
                        items:
                          type: array
                          items:
                            oneOf:
                              - type: string
                              - type: integer
                  manager:
                    type: object
                    properties:
                      last_refresh_at:
                        type: string
                      outdated_queries_count:
                        type: string
                      query_ids:
                        type: string
                      queues:
                        type: object
                        properties:
                          celery:
                            type: object
                            properties:
                              data_sources:
                                type: string
                              size:
                                type: integer
                  queries_count:
                    type: integer
                  query_results_count:
                    type: integer
                  redis_used_memory:
                    type: integer
                  redis_used_memory_human:
                    type: string
                  unused_query_results_count:
                    type: integer
                  version:
                    type: string
                  widgets_count:
                    type: integer
                  workers:
                    type: array
                    items: {}
  /api/alerts:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    user:
                      $ref: '#/components/schemas/User'
                    state:
                      type: string
                    name:
                      type: string
                    rearm:
                      type: integer
                    updated_at:
                      type: string
                      format: date-time
                    query:
                      type: object
                      properties:
                        user:
                          $ref: '#/components/schemas/User'
                        created_at:
                          type: string
                          format: date-time
                        latest_query_data_id:
                          type: integer
                        schedule:
                          nullable: true
                        description:
                          type: string
                          nullable: true
                        tags:
                          type: array
                          items:
                            type: string
                        updated_at:
                          type: string
                          format: date-time
                        last_modified_by:
                          $ref: '#/components/schemas/User'
                        options:
                          type: object
                          additionalProperties: true
                        version:
                          type: integer
                        query_hash:
                          type: string
                        is_archiverd:
                          type: boolean
                        query:
                          type: string
                        api_key:
                          type: string
                        is_draft:
                          type: boolean
                        id:
                          type: integer
                        data_source_id:
                          type: integer
                        name:
                          type: string
                    created_at:
                      type: string
                      format: date-time
                    last_triggered_at:
                      type: string
                      format: date-time
                      nullable: true
                    id:
                      type: integer
                    options:
                      type: object
                      additionalProperties: true
      tags:
        - Alert
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                options:
                  type: object
                  additionalProperties: true
                name:
                  type: string
                query_id:
                  type: integer
                destination_id:
                  type: integer
                rearm:
                  type: integer
              required:
                - options
                - name
                - query_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  user:
                    $ref: '#/components/schemas/User'
                  state:
                    type: string
                  name:
                    type: string
                  rearm:
                    type: integer
                  updated_at:
                    type: string
                    format: date-time
                  query:
                    type: object
                    properties:
                      user:
                        $ref: '#/components/schemas/User'
                      created_at:
                        type: string
                        format: date-time
                      latest_query_data_id:
                        type: integer
                        nullable: true
                      schedule:
                        nullable: true
                      description:
                        type: string
                        nullable: true
                      tags:
                        type: array
                        items:
                          type: string
                      updated_at:
                        type: string
                        format: date-time
                      lats_modified_by:
                        type: object
                        properties:
                          auth_type:
                            type: string
                          is_disabled:
                            type: boolean
                          updated_at:
                            type: string
                            format: date-time
                          profile_image_url:
                            type: string
                          is_inviration_pending:
                            type: boolean
                          groups:
                            type: array
                            items:
                              type: integer
                          id:
                            type: integer
                          name:
                            type: string
                          created_at:
                            type: string
                            format: date-time
                          disabled_at:
                            type: string
                            format: date-time
                          is_email_verified:
                            type: boolean
                          active_at:
                            type: string
                            format: date-time
                          email:
                            type: string
                            format: email
                      options:
                        type: object
                        additionalProperties: true
                      version:
                        type: integer
                      query_hash:
                        type: string
                      is_archived:
                        type: boolean
                      query:
                        type: string
                      qpi_key:
                        type: string
                      is_draft:
                        type: boolean
                      id:
                        type: integer
                      data_source_id:
                        type: integer
                      name:
                        type: string
                  created_at:
                    type: string
                    format: date-time
                  last_triggered_at:
                    type: string
                    format: date-time
                    nullable: true
                  id:
                    type: integer
                  options:
                    type: object
                    additionalProperties: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      tags:
        - Alert
  /api/dashbaords:
    get:
      parameters:
        - in: query
          name: page_size
          schema:
            type: integer
        - in: query
          name: page
          schema:
            type: integer
        - in: query
          name: order
          schema:
            type: string
        - in: query
          name: q
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                  page:
                    type: integer
                  page_size:
                    type: integer
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        tags:
                          type: array
                          items:
                            type: string
                        is_archiverd:
                          type: boolean
                        updated_at:
                          type: string
                          format: date-time
                        is_favorite:
                          type: boolean
                        user:
                          $ref: '#/components/schemas/User'
                        layout:
                          type: array
                          items: {}
                        is_draft:
                          type: boolean
                        id:
                          type: integer
                        user_id:
                          type: integer
                        name:
                          type: string
                        created_at:
                          type: string
                          format: date-time
                        slug:
                          type: string
                        version:
                          type: integer
                        widgets:
                          nullable: true
                        dashboard_filters_enabled:
                          type: boolean
      tags:
        - Dashboard
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
              required:
                - name
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  tags:
                    type: array
                    items:
                      type: string
                  is_archived:
                    type: boolean
                  updated_at:
                    type: string
                    format: date-time
                  is_favorite:
                    type: boolean
                  user:
                    $ref: '#/components/schemas/User'
                  layout:
                    type: array
                    items: {}
                  is_draft:
                    type: boolean
                  id:
                    type: integer
                  user_id:
                    type: integer
                  name:
                    type: string
                  created_at:
                    type: string
                    format: date-time
                  slug:
                    type: string
                  version:
                    type: integer
                  widgets:
                    nullable: true
                  dashboard_filters_enabled:
                    type: boolean
      tags:
        - Dashboard
  /api/data_sources:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                    pause_reason:
                      type: string
                      nullable: true
                    syntex:
                      type: string
                    paused:
                      type: integer
                    view_only:
                      type: boolean
                    type:
                      type: string
                    id:
                      type: integer
      tags:
        - DataSource
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSourcesRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  scheduled_queue_name:
                    type: string
                  name:
                    type: string
                  pause_reason:
                    type: string
                    nullable: true
                  queue_name:
                    type: string
                  syntax:
                    type: string
                  paused:
                    type: integer
                  options:
                    type: object
                    properties:
                      dbname:
                        type: string
                  groups:
                    type: object
                  type:
                    type: string
                  id:
                    type: integer
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      tags:
        - DataSource
  /api/data_sources/types:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    configuration_schema:
                      $ref: '#/components/schemas/DataSourcesType'
                    type:
                      type: string
                    name:
                      type: string
      tags:
        - DataSource
  /api/data_sources/{data_source_id}:
    get:
      parameters:
        - in: path
          name: data_source_id
          schema:
            type: integer
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSource'
      tags:
        - DataSource
    post:
      parameters:
        - in: path
          name: data_source_id
          schema:
            type: integer
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSourcesRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSource'
      tags:
        - DataSource
    delete:
      parameters:
        - in: path
          name: data_source_id
          schema:
            type: integer
          required: true
      responses:
        '204':
          description: No Content
      tags:
        - DataSource
  /api/data_sources/{data_source_id}/schema:
    get:
      parameters:
        - in: path
          name: data_source_id
          schema:
            type: integer
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  schema:
                    type: array
                    items:
                      $ref: '#/components/schemas/Schema'
      tags:
        - DataSource
  /api/data_sources/{data_source_id}/pause:
    post:
      parameters:
        - in: path
          name: data_source_id
          schema:
            type: integer
          required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                reason:
                  type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                  pause_reason:
                    type: string
                  syntax:
                    type: string
                  paused:
                    type: integer
                  type:
                    type: string
                  id:
                    type: integer
      tags:
        - DataSource
    delete:
      parameters:
        - in: path
          name: data_source_id
          schema:
            type: integer
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                  pause_reason:
                    type: string
                    nullable: true
                  syntax:
                    type: string
                  paused:
                    type: integer
                  type:
                    type: string
                  id:
                    type: integer
      tags:
        - DataSource
  /api/data_sources/{data_source_id}/test:
    post:
      parameters:
        - in: path
          name: data_source_id
          schema:
            type: integer
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  ok:
                    type: boolean
      tags:
        - DataSource
  /api/groups:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    created_at:
                      type: string
                      format: date-time
                    permissions:
                      type: array
                      items:
                        type: string
                    type:
                      type: string
                    id:
                      type: integer
                    name:
                      type: string
      tags:
        - Group
  /api/queries:
    get:
      parameters:
        - in: query
          name: page_size
          schema:
            type: integer
        - in: query
          name: page
          schema:
            type: integer
        - in: query
          name: order
          schema:
            type: string
        - in: query
          name: q
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                  page:
                    type: integer
                  page_size:
                    type: integer
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        user:
                          $ref: '#/components/schemas/User'
                        created_at:
                          type: string
                          format: date-time
                        runtime:
                          nullable: true
                        latest_query_data_id:
                          type: integer
                          nullable: true
                        is_favorite:
                          type: boolean
                        schedule:
                          nullable: true
                        description:
                          type: string
                          nullable: true
                        tags:
                          type: array
                          items:
                            type: string
                        retrieved_at:
                          nullable: true
                        updated_at:
                          type: string
                          format: date-time
                        options:
                          type: object
                          additionalProperties: true
                        version:
                          type: number
                        last_modified_by_id:
                          type: integer
                        query_hash:
                          type: string
                        is_archived:
                          type: boolean
                        query:
                          type: string
                        api_key:
                          type: string
                        is_draft:
                          type: boolean
                        id:
                          type: integer
                        data_source_id:
                          type: integer
                        name:
                          type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      tags:
        - Query
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                data_source_id:
                  type: number
                query:
                  type: string
                name:
                  type: string
                description:
                  type: string
                schedule:
                  type: string
                options:
                  type: object
                  additionalProperties: true
              required:
                - data_source_id
                - query
                - name
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  user:
                    $ref: '#/components/schemas/User'
                  created_at:
                    type: string
                    format: date-time
                  latest_query_data_id:
                    type: number
                    nullable: true
                  schedule:
                    type: string
                    nullable: true
                  description:
                    type: string
                  tags:
                    type: array
                    items:
                      type: string
                  updated_at:
                    type: string
                    format: date-time
                  last_modified_by:
                    $ref: '#/components/schemas/User'
                  options:
                    type: object
                    additionalProperties: true
                  version:
                    type: integer
                  is_favorite:
                    type: boolean
                  query_hash:
                    type: string
                  is_archived:
                    type: boolean
                  query:
                    type: string
                  api_key:
                    type: string
                  is_draft:
                    type: boolean
                  id:
                    type: integer
                  data_source_id:
                    type: integer
                  name:
                    type: string
      tags:
        - Query
  /api/query_results:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                query:
                  type: string
                query_id:
                  type: number
                max_age:
                  type: number
                data_source_id:
                  type: number
                parameters:
                  type: object
                  additionalProperties: true
              required:
                - query
                - data_source_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  job:
                    type: object
                    properties:
                      status:
                        type: integer
                      error:
                        type: string
                      id:
                        type: string
                      query_result_id:
                        type: integer
                        nullable: true
                      updated_at:
                        type: integer
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      tags:
        - QueryResult
  /api/users:
    get:
      parameters:
        - in: query
          name: page
          schema:
            type: integer
        - in: query
          name: page_size
          schema:
            type: integer
        - in: query
          name: q
          schema:
            type: string
        - in: query
          name: disabled
          schema:
            type: boolean
          allowEmptyValue: true
        - in: query
          name: pending
          schema:
            type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                  page:
                    type: integer
                  page_size:
                    type: integer
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
      tags:
        - User
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                email:
                  type: string
                  format: email
              required:
                - name
                - email
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '400':
          description: Bad Request
          content:
            applicatin/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      tags:
        - User
  /api/users/{userId}:
    get:
      parameters:
        - in: path
          name: userId
          schema:
            type: integer
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
      tags:
        - User
    post:
      parameters:
        - in: path
          name: userId
          schema:
            type: integer
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  format: email
                name:
                  type: string
                password:
                  type: string
                old_password:
                  type: string
                groups:
                  type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      tags:
        - User
    delete:
      parameters:
        - in: path
          name: userId
          schema:
            type: integer
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
      tags:
        - User
  /api/users/{userId}/invite:
    post:
      parameters:
        - in: path
          name: userId
          schema:
            type: integer
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
      tags:
        - User
  /api/users/{userId}/reset_password:
    post:
      parameters:
        - in: path
          name: userId
          schema:
            type: integer
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  reset_link:
                    type: string
                    format: uri
      tags:
        - User
  /api/users/{userId}/regenerate_api_key:
    post:
      parameters:
        - in: path
          name: userId
          schema:
            type: integer
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      tags:
        - User
  /api/users/{userId}/disable:
    post:
      parameters:
        - in: path
          name: userId
          schema:
            type: integer
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      tags:
        - User
    delete:
      parameters:
        - in: path
          name: userId
          schema:
            type: integer
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      tags:
        - User
  /api/visualizations:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                query_id:
                  type: integer
                name:
                  type: string
                description:
                  type: string
                options:
                  type: object
                  additionalProperties: true
                type:
                  type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  description:
                    nullable: true
                  created_at:
                    type: string
                  updated_at:
                    type: string
                  id:
                    type: integer
                  type:
                    type: string
                  options:
                    type: object
                    additionalProperties: true
                  name:
                    type: string
      tags:
        - Visualization
  /api/widgets:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                dashboard_id:
                  type: integer
                visualizationid:
                  type: integer
                options:
                  type: object
                  additionalProperties: true
                text:
                  type: string
                width:
                  type: number
              required:
                - dasboard_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  widget:
                    type: object
                    additionalProperties: true
      tags:
        - Widget
  /api/destinations:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    icon:
                      type: string
                    type:
                      type: string
                    id:
                      type: integer
                    name:
                      type: string
      tags:
        - Destination
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DestinationRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  options:
                    type: object
                    additionalProperties: true
                  icon:
                    type: string
                  type:
                    type: string
                  id:
                    type: integer
                  name:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      tags:
        - Destination
  /api/destinations/types:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DestinationType'
      tags:
        - Destination
  /api/destinations/{destination_id}:
    get:
      parameters:
        - in: path
          name: destination_id
          schema:
            type: integer
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  options:
                    type: object
                    properties:
                      url:
                        type: string
                      username:
                        type: string
                      channel:
                        type: string
                    additionalProperties: true
                  icon:
                    type: string
                  type:
                    type: string
                  id:
                    type: integer
                  name:
                    type: string
      tags:
        - Destination
    post:
      parameters:
        - in: path
          name: destination_id
          schema:
            type: integer
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DestinationRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  options:
                    type: object
                    properties:
                      addresses:
                        type: string
                      url:
                        type: string
                      username:
                        type: string
                      channel:
                        type: string
                    additionalProperties: true
                  icon:
                    type: string
                  type:
                    type: string
                  id:
                    type: integer
                  name:
                    type: string
      tags:
        - Destination
    delete:
      parameters:
        - in: path
          name: destination_id
          schema:
            type: integer
          required: true
      responses:
        '204':
          description: NO CONTENT
      tags:
        - Destination
  /api/query_snippets:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    description:
                      type: string
                    created_at:
                      type: string
                      format: date-time
                    updated_at:
                      type: string
                      format: date-time
                    snippet:
                      type: string
                    trigger:
                      type: string
                    user:
                      $ref: '#/components/schemas/User'
                    id:
                      type: integer
      tags:
        - QuerySnippet
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                trigger:
                  type: object
                description:
                  type: string
                snippet:
                  type: string
              required:
                - trigger
                - description
                - snippet
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  description:
                    type: string
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
                  snippet:
                    type: string
                  trigger:
                    type: string
                  user:
                    $ref: '#/components/schemas/User'
                  id:
                    type: integer
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      tags:
        - QuerySnippet
  /api/settings/organization:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  settings:
                    type: object
                    properties:
                      date_format:
                        type: string
                      auth_jwt_auth_public_certs_url:
                        type: string
                      auth_jwt_auth_issuer:
                        type: string
                      auth_jwt_login_enabled:
                        type: boolean
                      auth_saml_nameid_format:
                        type: string
                      auth_jwt_auth_algorithms:
                        type: array
                        items: {}
                      auth_google_apps_domains:
                        type: array
                        items: {}
                      auth_jwt_auth_cookie_name:
                        type: string
                      auth_jwt_auth_audience:
                        type: string
                      auth_jwt_auth_header_name:
                        type: string
                      feature_show_permissions_control:
                        type: boolean
                      auth_saml_entity_id:
                        type: string
                      auth_passowrd_login_enabled:
                        type: boolean
                      auth_saml_metadata_url:
                        type: string
                      auth_saml_enabled:
                        type: boolean
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      tags:
        - Setting
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                auth_password_login_enabled:
                  type: boolean
                auth_google_apps_domains:
                  type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  settings:
                    type: object
                    properties:
                      date_format:
                        type: string
                      auth_jwt_auth_public_certs_url:
                        type: string
                      auth_jwt_auth_issuer:
                        type: string
                      auth_jwt_login_enabled:
                        type: boolean
                      auth_saml_nameid_format:
                        type: string
                      auth_jwt_auth_algorithms:
                        type: array
                        items: {}
                      auth_google_apps_domains:
                        type: array
                        items: {}
                      auth_jwt_auth_cookie_name:
                        type: string
                      auth_jwt_auth_audience:
                        type: string
                      auth_jwt_auth_header_name:
                        type: string
                      feature_show_permissions_control:
                        type: boolean
                      auth_saml_entity_id:
                        type: string
                      auth_passowrd_login_enabled:
                        type: boolean
                      auth_saml_metadata_url:
                        type: string
                      auth_saml_enabled:
                        type: boolean
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      tags:
        - Setting

components:
  schemas:
    DataSource:
      type: object
      properties:
        scheduled_queue_name:
          type: string
        name:
          type: string
        pause_reason:
          nullable: true
        queue_name:
          type: string
        syntax:
          type: string
        paused:
          type: integer
        options:
          type: object
          properties:
            url:
              type: string
        groups:
          type: object
          additionalProperties:
            type: boolean
        type:
          type: string
        id:
          type: integer
    DataSourcesRequest:
      type: object
      properties:
        options:
          type: object
          properties:
            dbname:
              type: string
        name:
          type: string
        type:
          type: string
          enum:
            - mysql
            - pg
            - prometheus
      required:
        - options
        - name
        - type
    DataSourcesType:
      type: object
      properties:
        required:
          type: array
          items:
            type: string
        type:
          type: string
        properties:
          type: object
          properties:
            db:
              type: object
              properties:
                type:
                  type: string
                title:
                  type: string
            apikey:
              type: object
              properties:
                type:
                  type: string
            endpoint:
              type: object
              properties:
                type:
                  type: string
            type:
              type: object
              properties:
                type:
                  type: string
            get_schema:
              type: object
              properties:
                default:
                  type: boolean
                type:
                  type: string
                title:
                  type: string
    DestinationRequest:
      type: object
      properties:
        options:
          type: object
          additionalProperties: true
        name:
          type: string
        type:
          type: string
          enum:
            - email
      required:
        - options
        - name
        - type
    DestinationType:
      type: object
      properties:
        configuration_schema:
          type: object
          properties:
            required:
              type: array
              items:
                type: string
            type:
              type: string
            properties:
              type: object
              additionalProperties: true
        type:
          type: string
        name:
          type: string
        icon:
          type: string
    Schema:
      type: object
      properties:
        name:
          type: string
        columns:
          type: array
          items:
            type: string
    User:
      type: object
      properties:
        auth_type:
          type: string
        is_disabled:
          type: boolean
        updated_at:
          type: string
          format: date-time
        profile_image_url:
          type: string
          format: uri
        is_invitation_pending:
          type: boolean
        groups:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              name:
                type: string
        id:
          type: integer
        name:
          type: string
        created_at:
          type: string
          format: date-time
        disabled_at:
          type: string
          format: date-time
          nullable: true
        is_email_verified:
          type: boolean
        api_key:
          type: string
        active_at:
          type: string
          format: date-time
        email:
          type: string
          format: email