GET /api/?format=api
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/vnd.oai.openapi
Vary: Accept

openapi: 3.0.2
info:
  title: HuBMAP cell indexing
  version: 0.1-dev
paths:
  /api/status/:
    get:
      operationId: listStatusViewSets
      description: ''
      parameters:
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    example: 123
                  next:
                    type: string
                    nullable: true
                    format: uri
                    example: http://api.example.org/accounts/?page=4
                  previous:
                    type: string
                    nullable: true
                    format: uri
                    example: http://api.example.org/accounts/?page=2
                  results:
                    type: array
                    items: {}
          description: ''
      tags:
      - api
  /api/gene/:
    post:
      operationId: createQueryViewSet
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema: {}
          application/x-www-form-urlencoded:
            schema: {}
          multipart/form-data:
            schema: {}
      responses:
        '201':
          content:
            application/json:
              schema: {}
          description: ''
      tags:
      - api
  /api/cell/:
    post:
      operationId: createQueryViewSet
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema: {}
          application/x-www-form-urlencoded:
            schema: {}
          multipart/form-data:
            schema: {}
      responses:
        '201':
          content:
            application/json:
              schema: {}
          description: ''
      tags:
      - api
  /api/organ/:
    post:
      operationId: createQueryViewSet
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema: {}
          application/x-www-form-urlencoded:
            schema: {}
          multipart/form-data:
            schema: {}
      responses:
        '201':
          content:
            application/json:
              schema: {}
          description: ''
      tags:
      - api
  /api/protein/:
    post:
      operationId: createQueryViewSet
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema: {}
          application/x-www-form-urlencoded:
            schema: {}
          multipart/form-data:
            schema: {}
      responses:
        '201':
          content:
            application/json:
              schema: {}
          description: ''
      tags:
      - api
  /api/cluster/:
    post:
      operationId: createQueryViewSet
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema: {}
          application/x-www-form-urlencoded:
            schema: {}
          multipart/form-data:
            schema: {}
      responses:
        '201':
          content:
            application/json:
              schema: {}
          description: ''
      tags:
      - api
  /api/dataset/:
    post:
      operationId: createQueryViewSet
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema: {}
          application/x-www-form-urlencoded:
            schema: {}
          multipart/form-data:
            schema: {}
      responses:
        '201':
          content:
            application/json:
              schema: {}
          description: ''
      tags:
      - api
  /api/celltype/:
    post:
      operationId: createQueryViewSet
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema: {}
          application/x-www-form-urlencoded:
            schema: {}
          multipart/form-data:
            schema: {}
      responses:
        '201':
          content:
            application/json:
              schema: {}
          description: ''
      tags:
      - api
  /api/difference/:
    post:
      operationId: createOperationViewSet
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema: {}
          application/x-www-form-urlencoded:
            schema: {}
          multipart/form-data:
            schema: {}
      responses:
        '201':
          content:
            application/json:
              schema: {}
          description: ''
      tags:
      - api
  /api/union/:
    post:
      operationId: createOperationViewSet
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema: {}
          application/x-www-form-urlencoded:
            schema: {}
          multipart/form-data:
            schema: {}
      responses:
        '201':
          content:
            application/json:
              schema: {}
          description: ''
      tags:
      - api
  /api/intersection/:
    post:
      operationId: createOperationViewSet
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema: {}
          application/x-www-form-urlencoded:
            schema: {}
          multipart/form-data:
            schema: {}
      responses:
        '201':
          content:
            application/json:
              schema: {}
          description: ''
      tags:
      - api
  /api/count/:
    post:
      operationId: createSetCountViewSet
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema: {}
          application/x-www-form-urlencoded:
            schema: {}
          multipart/form-data:
            schema: {}
      responses:
        '201':
          content:
            application/json:
              schema: {}
          description: ''
      tags:
      - api
  /api/mean/:
    post:
      operationId: createStatisticViewSet
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema: {}
          application/x-www-form-urlencoded:
            schema: {}
          multipart/form-data:
            schema: {}
      responses:
        '201':
          content:
            application/json:
              schema: {}
          description: ''
      tags:
      - api
  /api/min/:
    post:
      operationId: createStatisticViewSet
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema: {}
          application/x-www-form-urlencoded:
            schema: {}
          multipart/form-data:
            schema: {}
      responses:
        '201':
          content:
            application/json:
              schema: {}
          description: ''
      tags:
      - api
  /api/max/:
    post:
      operationId: createStatisticViewSet
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema: {}
          application/x-www-form-urlencoded:
            schema: {}
          multipart/form-data:
            schema: {}
      responses:
        '201':
          content:
            application/json:
              schema: {}
          description: ''
      tags:
      - api
  /api/stddev/:
    post:
      operationId: createStatisticViewSet
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema: {}
          application/x-www-form-urlencoded:
            schema: {}
          multipart/form-data:
            schema: {}
      responses:
        '201':
          content:
            application/json:
              schema: {}
          description: ''
      tags:
      - api
  /api/cellevaluation/:
    post:
      operationId: createCell
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Cell'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Cell'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Cell'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cell'
          description: ''
      tags:
      - api
  /api/celltypeevaluation/:
    post:
      operationId: createCellType
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CellType'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CellType'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CellType'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CellType'
          description: ''
      tags:
      - api
  /api/geneevaluation/:
    post:
      operationId: createGene
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Gene'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Gene'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Gene'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Gene'
          description: ''
      tags:
      - api
  /api/organevaluation/:
    post:
      operationId: createOrgan
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Organ'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Organ'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Organ'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organ'
          description: ''
      tags:
      - api
  /api/clusterevaluation/:
    post:
      operationId: createCluster
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Cluster'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Cluster'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Cluster'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
          description: ''
      tags:
      - api
  /api/datasetevaluation/:
    post:
      operationId: createDataset
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dataset'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dataset'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Dataset'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dataset'
          description: ''
      tags:
      - api
  /api/proteinevaluation/:
    post:
      operationId: createProtein
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Protein'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Protein'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Protein'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Protein'
          description: ''
      tags:
      - api
  /api/celldetailevaluation/:
    post:
      operationId: createCellAndValues
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CellAndValues'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CellAndValues'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CellAndValues'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CellAndValues'
          description: ''
      tags:
      - api
  /api/celltypedetailevaluation/:
    post:
      operationId: createCellType
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CellType'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CellType'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CellType'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CellType'
          description: ''
      tags:
      - api
  /api/genedetailevaluation/:
    post:
      operationId: createGene
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GeneAndValues'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/GeneAndValues'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/GeneAndValues'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneAndValues'
          description: ''
      tags:
      - api
  /api/organdetailevaluation/:
    post:
      operationId: createOrgan
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganAndValues'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/OrganAndValues'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/OrganAndValues'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganAndValues'
          description: ''
      tags:
      - api
  /api/clusterdetailevaluation/:
    post:
      operationId: createCluster
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClusterAndValues'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ClusterAndValues'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ClusterAndValues'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterAndValues'
          description: ''
      tags:
      - api
  /api/datasetdetailevaluation/:
    post:
      operationId: createDataset
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatasetAndValues'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DatasetAndValues'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DatasetAndValues'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetAndValues'
          description: ''
      tags:
      - api
  /api/proteindetailevaluation/:
    post:
      operationId: createProtein
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Protein'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Protein'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Protein'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Protein'
          description: ''
      tags:
      - api
  /api/bounds/:
    post:
      operationId: createValueBoundsViewSet
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema: {}
          application/x-www-form-urlencoded:
            schema: {}
          multipart/form-data:
            schema: {}
      responses:
        '201':
          content:
            application/json:
              schema: {}
          description: ''
      tags:
      - api
components:
  schemas:
    Cell:
      type: object
      properties:
        cell_id:
          type: string
          nullable: true
          maxLength: 128
        modality:
          type: string
          readOnly: true
        dataset:
          type: string
          readOnly: true
        organ:
          type: string
          readOnly: true
        cell_type:
          type: string
          readOnly: true
        clusters:
          type: string
          readOnly: true
    CellType:
      type: object
      properties:
        grouping_name:
          type: string
          nullable: true
          maxLength: 64
    Gene:
      type: object
      properties:
        gene_symbol:
          type: string
          maxLength: 64
        go_terms:
          type: array
          items:
            type: string
          nullable: true
        summary:
          type: object
      required:
      - gene_symbol
      - summary
    Organ:
      type: object
      properties:
        grouping_name:
          type: string
          nullable: true
          maxLength: 64
    Cluster:
      type: object
      properties:
        cluster_method:
          type: string
          maxLength: 16
        cluster_data:
          type: string
          maxLength: 16
        grouping_name:
          type: string
          nullable: true
          maxLength: 64
        dataset:
          type: string
          readOnly: true
      required:
      - cluster_method
      - cluster_data
    Dataset:
      type: object
      properties:
        uuid:
          type: string
          maxLength: 32
        annotation_metadata:
          type: object
      required:
      - uuid
      - annotation_metadata
    Protein:
      type: object
      properties:
        protein_id:
          type: string
          maxLength: 32
        go_terms:
          type: array
          items:
            type: string
          nullable: true
        summary:
          type: object
      required:
      - protein_id
      - summary
    CellAndValues:
      type: object
      properties:
        cell_id:
          type: string
          nullable: true
          maxLength: 128
        modality:
          type: string
          readOnly: true
        dataset:
          type: string
          readOnly: true
        organ:
          type: string
          readOnly: true
        cell_type:
          type: string
          readOnly: true
        clusters:
          type: string
          readOnly: true
        values:
          type: string
          readOnly: true
    GeneAndValues:
      type: object
      properties:
        gene_symbol:
          type: string
          maxLength: 64
        go_terms:
          type: array
          items:
            type: string
          nullable: true
        summary:
          type: object
        values:
          type: string
          readOnly: true
      required:
      - gene_symbol
      - summary
    OrganAndValues:
      type: object
      properties:
        grouping_name:
          type: string
          nullable: true
          maxLength: 64
        values:
          type: string
          readOnly: true
    ClusterAndValues:
      type: object
      properties:
        cluster_method:
          type: string
          maxLength: 16
        cluster_data:
          type: string
          maxLength: 16
        grouping_name:
          type: string
          nullable: true
          maxLength: 64
        dataset:
          type: string
          readOnly: true
        values:
          type: string
          readOnly: true
      required:
      - cluster_method
      - cluster_data
    DatasetAndValues:
      type: object
      properties:
        uuid:
          type: string
          maxLength: 32
        annotation_metadata:
          type: object
        values:
          type: string
          readOnly: true
      required:
      - uuid
      - annotation_metadata