University of Chicago datasets API

openapi: 3.0.0
info:
  title: Fence OpenAPI Specification admin/user datasets API
  version: 0.1.0
  description: Access management for Gen3 data commons. Code is available on [GitHub](https://github.com/uc-cdis/fence).
  termsOfService: http://cdis.uchicago.edu/terms/
  contact:
    email: cdis@uchicago.edu
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://example.domain/
tags:
- name: datasets
paths:
  /datasets:
    get:
      tags:
      - datasets
      summary: Get counts for nodes for each project
      parameters:
      - in: query
        name: nodes
        description: comma delimited nodes to get counts for
        schema:
          type: string
      responses:
        '200':
          description: node counts for each project
          content:
            application/json:
              schema:
                type: object
                example:
                  project__A:
                    case: 0
                    aliquot: 1
                  project_B:
                    case: 2
                    aliquot: 3
        '401':
          description: unauthorized request
        '400':
          description: invalid request
  /datasets/projects:
    get:
      tags:
      - datasets
      summary: Get high level information for all projects
      responses:
        '200':
          description: high level information for all projects
          content:
            application/json:
              schema:
                type: object
                properties:
                  projects:
                    type: array
                    items:
                      $ref: '#/components/schemas/Project'
                example:
                  projects:
                  - name: project_A
                    code: A_code
                    dbgap_accession_number: 123
        '401':
          description: unauthorized request
        '400':
          description: invalid request
components:
  schemas:
    Project:
      type: object
      properties:
        name:
          type: string
        code:
          type: string
        dbgap_accession_number:
          type: string
        description:
          type: string
        image_url:
          type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /oauth/authorize
          tokenUrl: /oauth/token
          scopes:
            user: generic user access