-
CCF API
- Production: https://ccf-api.hubmapconsortium.org
- Staging: https://ccf-api--staging.herokuapp.com
- OpenAPI Specification: ccf-api-spec.yaml
-
CCF API Client Libraries:
- JavaScript:
@ccf-openapi/js-client
- TypeScript:
@ccf-openapi/ts-client
- Angular 12+:
@ccf-openapi/ng-client
- Python 3.6+:
ccf-openapi
- JavaScript:
Deliverable or Milestone | Due Date | Status | Links |
---|---|---|---|
1.2.1.1 Develop an OpenAPI specification (CCF-API) to be implemented on both HuBMAP and GTEx clouds for data interoperability when used from HuBMAP Exploration User Interface (EUI) or other compatible CCF-API clients (Joint) | 12/21/2022 | Complete | spec |
1.2.1.2 Extend CCF to capture Anatomical Structures, Cell Types, plus Biomarkers (ASCT+B) information in GTEx anatomogram data (IU) | 12/31/2022 | Complete | dashboard |
1.2.1.3 Spatially register GTEx tissue samples that currently overlap with HuBMAP using the CCF Registration User Interface (RUI) (Joint) | 12/31/2022 | Complete | demo1 demo2 production |
1.2.2.1 Implement and deploy the FAIR CCF-API for HuBMAP data in the HuBMAP cloud (IU) | 12/31/2022 | Complete | live API code |
1.2.2.2 Validate CCF ASCT+B tables using GTEx RNA and snRNAseq data and revising the tables as needed (Joint) | 3/31/2022 | Complete | |
1.2.3.1 Implement CCF-API client libraries in Python and JavaScript for use in most cloud workspaces (IU) | 3/31/2022 | Complete | See above |
1.2.3.2 Deploy EUI as a web component compatible with most cloud workspaces (IU) | 3/31/2022 | Complete | demo gtex portal |
1.2.3.3 Demonstrate cross-search capabilities for ASCT+B data in support of increased interoperability of GTEx and HuBMAP data (GTEx) | 3/31/2022 | Complete | demo |
1.2.4.1 Publish documentation for the CCF-API, data querying from cloud workspaces, and EUI integration into portals/cloud workspaces (IU) | 6/30/2022 | Complete | API docs |
1.2.4.2 Develop a video tutorial and training module to be hosted on the GTEx portal to help users find and interact with the data on the HuBMAP EUI and for inclusion in an online course (Joint) | 6/30/2022 | Complete | video |