openapi: 3.2.0
info:
  title: Atscale Catalogs API
  version: '2026-09-26'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-09-26: 28 operation(s) read from 34 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Atscale has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 5
    documentation: 23
    pages-with-code: 4
    pages-read: 34
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-09-26'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://documentation.atscale.com/container-api/Data%20Catalog%20API/request-reference
  - https://documentation.atscale.com/installer-api/Data%20Catalog%20API/request-reference
  - https://documentation.atscale.com/installer-api/list-webhooks
  - https://documentation.atscale.com/installer-api/create-new-webhook
  - https://documentation.atscale.com/installer-api/delete-specific-webhook
  - https://help.atscale.com/kb/how-to-create-edit-and-delete-a-user-with-the-api
  - https://documentation.atscale.com/installer-api/get-org-org-id-webhooks-hook-id
  - https://documentation.atscale.com/container/managing-atscale/managing-aggregates/rebuilding-aggregates-using-the-rest-api
  - https://documentation.atscale.com/container-api/xmla
  - https://documentation.atscale.com/container-api/export
  - https://documentation.atscale.com/container-api/import
  - https://documentation.atscale.com/installer-api/get-org
  - https://documentation.atscale.com/installer-api/get-orgs
  - https://documentation.atscale.com/installer-api/post-org
  - https://documentation.atscale.com/container-api/aggregates
  - https://documentation.atscale.com/container-api/plan-query
  - https://documentation.atscale.com/container-api/get-catalogs
  - https://documentation.atscale.com/container-api/submit-query
  - https://documentation.atscale.com/container-api/exchange-token
  - https://documentation.atscale.com/container-api/get-query-data
  - https://documentation.atscale.com/container-api/aggregate-block
  - https://documentation.atscale.com/container-api/create-schedule
  - https://documentation.atscale.com/container-api/delete-schedule
  - https://documentation.atscale.com/container-api/deploy-from-git
  - https://documentation.atscale.com/container-api/trigger-new-job
  - https://documentation.atscale.com/installer-api/post-org-org-id
  - https://documentation.atscale.com/container-api/aggregate-delete
  - https://documentation.atscale.com/container-api/get-dw-snowflake
  - https://documentation.atscale.com/installer-api/get-sessiontoken
  - https://documentation.atscale.com/container-api/aggregate-unblock
  - https://documentation.atscale.com/container-api/get-catalog-repos
  - https://documentation.atscale.com/installer-api/delete-org-org-id
  - https://documentation.atscale.com/container-api/get-dw-data-bricks
  - https://documentation.atscale.com/container-api/aggregate-instances
servers:
- url: http://atscale-node-01.docker.infra.atscale.com:10500
security:
- bearer: []
tags:
- name: Catalogs
paths:
  /v1/catalogs/{catalogid}/models/{modelid}/aggregates-creation/scheduler/jobs/{jobid}:
    delete:
      operationId: delete_v1_catalogs_catalogid_models_modelid_aggregates_creation_scheduler_jobs_j
      tags:
      - Catalogs
      summary: Delete the schedule with the specified ID
      description: Delete the schedule with the specified ID.
      x-source: https://documentation.atscale.com/container-api/delete-schedule
      parameters:
      - name: catalogid
        in: path
        required: true
        schema:
          type: string
      - name: modelid
        in: path
        required: true
        schema:
          type: string
      - name: jobid
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/catalogs/{catalogid}/models/{modelid}/aggregates-creation/{aggregatescreationid}:
    post:
      operationId: post_v1_catalogs_catalogid_models_modelid_aggregates_creation_aggregatescreation
      tags:
      - Catalogs
      summary: Trigger a new aggregate creation job
      x-source: https://documentation.atscale.com/container-api/trigger-new-job
      parameters:
      - name: catalogid
        in: path
        required: true
        schema:
          type: string
      - name: modelid
        in: path
        required: true
        schema:
          type: string
      - name: aggregatescreationid
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        description: Authorization header.
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1CatalogsCatalogidModelsModelidAggregatesCreationAggreg'
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at aggregatescreationId
  /v1/catalogs/deploy:
    post:
      operationId: post_v1_catalogs_deploy
      tags:
      - Catalogs
      summary: Deploy SML from a git repository
      x-source: https://documentation.atscale.com/container-api/deploy-from-git
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1CatalogsDeployRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1CatalogsDeployResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostV1CatalogsDeployRequest:
      type: object
      properties:
        repoUrl:
          type: string
        gitToken:
          type: string
        gitUsername:
          type: string
        branch:
          type: string
        catalogName:
          type: string
        catalogLabel:
          type: string
        tableauServers:
          type: object
          description: Array of tableau server objects
      required:
      - repoUrl
      - gitToken
    PostV1CatalogsDeployResponse:
      type: object
      properties:
        catalogId:
          type: string
          description: required
        tableau:
          type: object
          description: Array of tableau deployment results
        compilationWarnings:
          type: object
          description: Compilation warnings details
    PostV1CatalogsCatalogidModelsModelidAggregatesCreationAggreg:
      type: object
      properties:
        success:
          type: boolean
          description: Success indicator.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer