bio2rdf-openapi.yaml

openapi: 3.0.0
info:
  title: Bio2RDF
  description: Bio2RDF is an open source project to generate and provide linked data for the life sciences.
  termsOfService: https://github.com/bio2rdf/bio2rdf-scripts/wiki/Terms-of-use
  license:
    name: MIT License
    url: https://github.com/bio2rdf/bio2rdf-scripts/blob/master/MIT-LICENSE.txt
  contact: 
    name: Michel Dumontier
    email: michel.dumontier@gmail.com
    x-role: responsible developer
    x-id: https://orcid.org/0000-0003-4727-9435
  version: 1.0.0  
  x-implementationLanguage: PHP
  x-accessRestriction: none
x-externalResources:
  - x-url: http://bio2rdf.org
    x-description: Main website
    x-type: website
  - x-url: https://github.com/bio2rdf/bio2rdf-scripts/wiki
    x-description: github repository
    x-type: api documentation
servers:
  - url: http://bio2rdf.org
    description: Bio2RDF Production server
    x-location: Maastricht, Netherlands
    x-maturity: production
  - url: https://bio2rdf.org
    description: Bio2RDF Production server
    x-location: Maastricht, Netherlands
    x-maturity: production
  - url: https://openlifedata.org
paths:
  /{prefix}:{identifier}:
    parameters:
      - name: prefix
        in: path
        description: a valid prefix (see http://prefixcommons.org)
        schema:
          type: string
          example: drugbank
        required: true
      - name: identifier
        in: path
        description: a valid identifier for the resource
        schema:
          type: string
          example: DB00001
        required: true
    
    get:
      operationId: getItem
      summary: Retrieve entity by prefixed identifier
      responses:
        '200':
          description: a representation of the entity
          content:
            'text/plain': {}
            'text/turtle': {}
            'text/csv': {}
            'text/tab-separated-values': {}
            'application/ld+json': {}
            'application/rdf+json': {}
            'application/rdf+xml': {}
            'application/sparql-results+json': {}
            'application/sparql-results+xml': {}

  /sparql:
    parameters:
      - name: query
        in: query
        description: A valid SPARQL query
        schema:
          type: string
        required: true
      - name: maxrows
        in: query
        description: Limits the number of results returned by the endpoint. Use OFFSET and LIMIT in your query to paginate through results. (Minimum 1, Maximum 10,000)
        required: true
        schema:
            type: integer
            minimum: 1
            maximum: 10000
            default: 1000    
    get:
      operationId: query
      summary: Perform a SPARQL query.
      responses:
        '200':
          description: SPARQL query result
          content:
            'application/sparql-results+xml': {}
            'application/sparql-results+json': {}
    post:
      operationId: postQuery
      summary: Perform a SPARQL query
      responses:
        '200':
          description: SPARQL query result
          content:
            'application/sparql-results+xml': {}
            'application/sparql-results+json': {}