mygene.info.openapi.v3

openapi: '3.0'
info:
  version: 3.0.0
  title: MyGene.info API (for test)
  description: >-
    MyGene.info provides simple-to-use REST web services to query/retrieve gene annotation data. 
    It supports all species with known genes and provides always up-to-date gene annotations (updated weekly).
    Learn more about [MyGene.info](http://mygene.info/).
  termsOfService: 'http://mygene.info/terms/'
  contact:
    name: Chunlei Wu
    x-role: responsible developer
    email: help@mygene.info
    x-id: 'http://orcid.org/0000-0002-2629-6124'
  x-maturity: production
  x-implementationLanguage: Python
externalDocs:
  description: Find more info here
  url: 'https://docs.mygene.info'
x-externalResources:
  - x-url: 'http://example.org/api/docs'
    x-type: api documentation
  - x-url: 'https://doi.org/10.1093/nar/gks1114'
    x-type: publication
    x-description: 'BioGPS and MyGene.info: organizing online, gene-centric information'
  - x-url: 'http://twitter.com/mygeneinfo'
    x-type: social media
servers:
  - url: 'http://mygene.info/{basePath}'
    description: Development server
    x-location: 'California, USA'
    variables:
      basePath: 
        default: v3
      port: {
          "enum": [
            '8443',
            '443'
          ],
          "default": '8443'
        }
tags:
  - x-id: 'http://purl.bioontology.org/ontology/MESH/D005796'
    name: Genes
components:
  schemas:
    Category:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    Tag:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
  parameters:
    skipParam:
      name: skip
      in: query
      description: number of items to skip
      required: true
      schema:
        type: integer
        format: int32
    limitParam:
      name: limit
      in: query
      description: max records to return
      required: true
      schema:
        type: integer
        format: int32
  responses:
    NotFound:
      description: Entity not found.
    IllegalInput:
      description: Illegal input for operation.
  securitySchemes:
    api_key:
      type: apiKey
      name: api_key
      in: header
    petstore_auth:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: 'http://example.org/api/oauth/dialog'
          scopes:
            'write:pets': modify genes in your account
            'read:pets': read your genes
paths:
  /query:
    get:
      tags:
        - query
      description: Makes gene query and returns matching gene list.
      summary: Makes gene query and returns matching gene list.
      x-accessRestriction: fee
      parameters:
        - name: q
          in: query
          description: >-
            Query string. Examples "CDK2", "NM_052827", "204639_at". The
            detailed query syntax can be found at
            http://docs.mygene.info/en/latest/doc/query_service.html
          required: true
          schema:
            type: string
          x-parameterType: InputParameter
          x-valueType:
            - 'http://identifiers.org/hgnc.symbol'
            - 'http://identifiers.org/refseq'
            - 'http://identifiers.org/unigene'
            - 'http://identifiers.org/uniprot'
            - 'http://identifiers.org/pdb'
      operationId: add operation id here
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              x-responseValueType:
                - path: a.id
                  valueType: 'http://example.org/a.id'
                - path: a.b.c.id
                  valueType: 'http://example.org/c.id'
  '/gene/{geneid}':
    get:
      tags:
        - gene
      parameters:
        - name: geneid
          in: path
          description: >-
            Entrez or Ensembl gene id, e.g., 1017, ENSG00000170248. A retired
            Entrez Gene id works too if it is replaced by a new one, e.g.,
            245794
          required: true
          x-parameterType: InputParameter
          x-valueType:
            - 'http://identifiers.org/ncbigene'
            - 'http://identifiers.org/ensembl'
          x-defaultValue: add default
          x-exampleValue: '1017'
      operationId: getAnnotation
      summary: add summary
      responses:
        '200':
          description: Successful response
          "content": {
    "application/json": {
      "schema": {
        "type": "array",
        "items": {
          "properties": {
                    "reporter": {
                      "properties": {
                        "HTA-2_0": {
                          "type": "string"
                        },
                        "HG-U133_Plus_2": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "HuGene-2_1": {
                          "type": "integer"
                        },
                        "HuGene-1_1": {
                          "type": "integer"
                        },
                        "HG-U95Av2": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "HuEx-1_0": {
                          "type": "integer"
                        }
                      },
                      "type": "object"
                 }
              }
           }
        }
      }
    }
          x-responseSchema: 'http://www.w3.org/ns/anno.jsonld'
          x-JSONLDContext: 'http://www.w3.org/ns/anno.jsonld'
          x-responseValueType:
            - path: ec
              valueType: 'http://identifiers.org/ec-code/'
            - path: ensembl.gene
              valueType: 'http://identifiers.org/ensembl/'
            - path: ensembl.translation.protein
              valueType: 'http://identifiers.org/ensembl/'
            - path: ensembl.translation.rna
              valueType: 'http://identifiers.org/ensembl/'
            - path: entrezgene
              valueType: 'http://identifiers.org/ncbigene/'
            - path: generif.pubmed
              valueType: 'http://identifiers.org/pubmed/'