default_dataset_schema.yaml

openapi: 3.0.2
servers: []
info:
  version: "draft.3"
  title: GA4GH Beacon Dataset Default Schema
  description: >-
    Schema for datasets to be used as default by the Beacon.
  contact:
    email: beacon@ga4gh.org
  license:
    name: Apache 2.0
    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
externalDocs:
  description: |
    Beacon Project
  url: 'http://beacon-project.io/'
paths: {}
components:
  schemas:
    DatasetDetail:
      description: |
        Description of the dataset.
      type: object
      properties:
        datasetId:
          description: |
            Dataset reference ID (internal ID)
          type: string
        datasetName:
          description: |
            Dataset name. Reference to source.
          type: string
          example:  
            - 'DECIPHER'
            - 'DisGenNET'
        datasetype:
          description: |
            Dataset type: variant-level (aggregated) or case-level
          type: string
          enum:
            - variant-level
            - case-level
          example:
            - 'variant-level (aggregated)'
            - 'case-level'