airr-community / airr-standards

AIRR Community Data Standards
https://docs.airr-community.org
Creative Commons Attribution 4.0 International
35 stars 23 forks source link

Improve API documentation for fields #624

Open bcorrie opened 2 years ago

bcorrie commented 2 years ago

A user has pointed out that our documentation for API query fields is not particular good. We don't actually have a list of fields that the user can use to query the API as the GDC docs do. https://docs.gdc.cancer.gov/API/Users_Guide/Appendix_A_Available_Fields/#projects-field-groups

For example:

The hierarchy is essentially below - where FIELD(Study) means any Field from the Study object. But the user has to figure this out from reading the spec I believe 8-(

study.FIELD(Study) subject.FIELD(Subject) subject.diagnosis.FIELD(Diagnosis) sample.FIELD(Sample) sample.FIELD(CellProcessing) sample.FIELD(NucleicAcidProcessing) sample.FIELD(SequencingRun) sample.pcr_target.FIELD(PCRTarget) sample.sequencing_files.FIELD(SequencingData) data_processing.FIELD(DataProcessing)

bcorrie commented 6 months ago

This is worth keeping as something to do, but we won't get there for v2.0.