fork/cellxgene
1
0
Fork 0
mirror of https://github.com/chanzuckerberg/cellxgene.git synced 2026-09-25 19:38:12 +08:00
Code Issues Packages Projects Releases Wiki Activity

add current front-end dependencies to documentation (#328)

Browse Source 
Add current front-end dependencies to document, highlighting minimum required support for routes.
This commit is contained in:
Bruce Martin
2018-10-14 08:06:51 -07:00
committed by GitHub
parent dcb3f6e901
commit bf0154ada6
1 changed files with 28 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/REST_API.md
+28 -1
View File
@@ -1,6 +1,6 @@
# cellxgene REST API 0.2 specification
Items marked as (_future_) are intended for future implementation, and are included in the design to round out the concept, and highlight what we would do when/if we needed more functionality. The (_future_) items are not currently used by the cellxgene web application, and may be omitted from any backend.
Items marked as (_future_) are intended for future implementation, and are included in the design to round out the concept, and highlight what we would do when/if we needed more functionality. The (_future_) items are not currently used by the cellxgene web application, and may be omitted from any backend - see [Current Front-End Dependencies](#current-front-end-dependencies) for more details.
_Caveat emptor, partial spec_: this is a sketch for a spec, not a full spec, and some shortcuts have been taken in the authorship. Best practices for a REST API are assumed but not documented here, such as API versioning, reasonable choices for HTTP response codes, etc. In addition, for clarity the JSON examples will not always have all required quoting (eg, on keys) - the actual implementation should use legal JSON/CSV.
@@ -667,6 +667,33 @@ POST /data/saveSelection?name=myFavCluster
}
```
## Current Front-End Dependencies
The cellxgene web front-end currently uses the following routes & features.
Routes:
- `GET /config`
- `GET /schema`
- `GET /annotations/obs`
- `GET /annotations/var`
- `GET /layout/obs`
- `PUT /data/obs` - request will contain a filter by var `name`
- `POST /diffexp/obs` - mode `topN`, typically with a couple of 10, and two sets defined by an obs index filter (`{ filter: { obs: { index: [...] } } }`)
- `PUT /layout/obs` - (_coming soon_) request will contain a filter by obs index
Requests include the following content negotiation headers:
- `Accept: application/json` - CSV not currently used in any routes
- `Accept-Encoding: gzip, deflate, br`
Currently unused routes:
- `/data/var`
- `/cluster/*`
- `/layout/var`
- `/data/saveSelection`
<!-- Endnotes themselves at the bottom. -->
## Notes