spec3.yaml

components:
  requestBodies:
    ExecuteQueryLambdaRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ExecuteQueryLambdaRequest'
      description: JSON object
    GetCollectionCommitRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GetCollectionCommitRequest'
      description: JSON object
      required: true
    QueryRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/QueryRequest'
      description: JSON object
      required: true
  schemas:
    AddDocumentsRequest:
      properties:
        data:
          description: Array of documents to be added to the collection.
          example: '[{ "field": "value" }]'
          items:
            type: object
          type: array
      required:
      - data
      type: object
    AddDocumentsResponse:
      properties:
        data:
          description: Information about the added documents.
          items:
            $ref: '#/components/schemas/DocumentStatus'
          type: array
        last_offset:
          description: A string representing the collection offset after completing
            the write.
          example: f1:0:0:0:0
          type: string
      type: object
    Alias:
      properties:
        collections:
          description: List of fully qualified collection names referenced by alias.
          example: '["commons.foo", "prod.demo"]'
          items:
            type: string
          type: array
        created_at:
          description: ISO-8601 date.
          example: '2001-08-28T00:23:41Z'
          type: string
        created_by_apikey_name:
          description: Name of the API key that was used to create this object if
            one was used.
          type: string
        creator_email:
          description: Email of the creator.
          example: xyz@rockset.com
          type: string
        description:
          description: Alias description.
          example: alias referencing collection in workspace
          type: string
        modified_at:
          description: ISO-8601 date.
          example: '2001-08-28T00:23:42Z'
          type: string
        name:
          description: Name of the alias.
          example: demo
          type: string
        state:
          description: State of the alias.
          enum:
          - CREATED
          - DELETED
          example: CREATED
          type: string
        workspace:
          description: Name of the workspace.
          example: commons
          type: string
      type: object
    ApiKey:
      description: API keys are used to authenticate requests to Rockset's API. An
        API key is tied to the user who creates it.
      properties:
        created_at:
          description: Date that API key was created (ISO-8601 format).
          example: '2001-08-28T00:23:41Z'
          type: string
        created_by:
          description: Email of API key owner.
          example: test@rockset.com
          type: string
        created_by_apikey_name:
          description: Name of the API key that was used to create this object if
            one was used.
          type: string
        expiry_time:
          description: The expiration date of this API key.
          example: '2001-08-28T00:23:41Z'
          type: string
        key:
          description: This field will only be populated with the full key when creating
            an API key. Otherwise, it will be an API key identifier of 6 characters.
          example: aB35kD
          type: string
        last_access_time:
          description: Date that API key was most recently used (ISO-8601 format).
          example: '2001-08-28T00:23:41Z'
          type: string
        name:
          description: Name of the API key.
          example: my-key
          type: string
        role:
          description: Role specifying access control. If not specified, API key will
            have access to all of the associated user's roles.
          example: read-only
          type: string
        state:
          description: Current state of this key.
          enum:
          - ACTIVE
          - SUSPENDED
          example: ACTIVE
          type: string
      required:
      - key
      - name
      type: object
    AsyncQueryOptions:
      properties:
        client_timeout_ms:
          description: 'If the query completes before the client timeout, the results
            are returned. Otherwise if the client timeout is exceeded, the query id
            will be returned, and the query will continue to run in the background
            for up to 30 minutes. (The 30 minute timeout can be configured lower with
            timeout_ms.) `async_options.client_timeout_ms` only applies when `async`
            is true. The default value of `client_timeout_ms` is 0, so async query
            requests will immediately return with a query id by default. '
          format: int64
          type: integer
        max_initial_results:
          description: '[DEPRECATED] Use the query request `max_initial_results` instead.
            The maximum number of results you will receive as a client. If the query
            exceeds this limit, the remaining results can be requested using a returned
            pagination cursor. In addition, there is a maximum response size of 100MiB
            so fewer than `max_results` may be returned.'
          format: int64
          type: integer
        timeout_ms:
          description: '[DEPRECATED] Use the query request `timeout_ms` instead. The
            maximum amount of time that the system will attempt to complete query
            execution before aborting the query and returning an error. This must
            be set to a value that is greater than or equal to the client timeout,
            and the maximum value of this timeout is 30 minutes.'
          format: int64
          type: integer
      type: object
    AutoScalingPolicy:
      properties:
        enabled:
          description: Whether auto scaling policy is enabled.
          example: true
          type: boolean
        max_size:
          description: Maximum size Rockset can auto scale the Virtual Instance to.
            This value should be one of the dedicated sizes greater than or same as
            the min_size and lower than or same as the current size.
          enum:
          - FREE
          - NANO
          - SHARED
          - MILLI
          - XSMALL
          - SMALL
          - MEDIUM
          - LARGE
          - XLARGE
          - XLARGE2
          - XLARGE4
          - XLARGE8
          - XLARGE16
          example: XLARGE2
          type: string
        min_size:
          description: Minimum size Rockset can auto scale the Virtual Instance to.
            This value should be one of the dedicated sizes lower than or same as
            the max_size and greater than or same as the current size.
          enum:
          - FREE
          - NANO
          - SHARED
          - MILLI
          - XSMALL
          - SMALL
          - MEDIUM
          - LARGE
          - XLARGE
          - XLARGE2
          - XLARGE4
          - XLARGE8
          - XLARGE16
          example: LARGE
          type: string
      type: object
    AvroParams:
      type: object
    AwsAccessKey:
      properties:
        aws_access_key_id:
          description: AWS access key ID.
          example: AKIAIOSFODNN7EXAMPLE
          type: string
        aws_secret_access_key:
          description: AWS secret access key.
          example: wJal....
          type: string
      required:
      - aws_access_key_id
      - aws_secret_access_key
      type: object
    AwsRole:
      properties:
        aws_external_id:
          description: External id used for integration.
          example: external id of aws
          type: string
        aws_role_arn:
          description: ARN of rockset-role created in your account.
          example: arn:aws:iam::2378964092:role/rockset-role
          type: string
      required:
      - aws_role_arn
      type: object
    AzureBlobStorageIntegration:
      properties:
        connection_string:
          description: Credentials for the Azure Blob Service.
          example: 'BlobEndpoint=https://<NamespaceName>.blob.core.windows.net;

            SharedAccessSignature=<KeyValue>'
          type: string
      required:
      - connection_string
      type: object
    AzureEventHubsIntegration:
      properties:
        connection_string:
          description: Credentials for the Azure Event Hubs.
          example: Endpoint=sb://<NamespaceName>.servicebus.windows.net/;SharedAccessKeyName=<KeyName>;SharedAccessKey=<KeyValue>
          type: string
      type: object
    AzureServiceBusIntegration:
      properties:
        connection_string:
          description: Credentials for the Azure Service Bus.
          example: Endpoint=sb://<NamespaceName>.servicebus.windows.net/;SharedAccessKeyName=<KeyName>;SharedAccessKey=<KeyValue>
          type: string
      required:
      - connection_string
      type: object
    BulkStats:
      properties:
        data_downloaded_bytes:
          description: Size in bytes of documents downloaded from source during an
            ongoing or completed bulk ingest. This includes documents that are dropped
            and reingested.
          example: 10000000
          format: int64
          type: integer
        data_indexed_bytes:
          description: Size in bytes of documents indexed. This is the total size
            of documents after transformations and dropping before indexes are built.
          example: 8000000
          format: int64
          type: integer
        data_indexed_throughput_bytes:
          description: Throughput of documents indexed in the last minute measured
            in bytes/s. This is based off the data_indexed_bytes size. Throughput
            during the download stage is shown on a per-source granularity in the
            sources field of the Collection response.
          example: 800000.5
          format: double
          type: number
        documents_downloaded:
          description: Number of documents downloaded from source during an ongoing
            or completed bulk ingest. This includes documents that are dropped and
            reingested.
          example: 10000
          format: int64
          type: integer
        download_compute_ms:
          description: Bulk ingest compute units in milliseconds used for downloading
            documents.
          example: 50000
          format: int64
          type: integer
        downloading_stage_done_at:
          description: ISO-8601 date of when the downloading stage was completed.
          example: '2001-08-28T00:23:41Z'
          type: string
        finalizing_stage_done_at:
          description: ISO-8601 date of when the finalizing stage was completed.
          example: '2001-08-28T00:23:41Z'
          type: string
        index_compute_ms:
          description: Bulk ingest compute units in milliseconds used for indexing
            documents.
          example: 100000
          format: int64
          type: integer
        indexing_stage_done_at:
          description: ISO-8601 date of when the indexing stage was completed.
          example: '2001-08-28T00:23:41Z'
          type: string
        initializing_stage_done_at:
          description: ISO-8601 date of when the initializing stage was completed.
          example: '2001-08-28T00:23:41Z'
          type: string
        pre_index_size_bytes:
          description: Size in bytes of documents before being indexed. This is the
            total size of documents after decompression, transformations, and dropping.
            This is equal to data_indexed_bytes after the indexing stage is done unless
            there are retries during indexing the data.
          example: 8000000
          format: int64
          type: integer
        provisioning_stage_done_at:
          description: ISO-8601 date of when the provisioning stage was completed.
          example: '2001-08-28T00:23:41Z'
          type: string
        started_at:
          description: ISO-8601 date of when the bulk ingest was started.
          example: '2001-08-28T00:23:41Z'
          type: string
        total_index_size_bytes:
          description: Total size of indexes after the completed bulk ingest. This
            is the same as collection size.
          example: 10000000
          format: int64
          type: integer
        transformation_compute_ms:
          description: Bulk ingest compute units in milliseconds used for ingest transformation.
          example: 50000
          format: int64
          type: integer
      type: object
    CancelQueryResponse:
      properties:
        data:
          $ref: '#/components/schemas/QueryInfo'
      type: object
    Cluster:
      properties:
        apiserver_url:
          description: Api server url for cluster.
          example: api.rockset.us-west-2.rockset.com
          type: string
        aws_region:
          description: Aws region.
          example: us-west-2
          type: string
        cluster_type:
          description: Cluster type.
          enum:
          - PUBLIC
          example: PRIVATE
          type: string
        domain:
          description: Domain of org using cluster.
          example: rockset
          type: string
        id:
          description: Unique identifier for the cluster.
          example: asdf98-as9df8adf-adsf9asfd
          type: string
        top_level_domain:
          description: Top level domain of org using cluster.
          example: .com
          type: string
      type: object
    Collection:
      properties:
        aliases:
          description: List of aliases for a collection.
          items:
            $ref: '#/components/schemas/Alias'
          type: array
        bulk_stats:
          items:
            $ref: '#/components/schemas/BulkStats'
          type: array
        clustering_key:
          description: List of clustering fields for a collection.
          items:
            $ref: '#/components/schemas/FieldPartition'
          type: array
        created_at:
          description: ISO-8601 date.
          example: '2001-08-28T00:23:41Z'
          type: string
        created_by:
          description: Email of user who created the collection.
          example: hello@rockset.com
          type: string
        created_by_apikey_name:
          description: Name of the API key that was used to create this collection
            if one was used.
          type: string
        description:
          description: Text describing the collection.
          example: transactions from stores worldwide
          type: string
        field_mapping_query:
          $ref: '#/components/schemas/FieldMappingQuery'
          description: Field mapping for a collection.
        field_mappings:
          description: List of mappings applied on all documents in a collection.
          items:
            $ref: '#/components/schemas/FieldMappingV2'
          type: array
        insert_only:
          description: Whether the collection is insert only or not.
          type: boolean
        name:
          description: Unique identifer for collection, can contain alphanumeric or
            dash characters.
          example: global-transactions
          pattern: ^[A-Za-z0-9_\-.]+$
          type: string
        read_only:
          description: Whether the collection is read-only or not.
          type: boolean
        retention_secs:
          description: Number of seconds after which data is purged based on event
            time.
          example: 2592000
          format: int64
          type: integer
        rrn:
          description: Collection RRN.
          example: rrn:col:use1a1:123e4567-e89b-12d3-a456-556642440000
          type: string
        sources:
          description: List of sources from which collection ingests.
          items:
            $ref: '#/components/schemas/Source'
          type: array
        stats:
          $ref: '#/components/schemas/CollectionStats'
          description: Metrics about the collection.
        status:
          description: Current status of collection.
          enum:
          - INITIALIZED
          - CREATED
          - READY
          - PAUSED
          - DELETED
          - PAUSING
          - RESUMING
          - PREPARING_BULK
          - BULK_INGEST_MODE
          - EXITING_BULK_INGEST_MODE
          - ENCRYPTION_KEY_ERROR
          - UNKNOWN
          example: READY
          type: string
        storage_compression_type:
          description: RocksDB storage compression type.
          enum:
          - LZ4
          - ZSTD
          - UNKNOWN
          type: string
        workspace:
          description: Name of the workspace that the collection is in.
          example: commons
          type: string
      type: object
    CollectionMount:
      properties:
        collection_path:
          description: Collection path.
          example: commons.foo
          type: string
        created_at:
          description: ISO-8601 date.
          example: '2001-08-28T00:23:41Z'
          type: string
        id:
          description: Mount ID.
          example: 5ac23....
          type: string
        last_refresh_time_millis:
          description: Unix timestamp of most recent refresh. Not applicable for live
            mounts.
          example: 123123764
          format: int64
          type: integer
        rrn:
          description: Mount RRN.
          example: rrn:mnt:use1a1:123e4567-e89b-12d3-a456-556642440000
          type: string
        snapshot_expiration_time_millis:
          description: Time in millis at which the snapshot expires.
          example: 864000000
          format: int64
          type: integer
        state:
          description: Mount type.
          enum:
          - CREATING
          - ACTIVE
          - REFRESHING
          - EXPIRED
          - DELETING
          - SWITCHING_REFRESH_TYPE
          - SUSPENDED
          - SUSPENDING
          example: ACTIVE
          type: string
        stats:
          $ref: '#/components/schemas/CollectionMountStats'
          description: Stats about this Collection Mount
        virtual_instance_id:
          description: Virtual instance ID.
          example: 5ac23....
          type: string
        virtual_instance_rrn:
          description: Virtual Instance RRN.
          example: rrn:vi:use1a1:123e4567-e89b-12d3-a456-556642440000
          type: string
      type: object
    CollectionMountResponse:
      properties:
        data:
          $ref: '#/components/schemas/CollectionMount'
          description: Resource mount object.
      type: object
    CollectionMountStats:
      properties:
        last_queried_ms:
          description: Milliseconds since Unix epoch Jan 1, 1970.
          example: 1535101119334
          format: int64
          type: integer
      type: object
    CollectionStats:
      properties:
        bulk_bytes_inserted:
          description: Total number of bytes inserted into the collection during bulk.
          format: int64
          type: integer
        bulk_bytes_overwritten:
          description: Total number of bytes overwritten in writing into the collection
            during bulk.
          format: int64
          type: integer
        bytes_inserted:
          description: Total number of bytes inserted into the collection.
          example: 123456
          format: int64
          type: integer
        bytes_overwritten:
          description: Total number of bytes overwritten in writing into the collection.
          example: 123456
          format: int64
          type: integer
        column_index_size:
          description: Total collection column index size in bytes.
          example: 123456
          format: int64
          type: integer
        doc_count:
          description: Number of documents in the collection.
          example: 2145
          format: int64
          type: integer
        fill_progress:
          description: Number between 0 and 1 that indicates progress of collection
            creation.
          example: 0.6
          format: double
          type: number
        inverted_index_size:
          description: Total collection inverted index size in bytes.
          example: 123456
          format: int64
          type: integer
        last_queried_ms:
          description: Milliseconds since Unix epoch Jan 1, 1970.
          example: 1535101119334
          format: int64
          type: integer
        last_updated_ms:
          description: Milliseconds since Unix epoch Jan 1, 1970.
          example: 1535101094433
          format: int64
          type: integer
        purged_doc_count:
          description: Number of documents purged from the collection.
          example: 2145
          format: int64
          type: integer
        purged_doc_size:
          description: Total size of bytes purged in bytes.
          example: 123456
          format: int64
          type: integer
        range_index_size:
          description: Total collection range index size in bytes.
          example: 123456
          format: int64
          type: integer
        row_index_size:
          description: Total collection row index size in bytes.
          example: 123456
          format: int64
          type: integer
        total_index_size:
          description: Total collection index size in bytes.
          example: 123456
          format: int64
          type: integer
        total_size:
          description: Total collection size in bytes.
          example: 123456
          format: int64
          type: integer
      type: object
    CreateAliasRequest:
      properties:
        collections:
          description: List of fully qualified collection names referenced by alias.
          example: '["commons.foo", "prod.demo"]'
          items:
            type: string
          type: array
        description:
          description: Optional description.
          example: version alias
          type: string
        name:
          description: Alias name.
          example: aliasName
          type: string
      required:
      - collections
      - name
      type: object
    CreateAliasResponse:
      properties:
        data:
          $ref: '#/components/schemas/Alias'
          description: Alias that was created.
      type: object
    CreateApiKeyRequest:
      properties:
        created_by:
          type: string
        expiry_time:
          description: If provided, the API key will automatically expire at this
            time (ISO-8601 format). Requires premium.
          example: '2001-08-28T00:23:41Z'
          type: string
        name:
          description: Name for this API key.
          example: my-app
          type: string
        role:
          type: string
      required:
      - name
      type: object
    CreateApiKeyResponse:
      properties:
        data:
          $ref: '#/components/schemas/ApiKey'
          description: The API key that was created.
      type: object
    CreateCollectionMountRequest:
      properties:
        collection_paths:
          description: Collections to mount.
          example: '["commons.foo", "commons.bar"]'
          items:
            type: string
          type: array
      type: object
    CreateCollectionMountsResponse:
      properties:
        data:
          description: Mounts created.
          items:
            $ref: '#/components/schemas/CollectionMount'
          type: array
      type: object
    CreateCollectionRequest:
      properties:
        clustering_key:
          description: Deprecated. List of clustering fields. Use CLUSTER BY clause
            in `field_mapping_query` instead.
          items:
            $ref: '#/components/schemas/FieldPartition'
          type: array
        description:
          description: Text describing the collection.
          example: transactions from stores worldwide
          type: string
        event_time_info:
          $ref: '#/components/schemas/EventTimeInfo'
          description: Deprecated. Configuration for event data. Use an _event_time
            mapping in `field_mapping_query` instead.
        field_mapping_query:
          $ref: '#/components/schemas/FieldMappingQuery'
          description: Ingest transformation query.
        name:
          description: Unique identifier for collection, can contain alphanumeric
            or dash characters.
          example: global-transactions
          type: string
        retention_secs:
          description: Number of seconds after which data is purged, based on event
            time. Minimum allowable value is 3600s/1 hour. The maximum value is strictly
            less than 10 years.
          example: 1000000
          format: int64
          maximum: 315359999
          minimum: 3600
          type: integer
        source_download_soft_limit_bytes:
          description: Soft ingest limit for this collection.
          format: int64
          type: integer
        sources:
          description: List of sources from which to ingest data.
          items:
            $ref: '#/components/schemas/Source'
          type: array
        storage_compression_type:
          description: RocksDB storage compression type.
          enum:
          - LZ4
          - ZSTD
          example: LZ4
          type: string
      type: object
    CreateCollectionResponse:
      properties:
        data:
          $ref: '#/components/schemas/Collection'
          description: Collection that was created.
      type: object
    CreateIntegrationRequest:
      properties:
        azure_blob_storage:
          $ref: '#/components/schemas/AzureBlobStorageIntegration'
          description: Azure Blob Storage details.
        azure_event_hubs:
          $ref: '#/components/schemas/AzureEventHubsIntegration'
          description: Azure Event Hubs details.
        azure_service_bus:
          $ref: '#/components/schemas/AzureServiceBusIntegration'
          description: Azure Service Bus details.
        description:
          description: Longer explanation for the integration.
          example: AWS account with event data for the data science team.
          type: string
        dynamodb:
          $ref: '#/components/schemas/DynamodbIntegration'
          description: Amazon DynamoDB details, must have one of aws_access_key or
            aws_role.
        gcs:
          $ref: '#/components/schemas/GcsIntegration'
          description: GCS details.
        is_write_enabled:
          description: is write access enabled for this integration.
          type: boolean
        kafka:
          $ref: '#/components/schemas/KafkaIntegration'
        kinesis:
          $ref: '#/components/schemas/KinesisIntegration'
          description: Amazon Kinesis details, must have one of aws_access_key or
            aws_role.
        mongodb:
          $ref: '#/components/schemas/MongoDbIntegration'
          description: MongoDb details.
        name:
          description: Descriptive label.
          example: event-logs
          type: string
        s3:
          $ref: '#/components/schemas/S3Integration'
          description: Amazon S3 details, must have one of aws_access_key or aws_role.
        snowflake:
          $ref: '#/components/schemas/SnowflakeIntegration'
          description: Snowflake details.
      required:
      - name
      type: object
    CreateIntegrationResponse:
      properties:
        data:
          $ref: '#/components/schemas/Integration'
          description: Integration object that was created.
      type: object
    CreateQueryLambdaRequest:
      properties:
        description:
          description: Optional description.
          example: production version foo
          type: string
        is_public:
          type: boolean
        name:
          description: Query Lambda name.
          example: myQueryLambda
          type: string
        sql:
          $ref: '#/components/schemas/QueryLambdaSql'
          description: Query Lambda SQL query.
      required:
      - name
      - sql
      type: object
    CreateQueryLambdaTagRequest:
      properties:
        tag_name:
          description: Name of Query Lambda tag.
          example: production
          type: string
        version:
          description: Hash identifying a Query Lambda tag.
          example: 123ABC
          type: string
      required:
      - tag_name
      - version
      type: object
    CreateRoleRequest:
      properties:
        description:
          description: Description for the role.
          example: Role with read and write privileges to all collections.
          type: string
        privileges:
          description: List of privileges that will be associated with the role.
          items:
            $ref: '#/components/schemas/Privilege'
          type: array
        role_name:
          description: Unique identifier for the role.
          example: read_write
          type: string
      type: object
    CreateScheduledLambdaRequest:
      properties:
        apikey:
          description: The apikey to use when triggering execution of the associated
            query lambda.
          example: qoiwkjndksd
          type: string
        cron_string:
          description: The UNIX-formatted cron string for this scheduled query lambda.
          example: '* * * * *'
          type: string
        ql_name:
          description: The name of the QL to use for scheduled execution.
          example: ql_name
          type: string
        tag:
          description: The QL tag to use for scheduled execution. One of either the
            QL tag or version must be specified
          example: production
          type: string
        total_times_to_execute:
          description: The number of times to execute this scheduled query lambda.
            Once this scheduled query lambda has been executed this many times, it
            will no longer be executed.
          example: 1
          format: int64
          type: integer
        version:
          description: The version of the QL to use for scheduled execution. One of
            either the QL version or tag must be specified.
          example: abcdef1234
          type: string
        webhook_auth_header:
          description: The value to use as the authorization header when hitting the
            webhook.
          example: bearer qiowjkjkdskdskldio
          type: string
        webhook_payload:
          description: The payload that should be sent to the webhook. JSON format.
          type: string
        webhook_url:
          description: The URL of the webhook that should be triggered after this
            scheduled query lambda completes.
          example: https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX
          type: string
      required:
      - apikey
      - cron_string
      - ql_name
      type: object
    CreateUserRequest:
      properties:
        email:
          description: User email, must be unique.
          example: hello@rockset.com
          type: string
        first_name:
          description: User first name.
          example: John
          type: string
        last_name:
          description: User last name.
          example: Doe
          type: string
        roles:
          description: List of roles for a given user.
          example: '["admin", "member", "read-only"]'
          items:
            type: string
          type: array
      required:
      - email
      - roles
      type: object
    CreateUserResponse:
      properties:
        data:
          $ref: '#/components/schemas/User'
          description: User that was created.
      type: object
    CreateViewRequest:
      properties:
        description:
          description: Optional description.
          example: view of awesome collection
          type: string
        name:
          description: View name.
          example: myAwesomeView
          type: string
        query:
          description: SQL for this view.
          example: SELECT * FROM foo
          type: string
      required:
      - name
      - query
      type: object
    CreateViewResponse:
      properties:
        data:
          $ref: '#/components/schemas/View'
          description: View that was updated.
      type: object
    CreateVirtualInstanceRequest:
      properties:
        auto_suspend_seconds:
          description: Number of seconds without queries after which the VI is suspended
          example: 3600
          format: int32
          type: integer
        description:
          description: Description of requested virtual instance.
          example: VI serving prod traffic
          type: string
        enable_remount_on_resume:
          description: When a Virtual Instance is resumed, it will remount all collections
            that were mounted when the Virtual Instance was suspended.
          example: true
          type: boolean
        instance_class:
          description: Virtual Instance Class. Use `MO_IL` for Memory Optimized and
            `GP_IL` for General Purpose instance class.
          enum:
          - MO_IL
          - GP_IL
          example: MO_IL
          type: string
        mount_refresh_interval_seconds:
          description: DEPRECATED. Use `mount_type` instead. Number of seconds between
            data refreshes for mounts on this Virtual Instance. The only valid values
            are 0 and null. 0 means the data will be refreshed continuously and null
            means the data will never refresh.
          example: 0
          format: int32
          type: integer
        mount_type:
          description: The mount type of collections that this Virtual Instance will
            query. Live mounted collections stay up-to-date with the underlying collection
            in real-time. Static mounted collections do not stay up-to-date. See https://docs.rockset.com/documentation/docs/using-virtual-instances#virtual-instance-configuration
          enum:
          - LIVE
          - STATIC
          example: LIVE
          type: string
        name:
          description: Unique identifier for virtual instance, can contain alphanumeric
            or dash characters.
          example: prod_vi
          type: string
        type:
          description: Requested virtual instance type.
          enum:
          - FREE
          - NANO
          - SHARED
          - MILLI
          - XSMALL
          - SMALL
          - MEDIUM
          - LARGE
          - XLARGE
          - XLARGE2
          - XLARGE4
          - XLARGE8
          - XLARGE16
          example: LARGE
          type: string
      required:
      - name
      type: object
    CreateVirtualInstanceResponse:
      properties:
        data:
          $ref: '#/components/schemas/VirtualInstance'
          description: Virtual instance object.
      type: object
    CreateWorkspaceRequest:
      properties:
        description:
          description: Longer explanation for the workspace.
          example: Datasets of system logs for the ops team.
          type: string
        name:
          description: Descriptive label and unique identifier.
          example: event_logs
          type: string
      required:
      - name
      type: object
    CreateWorkspaceResponse:
      properties:
        data:
          $ref: '#/components/schemas/Workspace'
          description: The workspace that was created.
      type: object
    CsvParams:
      properties:
        columnNames:
          description: Names of columns.
          example: '["c1", "c2", "c3"]'
          items:
            type: string
          type: array
        columnTypes:
          description: Names of columns.
          example: '["BOOLEAN", "INTEGER", "FLOAT", "STRING"]'
          items:
            enum:
            - UNKNOWN
            - BOOLEAN
            - BOOL
            - INTEGER
            - INT
            - FLOAT
            - TIME
            - DATE
            - DATETIME
            - TIMESTAMP
            - STRING
            type: string
          type: array
        encoding:
          description: 'One of: UTF-8, ISO_8859_1, UTF-16.'
          example: UTF-8
          type: string
        escapeChar:
          description: escape character removes any special meaning from the following
            character,default is '\'
          example: \
          type: string
        firstLineAsColumnNames:
          description: If the first line in every object specifies the column names.
          example: true
          type: boolean
        quoteChar:
          description: character within which a cell value is enclosed,null character
            if no such character, default is '"'
          example: '"'
          type: string
        separator:
          description: A single character that is the column separator.
          example: ','
          type: string
      type: object
    DeleteAliasResponse:
      properties:
        data:
          $ref: '#/components/schemas/Alias'
          description: Alias that was deleted.
      type: object
    DeleteApiKeyResponse:
      properties:
        data:
          $ref: '#/components/schemas/ApiKey'
          description: The API key that was deleted.
      type: object
    DeleteCollectionResponse:
      properties:
        data:
          $ref: '#/components/schemas/Collection'
          description: Collection that was deleted.
      type: object
    DeleteDocumentsRequest:
      properties:
        data:
          description: Array of IDs of documents to be deleted.
          items:
            $ref: '#/components/schemas/DeleteDocumentsRequestData'
          type: array
      required:
      - data
      type: object
    DeleteDocumentsRequestData:
      properties:
        _id:
          description: Unique document ID.
          example: 2cd61e3b
          type: string
      required:
      - _id
      type: object
    DeleteDocumentsResponse:
      properties:
        data:
          description: Information about deleted documents.
          items:
            $ref: '#/components/schemas/DocumentStatus'
          type: array
        last_offset:
          description: A string representing the collection offset after completing
            the deletes.
          example: f1:0:0:0:0
          type: string
      type: object
    DeleteIntegrationResponse:
      properties:
        data:
          $ref: '#/components/schemas/Integration'
          description: Integration object that was deleted.
      type: object
    DeleteQueryLambdaResponse:
      properties:
        data:
          $ref: '#/components/schemas/QueryLambda'
          description: Query Lambda details.
      type: object
    DeleteSourceResponse:
      properties:
        data:
          $ref: '#/components/schemas/Source'
          description: source that was deleted
      type: object
    DeleteUserResponse:
      properties:
        data:
          $ref: '#/components/schemas/User'
          description: User object that was deleted.
      type: object
    DeleteViewResponse:
      properties:
        data:
          $ref: '#/components/schemas/View'
          description: View that was deleted.
      type: object
    DeleteVirtualInstanceResponse:
      properties:
        data:
          $ref: '#/components/schemas/VirtualInstance'
          description: Virtual instance that was deleted.
      type: object
    DeleteWorkspaceResponse:
      properties:
        data:
          $ref: '#/components/schemas/Workspace'
          description: The workspace that was deleted.
      type: object
    DeploymentSettings:
      properties:
        default_query_vi:
          description: RRN of the Virtual Instance that all queries will be routed
            to by default
          example: rrn:vi:use1a1:123e4567-e89b-12d3-a456-556642440000
          type: string
      type: object
    DeploymentSettingsResponse:
      properties:
        data:
          $ref: '#/components/schemas/DeploymentSettings'
          description: Deployment settings
      type: object
    DocumentStatus:
      properties:
        _collection:
          description: Collection name.
          example: customers
          type: string
        _id:
          description: Unique document ID.
          example: 2cd61e3b
          type: string
        error:
          $ref: '#/components/schemas/ErrorModel'
          description: Error message, if any.
        patch_id:
          description: Unique id used to represent each patch request.
          example: 486gsg8
          type: string
        status:
          description: Status of the document.
          enum:
          - ADDED
          - REPLACED
          - DELETED
          - PATCHED
          - ERROR
          example: ADDED
          type: string
      type: object
    DynamodbIntegration:
      properties:
        aws_access_key:
          $ref: '#/components/schemas/AwsAccessKey'
          description: Credentials for an AWS access key integration.
        aws_role:
          $ref: '#/components/schemas/AwsRole'
          description: Role used for external id type authentication.
        s3_export_bucket_name:
          description: S3 bucket used for export during collection initial dump.
          type: string
      type: object
    ErrorModel:
      description: Describes details about an error
      properties:
        column:
          description: Column where the error happened (if applicable).
          format: int32
          type: integer
        error_id:
          description: ID of the error.
          type: string
        line:
          description: Line where the error happened (if applicable).
          format: int32
          type: integer
        message:
          description: Descriptive message about the error.
          example: collection not found
          type: string
        query_id:
          description: ID of the query (if applicable).
          type: string
        trace_id:
          description: Internal trace ID to help with debugging.
          type: string
        type:
          description: Category of the error.
          enum:
          - AUTHEXCEPTION
          - VERSIONEXCEPTION
          - INTERNALERROR
          - INVALIDINPUT
          - NOTIMPLEMENTEDYET
          - RESOURCEEXCEEDED
          - ALREADYEXISTS
          - METHODNOTALLOWED
          - NOTACCEPTABLE
          - UNSUPPORTEDMEDIATYPE
          - NOTFOUND
          - DEPENDENTRESOURCES
          - QUERY_ERROR
          - NOT_READY
          - FORBIDDEN
          - QUERY_TIMEOUT
          - CONNECTION_ERROR
          - CONTENTTOOLARGE
          - CREATING
          - BADREQUEST
          - SERVICEUNAVAILABLE
          - CONFLICT
          - RATELIMITEXCEEDED
          - QUERY_CANCELLED
          - CLIENT_CONNECTION_ERROR
          example: INVALIDINPUT
          type: string
        virtual_instance_rrn:
          description: Virtual Instance RRN for the Virtual Instance that the query
            was run on (if applicable).
          example: rrn:vi:use1a1:123e4567-e89b-12d3-a456-556642440000
          type: string
      type: object
    EventTimeInfo:
      properties:
        field:
          description: Name of the field containing event time.
          example: timestamp
          type: string
        format:
          description: 'Format of time field, can be one of: milliseconds_since_epoch,
            seconds_since_epoch.'
          example: seconds_since_epoch
          type: string
        time_zone:
          description: Default time zone, in standard IANA format.
          example: UTC
          type: string
      required:
      - field
      type: object
    ExecutePublicQueryLambdaRequest:
      properties:
        default_row_limit:
          description: Row limit to use if no limit specified in the SQL query text.
          format: int32
          type: integer
        parameters:
          description: List of named parameters.
          items:
            $ref: '#/components/schemas/QueryParameter'
          type: array
      type: object
    ExecuteQueryLambdaRequest:
      properties:
        async:
          description: 'If true, the query will run asynchronously for up to 30 minutes.
            The query request will immediately return with a query id that can be
            used to retrieve the query status and results. If false or not specified,
            the query will return with results once completed or timeout after 2 minutes.
            (To return results directly for shorter queries while still allowing a
            timeout of up to 30 minutes, set `async_options.client_timeout_ms`.) '
          type: boolean
        async_options:
          $ref: '#/components/schemas/AsyncQueryOptions'
          description: Options for configuring Asynchronous Query Mode.
        debug_threshold_ms:
          description: If query execution takes longer than this value, debug information
            will be logged. If the query text includes the DEBUG hint and this parameter
            is also provided, only this value will be used and the DEBUG hint will
            be ignored.
          format: int64
          type: integer
        default_row_limit:
          description: Row limit to use if no limit specified in the SQL query text.
          format: int32
          type: integer
        initial_paginate_response_doc_count:
          description: '[DEPRECATED] Use `max_initial_results` instead. Number of
            documents to return in addition to paginating for this query call. Only
            relevant if `paginate` flag is also set.'
          format: int32
          type: integer
        max_initial_results:
          description: This limits the maximum number of results in the initial response.
            A pagination cursor is returned if the number of results exceeds `max_initial_results`.
            If `max_initial_results` is not set, all results will be returned in the
            initial response up to 4 million. If `max_initial_results` is set, the
            value must be between 0 and 100,000. If the query is async and `client_timeout_ms`
            is exceeded, `max_initial_results` does not apply since none of the results
            will be returned with the initial response.
          format: int64
          type: integer
        paginate:
          description: Flag to paginate and store the results of this query for later
            / sequential retrieval.
          type: boolean
        parameters:
          description: List of named parameters.
          items:
            $ref: '#/components/schemas/QueryParameter'
          type: array
        timeout_ms:
          description: If a query exceeds the specified timeout, the query will automatically
            stop and return an error. The query timeout defaults to a maximum of 2
            minutes. If `async` is true, the query timeout defaults to a maximum of
            30 minutes.
          format: int64
          type: integer
        virtual_instance_id:
          description: Virtual instance on which to run the query.
          type: string
      type: object
    ExecutionStatus:
      properties:
        message:
          description: Message describing the execution status.
          type: string
        state:
          description: The scheduled query lambda execution status
          enum:
          - WARNING
          - ERROR
          example: ERROR
          type: string
      type: object
    FieldMappingQuery:
      properties:
        sql:
          description: SELECT * EXCEPT (name), SHA256(name) AS name_anon FROM _input.
          example: sql
          type: string
      type: object
    FieldMappingV2:
      properties:
        input_fields:
          description: A List of InputField for this mapping.
          items:
            $ref: '#/components/schemas/InputField'
          type: array
        is_drop_all_fields:
          description: A boolean that determines whether to drop all fields in this
            document. If set, input and output fields should not be set
          example: true
          type: boolean
        name:
          description: A user specified string that is a name for this mapping.
          example: myTestMapping
          type: string
        output_field:
          $ref: '#/components/schemas/OutputField'
          description: An OutputField for this mapping.
      type: object
    FieldPartition:
      properties:
        field_name:
          description: The name of a field, parsed as a SQL qualified name.
          example: address.city.zipcode
          type: string
        keys:
          description: The values for partitioning of a field. Unneeded if the partition
            type is AUTO.
          example: '["value1", "value2"]'
          items:
            type: string
          type: array
        type:
          description: The type of partitions on a field.
          enum:
          - AUTO
          example: AUTO
          type: string
      type: object
    FormatParams:
      properties:
        avro:
          $ref: '#/components/schemas/AvroParams'
        bson:
          type: boolean
        csv:
          $ref: '#/components/schemas/CsvParams'
        json:
          description: Source data is in json format.
          example: true
          type: boolean
        mssql_dms:
          type: boolean
        mysql_dms:
          type: boolean
        oracle_dms:
          type: boolean
        postgres_dms:
          type: boolean
        xml:
          $ref: '#/components/schemas/XmlParams'
      type: object
    GcpServiceAccount:
      properties:
        service_account_key_file_json:
          description: Contents of JSON Service Account key file.
          type: string
      required:
      - service_account_key_file_json
      type: object
    GcsIntegration:
      properties:
        gcp_service_account:
          $ref: '#/components/schemas/GcpServiceAccount'
          description: Credentials for an GCP key integration.
      type: object
    GetAliasResponse:
      properties:
        data:
          $ref: '#/components/schemas/Alias'
          description: Alias that was requested.
      type: object
    GetApiKeyResponse:
      properties:
        data:
          $ref: '#/components/schemas/ApiKey'
          description: The requested API key object.
      type: object
    GetCollectionCommit:
      properties:
        data:
          $ref: '#/components/schemas/GetCollectionCommitData'
        offsets:
          $ref: '#/components/schemas/Offsets'
      type: object
    GetCollectionCommitData:
      properties:
        fence:
          description: The max offset passed in the request which is the latest offset
            that was compared to the commit.
          example: f1:0:14:9:7093
          type: string
        passed:
          description: True if all the data in the offsets are available to be queried.
            False if one or more of the offsets is still behind the request offsets.
          example: true
          type: boolean
      type: object
    GetCollectionCommitRequest:
      properties:
        name:
          description: a list of zero or more collection offset fences
          example: '["f1:0:14:9:7092","f1:0:14:9:7093"]'
          items:
            type: string
          type: array
      type: object
    GetCollectionResponse:
      properties:
        data:
          $ref: '#/components/schemas/Collection'
          description: Collection that was requested.
      type: object
    GetIntegrationResponse:
      properties:
        data:
          $ref: '#/components/schemas/Integration'
          description: Integration object.
      type: object
    GetQueryResponse:
      properties:
        data:
          $ref: '#/components/schemas/QueryInfo'
      type: object
    GetSourceResponse:
      properties:
        data:
          $ref: '#/components/schemas/Source'
          description: source config for source
      type: object
    GetViewResponse:
      properties:
        data:
          $ref: '#/components/schemas/View'
          description: View that was requested.
      type: object
    GetVirtualInstanceResponse:
      properties:
        data:
          $ref: '#/components/schemas/VirtualInstance'
          description: Virtual instance that was requested.
      type: object
    GetWorkspaceResponse:
      properties:
        data:
          $ref: '#/components/schemas/Workspace'
          description: The workspace that was requested.
      type: object
    InputField:
      properties:
        field_name:
          description: The name of a field, parsed as a SQL qualified name.
          example: address.city.zipcode
          type: string
        if_missing:
          description: Define the behaviour if fieldName is missing or is null.
          enum:
          - SKIP
          - PASS
          example: SKIP
          type: string
        is_drop:
          description: If true, then drop fieldName from the document.
          example: true
          type: boolean
        param:
          description: Sql parameter name.
          example: zip
          type: string
      type: object
    Integration:
      description: Integrations that can be associated with data sources to create
        collections. Only one type of integration may be specified.
      properties:
        azure_blob_storage:
          $ref: '#/components/schemas/AzureBlobStorageIntegration'
          description: Azure Blob Storage details.
        azure_event_hubs:
          $ref: '#/components/schemas/AzureEventHubsIntegration'
          description: Azure Event Hubs details.
        azure_service_bus:
          $ref: '#/components/schemas/AzureServiceBusIntegration'
          description: Azure Service Bus details.
        collections:
          description: List of collections that use the integration.
          items:
            $ref: '#/components/schemas/Collection'
          type: array
        created_at:
          description: ISO-8601 date.
          example: '2001-08-28T00:23:41Z'
          type: string
        created_by:
          description: Email of user who created the integration.
          example: hello@rockset.com
          type: string
        created_by_apikey_name:
          description: Name of the API key that was used to create this object if
            one was used.
          type: string
        description:
          description: Longer explanation for the integration.
          example: AWS account with event data for the data science team.
          type: string
        dynamodb:
          $ref: '#/components/schemas/DynamodbIntegration'
          description: Amazon DynamoDB details, must have one of aws_access_key or
            aws_role.
        gcs:
          $ref: '#/components/schemas/GcsIntegration'
          description: GCS details.
        is_write_enabled:
          description: is write access enabled for this integration
          type: boolean
        kafka:
          $ref: '#/components/schemas/KafkaIntegration'
          description: Kafka details.
        kinesis:
          $ref: '#/components/schemas/KinesisIntegration'
          description: Amazon Kinesis details, must have one of aws_access_key or
            aws_role.
        mongodb:
          $ref: '#/components/schemas/MongoDbIntegration'
          description: MongoDb details.
        name:
          description: Descriptive label and unique identifier.
          example: event-logs
          type: string
        owner_email:
          description: User that owns this integration.
          example: abc@rockset.com
          type: string
        s3:
          $ref: '#/components/schemas/S3Integration'
          description: Amazon S3 details, must have one of aws_access_key or aws_role.
        snowflake:
          $ref: '#/components/schemas/SnowflakeIntegration'
          description: Snowflake details.
      required:
      - created_by
      - name
      type: object
    KafkaIntegration:
      properties:
        aws_role:
          $ref: '#/components/schemas/AwsRole'
          description: Details of an AWS cross-account role integration.
        bootstrap_servers:
          description: The Kafka bootstrap server url(s). Required only for V3 integration.
          example: localhost:9092
          type: string
        connection_string:
          description: Kafka connection string.
          type: string
        kafka_data_format:
          description: The format of the Kafka topics being tailed.
          enum:
          - JSON
          - AVRO
          example: JSON
          type: string
        kafka_topic_names:
          description: Kafka topics to tail.
          items:
            type: string
          type: array
          uniqueItems: true
        schema_registry_config:
          $ref: '#/components/schemas/SchemaRegistryConfig'
          description: Kafka configurations for schema registry.
        security_config:
          $ref: '#/components/schemas/KafkaV3SecurityConfig'
          description: Kafka security configurations.
        source_status_by_topic:
          additionalProperties:
            $ref: '#/components/schemas/StatusKafka'
          description: The status of the Kafka source by topic.
          example: '{"topic-a": "DORMANT"}'
          readOnly: true
          type: object
        use_v3:
          type: boolean
      type: object
    KafkaV3SecurityConfig:
      properties:
        api_key:
          type: string
        secret:
          type: string
      type: object
    KinesisIntegration:
      properties:
        aws_access_key:
          $ref: '#/components/schemas/AwsAccessKey'
          description: Credentials for an AWS access key integration.
        aws_role:
          $ref: '#/components/schemas/AwsRole'
          description: Details of an AWS cross-account role integration.
      type: object
    ListAliasesResponse:
      properties:
        data:
          description: List of all aliases.
          items:
            $ref: '#/components/schemas/Alias'
          type: array
      type: object
    ListApiKeysResponse:
      properties:
        data:
          description: List of API key objects.
          items:
            $ref: '#/components/schemas/ApiKey'
          type: array
      type: object
    ListCollectionMountsResponse:
      properties:
        data:
          description: List of all collection mounts.
          items:
            $ref: '#/components/schemas/CollectionMount'
          type: array
      type: object
    ListCollectionsResponse:
      properties:
        data:
          description: List of all collections.
          items:
            $ref: '#/components/schemas/Collection'
          type: array
      type: object
    ListIntegrationsResponse:
      properties:
        data:
          description: List of integration objects.
          items:
            $ref: '#/components/schemas/Integration'
          type: array
      type: object
    ListQueriesResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/QueryInfo'
          type: array
      type: object
    ListQueryLambdaTagsResponse:
      properties:
        data:
          description: List of all tags associated with a Query Lambda.
          items:
            $ref: '#/components/schemas/QueryLambdaTag'
          type: array
      type: object
    ListQueryLambdaVersionsResponse:
      properties:
        data:
          description: List of all versions for a particular Query Lambda.
          items:
            $ref: '#/components/schemas/QueryLambdaVersion'
          type: array
      type: object
    ListQueryLambdasResponse:
      properties:
        data:
          description: List of all Query Lambdas.
          items:
            $ref: '#/components/schemas/QueryLambda'
          type: array
      type: object
    ListRolesResponse:
      properties:
        data:
          description: List of all roles.
          items:
            $ref: '#/components/schemas/Role'
          type: array
      type: object
    ListSourcesResponse:
      properties:
        data:
          description: List of all sources in a collection
          items:
            $ref: '#/components/schemas/Source'
          type: array
      type: object
    ListUnsubscribePreferencesResponse:
      properties:
        data:
          description: List of notification preferences.
          items:
            $ref: '#/components/schemas/UnsubscribePreference'
          type: array
      type: object
    ListUsersResponse:
      properties:
        data:
          description: List of users.
          items:
            $ref: '#/components/schemas/User'
          type: array
      type: object
    ListViewsResponse:
      properties:
        data:
          description: List of all views.
          items:
            $ref: '#/components/schemas/View'
          type: array
      type: object
    ListVirtualInstancesResponse:
      properties:
        data:
          description: List of all virtual instances.
          items:
            $ref: '#/components/schemas/VirtualInstance'
          type: array
      type: object
    ListWorkspacesResponse:
      properties:
        data:
          description: List of workspaces.
          items:
            $ref: '#/components/schemas/Workspace'
          type: array
      type: object
    MongoDbIntegration:
      properties:
        connection_uri:
          description: MongoDB connection URI string.
          example: mongodb+srv://<username>:<password>@server.example.com/
          type: string
        tls:
          $ref: '#/components/schemas/TLSConfig'
          description: TLS configuration for mongo connection
      required:
      - connection_uri
      type: object
    Offsets:
      properties:
        commit:
          description: An encoded value representing the most recent offsets that
            have been committed. If the fence offset is less than or equal to the
            commit, then passed is true.
          example: f1:0:14:9:7093
          type: string
      type: object
    Organization:
      description: An organization in Rockset is a container for users and collections.
      properties:
        clusters:
          description: List of clusters associated with this org.
          example: '[{ ... }]'
          items:
            $ref: '#/components/schemas/Cluster'
          type: array
        created_at:
          description: ISO-8601 date.
          example: '2001-08-28T00:23:41Z'
          type: string
        display_name:
          description: Name of the organization.
          example: Rockset, Inc
          type: string
        external_id:
          description: Organization's unique external ID within Rockset.
          example: <hash>
          type: string
        id:
          description: Unique identifier for the organization.
          example: rockset
          type: string
        rockset_user:
          description: Rockset's global AWS user.
          example: <id>
          type: string
        sso_connection:
          description: Connection name of SSO connection.
          example: rockset
          type: string
        sso_only:
          description: Whether or not SSO is the only permitted form of auth.
          example: true
          type: boolean
      type: object
    OrganizationResponse:
      properties:
        data:
          $ref: '#/components/schemas/Organization'
          description: Organization object.
      type: object
    OutputField:
      properties:
        field_name:
          description: The name of a field, parsed as a SQL qualified name.
          example: zip_hash
          type: string
        on_error:
          description: 'Error in Mapping execution: ''skip'' or ''fail''.'
          enum:
          - SKIP
          - FAIL
          example: SKIP
          type: string
        value:
          $ref: '#/components/schemas/SqlExpression'
          description: The name of a sql function.
          example: SHA256(:zip)
      type: object
    Pagination:
      properties:
        start_cursor:
          description: Use this cursor to fetch the first page of results for this
            query.
          example: vZNDIBi_E_cIwjo8ZbFl7XcxXxd4VfwjB7Q5CF6tplw0RqNgyG7q4sPuHUTBhYnrg
          type: string
      type: object
    PaginationInfo:
      properties:
        current_page_doc_count:
          description: Number of documents returned in this result set.
          example: 1000
          format: int64
          type: integer
        next_cursor:
          description: Cursor to use to get the list of documents.
          example: testnextcursor
          type: string
        next_cursor_offset:
          description: The doc offset that next_cursor starts at.
          example: 2000
          format: int64
          type: integer
        next_page_link:
          description: Direct link to the next page of results.
          example: https://api.rs2.usw2.rockset.com/....
          readOnly: true
          type: string
        start_cursor:
          description: Cursor used to retrieve the first set of documents.
          example: startcursor
          type: string
      type: object
    PatchDocument:
      properties:
        _id:
          description: Unique ID of the document to be patched.
          example: ca2d6832-1bfd-f88f-0620-d2aa27a5d86c
          type: string
        patch:
          description: List of patch operations.
          items:
            $ref: '#/components/schemas/PatchOperation'
          type: array
      required:
      - _id
      - patch
      type: object
    PatchDocumentsRequest:
      properties:
        data:
          description: List of patches to be applied.
          items:
            $ref: '#/components/schemas/PatchDocument'
          type: array
      required:
      - data
      type: object
    PatchDocumentsResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/DocumentStatus'
          type: array
        last_offset:
          description: A string representing the collection offset after completing
            the patch.
          example: f1:0:0:0:0
          type: string
      required:
      - data
      type: object
    PatchOperation:
      properties:
        from:
          description: '[JSON Pointer](https://datatracker.ietf.org/doc/html/rfc6901)
            referencing a location in the target document. Required for `COPY` and
            `MOVE` operations.'
          type: string
        op:
          description: '[JSON Patch operation](https://datatracker.ietf.org/doc/html/rfc6902#page-4)
            to be performed in this patch. Case insensitive.'
          enum:
          - ADD
          - REPLACE
          - REMOVE
          - COPY
          - MOVE
          - TEST
          - INCREMENT
          example: ADD
          type: string
        path:
          description: '[JSON Pointer](https://datatracker.ietf.org/doc/html/rfc6901)
            referencing a location in the target document where the operation is performed'
          example: /foo/bar
          type: string
        value:
          description: Value used in the patch operation. Required for `ADD`, `REPLACE`,
            `TEST`, and `INCREMENT` operations.
          example: baz
          type: object
      required:
      - op
      - path
      type: object
    Privilege:
      properties:
        action:
          description: The action allowed by this privilege.
          enum:
          - ALL_GLOBAL_ACTIONS
          - GET_ORG_GLOBAL
          - GET_CURRENT_USER_GLOBAL
          - INVITE_USER_GLOBAL
          - DELETE_USER_GLOBAL
          - LIST_USERS_GLOBAL
          - GET_BILLING_GLOBAL
          - UPDATE_BILLING_GLOBAL
          - UPDATE_SETTINGS_GLOBAL
          - GET_METRICS_GLOBAL
          - CREATE_VI_GLOBAL
          - UPDATE_VI_GLOBAL
          - LIST_VI_GLOBAL
          - CREATE_WS_GLOBAL
          - LIST_WS_GLOBAL
          - CREATE_INTEGRATION_GLOBAL
          - DELETE_INTEGRATION_GLOBAL
          - LIST_INTEGRATIONS_GLOBAL
          - EXPORT_DATA_GLOBAL
          - UPDATE_RESOURCE_OWNER_GLOBAL
          - CREATE_API_KEY_GLOBAL
          - CREATE_ROLE_GLOBAL
          - UPDATE_ROLE_GLOBAL
          - DELETE_ROLE_GLOBAL
          - LIST_ROLES_GLOBAL
          - GRANT_REVOKE_ROLE_GLOBAL
          - CREATE_QUERY_LOGS_COLLECTION_GLOBAL
          - CREATE_INGEST_LOGS_COLLECTION_GLOBAL
          - ALL_INTEGRATION_ACTIONS
          - CREATE_COLLECTION_INTEGRATION
          - ALL_WORKSPACE_ACTIONS
          - DELETE_WS
          - QUERY_DATA_WS
          - WRITE_DATA_WS
          - CREATE_COLLECTION_WS
          - DELETE_COLLECTION_WS
          - UPDATE_COLLECTION_WS
          - CREATE_ALIAS_WS
          - DELETE_ALIAS_WS
          - CREATE_SNAPSHOT_WS
          - LIST_RESOURCES_WS
          - CREATE_QUERY_LAMBDA_WS
          - DELETE_QUERY_LAMBDA_WS
          - EXECUTE_QUERY_LAMBDA_WS
          - CREATE_SCHEDULED_LAMBDA_WS
          - DELETE_SCHEDULED_LAMBDA_WS
          - CREATE_VIEW_WS
          - DELETE_VIEW_WS
          - ALL_VI_ACTIONS
          - QUERY_VI
          - UPDATE_VI
          - SUSPEND_RESUME_VI
          - DELETE_VI
          - CREATE_SIMILARITY_INDEX_WS
          - DELETE_SIMILARITY_INDEX_WS
          - CREATE_NETWORK_CONFIGURATION_GLOBAL
          - DELETE_NETWORK_CONFIGURATION_GLOBAL
          - LIST_NETWORK_CONFIGURATIONS_GLOBAL
          - UPDATE_DEPLOYMENT_DEFAULT_QUERY_VI
          example: CREATE_COLLECTION_WS
          type: string
        cluster:
          description: Cluster ID (`usw2a1` for us-west-2, `use1a1` for us-east-1,
            `euc1a1` for eu-central-1) for which the action is allowed. Defaults to
            '*All*' if not specified.
          example: '*ALL*'
          type: string
        resource_name:
          description: The resources on which the action is allowed. Defaults to '*All*'
            if not specified.
          example: commons
          type: string
      type: object
    QueryError:
      properties:
        message:
          description: A message associated with the error, containing more information
            about it.
          example: Too many rows
          type: string
        status_code:
          description: The HTTP status code associated with this error, had it been
            sent as the response status code
          example: 429
          format: int32
          type: integer
        type:
          description: The type of error.
          example: ResourceExceeded
          type: string
      type: object
    QueryFieldType:
      properties:
        name:
          description: Name of the field.
          example: _id
          type: string
        type:
          description: Data type of the field.
          example: string
          type: string
      required:
      - name
      - type
      type: object
    QueryInfo:
      properties:
        destination_uri:
          description: destination for query results. Only populated for Insert INTO
            s3 queries.
          type: string
        executed_by:
          description: User ID who executed the query.
          example: xyz@rockset.com
          type: string
        expires_at:
          description: Time (UTC) that query results expire. Only populated if `status`
            is `COMPLETE`.
          example: '2001-08-28T00:23:41Z'
          type: string
        last_offset:
          description: The log offset that query results were written to in the destination
            collection. Only populated for INSERT INTO queries.
          type: string
        pagination:
          $ref: '#/components/schemas/Pagination'
          description: Information for fetching query results pages. Only populated
            if `status` is `COMPLETE`.
        query_errors:
          description: Errors encountered while executing the query.
          items:
            $ref: '#/components/schemas/QueryError'
          type: array
        query_id:
          description: Unique Query ID.
          example: 5b596206-c632-4a08-8343-0c560f7ef7f1
          type: string
        sql:
          description: The SQL query for this request
          type: string
        stats:
          $ref: '#/components/schemas/Stats'
          description: Various stats about the query's execution.
        status:
          description: Status of the query.
          enum:
          - QUEUED
          - RUNNING
          - COMPLETED
          - ERROR
          - CANCELLED
          example: RUNNING
          type: string
        submitted_at:
          description: Time (UTC) the query request was first received and queued
            for execution.
          example: '2001-08-28T00:23:41Z'
          type: string
      type: object
    QueryLambda:
      properties:
        collections:
          description: Collections/aliases queried by underlying SQL query.
          items:
            type: string
          type: array
        last_updated:
          description: ISO-8601 date of when Query Lambda was last updated.
          example: '2001-08-28T00:23:41Z'
          type: string
        last_updated_by:
          description: User that created this Query Lambda.
          example: ..@rockset.com
          type: string
        latest_version:
          $ref: '#/components/schemas/QueryLambdaVersion'
          description: Query Lambda version details for most recently created version.
        name:
          description: Query Lambda name.
          example: myQuery
          type: string
        version_count:
          description: Number of Query Lambda versions.
          example: 1
          format: int32
          type: integer
        workspace:
          description: Workspace of this Query Lambda.
          example: commons
          type: string
      type: object
    QueryLambdaSql:
      properties:
        default_parameters:
          description: Default parameters for this Query Lambda.
          items:
            $ref: '#/components/schemas/QueryParameter'
          type: array
        query:
          description: SQL text.
          example: SELECT 'Foo'
          type: string
      required:
      - query
      type: object
    QueryLambdaStats:
      properties:
        last_executed:
          description: ISO-8601 date.
          example: '2001-08-28T00:23:41Z'
          type: string
        last_executed_by:
          description: User who last executed Query Lambda.
          example: '...@rockset.com'
          type: string
        last_execution_error:
          description: ISO-8601 date of last execution failure.
          example: '2001-08-28T00:23:41Z'
          type: string
        last_execution_error_message:
          description: Error message associated with last failed execution.
          example: '[error message]'
          type: string
      type: object
    QueryLambdaTag:
      properties:
        tag_name:
          description: Name of Query Lambda tag.
          example: production
          type: string
        version:
          $ref: '#/components/schemas/QueryLambdaVersion'
          description: Query lambda version.
          example: b1d7c9a34b50cd
      type: object
    QueryLambdaTagResponse:
      properties:
        data:
          $ref: '#/components/schemas/QueryLambdaTag'
          description: Updated Query Lambda tag.
      type: object
    QueryLambdaVersion:
      properties:
        collections:
          description: Collections queried by underlying SQL query.
          items:
            type: string
          type: array
        created_at:
          description: ISO-8601 date of when Query Lambda was created.
          example: '2001-08-28T00:23:41Z'
          type: string
        created_by:
          description: User that created this Query Lambda.
          example: ..@rockset.com
          type: string
        created_by_apikey_name:
          description: Name of the API key that was used to create this object if
            one was used.
          type: string
        description:
          description: Optional description.
          example: production version foo
          type: string
        name:
          description: Query Lambda name.
          example: myQuery
          type: string
        public_access_id:
          description: Public access ID associated with this QL version
          type: string
        sql:
          $ref: '#/components/schemas/QueryLambdaSql'
          description: Query Lambda SQL query.
        state:
          description: Status of this Query Lambda.
          enum:
          - ACTIVE
          - INVALID_SQL
          example: ACTIVE
          type: string
        stats:
          $ref: '#/components/schemas/QueryLambdaStats'
          description: Stats related to this Query Lambda.
        version:
          description: Query Lambda version.
          example: acb99feg92bcaf
          type: string
        workspace:
          description: Workspace of this Query Lambda.
          example: commons
          type: string
      type: object
    QueryLambdaVersionResponse:
      properties:
        data:
          $ref: '#/components/schemas/QueryLambdaVersion'
          description: Query Lambda version details.
      type: object
    QueryPaginationResponse:
      properties:
        pagination:
          $ref: '#/components/schemas/PaginationInfo'
          description: Pagination metadata.
        results:
          description: List of documents returned by the query.
          items:
            type: object
          type: array
        results_total_doc_count:
          description: Total documents returned by the query.
          format: int64
          type: integer
      type: object
    QueryParameter:
      properties:
        name:
          description: Name of the field.
          example: _id
          type: string
        type:
          description: Deprecated. Data type of the field.
          example: string
          type: string
        value:
          description: Literal value of the field.
          example: 85beb391
          type: string
      required:
      - name
      - type
      - value
      type: object
    QueryRequest:
      properties:
        async:
          description: 'If true, the query will run asynchronously for up to 30 minutes.
            The query request will immediately return with a query id that can be
            used to retrieve the query status and results. If false or not specified,
            the query will return with results once completed or timeout after 2 minutes.
            (To return results directly for shorter queries while still allowing a
            timeout of up to 30 minutes, set `async_options.client_timeout_ms`.) '
          type: boolean
        async_options:
          $ref: '#/components/schemas/AsyncQueryOptions'
          description: Options for configuring Asynchronous Query Mode.
        debug_threshold_ms:
          description: If query execution takes longer than this value, debug information
            will be logged. If the query text includes the DEBUG hint and this parameter
            is also provided, only this value will be used and the DEBUG hint will
            be ignored.
          format: int64
          type: integer
        max_initial_results:
          description: This limits the maximum number of results in the initial response.
            A pagination cursor is returned if the number of results exceeds `max_initial_results`.
            If `max_initial_results` is not set, all results will be returned in the
            initial response up to 4 million. If `max_initial_results` is set, the
            value must be between 0 and 100,000. If the query is async and `client_timeout_ms`
            is exceeded, `max_initial_results` does not apply since none of the results
            will be returned with the initial response.
          format: int64
          type: integer
        sql:
          $ref: '#/components/schemas/QueryRequestSql'
          description: Main query request body.
        timeout_ms:
          description: If a query exceeds the specified timeout, the query will automatically
            stop and return an error. The query timeout defaults to a maximum of 2
            minutes. If `async` is true, the query timeout defaults to a maximum of
            30 minutes.
          format: int64
          type: integer
      required:
      - sql
      type: object
    QueryRequestSql:
      properties:
        default_row_limit:
          description: Row limit to use. Limits specified in the query text will override
            this default.
          format: int32
          type: integer
        initial_paginate_response_doc_count:
          description: '[DEPRECATED] Use `max_initial_results` instead. Number of
            documents to return in addition to paginating for this query call. Only
            relevant if `paginate` flag is also set.'
          format: int32
          type: integer
        parameters:
          description: List of named parameters.
          items:
            $ref: '#/components/schemas/QueryParameter'
          type: array
        query:
          description: SQL query string.
          example: SELECT * FROM foo where _id = :_id
          type: string
      required:
      - query
      type: object
    QueryResponse:
      properties:
        collections:
          description: List of collections referenced in the query.
          items:
            type: string
          type: array
        column_fields:
          description: Meta information about each column in the result set. Not populated
            in `SELECT *` queries.
          items:
            $ref: '#/components/schemas/QueryFieldType'
          type: array
        last_offset:
          description: If this was a write query, this is the log offset the query
            was written to.
          type: string
        pagination:
          $ref: '#/components/schemas/PaginationInfo'
          description: Pagination information. Only populated if `paginate` is specified
            in the query request.
        query_errors:
          description: Errors encountered while executing the query.
          items:
            $ref: '#/components/schemas/QueryError'
          type: array
        query_id:
          description: Unique ID for this query.
          type: string
        query_lambda_path:
          description: The full path of the executed query lambda. Includes version
            information.
          type: string
        results:
          description: Results from the query.
          items:
            type: object
          type: array
        results_total_doc_count:
          description: Number of results generated by the query.
          format: int64
          type: integer
        stats:
          $ref: '#/components/schemas/QueryResponseStats'
          description: Meta information about the query including execution latencies.
        status:
          description: 'Status of query execution. Possible values: `QUEUED`, `RUNNING`,
            `COMPLETED`, `ERROR`.'
          enum:
          - QUEUED
          - RUNNING
          - COMPLETED
          - ERROR
          example: RUNNING
          type: string
        warnings:
          items:
            type: string
          type: array
      type: object
    QueryResponseStats:
      properties:
        elapsed_time_ms:
          description: Query time in milliseconds.
          example: 126
          format: int64
          type: integer
        throttled_time_micros:
          description: Time query was throttled by admission control.
          example: 126
          format: int64
          type: integer
      type: object
    ResumeVirtualInstanceResponse:
      properties:
        data:
          $ref: '#/components/schemas/VirtualInstance'
          description: Virtual instance that was resumed.
      type: object
    Role:
      properties:
        created_at:
          description: ISO-8601 date of when the role was created.
          example: '2001-08-28T00:23:41Z'
          type: string
        created_by:
          description: Email of the user who created the role.
          example: hello@rockset.com
          type: string
        description:
          description: Description for the role.
          example: Role with read and write privileges to all collections.
          type: string
        owner_email:
          description: Email of the user who currently owns the role.
          example: hello@rockset.com
          type: string
        privileges:
          description: List of privileges associated with the role.
          items:
            $ref: '#/components/schemas/Privilege'
          type: array
        role_name:
          description: Unique identifier for the role.
          example: read_write
          type: string
      type: object
    RoleResponse:
      properties:
        data:
          $ref: '#/components/schemas/Role'
      type: object
    S3Integration:
      properties:
        aws_access_key:
          $ref: '#/components/schemas/AwsAccessKey'
          description: Credentials for an AWS access key integration.
        aws_role:
          $ref: '#/components/schemas/AwsRole'
          description: Details of an AWS cross-account role integration.
      type: object
    ScheduledLambda:
      properties:
        cron_string:
          description: The UNIX-formatted cron string for this scheduled query lambda.
          example: '* * * * *'
          type: string
        execution_count:
          description: The number of times this scheduled QL has been executed.
          example: 5
          format: int64
          type: integer
        last_completion_date:
          description: The last time this scheduled query lambda completed successfully.
          example: '2001-08-28T00:23:41Z'
          type: string
        last_query_id:
          description: The ID of the query that was triggered by this scheduled lambda's
            last run.
          example: salkdjfsd-1jakdsjfksaj
          type: string
        next_execution_date:
          description: The next time this scheduled query lambda will be executed.
          example: '2001-08-28T00:23:41Z'
          type: string
        ql_name:
          description: The name of the associated query lambda.
          example: example_ql
          type: string
        query_execution_status:
          $ref: '#/components/schemas/ExecutionStatus'
          description: Query execution status of the scheduled lambda. This field
            will only be populated when the query execution encounters a warning or
            error state.
        resume_permanent_error:
          description: Boolean flag to allow a scheduled query lambda to resume execution
            after being suspended due to execution failure. This flag will be unset
            after scheduled lambda execution.
          type: boolean
        rrn:
          description: Scheduled Lambda mapping RRN.
          example: rrn:sl:use1a1:123e4567-e89b-12d3-a456-556642440000
          type: string
        tag:
          description: The query lambda tag.
          example: production
          type: string
        total_times_to_execute:
          description: The number of times to execute this scheduled query lambda.
            Once this scheduled query lambda has been executed this many times, it
            will no longer be executed.
          example: 5
          format: int64
          type: integer
        version:
          description: The version of the associated query lambda.
          example: abcde1234
          type: string
        webhook_execution_status:
          $ref: '#/components/schemas/ExecutionStatus'
          description: Webhook execution status of the scheduled lambda. This field
            will only be populated when the webhook execution encounters a warning
            or error state.
        webhook_payload:
          description: The payload that should be sent to the webhook.
          example: '{"text": "A scheduled query lambda completed execution. Query
            ID: {{QUERY_ID}}, Initial results: {{QUERY_RESULTS}}"'
          type: string
        webhook_url:
          description: The URL of the webhook that should be triggered after this
            scheduled query lambda completes.
          example: https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX
          type: string
        workspace:
          description: Workspace of the associated query lambda.
          example: commons
          type: string
      type: object
    ScheduledLambdaResponse:
      properties:
        data:
          $ref: '#/components/schemas/ScheduledLambda'
          description: Scheduled lambda mapping
      type: object
    SchemaRegistryConfig:
      properties:
        key:
          description: The secure API key for schema registry.
          type: string
        secret:
          description: The secure API password registry.
          type: string
        url:
          description: Schema registry URL.
          type: string
      type: object
    SnowflakeIntegration:
      properties:
        aws_access_key:
          $ref: '#/components/schemas/AwsAccessKey'
          description: Credentials for an AWS access key integration.
        aws_role:
          $ref: '#/components/schemas/AwsRole'
          description: Details of an AWS cross-account role integration.
        default_warehouse:
          description: default snowflake data warehouse name for query execution.
            Warehouse name can be overridden in the collection.
          type: string
        password:
          description: Snowflake database password.
          type: string
        s3_export_path:
          description: S3 path used for running 'COPY INTO' command on snowflake table.
          example: s3://bucket/prefix
          type: string
        snowflake_url:
          description: Snowflake browser url.
          example: acme-marketing-test-account.snowflakecomputing.com
          type: string
        user_role:
          description: Snowflake user role. If unspecified, will use the default user
            role.
          type: string
        username:
          description: Snowflake database username.
          type: string
      required:
      - default_warehouse
      - password
      - s3_export_path
      - snowflake_url
      - username
      type: object
    Source:
      description: 'Details about the data source for the given collection. Only one
        of the following fields are allowed to be defined. Only collections can act
        as data sources for views. '
      properties:
        azure_blob_storage:
          $ref: '#/components/schemas/SourceAzureBlobStorage'
          description: Configuration for ingestion from Azure Blob Storage.
        azure_event_hubs:
          $ref: '#/components/schemas/SourceAzureEventHubs'
          description: Configuration for ingestion from Azure Event Hubs.
        azure_service_bus:
          $ref: '#/components/schemas/SourceAzureServiceBus'
        dynamodb:
          $ref: '#/components/schemas/SourceDynamoDb'
          description: Configuration for ingestion from  a dynamodb table.
        file_upload:
          $ref: '#/components/schemas/SourceFileUpload'
          description: File upload details.
          readOnly: true
        format_params:
          $ref: '#/components/schemas/FormatParams'
          description: Format parameters for data from this source.
        gcs:
          $ref: '#/components/schemas/SourceGcs'
          description: Configuration for ingestion from GCS.
        id:
          description: Unique source identifier.
          example: a1df483c-734e-485b-8005-f46386ef42f6
          readOnly: true
          type: string
        ingest_transformation:
          $ref: '#/components/schemas/FieldMappingQuery'
          description: Ingest transformation for a source.
        integration_name:
          description: Name of integration to use.
          example: aws-integration
          type: string
        kafka:
          $ref: '#/components/schemas/SourceKafka'
          description: Kafka collection identifier.
        kinesis:
          $ref: '#/components/schemas/SourceKinesis'
          description: Configuration for ingestion from kinesis stream.
        mongodb:
          $ref: '#/components/schemas/SourceMongoDb'
          description: MongoDB collection details.
        resume_at:
          description: ISO-8601 date when source would be auto resumed, if suspended
          example: '2019-01-15T21:48:23Z'
          readOnly: true
          type: string
        s3:
          $ref: '#/components/schemas/SourceS3'
          description: Configuration for ingestion from S3.
        snapshot:
          $ref: '#/components/schemas/SourceSnapshot'
          description: Configuration for restoring from snapshot.
        snowflake:
          $ref: '#/components/schemas/SourceSnowflake'
          description: Configuration for ingestion from Snowflake.
        status:
          $ref: '#/components/schemas/Status'
          description: The ingest status of this source.
          readOnly: true
        suspended_at:
          description: ISO-8601 date when source was suspended, if suspended
          example: '2019-01-15T21:48:23Z'
          readOnly: true
          type: string
        system:
          $ref: '#/components/schemas/SourceSystem'
        write_api:
          $ref: '#/components/schemas/SourceWriteApi'
      type: object
    SourceAzBlobStorageBase:
      properties:
        settings:
          $ref: '#/components/schemas/SourceAzBlobStorageSettings'
          description: custom settings for Azure blob Storage source
      type: object
    SourceAzBlobStorageSettings:
      properties:
        azblob_scan_frequency:
          description: 'Rockset scans an Azure blob Storage container based on a defined
            time interval. The scan frequency determines the length of time between
            a new scan and the previous scan. If the previous scan finds new objects
            or updates to existing objects, Rockset immediately scans the bucket again
            after processing changes from the previous scan. Duration value is of
            type ISO 8601 (e.g. PT5H, PT4M, PT3S). It doesn''t account for DST, leap
            seconds and leap years. Minimum value: PT1S. Maximum value: PT1H.'
          example: PT5M
          type: string
      type: object
    SourceAzureBlobStorage:
      properties:
        blob_bytes_total:
          format: int64
          readOnly: true
          type: integer
        blob_count_downloaded:
          format: int64
          readOnly: true
          type: integer
        blob_count_total:
          format: int64
          readOnly: true
          type: integer
        container:
          description: Name of Azure blob Storage container you want to ingest from.
          example: server-logs
          type: string
        pattern:
          description: Glob-style pattern that selects keys to ingest. Only either
            prefix or pattern can be specified.
          example: prefix/to/**/keys/*.format
          type: string
        prefix:
          description: Prefix that selects blobs to ingest.
          example: prefix/to/blobs
          type: string
        settings:
          $ref: '#/components/schemas/SourceAzBlobStorageSettings'
          description: custom settings for Azure blob Storage source
      type: object
    SourceAzureEventHubs:
      properties:
        hub_id:
          description: Name of the hub which rockset should ingest from.
          example: event-hub-1
          type: string
        offset_reset_policy:
          description: The offset reset policy.
          enum:
          - LATEST
          - EARLIEST
          example: EARLIEST
          type: string
        status:
          $ref: '#/components/schemas/StatusAzureEventHubs'
          description: Source status.
          readOnly: true
      type: object
    SourceAzureServiceBus:
      properties:
        status:
          $ref: '#/components/schemas/StatusAzureServiceBus'
          description: Azure Service bus source status.
          readOnly: true
        subscription:
          description: The subscription to read from the topic.
          example: rockset-subscription
          type: string
        topic:
          description: Name of the topic which rockset should ingest from.
          example: rockset-topic
          type: string
      type: object
    SourceBase:
      properties:
        azure_blob_storage:
          $ref: '#/components/schemas/SourceAzBlobStorageBase'
          description: Configuration for ingestion from Azure Blob Storage.
        dynamodb:
          $ref: '#/components/schemas/SourceDynamoDbBase'
          description: Configuration for ingestion from a DynamoDb table.
        gcs:
          $ref: '#/components/schemas/SourceGcsBase'
          description: Configuration for ingestion from GCS.
        s3:
          $ref: '#/components/schemas/SourceS3Base'
          description: Configuration for ingestion from S3.
      type: object
    SourceDynamoDb:
      properties:
        aws_region:
          description: AWS region name of DynamoDB table, by default us-west-2 is
            used.
          example: us-east-2
          type: string
        current_status:
          $ref: '#/components/schemas/StatusDynamoDbV2'
          description: DynamoDB source status v2.
          readOnly: true
        rcu:
          description: Max RCU usage for scan.
          example: 1000
          format: int64
          type: integer
        settings:
          $ref: '#/components/schemas/SourceDynamoDbSettings'
          description: custom settings for Amazon DynamoDB source
        status:
          $ref: '#/components/schemas/StatusDynamoDb'
          description: DynamoDB source status.
          readOnly: true
        table_name:
          description: Name of DynamoDB table containing data.
          example: dynamodb_table_name
          type: string
        use_scan_api:
          description: Whether to use DynamoDB Scan API for the initial scan.
          type: boolean
      required:
      - table_name
      type: object
    SourceDynamoDbBase:
      properties:
        settings:
          $ref: '#/components/schemas/SourceDynamoDbSettings'
          description: custom settings for Amazon DynamoDB source
      type: object
    SourceDynamoDbSettings:
      properties:
        dynamodb_stream_poll_frequency:
          description: 'Each DynamoDB stream can have one to many shards, and Rockset
            polls each DynamoDB shard at a fixed rate. Decreasing the duration between
            polls helps reduce ingest latency, while increasing the duration can prevent  Rockset
            from keeping up with the updates. If the latency exceeds 24 hours (DynamoDB
            stream retention duration), Rockset will not be able to process all of
            the streaming updates. Each request also has a fixed price associated
            with it. Duration value is of type ISO 8601 (e.g. PT5H, PT4M, PT3S). It
            doesn''t account for DST, leap seconds and leap years. Minimum value:
            PT0.25S. Maximum value: PT5M.'
          example: PT1S
          type: string
      type: object
    SourceFileUpload:
      properties:
        file_name:
          description: Name of the file.
          example: file1.json
          type: string
        file_size:
          description: Size of the file in bytes.
          example: 12345
          format: int64
          type: integer
        file_upload_time:
          description: Time of file upload.
          example: '2019-01-15T21:48:23Z'
          type: string
      required:
      - file_name
      - file_size
      - file_upload_time
      type: object
    SourceGcs:
      properties:
        bucket:
          description: Name of GCS bucket you want to ingest from.
          example: server-logs
          type: string
        object_bytes_downloaded:
          format: int64
          readOnly: true
          type: integer
        object_bytes_total:
          format: int64
          readOnly: true
          type: integer
        object_count_downloaded:
          format: int64
          readOnly: true
          type: integer
        object_count_total:
          format: int64
          readOnly: true
          type: integer
        pattern:
          description: Glob-style pattern that selects keys to ingest. Only either
            prefix or pattern can be specified.
          example: prefix/to/**/keys/*.format
          type: string
        prefix:
          description: Prefix that selects keys to ingest.
          example: prefix/to/keys
          type: string
        settings:
          $ref: '#/components/schemas/SourceGcsSettings'
          description: custom settings for Google cloud Storage source
      type: object
    SourceGcsBase:
      properties:
        settings:
          $ref: '#/components/schemas/SourceGcsSettings'
          description: custom settings for Google cloud Storage source
      type: object
    SourceGcsSettings:
      properties:
        gcs_scan_frequency:
          description: 'Rockset scans a GCS bucket based on a defined time interval.
            The scan frequency determines the length of time between a new scan and
            the previous scan. If the previous scan finds new objects or updates to
            existing objects, Rockset immediately scans the bucket again after processing
            changes from the previous scan. Duration value is of type ISO 8601 (e.g.
            PT5H, PT4M, PT3S). It doesn''t account for DST, leap seconds and leap
            years. Minimum value: PT1S. Maximum value: PT1H.'
          example: PT5M
          type: string
      type: object
    SourceKafka:
      properties:
        client_id:
          description: The kafka client id being used.
          example: cwc|0013a00001hSJ7oAAG|rockset-colln-consumer
          type: string
        consumer_group_id:
          description: The Kafka consumer group Id being used.
          example: org-collection
          type: string
        kafka_topic_name:
          description: The Kafka topic to be tailed.
          example: example-topic
          type: string
        offset_reset_policy:
          description: The offset reset policy.
          enum:
          - LATEST
          - EARLIEST
          example: EARLIEST
          type: string
        status:
          $ref: '#/components/schemas/StatusKafka'
          description: Kafka source status.
          readOnly: true
        use_v3:
          description: Whether to use v3 integration.
          type: boolean
      type: object
    SourceKinesis:
      properties:
        aws_region:
          description: AWS region name of Kinesis stream, by default us-west-2 is
            used.
          example: us-east-2
          type: string
        dms_primary_key:
          description: Set of fields that correspond to a DMS primary key.
          items:
            type: string
          type: array
        offset_reset_policy:
          description: For non-DMS streams, Rockset can tail from the earliest end
            or latest end of kinesis source.
          enum:
          - LATEST
          - EARLIEST
          example: EARLIEST
          type: string
        stream_name:
          description: Name of kinesis stream.
          example: click_stream
          type: string
      required:
      - stream_name
      type: object
    SourceMongoDb:
      properties:
        collection_name:
          description: MongoDB collection name.
          example: my_collection
          type: string
        database_name:
          description: MongoDB database name containing this collection.
          example: my_database
          type: string
        retrieve_full_document:
          description: Whether to get the full document from the MongoDB change stream
            to enable multi-field expression transformations. Selecting this option
            will increase load on your upstream MongoDB database.
          type: boolean
        status:
          $ref: '#/components/schemas/StatusMongoDb'
          description: MongoDB source status.
          readOnly: true
      required:
      - collection_name
      - database_name
      type: object
    SourceS3:
      properties:
        bucket:
          description: Address of S3 bucket containing data.
          example: s3://customer-account-info
          type: string
        object_bytes_downloaded:
          format: int64
          readOnly: true
          type: integer
        object_bytes_total:
          format: int64
          readOnly: true
          type: integer
        object_count_downloaded:
          format: int64
          readOnly: true
          type: integer
        object_count_total:
          format: int64
          readOnly: true
          type: integer
        pattern:
          description: Glob-style pattern that selects keys to ingest. Only either
            prefix or pattern can be specified.
          example: prefix/to/**/keys/*.format
          type: string
        prefix:
          description: Prefix that selects keys to ingest.
          example: prefix/to/keys
          type: string
        prefixes:
          description: Deprecated in favor of `prefix`. List of prefixes to paths
            from which data should be ingested.
          example: '["/transactions", "/stores"]'
          items:
            type: string
          readOnly: true
          type: array
        region:
          description: AWS region containing source bucket.
          example: us-west-2
          type: string
        settings:
          $ref: '#/components/schemas/SourceS3Settings'
          description: custom settings for Amazon S3 source
      required:
      - bucket
      type: object
    SourceS3Base:
      properties:
        settings:
          $ref: '#/components/schemas/SourceS3Settings'
          description: custom settings for Amazon S3 source
      type: object
    SourceS3Settings:
      properties:
        s3_scan_frequency:
          description: 'Rockset scans an S3 bucket based on a defined time interval.
            The scan frequency determines the length of time between a new scan and
            the previous scan. If the previous scan finds new objects or updates to
            existing objects, Rockset immediately scans the bucket again after processing
            changes from the previous scan. Duration value is of type ISO 8601 (e.g.
            PT5H, PT4M, PT3S). It doesn''t account for DST, leap seconds and leap
            years. Minimum value: PT1S. Maximum value: PT1H.'
          example: PT5M
          type: string
      type: object
    SourceSnapshot:
      properties:
        source_collection_path:
          description: A representation of the workspace and collection where the
            source snapshot originated.
          example: myWorkspace.myCollection
          type: string
        source_snapshot_rrn:
          description: RRN of the snapshot that the new collection will be created
            from.
          example: rrn:snap:use1a1:123e4567-e89b-12d3-a456-556642440000
          type: string
      type: object
    SourceSnowflake:
      properties:
        database:
          description: Name of the snowflake database.
          example: NASDAQ
          type: string
        schema:
          description: Name of the snowflake database schema.
          example: PUBLIC
          type: string
        status:
          $ref: '#/components/schemas/StatusSnowflake'
          description: Snowflake source status.
          readOnly: true
        table_name:
          description: Name of the snowflake table.
          example: COMPANIES
          type: string
        warehouse:
          description: Name of the data warehouse to be used.
          example: COMPUTE_XL
          type: string
      required:
      - database
      - schema
      - table_name
      type: object
    SourceSystem:
      properties:
        type:
          description: The type of this system source.
          enum:
          - QUERY_LOGS
          - INGEST_LOGS
          example: QUERY_LOGS
          type: string
        workspace:
          description: The workspace for which collections will have logs created.
            If unspecified, logs will be created for collections in all workspaces.
            Currently only supported for the INGEST_LOGS system source.
          example: commons
          type: string
      type: object
    SourceWriteApi:
      type: object
    SqlExpression:
      properties:
        sql:
          description: The name of a sql function.
          example: SHA256()
          type: string
      type: object
    Stats:
      properties:
        elapsed_time_ms:
          description: Total execution time (including time queued) of the query,
            in milliseconds.
          example: 128
          format: int64
          type: integer
        result_set_bytes_size:
          description: Number of bytes in the query result set. Only populated if
            `status` is `COMPLETE`. Not populated for INSERT INTO queries.
          example: 1235
          format: int64
          type: integer
        result_set_document_count:
          description: Number of documents returned by the query. Only populated if
            `status` is `COMPLETE`.
          example: 1235
          format: int64
          type: integer
        result_set_file_count:
          description: Number of files written by by the query. Only populated if
            `status` is `COMPLETE` and the query is an export query.
          example: 1235
          format: int64
          type: integer
        throttled_time_ms:
          description: Time query spent queued, in milliseconds.
          example: 16
          format: int64
          type: integer
      type: object
    Status:
      properties:
        detected_size_bytes:
          description: Size in bytes detected for the source at collection initialization.
            This size can be 0 or null for event stream sources.
          format: int64
          type: integer
        last_processed_at:
          description: ISO-8601 date when source was last processed.
          example: '2019-01-15T21:48:23Z'
          type: string
        last_processed_item:
          description: Last source item processed by ingester.
          example: /path/to/some/object
          type: string
        message:
          description: State message.
          example: error 403 forbidden
          type: string
        state:
          description: Status of the Source's ingestion.
          enum:
          - INITIALIZING
          - WATCHING
          - PROCESSING
          - COMPLETED
          - ERROR
          - SUSPENDED
          example: INITIALIZING
          type: string
        total_processed_items:
          description: Total items processed of source.
          example: 32849023
          format: int64
          type: integer
      type: object
    StatusAzureEventHubs:
      properties:
        last_consumed_time:
          description: Time at which the last document was consumed.
          example: '2001-08-28T00:23:41Z'
          type: string
        num_documents_processed:
          description: Number of documents consumed.
          example: 1337
          format: int64
          type: integer
        partitions:
          description: Status info per partition.
          items:
            $ref: '#/components/schemas/StatusAzureEventHubsPartition'
          type: array
        state:
          description: State of the source.
          enum:
          - NO_DOCS_YET
          - ACTIVE
          - DORMANT
          example: ACTIVE
          type: string
      type: object
    StatusAzureEventHubsPartition:
      properties:
        offset_lag:
          description: Per partition lag for offset.
          example: 10
          format: int64
          type: integer
        partition_number:
          description: The number of this partition.
          example: 123
          format: int32
          type: integer
        partition_offset:
          description: Latest offset of partition.
          example: 100
          format: int64
          type: integer
      type: object
    StatusAzureServiceBus:
      properties:
        first_processed_at:
          description: Service Bus first message processed time in ISO-8601 format.
          example: '2021-08-28T00:23:41Z'
          type: string
        records_processed:
          description: Number of records processed.
          example: 1000
          format: int64
          type: integer
        sessions:
          additionalProperties:
            $ref: '#/components/schemas/StatusAzureServiceBusSession'
          description: Sessions processed.
          type: object
      type: object
    StatusAzureServiceBusSession:
      properties:
        last_processed:
          description: Most recent ISO-8601 date when a message from this session
            was processed.
          example: '2022-08-23T00:13:41Z'
          type: string
        sequence_number:
          description: The last processed sequence number within this session.
          example: 323862
          format: int64
          type: integer
      type: object
    StatusDynamoDb:
      properties:
        scan_end_time:
          description: DynamoDb scan end time.
          example: '2001-08-28T00:23:41Z'
          type: string
        scan_records_processed:
          description: Number of records inserted using scan.
          example: 1000
          format: int64
          type: integer
        scan_start_time:
          description: DynamoDB scan start time.
          example: '2001-08-28T00:23:41Z'
          type: string
        scan_total_records:
          description: Number of records in DynamoDB table at time of scan.
          example: 2000
          format: int64
          type: integer
        state:
          description: State of current ingest for this table.
          enum:
          - INITIALIZING
          - SCANNING_TABLE
          - PROCESSING_STREAM
          example: SCANNING_TABLE
          type: string
        stream_last_processed_at:
          description: ISO-8601 date when source was last processed.
          example: '2019-01-15T21:48:23Z'
          type: string
      type: object
    StatusDynamoDbV2:
      properties:
        initial_dump_completion_percentage:
          example: 0.73
          format: double
          type: number
        state:
          description: State of current ingest for this table.
          enum:
          - INITIALIZING
          - SCANNING
          - EXPORTING_TO_S3
          - DOWNLOADING_FROM_S3
          - PROCESSING_STREAM
          example: PROCESSING_STREAM
          type: string
        stream_last_processed_at:
          description: ISO-8601 date when source was last processed.
          example: '2019-01-15T21:48:23Z'
          type: string
      type: object
    StatusKafka:
      properties:
        kafka_partitions:
          description: Status info per partition.
          items:
            $ref: '#/components/schemas/StatusKafkaPartition'
          type: array
        last_consumed_time:
          description: Time at which the last document was consumed from Kafka.
          example: '2001-08-28T00:23:41Z'
          type: string
        num_documents_processed:
          description: Number of documents consumed by this Kafka topic.
          example: 1337
          format: int64
          type: integer
        state:
          description: State of the Kafka source.
          enum:
          - NO_DOCS_YET
          - ACTIVE
          - DORMANT
          example: ACTIVE
          type: string
      type: object
    StatusKafkaPartition:
      properties:
        offset_lag:
          description: Per partition lag for offset.
          example: 10
          format: int64
          type: integer
        partition_number:
          description: The number of this partition.
          example: 123
          format: int32
          type: integer
        partition_offset:
          description: Latest offset of partition.
          example: 100
          format: int64
          type: integer
      type: object
    StatusMongoDb:
      properties:
        scan_end_time:
          description: MongoDB scan end time.
          example: '2001-08-28T00:23:41Z'
          type: string
        scan_records_processed:
          description: Number of records inserted using scan.
          example: 1000
          format: int64
          type: integer
        scan_start_time:
          description: MongoDB scan start time.
          example: '2001-08-28T00:23:41Z'
          type: string
        scan_total_records:
          description: Number of records in MongoDB table at time of scan.
          example: 2000
          format: int64
          type: integer
        state:
          description: State of current ingest for this table.
          enum:
          - INITIALIZING
          - SCANNING_TABLE
          - PROCESSING_STREAM
          example: SCANNING_TABLE
          type: string
        stream_last_delete_processed_at:
          description: ISO-8601 date when delete from source was last processed.
          example: '2019-01-15T21:48:23Z'
          type: string
        stream_last_insert_processed_at:
          description: ISO-8601 date when new insert from source was last processed.
          example: '2019-01-15T21:48:23Z'
          type: string
        stream_last_update_processed_at:
          description: ISO-8601 date when update from source was last processed.
          example: '2019-01-15T21:48:23Z'
          type: string
        stream_records_deleted:
          description: Number of new records deleted using stream.
          example: 100
          format: int64
          type: integer
        stream_records_inserted:
          description: Number of new records inserted using stream.
          example: 10000
          format: int64
          type: integer
        stream_records_updated:
          description: Number of new records updated using stream.
          example: 1000
          format: int64
          type: integer
      type: object
    StatusSnowflake:
      properties:
        state:
          description: State of current ingest for this table.
          enum:
          - INITIALIZING
          - EXPORTING_TO_S3
          - DOWNLOADING_FROM_S3
          - COMPLETED
          example: EXPORTING_TO_S3
          type: string
      type: object
    SuspendSourceRequest:
      properties:
        resume_after_duration:
          description: duration to suspend source; 1h is the default
          example: 30min
          type: string
      type: object
    SuspendVirtualInstanceResponse:
      properties:
        data:
          $ref: '#/components/schemas/VirtualInstance'
          description: Virtual instance that was suspended.
      type: object
    TLSConfig:
      properties:
        ca_cert:
          description: PEM-formatted certificate chain of the Certificate Authority
            used to verify remote server. If empty, Rockset, will use publicly trusted
            CAs
          example: '-----BEGIN CERTIFICATE-----

            ....

            -----END CERTIFICATE-----'
          type: string
        client_cert:
          description: PEM-formatted certificate chain to use for client authentication
          example: '-----BEGIN CERTIFICATE-----

            ....

            -----END CERTIFICATE-----'
          type: string
        client_cert_expiry:
          description: Expiration date of the client certificate (represented as number
            of ms since epoch)
          example: 1695426751
          format: int64
          readOnly: true
          type: integer
        client_cert_subject:
          description: Subject of the client certificate, containing common name and
            other attributes
          example: CN=Sample Cert, OU=R&D, O=Company Ltd.
          readOnly: true
          type: string
        client_key:
          description: PEM-formatted private key to be used for client authentication
          example: '-----BEGIN RSA PRIVATE KEY-----

            ...

            -----END RSA PRIVATE KEY-----'
          type: string
      required:
      - client_cert
      - client_key
      type: object
    UnsubscribePreference:
      description: Notification preferences for the user.
      properties:
        notificationType:
          description: The type of notification to be unsubscribed from.
          example: create_apikey
          type: string
      required:
      - notificationType
      type: object
    UpdateAliasRequest:
      properties:
        collections:
          description: List of fully qualified collection names referenced by alias.
          example: '["commons.foo", "prod.demo"]'
          items:
            type: string
          type: array
        description:
          description: Optional description.
          example: version alias
          type: string
      required:
      - collections
      type: object
    UpdateApiKeyRequest:
      properties:
        clear_expiry_time:
          description: If set to true, the expiration time for this key will be cleared.
          example: true
          type: boolean
        expiry_time:
          description: If provided, the API key will automatically expire at this
            time (ISO-8601 format). Requires premium.
          example: '2001-08-28T00:23:41Z'
          type: string
        state:
          description: State that the api key should be set to.
          enum:
          - ACTIVE
          - SUSPENDED
          example: ACTIVE
          type: string
      type: object
    UpdateApiKeyResponse:
      properties:
        data:
          $ref: '#/components/schemas/ApiKey'
          description: The API key that was updated.
      type: object
    UpdateCollectionRequest:
      properties:
        description:
          description: Updated text describing the collection.
          example: transactions from stores worldwide
          type: string
        field_mapping_query:
          $ref: '#/components/schemas/FieldMappingQuery'
          description: Updated ingest transformation query. Note that updating the
            transformation will lead to a brief interruption in ingestion.
      type: object
    UpdateDeploymentSettingsRequest:
      properties:
        default_query_vi:
          description: RRN of the Virtual Instance that all queries will be routed
            to by default
          example: rrn:vi:use1a1:123e4567-e89b-12d3-a456-556642440000
          type: string
      type: object
    UpdateIntegrationRequest:
      properties:
        azure_blob_storage:
          $ref: '#/components/schemas/AzureBlobStorageIntegration'
          description: Azure Blob Storage details.
        azure_event_hubs:
          $ref: '#/components/schemas/AzureEventHubsIntegration'
          description: Azure Event Hubs details.
        azure_service_bus:
          $ref: '#/components/schemas/AzureServiceBusIntegration'
          description: Azure Service Bus details.
        description:
          description: Longer explanation for the integration.
          example: AWS account with event data for the data science team.
          type: string
        dynamodb:
          $ref: '#/components/schemas/DynamodbIntegration'
          description: Amazon DynamoDB details, must have one of aws_access_key or
            aws_role.
        gcs:
          $ref: '#/components/schemas/GcsIntegration'
          description: GCS details.
        is_write_enabled:
          description: is write access enabled for this integration.
          type: boolean
        kafka:
          $ref: '#/components/schemas/KafkaIntegration'
        kinesis:
          $ref: '#/components/schemas/KinesisIntegration'
          description: Amazon Kinesis details, must have one of aws_access_key or
            aws_role.
        mongodb:
          $ref: '#/components/schemas/MongoDbIntegration'
          description: MongoDb details.
        s3:
          $ref: '#/components/schemas/S3Integration'
          description: Amazon S3 details, must have one of aws_access_key or aws_role.
        snowflake:
          $ref: '#/components/schemas/SnowflakeIntegration'
          description: Snowflake details.
      type: object
    UpdateIntegrationResponse:
      properties:
        data:
          $ref: '#/components/schemas/Integration'
          description: Updated integration object.
      type: object
    UpdateQueryLambdaRequest:
      properties:
        description:
          description: Optional description.
          example: production version foo
          type: string
        is_public:
          type: boolean
        sql:
          $ref: '#/components/schemas/QueryLambdaSql'
          description: Query Lambda SQL query.
      type: object
    UpdateRoleRequest:
      properties:
        description:
          description: Description for the role.
          example: Role with read and write privileges to all collections.
          type: string
        privileges:
          description: List of privileges that will be associated with the role.
          items:
            $ref: '#/components/schemas/Privilege'
          type: array
      type: object
    UpdateScheduledLambdaRequest:
      properties:
        apikey:
          description: The apikey to use when triggering execution of the associated
            query lambda.
          example: qoiwkjndksd
          type: string
        resume_permanent_error:
          description: Boolean flag to allow a scheduled query lambda to resume execution
            after being suspended due to execution failure. This flag will be unset
            after scheduled lambda execution.
          type: boolean
        total_times_to_execute:
          description: The number of times to execute this scheduled query lambda.
          example: 1
          format: int64
          type: integer
        webhook_auth_header:
          description: The value to use as the authorization header when hitting the
            webhook.
          example: bearer qiowjkjkdskdskldio
          type: string
        webhook_payload:
          description: The payload that should be sent to the webhook. JSON format.
          type: string
        webhook_url:
          description: The URL of the webhook that should be triggered after this
            scheduled query lambda completes.
          example: https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX
          type: string
      type: object
    UpdateUnsubscribePreferencesRequest:
      properties:
        data:
          description: List of notification preferences.
          items:
            $ref: '#/components/schemas/UnsubscribePreference'
          type: array
      type: object
    UpdateUnsubscribePreferencesResponse:
      properties:
        data:
          description: List of notification preferences.
          items:
            $ref: '#/components/schemas/UnsubscribePreference'
          type: array
      type: object
    UpdateUserRequest:
      properties:
        first_name:
          description: User first name.
          example: John
          type: string
        last_name:
          description: User last name.
          example: Doe
          type: string
        roles:
          description: New list of roles for a given user.
          example: '["admin", "member", "read-only"]'
          items:
            type: string
          type: array
      type: object
    UpdateViewRequest:
      properties:
        description:
          description: Optional description.
          example: view of awesome collection
          type: string
        query:
          description: SQL for this view.
          example: SELECT * FROM foo
          type: string
      required:
      - query
      type: object
    UpdateViewResponse:
      properties:
        data:
          $ref: '#/components/schemas/View'
          description: View that was updated.
      type: object
    UpdateVirtualInstanceRequest:
      properties:
        auto_scaling_policy:
          $ref: '#/components/schemas/AutoScalingPolicy'
          description: Options for configuring auto scaling policy
          example: 'true'
        auto_suspend_enabled:
          description: Whether Query VI auto-suspend should be enabled for this Virtual
            Instance.
          example: true
          type: boolean
        auto_suspend_seconds:
          description: Number of seconds without queries after which the Query VI
            is suspended
          example: 3600
          format: int32
          type: integer
        description:
          description: New virtual instance description.
          example: VI for prod traffic
          type: string
        enable_remount_on_resume:
          description: When a Virtual Instance is resumed, it will remount all collections
            that were mounted when the Virtual Instance was suspended.
          example: true
          type: boolean
        instance_class:
          description: Virtual Instance Class. Use `MO_IL` for Memory Optimized and
            `GP_IL` for General Purpose instance class.
          enum:
          - MO_IL
          - GP_IL
          example: MO_IL
          type: string
        mount_refresh_interval_seconds:
          description: DEPRECATED. Use `mount_type` instead. Number of seconds between
            data refreshes for mounts on this Virtual Instance. The only valid values
            are 0 and null. 0 means the data will be refreshed continuously and null
            means the data will never refresh.
          example: 0
          format: int32
          type: integer
        mount_type:
          description: The mount type of collections that this Virtual Instance will
            query. Live mounted collections stay up-to-date with the underlying collection
            in real-time. Static mounted collections do not stay up-to-date. See https://docs.rockset.com/documentation/docs/using-virtual-instances#virtual-instance-configuration
          enum:
          - LIVE
          - STATIC
          example: LIVE
          type: string
        name:
          description: New virtual instance name.
          example: prod_vi
          type: string
        new_size:
          description: Requested virtual instance size.
          enum:
          - FREE
          - NANO
          - SHARED
          - MILLI
          - XSMALL
          - SMALL
          - MEDIUM
          - LARGE
          - XLARGE
          - XLARGE2
          - XLARGE4
          - XLARGE8
          - XLARGE16
          example: LARGE
          type: string
      type: object
    UpdateVirtualInstanceResponse:
      properties:
        data:
          $ref: '#/components/schemas/VirtualInstance'
          description: Virtual instance that was switched.
      type: object
    User:
      properties:
        created_at:
          description: ISO-8601 date.
          example: '2001-08-28T00:23:41Z'
          type: string
        email:
          description: User email.
          example: hello@rockset.com
          type: string
        first_name:
          description: User first name.
          example: John
          type: string
        last_name:
          description: User last name.
          example: Doe
          type: string
        roles:
          description: List of roles for a given user.
          example: '["admin", "member", "read-only"]'
          items:
            type: string
          type: array
        state:
          description: State of user - NEW / ACTIVE.
          example: ACTIVE
          type: string
      required:
      - email
      type: object
    ValidateQueryResponse:
      properties:
        collections:
          description: List of collections specified in query.
          example: '["commons.foo"]'
          items:
            type: string
          type: array
        parameters:
          description: List of parameters specified in query.
          example: '["foo"]'
          items:
            type: string
          type: array
      required:
      - collections
      - parameters
      type: object
    View:
      properties:
        created_at:
          description: ISO-8601 date.
          example: '2001-08-28T00:23:41Z'
          type: string
        created_by_apikey_name:
          description: Name of the API key that was used to create this object if
            one was used.
          type: string
        creator_email:
          description: Email of the creator.
          example: xyz@rockset.com
          type: string
        description:
          description: View description.
          example: view referencing collection in workspace
          type: string
        entities:
          description: List of entities referenced by view. An entity can be a view,
            alias or collection.
          example: '["common.foo_view", "prod.demo_alias", "dev.user_collection"]'
          items:
            type: string
          type: array
        modified_at:
          description: ISO-8601 date.
          example: '2001-08-28T00:23:42Z'
          type: string
        name:
          description: Name of the view.
          example: demo
          type: string
        owner_email:
          description: 'Email of the owner, note: deprecated and will always be null.'
          example: abc@rockset.com
          type: string
        path:
          type: string
        query_sql:
          description: SQL query of the view.
          example: SELECT * FROM commons.foo
          type: string
        state:
          description: State of the view.
          enum:
          - CREATED
          - SYNCING
          - DELETED
          example: CREATED
          type: string
        workspace:
          description: Name of the workspace.
          example: commons
          type: string
      type: object
    VirtualInstance:
      properties:
        auto_scaling_policy:
          $ref: '#/components/schemas/AutoScalingPolicy'
          description: Options for configuring auto scaling policy
        auto_suspend_seconds:
          description: Number of seconds without queries after which the VI is suspended
          example: 3600
          format: int32
          type: integer
        created_at:
          description: ISO-8601 date of when virtual instance was created.
          example: '2001-08-28T00:23:41Z'
          type: string
        created_by:
          description: Creator of requested virtual instance.
          example: hello@rockset.com
          type: string
        current_instance_class:
          description: Virtual Instance Class. `MO_IL` represents Memory Optimized
            and `GP_IL` represents General Purpose instance class.
          enum:
          - MO_BR
          - MO_IL
          - GP_IL
          example: MO_IL
          type: string
        current_size:
          description: Virtual instance current size.
          enum:
          - FREE
          - NANO
          - SHARED
          - MILLI
          - XSMALL
          - SMALL
          - MEDIUM
          - LARGE
          - XLARGE
          - XLARGE2
          - XLARGE4
          - XLARGE8
          - XLARGE16
          example: MEDIUM
          readOnly: true
          type: string
        default_vi:
          type: boolean
        description:
          description: Virtual instance description.
          example: VI for prod traffic
          type: string
        desired_instance_class:
          description: Virtual Instance Class.
          enum:
          - MO_BR
          - MO_IL
          - GP_IL
          example: MO_IL
          type: string
        desired_size:
          description: Virtual instance desired size.
          enum:
          - FREE
          - NANO
          - SHARED
          - MILLI
          - XSMALL
          - SMALL
          - MEDIUM
          - LARGE
          - XLARGE
          - XLARGE2
          - XLARGE4
          - XLARGE8
          - XLARGE16
          example: MEDIUM
          readOnly: true
          type: string
        enable_remount_on_resume:
          description: When a Virtual Instance is resumed, it will remount all collections
            that were mounted when the Virtual Instance was suspended.
          example: true
          type: boolean
        id:
          description: Unique identifier for virtual instance.
          example: 123e4567-e89b-12d3-a456-556642440000
          type: string
        monitoring_enabled:
          type: boolean
        mount_refresh_interval_seconds:
          description: DEPRECATED. Number of seconds between data refreshes for mounts
            on this Virtual Instance
          example: 3600
          format: int32
          type: integer
        mount_type:
          description: The mount type of collections that this Virtual Instance will
            query. Live mounted collections stay up-to-date with the underlying collection
            in real-time. Static mounted collections do not stay up-to-date. See https://docs.rockset.com/documentation/docs/using-virtual-instances#virtual-instance-configuration
          enum:
          - LIVE
          - STATIC
          example: LIVE
          type: string
        name:
          description: Virtual instance name.
          example: prod_vi
          type: string
        resumed_at:
          description: ISO-8601 date of when virtual instance was created.
          example: '2001-08-28T00:23:41Z'
          type: string
        rrn:
          description: Virtual Instance RRN.
          example: rrn:vi:use1a1:123e4567-e89b-12d3-a456-556642440000
          type: string
        state:
          description: Virtual instance state.
          enum:
          - INITIALIZING
          - PROVISIONING_RESOURCES
          - REBALANCING_COLLECTIONS
          - ACTIVE
          - SUSPENDING
          - SUSPENDED
          - RESUMING
          - DELETED
          - ENABLING_DEDICATED_SERVICES
          - DISABLING_DEDICATED_SERVICES
          example: ACTIVE
          type: string
        stats:
          $ref: '#/components/schemas/VirtualInstanceStats'
          description: Stats about this VirtualInstance
      required:
      - name
      type: object
    VirtualInstanceStats:
      properties:
        last_queried_ms:
          description: Milliseconds since Unix epoch Jan 1, 1970.
          example: 1535101119334
          format: int64
          type: integer
      type: object
    Workspace:
      description: Workspaces are organizational containers for collections.
      properties:
        collection_count:
          description: Number of collections that are immediate children of workspace.
          example: 3
          format: int64
          type: integer
        created_at:
          description: ISO-8601 date of when workspace was created.
          example: '2001-08-28T00:23:41Z'
          type: string
        created_by:
          description: Email of user who created the workspace.
          example: hello@rockset.com
          type: string
        description:
          description: Longer explanation for the workspace.
          example: Datasets of system logs for the ops team.
          type: string
        name:
          description: Descriptive label and unique identifier.
          example: event_logs
          type: string
      type: object
    XmlParams:
      properties:
        attribute_prefix:
          description: Tag to differentiate between attributes and elements.
          example: _attr
          type: string
        doc_tag:
          description: Tags with which documents are identified.
          example: row
          type: string
        encoding:
          description: Encoding in which data source is encoded.
          example: UTF-8
          type: string
        root_tag:
          description: Tag until which xml is ignored.
          example: root
          type: string
        value_tag:
          description: tag used for the value when there are attributes in the element
            having no child
          example: value
          type: string
      type: object
  securitySchemes:
    AuthorizationHeader:
      in: header
      name: Authorization
      type: apiKey
      x-bearer-format: ''
      x-default: ApiKey YOUR_ROCKSET_KEY
info:
  description: 'Rockset''s REST API allows for creating and managing all resources
    in Rockset. Each supported endpoint is documented below.


    All requests must be authorized with a Rockset API key, which can be created in
    the [Rockset console](https://console.rockset.com). The API key must be provided
    as `ApiKey <api_key>` in the `Authorization` request header. For example:

    ```

    Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT

    ```


    All endpoints are only accessible via https.


    Build something awesome!'
  title: REST API
  version: v1
openapi: 3.0.0
paths:
  /v1/orgs/self:
    get:
      description: Retrieve information about current organization.
      operationId: getOrganization
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationResponse'
          description: organization retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Get Organization
      tags:
      - Organizations
      x-rename: get
  /v1/orgs/self/aliases:
    get:
      description: Retrieve all aliases in an organization
      operationId: listAliases
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAliasesResponse'
          description: aliases retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: List Aliases
      tags:
      - Aliases
      x-rename: list
  /v1/orgs/self/collections:
    get:
      description: Retrieve all collections in an organization.
      operationId: listCollections
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCollectionsResponse'
          description: collections retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: List Collections
      tags:
      - Collections
      x-rename: list
  /v1/orgs/self/deploymentsettings:
    get:
      description: Retrieve settings for the current deployment.
      operationId: getDeploymentSettings
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentSettingsResponse'
          description: Deployment settings retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Retrieve Deployment Settings
      tags:
      - Deployment Settings
    put:
      description: Update settings for the current deployment.
      operationId: updateDeploymentSettings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDeploymentSettingsRequest'
        description: JSON object
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentSettingsResponse'
          description: Deployment settings updated successfully. Settings may take
            up to 1 minute to take effect
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Update Deployment Settings
      tags:
      - Deployment Settings
  /v1/orgs/self/integrations:
    get:
      description: List all integrations in an organization.
      operationId: listIntegrations
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListIntegrationsResponse'
          description: integrations retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: List Integrations
      tags:
      - Integrations
      x-rename: list
    post:
      description: Create a new integration.
      operationId: createIntegration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateIntegrationRequest'
        description: integration credentials
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateIntegrationResponse'
          description: integration created successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Create Integration
      tags:
      - Integrations
  /v1/orgs/self/integrations/{integration}:
    delete:
      description: Remove an integration.
      operationId: deleteIntegration
      parameters:
      - description: name of the integration
        in: path
        name: integration
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteIntegrationResponse'
          description: integration deleted successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Delete Integration
      tags:
      - Integrations
      x-rename: delete
    get:
      description: Retrieve information about a single integration.
      operationId: getIntegration
      parameters:
      - description: name of the integration
        in: path
        name: integration
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIntegrationResponse'
          description: integration retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Retrieve Integration
      tags:
      - Integrations
      x-rename: get
    put:
      description: Update an existing integration.
      operationId: updateIntegration
      parameters:
      - in: path
        name: integration
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateIntegrationRequest'
        description: integration configuration
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateIntegrationResponse'
          description: integration updated successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Update Integration
      tags:
      - Integrations
      x-rename: update
  /v1/orgs/self/lambdas:
    get:
      description: List all Query Lambdas in an organization.
      operationId: listAllQueryLambdas
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListQueryLambdasResponse'
          description: Query Lambdas listed successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: List Query Lambdas
      tags:
      - Query Lambdas
  /v1/orgs/self/queries:
    get:
      description: Lists actively queued and running queries.
      operationId: listActiveQueries
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListQueriesResponse'
          description: successfully fetched queries
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: List Queries
      tags:
      - Queries
    post:
      description: Make a SQL query to Rockset. If you want to issue the query to
        a specific Virtual Instance use this https://docs.rockset.com/documentation/reference/queryvirtualinstance
      operationId: query
      requestBody:
        $ref: '#/components/requestBodies/QueryRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponse'
          description: query executed successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Execute SQL Query
      tags:
      - Queries
  /v1/orgs/self/queries/validations:
    post:
      description: Validate a SQL query with Rockset's parser and planner.
      operationId: validate
      requestBody:
        $ref: '#/components/requestBodies/QueryRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateQueryResponse'
          description: query validated successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Validate Query
      tags:
      - Queries
  /v1/orgs/self/queries/{queryId}:
    delete:
      description: Attempts to cancel an actively-running query.
      operationId: cancelQuery
      parameters:
      - in: path
        name: queryId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelQueryResponse'
          description: Successfully canceled query
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Cancel Query
      tags:
      - Queries
    get:
      description: Returns information about a query.
      operationId: getQuery
      parameters:
      - in: path
        name: queryId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetQueryResponse'
          description: Successfully fetched query info
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Retrieve Query
      tags:
      - Queries
  /v1/orgs/self/queries/{queryId}/pages:
    get:
      description: Returns a page of query results.
      operationId: getQueryResults
      parameters:
      - in: path
        name: queryId
        required: true
        schema:
          type: string
      - description: Cursor to current page. If unset, will default to the first page.
        in: query
        name: cursor
        required: false
        schema:
          type: string
      - description: Number of documents to fetch.
        in: query
        name: docs
        required: false
        schema:
          format: int32
          type: integer
      - description: Offset from the cursor of the first document to be returned
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryPaginationResponse'
          description: successfully fetched query results
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Retrieve Query Results Page
      tags:
      - Queries
  /v1/orgs/self/roles:
    get:
      description: List all roles for your organization.
      operationId: listRoles
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRolesResponse'
          description: roles retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: List Roles
      tags:
      - Custom Roles
      x-rename: list
    post:
      description: Create a role for your organization.
      operationId: createRole
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRoleRequest'
        description: JSON Object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleResponse'
          description: role created successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Create a Role
      tags:
      - Custom Roles
      x-rename: create
  /v1/orgs/self/roles/{roleName}:
    delete:
      description: Delete a role for your organization.
      operationId: deleteRole
      parameters:
      - in: path
        name: roleName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleResponse'
          description: role deleted successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Delete a Role
      tags:
      - Custom Roles
      x-rename: delete
    get:
      description: Retrieve a role by name for your organization.
      operationId: getRole
      parameters:
      - in: path
        name: roleName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleResponse'
          description: role retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Retrieve role
      tags:
      - Custom Roles
      x-rename: get
    post:
      description: Update a role for your organization.
      operationId: updateRole
      parameters:
      - in: path
        name: roleName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRoleRequest'
        description: JSON Object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleResponse'
          description: role updated successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Update a Role
      tags:
      - Custom Roles
      x-rename: update
  /v1/orgs/self/users:
    get:
      description: Retrieve all users for an organization.
      operationId: listUsers
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListUsersResponse'
          description: users retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: List Users
      tags:
      - Users
      x-rename: list
    post:
      description: Create a new user for an organization.
      operationId: createUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateUserResponse'
          description: user created successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Create User
      tags:
      - Users
      x-rename: create
  /v1/orgs/self/users/self:
    get:
      description: Retrieve currently authenticated user.
      operationId: getCurrentUser
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: user retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Retrieve Current User
      tags:
      - Users
  /v1/orgs/self/users/self/apikeys:
    post:
      description: Create a new API key for the authenticated user.
      operationId: createApiKey
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateApiKeyRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateApiKeyResponse'
          description: API key created successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Create API Key
      tags:
      - API Keys
      x-rename: create
  /v1/orgs/self/users/self/preferences:
    get:
      description: Get all notification preferences.
      operationId: listUnsubscribePreferences
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListUnsubscribePreferencesResponse'
          description: Notification preferences retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Retrieve Notification Preferences
      tags:
      - Users
    post:
      description: Update notification preference.
      operationId: updateUnsubscribePreferences
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUnsubscribePreferencesRequest'
        description: JSON Object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateUnsubscribePreferencesResponse'
          description: Notification preference created successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Update Notification Preferences
      tags:
      - Users
  /v1/orgs/self/users/{user}:
    delete:
      description: Delete a user from an organization.
      operationId: deleteUser
      parameters:
      - description: user email
        in: path
        name: user
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteUserResponse'
          description: user deleted successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Delete User
      tags:
      - Users
      x-rename: delete
    get:
      description: Retrieve user by email.
      operationId: getUser
      parameters:
      - description: user email
        in: path
        name: user
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: user found
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Retrieve User
      tags:
      - Users
      x-rename: get
    post:
      description: Update a user in an organization.
      operationId: updateUser
      parameters:
      - description: email of the user to update
        in: path
        name: user
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: user updated successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Update User
      tags:
      - Users
      x-rename: update
  /v1/orgs/self/users/{user}/apikeys:
    get:
      description: List API key metadata for any user in your organization.
      operationId: listApiKeys
      parameters:
      - description: Email of the API key owner. Use `self` to specify the currently
          authenticated user.
        example: admin@me.com
        in: path
        name: user
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListApiKeysResponse'
          description: API keys retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: List API Keys
      tags:
      - API Keys
      x-rename: list
  /v1/orgs/self/users/{user}/apikeys/{name}:
    delete:
      description: Delete an API key for any user in your organization.
      operationId: deleteApiKey
      parameters:
      - description: Name of the API key.
        example: my-key
        in: path
        name: name
        required: true
        schema:
          type: string
      - description: Email of the API key owner. Use `self` to specify the currently
          authenticated user.
        example: admin@me.com
        in: path
        name: user
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiKeyResponse'
          description: API key deleted successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Delete API Key
      tags:
      - API Keys
      x-rename: delete
    get:
      description: Retrieve a particular API key for any user in your organization.
      operationId: getApiKey
      parameters:
      - description: Email of the API key owner. Use `self` to specify the currently
          authenticated user.
        example: admin@me.com
        in: path
        name: user
        required: true
        schema:
          type: string
      - description: Name of the API key.
        example: my-key
        in: path
        name: name
        required: true
        schema:
          type: string
      - description: Reveal full key.
        example: true
        in: query
        name: reveal
        required: false
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiKeyResponse'
          description: API key retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Retrieve API Key
      tags:
      - API Keys
      x-rename: get
    post:
      description: Update the state of an API key for any user in your organization.
      operationId: updateApiKey
      parameters:
      - description: Name of the API key.
        example: my-key
        in: path
        name: name
        required: true
        schema:
          type: string
      - description: Email of the API key owner. Use `self` to specify the currently
          authenticated user.
        example: admin@me.com
        in: path
        name: user
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateApiKeyRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateApiKeyResponse'
          description: API key successfully updated
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Update API Key State
      tags:
      - API Keys
      x-rename: update
  /v1/orgs/self/views:
    get:
      description: Retrieve all views in an organization
      operationId: listViews
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListViewsResponse'
          description: views retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: List Views
      tags:
      - Views
      x-rename: list
  /v1/orgs/self/virtualinstances:
    get:
      description: Retrieve all virtual instances in an organization.
      operationId: listVirtualInstances
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListVirtualInstancesResponse'
          description: virtual instances retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: List Virtual Instances
      tags:
      - Virtual Instances
      x-rename: list
    post:
      description: Create virtual instance
      operationId: createVirtualInstance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVirtualInstanceRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVirtualInstanceResponse'
          description: virtual instance created successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Create Virtual Instance
      tags:
      - Virtual Instances
      x-rename: create
  /v1/orgs/self/virtualinstances/{virtualInstanceId}:
    delete:
      description: Delete a virtual instance.
      operationId: deleteVirtualInstance
      parameters:
      - description: Virtual Instance RRN
        in: path
        name: virtualInstanceId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteVirtualInstanceResponse'
          description: virtual instance deleted successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Delete Virtual Instance
      tags:
      - Virtual Instances
      x-rename: delete
    get:
      description: Get details about a virtual instance.
      operationId: getVirtualInstance
      parameters:
      - description: Virtual Instance RRN
        in: path
        name: virtualInstanceId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVirtualInstanceResponse'
          description: virtual instance retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Retrieve Virtual Instance
      tags:
      - Virtual Instances
      x-rename: get
    post:
      description: Update the properties of a virtual instance.
      operationId: setVirtualInstance
      parameters:
      - description: Virtual Instance RRN
        in: path
        name: virtualInstanceId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVirtualInstanceRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateVirtualInstanceResponse'
          description: virtual instance updated successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Update Virtual Instance
      tags:
      - Virtual Instances
      x-rename: update
  /v1/orgs/self/virtualinstances/{virtualInstanceId}/mounts:
    get:
      description: List collection mounts for a particular VI.
      operationId: listCollectionMounts
      parameters:
      - description: Virtual Instance RRN
        in: path
        name: virtualInstanceId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCollectionMountsResponse'
          description: resource mounted
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: List Collection Mounts
      tags:
      - Virtual Instances
    post:
      description: Mount a collection to this virtual instance.
      operationId: mountCollection
      parameters:
      - description: Virtual Instance RRN
        in: path
        name: virtualInstanceId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCollectionMountRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCollectionMountsResponse'
          description: collection mounted
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Mount Collections
      tags:
      - Virtual Instances
  /v1/orgs/self/virtualinstances/{virtualInstanceId}/mounts/{collectionPath}:
    delete:
      description: Unmount a collection from this virtual instance.
      operationId: unmountCollection
      parameters:
      - description: Virtual Instance RRN
        in: path
        name: virtualInstanceId
        required: true
        schema:
          type: string
      - in: path
        name: collectionPath
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionMountResponse'
          description: collection unmounted
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Unmount Collection
      tags:
      - Virtual Instances
    get:
      description: Retrieve a mount on this virtual instance.
      operationId: getCollectionMount
      parameters:
      - description: Virtual Instance RRN
        in: path
        name: virtualInstanceId
        required: true
        schema:
          type: string
      - in: path
        name: collectionPath
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionMountResponse'
          description: collection unmounted
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Get Collection Mount
      tags:
      - Virtual Instances
  /v1/orgs/self/virtualinstances/{virtualInstanceId}/mounts/{collectionPath}/offsets/commit:
    post:
      description: Determines if the collection includes data at or after the specified
        fence(s) for close read-after-write semantics.
      operationId: getMountOffsets
      parameters:
      - description: Virtual Instance RRN
        in: path
        name: virtualInstanceId
        required: true
        schema:
          type: string
      - in: path
        name: collectionPath
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetCollectionCommitRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionCommit'
          description: Successfully returned collection commit
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Get Collection Commit
      tags:
      - Virtual Instances
  /v1/orgs/self/virtualinstances/{virtualInstanceId}/queries:
    get:
      description: Lists actively queued and running queries for a particular Virtual
        Instance.
      operationId: getVirtualInstanceQueries
      parameters:
      - description: Virtual Instance RRN
        in: path
        name: virtualInstanceId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListQueriesResponse'
          description: successfully fetched queries
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: List Queries
      tags:
      - Virtual Instances
    post:
      description: Make a SQL query to Rockset.
      operationId: queryVirtualInstance
      parameters:
      - description: Virtual Instance RRN
        in: path
        name: virtualInstanceId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponse'
          description: query executed successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Execute SQL Query on a specific Virtual Instance
      tags:
      - Virtual Instances
  /v1/orgs/self/virtualinstances/{virtualInstanceId}/resume:
    post:
      description: Resume a virtual instance.
      operationId: resumeVirtualInstance
      parameters:
      - description: Virtual Instance RRN
        in: path
        name: virtualInstanceId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResumeVirtualInstanceResponse'
          description: virtual instance resumed successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Resume Virtual Instance
      tags:
      - Virtual Instances
  /v1/orgs/self/virtualinstances/{virtualInstanceId}/suspend:
    post:
      description: Suspend a virtual instance.
      operationId: suspendVirtualInstance
      parameters:
      - description: Virtual Instance RRN
        in: path
        name: virtualInstanceId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuspendVirtualInstanceResponse'
          description: virtual instance suspended successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Suspend Virtual Instance
      tags:
      - Virtual Instances
  /v1/orgs/self/ws:
    get:
      description: List all workspaces in an organization.
      operationId: listWorkspaces
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWorkspacesResponse'
          description: workspaces retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: List Workspaces
      tags:
      - Workspaces
      x-rename: list
    post:
      description: Create a new workspace.
      operationId: createWorkspace
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWorkspaceRequest'
        description: workspace details
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWorkspaceResponse'
          description: workspace created successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Create Workspace
      tags:
      - Workspaces
      x-rename: create
  /v1/orgs/self/ws/{workspace}:
    delete:
      description: Remove a workspace.
      operationId: deleteWorkspace
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWorkspaceResponse'
          description: workspace deleted successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Delete Workspace
      tags:
      - Workspaces
      x-rename: delete
    get:
      description: Get information about a single workspace.
      operationId: getWorkspace
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkspaceResponse'
          description: workspace retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Retrieve Workspace
      tags:
      - Workspaces
      x-rename: get
  /v1/orgs/self/ws/{workspace}/aliases:
    get:
      description: Retrieve all aliases in a workspace.
      operationId: workspaceAliases
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAliasesResponse'
          description: aliases retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: List Aliases in Workspace
      tags:
      - Aliases
    post:
      description: Create new alias in a workspace.
      operationId: createAlias
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAliasRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAliasResponse'
          description: alias created successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Create Alias
      tags:
      - Aliases
      x-rename: create
  /v1/orgs/self/ws/{workspace}/aliases/{alias}:
    delete:
      description: Delete an alias.
      operationId: deleteAlias
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the alias
        in: path
        name: alias
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAliasResponse'
          description: alias deleted successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Delete Alias
      tags:
      - Aliases
      x-rename: delete
    get:
      description: Get details about an alias
      operationId: getAlias
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the alias
        in: path
        name: alias
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAliasResponse'
          description: alias retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Retrieve Alias
      tags:
      - Aliases
      x-rename: get
    post:
      description: Update alias in a workspace.
      operationId: updateAlias
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the alias
        in: path
        name: alias
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAliasRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAliasResponse'
          description: alias updated successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Update Alias
      tags:
      - Aliases
      x-rename: update
  /v1/orgs/self/ws/{workspace}/collections:
    get:
      description: Retrieve all collections in a workspace.
      operationId: workspaceCollections
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCollectionsResponse'
          description: collections retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: List Collections in Workspace
      tags:
      - Collections
    post:
      description: Create new collection in a workspace.
      operationId: createCollection
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCollectionRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCollectionResponse'
          description: collection created successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Create Collection
      tags:
      - Collections
  /v1/orgs/self/ws/{workspace}/collections/{collection}:
    delete:
      description: Delete a collection and all its documents from Rockset.
      operationId: deleteCollection
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the collection
        in: path
        name: collection
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCollectionResponse'
          description: collection deleted successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Delete Collection
      tags:
      - Collections
      x-rename: delete
    get:
      description: Get details about a collection.
      operationId: getCollection
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the collection
        in: path
        name: collection
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionResponse'
          description: collection retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Retrieve Collection
      tags:
      - Collections
      x-rename: get
    put:
      description: Update details about a collection.
      operationId: updateCollection
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the collection
        in: path
        name: collection
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCollectionRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionResponse'
          description: collection updated successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Update Collection
      tags:
      - Collections
      x-rename: update
  /v1/orgs/self/ws/{workspace}/collections/{collection}/docs:
    delete:
      description: Delete documents from a collection.
      operationId: deleteDocuments
      parameters:
      - description: Name of the workspace.
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: Name of the collection.
        in: path
        name: collection
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteDocumentsRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDocumentsResponse'
          description: documents deleted successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Delete Documents
      tags:
      - Documents
    patch:
      description: Update existing documents in a collection.
      operationId: patchDocuments
      parameters:
      - description: Name of the workspace.
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: Name of the collection.
        in: path
        name: collection
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchDocumentsRequest'
        description: JSON Patch objects
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchDocumentsResponse'
          description: Documents patched successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '413':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: content too large
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Patch Documents
      tags:
      - Documents
    post:
      description: Add documents to a collection.
      operationId: addDocuments
      parameters:
      - description: Name of the workspace.
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: Name of the collection.
        in: path
        name: collection
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddDocumentsRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddDocumentsResponse'
          description: documents added successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '413':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: content too large
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Add Documents
      tags:
      - Documents
  /v1/orgs/self/ws/{workspace}/collections/{collection}/offsets/commit:
    post:
      description: Determines if the collection includes data at or after the specified
        fence(s) for close read-after-write semantics.
      operationId: getCollectionOffsets
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the collection
        in: path
        name: collection
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetCollectionCommitRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionCommit'
          description: Successfully returned collection commit
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Get Collection Commit
      tags:
      - Collections
  /v1/orgs/self/ws/{workspace}/collections/{collection}/sources:
    get:
      description: Retrieve all sources in a collection.
      operationId: listCollectionSources
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the collection
        in: path
        name: collection
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSourcesResponse'
          description: collection sources retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: List sources in collection
      tags:
      - Sources
      x-rename: list
    post:
      description: Create new source in a collection.
      operationId: createSource
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the collection
        in: path
        name: collection
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Source'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSourceResponse'
          description: source created successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Create a source
      tags:
      - Sources
  /v1/orgs/self/ws/{workspace}/collections/{collection}/sources/{source}:
    delete:
      description: Delete a collection source
      operationId: deleteSource
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the collection
        in: path
        name: collection
        required: true
        schema:
          type: string
      - description: id of source
        in: path
        name: source
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSourceResponse'
          description: source deleted successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Delete Collection source
      tags:
      - Sources
      x-rename: delete
    get:
      description: Get details about a collection source.
      operationId: getSource
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the collection
        in: path
        name: collection
        required: true
        schema:
          type: string
      - description: id of source
        in: path
        name: source
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSourceResponse'
          description: collection retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Retrieve source
      tags:
      - Sources
      x-rename: get
    put:
      description: Update details about a collection source.
      operationId: updateSource
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the collection
        in: path
        name: collection
        required: true
        schema:
          type: string
      - description: id of source
        in: path
        name: source
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SourceBase'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSourceResponse'
          description: collection updated successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Update a collection source
      tags:
      - Sources
      x-rename: update
  /v1/orgs/self/ws/{workspace}/collections/{collection}/sources/{source}/resume:
    post:
      description: Resume source ingest
      operationId: resumeSource
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the collection
        in: path
        name: collection
        required: true
        schema:
          type: string
      - description: id of source
        in: path
        name: source
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSourceResponse'
          description: source was resumed
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Resume source ingest
      tags:
      - Sources
      x-rename: resume
  /v1/orgs/self/ws/{workspace}/collections/{collection}/sources/{source}/suspend:
    post:
      description: Suspend source ingest
      operationId: suspendSource
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the collection
        in: path
        name: collection
        required: true
        schema:
          type: string
      - description: id of source
        in: path
        name: source
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuspendSourceRequest'
        description: JSON object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSourceResponse'
          description: source was suspended
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Suspend source ingest
      tags:
      - Sources
      x-rename: suspend
  /v1/orgs/self/ws/{workspace}/lambdas:
    get:
      description: List all Query Lambdas under given workspace.
      operationId: listQueryLambdasInWorkspace
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListQueryLambdasResponse'
          description: Query Lambdas listed successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: List Query Lambdas in Workspace
      tags:
      - Query Lambdas
    post:
      description: Create a Query Lambda in given workspace.
      operationId: createQueryLambda
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateQueryLambdaRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryLambdaVersionResponse'
          description: Query Lambda created successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Create Query Lambda
      tags:
      - Query Lambdas
  /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}:
    delete:
      description: Delete a Query Lambda.
      operationId: deleteQueryLambda
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the Query Lambda
        in: path
        name: queryLambda
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteQueryLambdaResponse'
          description: Query Lambda deleted successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Delete Query Lambda
      tags:
      - Query Lambdas
  /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags:
    get:
      description: List all tags associated with a Query Lambda
      operationId: listQueryLambdaTags
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the Query Lambda
        in: path
        name: queryLambda
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListQueryLambdaTagsResponse'
          description: tags listed successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: List Query Lambda Tags
      tags:
      - Query Lambdas
    post:
      description: Create a tag for a specific Query Lambda version, or update that
        tag if it already exists.
      operationId: createQueryLambdaTag
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the Query Lambda
        in: path
        name: queryLambda
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateQueryLambdaTagRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryLambdaTagResponse'
          description: tag created successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Create Query Lambda Tag
      tags:
      - Query Lambdas
  /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags/{tag}:
    delete:
      description: Delete a tag for a specific Query Lambda
      operationId: deleteQueryLambdaTag
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the Query Lambda
        in: path
        name: queryLambda
        required: true
        schema:
          type: string
      - description: name of the tag
        in: path
        name: tag
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryLambdaTagResponse'
          description: tag deleted successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Delete Query Lambda Tag Version
      tags:
      - Query Lambdas
    get:
      description: Retrieve the Query Lambda version associated with a given tag.
      operationId: getQueryLambdaTagVersion
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the Query Lambda
        in: path
        name: queryLambda
        required: true
        schema:
          type: string
      - description: name of the tag
        in: path
        name: tag
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryLambdaTagResponse'
          description: version retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Retrieve Query Lambda Tag
      tags:
      - Query Lambdas
    post:
      description: Execute the Query Lambda version associated with a given tag.
      operationId: executeQueryLambdaByTag
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the Query Lambda
        in: path
        name: queryLambda
        required: true
        schema:
          type: string
      - description: tag
        in: path
        name: tag
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteQueryLambdaRequest'
        description: JSON object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponse'
          description: Query Lambda executed successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Execute Query Lambda By Tag
      tags:
      - Query Lambdas
  /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/version/{version}:
    delete:
      description: Delete a Query Lambda version.
      operationId: deleteQueryLambdaVersion
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the Query Lambda
        in: path
        name: queryLambda
        required: true
        schema:
          type: string
      - description: version
        in: path
        name: version
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryLambdaVersionResponse'
          description: Query Lambda version deleted successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Delete Query Lambda Version
      tags:
      - Query Lambdas
  /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions:
    get:
      description: List all versions of a Query Lambda.
      operationId: listQueryLambdaVersions
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the Query Lambda
        in: path
        name: queryLambda
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListQueryLambdaVersionsResponse'
          description: versions listed successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: List Query Lambda Versions
      tags:
      - Query Lambdas
    post:
      description: Create a new version of a Query Lambda in given workspace.
      operationId: updateQueryLambda
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the Query Lambda
        in: path
        name: queryLambda
        required: true
        schema:
          type: string
      - description: Create a new Query Lambda if one does not exist already.
        in: query
        name: create
        required: false
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateQueryLambdaRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryLambdaVersionResponse'
          description: Query Lambda updated successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Update Query Lambda
      tags:
      - Query Lambdas
  /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions/{version}:
    get:
      description: Retrieve details for a specified version of a Query Lambda.
      operationId: getQueryLambdaVersion
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the Query Lambda
        in: path
        name: queryLambda
        required: true
        schema:
          type: string
      - description: version
        in: path
        name: version
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryLambdaVersionResponse'
          description: Query Lambda retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Retrieve Query Lambda Version
      tags:
      - Query Lambdas
    post:
      description: Execute a particular version of a Query Lambda.
      operationId: executeQueryLambda
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the Query Lambda
        in: path
        name: queryLambda
        required: true
        schema:
          type: string
      - description: version
        in: path
        name: version
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteQueryLambdaRequest'
        description: JSON object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponse'
          description: Query Lambda executed successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Execute Query Lambda By Version
      tags:
      - Query Lambdas
  /v1/orgs/self/ws/{workspace}/scheduled_lambdas:
    post:
      description: Create a scheduled lambda mapping for your organization.
      operationId: createScheduledLambda
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateScheduledLambdaRequest'
        description: JSON Object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledLambdaResponse'
          description: scheduled lambda mapping created successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Create a Scheduled Lambda mapping
      tags:
      - Scheduled Lambdas
      x-rename: create
  /v1/orgs/self/ws/{workspace}/scheduled_lambdas/{scheduledLambdaId}:
    delete:
      description: Delete a scheduled lambda mapping for your organization.
      operationId: deleteScheduledLambda
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: Scheduled Lambda RRN
        in: path
        name: scheduledLambdaId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledLambdaResponse'
          description: scheduled lambda mapping deleted successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Delete a Scheduled Lambda mapping
      tags:
      - Scheduled Lambdas
      x-rename: delete
    get:
      description: Retrieve a scheduled lambda mapping for your organization.
      operationId: getScheduledLambda
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: Scheduled Lambda RRN
        in: path
        name: scheduledLambdaId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledLambdaResponse'
          description: scheduled lambda mapping retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Retrieve a Scheduled Lambda mapping
      tags:
      - Scheduled Lambdas
      x-rename: get
    post:
      description: Update a scheduled lambda mapping for your organization.
      operationId: updateScheduledLambda
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: Scheduled Lambda RRN
        in: path
        name: scheduledLambdaId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateScheduledLambdaRequest'
        description: JSON Object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledLambdaResponse'
          description: scheduled lambda mapping updated successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Update a Scheduled Lambda mapping
      tags:
      - Scheduled Lambdas
      x-rename: update
  /v1/orgs/self/ws/{workspace}/views:
    get:
      description: Retrieve all views in a workspace.
      operationId: workspaceViews
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListViewsResponse'
          description: views retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: List Views in Workspace
      tags:
      - Views
    post:
      description: Create a view
      operationId: createView
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateViewRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateViewResponse'
          description: view created successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Create View
      tags:
      - Views
      x-rename: create
  /v1/orgs/self/ws/{workspace}/views/{view}:
    delete:
      description: Delete a view
      operationId: deleteView
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the view
        in: path
        name: view
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteViewResponse'
          description: view deleted successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Delete View
      tags:
      - Views
      x-rename: delete
    get:
      description: Get details about a view
      operationId: getView
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the view
        in: path
        name: view
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetViewResponse'
          description: view retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Retrieve View
      tags:
      - Views
      x-rename: get
    post:
      description: Update a view
      operationId: updateView
      parameters:
      - description: name of the workspace
        in: path
        name: workspace
        required: true
        schema:
          default: commons
          type: string
      - description: name of the view
        in: path
        name: view
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateViewRequest'
        description: JSON object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateViewResponse'
          description: view updated successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Update View
      tags:
      - Views
      x-rename: update
  /v1/public/shared_lambdas/{public_access_id}:
    post:
      description: Execute a public query lambda (full version).
      operationId: executePublicQueryLambdaWithParams
      parameters:
      - description: public access ID of the query lambda
        in: path
        name: public_access_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecutePublicQueryLambdaRequest'
        description: JSON object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponse'
          description: Query Lambda executed successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not allowed
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not acceptable
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: request timeout
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: conflict
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not supported
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: resource exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: internal error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not implemented
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: bad gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: not ready
      summary: Execute a Public Query Lambda
      tags:
      - Shared Lambdas
security:
- AuthorizationHeader: []
servers:
- url: https://api.{region}.rockset.com/
  variables:
    region:
      default: usw2a1
      enum:
      - usw2a1
      - use1a1
      - euc1a1
      - euw1a1
      - apt2a1
tags:
- name: Aliases
- name: API Keys
- name: Collections
- name: Custom Roles
- name: Deployment Settings
- name: Documents
- name: Integrations
- name: Organizations
- name: Queries
- name: Query Lambdas
- name: Scheduled Lambdas
- name: Shared Lambdas
- name: Sources
- name: Users
- name: Views
- name: Virtual Instances
- name: Workspaces