Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 1.7 KB

api_specification.rst

File metadata and controls

44 lines (32 loc) · 1.7 KB

API Specification

The RNAget specification describes, at maximum, 18 API routes. These routes are subdivided into 4 groups according to the data type they serve. These routes, broken down by data type, are as follows:

  1. Projects: Serves project-related information. 3 Routes

    • /projects/:id
    • /projects
    • /projects/filters
  2. Studies: Serves study-related information. 3 Routes

    • /studies/:id
    • /studies
    • /studies/filters
  3. Expressions: Handles requests for querying, slicing, and downloading expression matrix data by gene name/id. 6 Routes

    • /expressions/formats
    • /expressions/filters
    • /expressions/:id/ticket
    • /expressions/:id/bytes
    • /expressions/ticket
    • /expressions/bytes
  4. Continuous: Handles requests for querying, slicing, and downloading expression matrix data by genomic coordinate. 6 Routes

    • /continuous/formats
    • /continuous/filters
    • /continuous/:id/ticket
    • /continuous/:id/bytes
    • /continuous/ticket
    • /continuous/bytes

Detailed descriptions of each route are available in the specification document.

Important points:

  • A server MAY implement all 18 API routes
  • A server MAY have unimplemented routes from the Expressions and/or Continuous data type groups. If a data type group is unimplemented, then ALL of the associated routes MUST be unplemented. In other words, a server MUST NOT implement only some routes for a data type group.