Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ADC API V2.1 extensions #550

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

ADC API V2.1 extensions #550

wants to merge 1 commit into from

Conversation

schristley
Copy link
Member

@schristley schristley commented Sep 16, 2021

  • add distinct operator for /repertoire and maybe others
  • add isa operator for /repertoire and maybe others

@schristley schristley added the ADC API V2 AIRR Data Commons API V2 label Sep 16, 2021
@schristley schristley added this to the AIRR v2.0.0 milestone Sep 16, 2021
@javh javh modified the milestones: AIRR 2.0, ADC 2.0 Oct 16, 2023
@bcorrie bcorrie modified the milestones: ADC 2.0, AIRR 2.0 Feb 8, 2024
@bcorrie
Copy link
Contributor

bcorrie commented Feb 8, 2024

@schristley can you elaborate a bit on what you see these operators doing.

I believe I understand isa but I also think it only has limited applicability for AIRR ontology fields. Would that be correct?

Can you elaborate on distinct?

@schristley
Copy link
Member Author

@schristley can you elaborate a bit on what you see these operators doing.

I believe I understand isa but I also think it only has limited applicability for AIRR ontology fields. Would that be correct?

Correct, only applies to fields that are ontology-backed otherwise is a query error.

Can you elaborate on distinct?

Thinking like the distinct operator in SQL or Mongo, which collapses the values to uniques and eliminates duplicates. I guess this wouldn't be an operator like = which is in the filter but would be more like facets. So for example, something like this on the /repertoire endpoint would return all of the unique subjects.

{ "distinct": ["repertoire_id", "subject.subject_id"] }

or this which would return all of the unique diagnoses

{ "distinct": ["subject.diagnosis.diseases_diagnosis.id"] }

As with facets, you could still have a query filter to restrict to a subset of data.

Would you dare to do something like this on the /rearrangement endpoint? ;-D

{ "distinct": ["junction_aa"] }

@bcorrie
Copy link
Contributor

bcorrie commented Feb 20, 2024

Changed this to v2.1 change to the ADC API

@bcorrie bcorrie modified the milestones: ADC 2.0, ADC 2.1 Feb 20, 2024
@bcorrie bcorrie removed the AIRRv2.0 label Feb 20, 2024
@bcorrie bcorrie changed the title ADC API V2 ADC API V2.1 extensions Aug 12, 2024
@bcorrie bcorrie added ADC API v2.1 Issues related to v2.1 release of ADC API and removed ADC API V2 AIRR Data Commons API V2 labels Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ADC API v2.1 Issues related to v2.1 release of ADC API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants