CubeNexus Inc Datasets API

openapi: 3.2.0
info:
  title: Fast Datasets API
  version: 0.1.0
tags:
- name: Datasets
paths:
  /datasets:
    get:
      summary: Get Datasets
      operationId: get_datasets_datasets_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: customer_slug
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Customer Slug
      - name: include_counts
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Include Counts
      - name: schema
        in: query
        required: false
        schema:
          type: string
          description: grains | features
          default: grains
          title: Schema
        description: grains | features
      - name: mode
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: '''tags'' for the tag-driven listing'
          title: Mode
        description: '''tags'' for the tag-driven listing'
      - name: X-Customer-Slug
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Customer-Slug
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Datasets
  /datasets/{dataset_id}:
    put:
      summary: Put Dataset
      operationId: put_dataset_datasets__dataset_id__put
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: dataset_id
        in: path
        required: true
        schema:
          type: string
          title: Dataset Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              title: Body
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Datasets
  /datasets/shared:
    get:
      summary: Get Shared Datasets
      description: 'Datasets other people have shared that this user may see.


        AUTHENTICATED, unlike `/datasets/public` below. That endpoint has no auth dependency

        and lists CubeNexus''s own curated catalogue; a user marking their lease map "public"

        is asking to share it with CubeNexus users, not to publish it to the open internet.

        Keeping the two paths separate is what preserves that distinction - user-published

        rows never appear on the unauthenticated one.


        Excludes the caller''s own datasets: those already come from `GET /datasets`, and

        listing them twice would make a user''s own upload look like something shared with

        them.'
      operationId: get_shared_datasets_datasets_shared_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - OAuth2PasswordBearer: []
      tags:
      - Datasets
  /datasets/access-levels:
    get:
      summary: Get Access Levels
      description: The sharing options and their labels, so the UI need not hardcode them.
      operationId: get_access_levels_datasets_access_levels_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Datasets
  /datasets/public:
    get:
      summary: Get Public Datasets
      operationId: get_public_datasets_datasets_public_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Datasets
  /datasets/cubenexus/all:
    get:
      summary: Get All Cubenexus Datasets
      operationId: get_all_cubenexus_datasets_datasets_cubenexus_all_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - OAuth2PasswordBearer: []
      tags:
      - Datasets
  /datasets/{dataset_id}/transfer:
    post:
      summary: Transfer Dataset To Cubenexus
      operationId: transfer_dataset_to_cubenexus_datasets__dataset_id__transfer_post
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: dataset_id
        in: path
        required: true
        schema:
          type: string
          title: Dataset Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Datasets
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: login