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

Additions and clarifications to ADC API documention #628

Closed bussec closed 6 months ago

javh commented 10 months ago

From the call:

bussec commented 8 months ago

From the call: Tabled, @bussec still has to review.

bcorrie commented 8 months ago

I have added a bunch of fixes/updates so that the API docs are consistent across all API endpoints. This included some consistency fixes to the adc_query_support x-airr attribute and the creation of related tables in the adc_api_limits document.

bcorrie commented 8 months ago

The adc_query_support changes in the spec for Receptor and ReceptorReactivity were done on #705 because that is where the current final version of those object's fields are defined.

bcorrie commented 6 months ago

Fixes #661

bcorrie commented 6 months ago

I believe #661 is fixed

bcorrie commented 6 months ago

I believe #623 is fixed

bcorrie commented 6 months ago

I believe fixes related to #705 are fixed

bcorrie commented 6 months ago

@bussec I think this looks good. Any chance you could weave your github mastery to resolve the conflicts? The conflicts are because we split adc_api.rst into multiple files.

If I don't get a thumbs up from you in a few days I will attempt it - no worries - I just think you will probably be able to do it more quickly 8-)

bcorrie commented 6 months ago

We will still need to do Receptor and CellReactivity changes a bit, after #705 is finished, but I don't think we need to wait this for those changes to be finalized.

bcorrie commented 6 months ago

@bussec I am working on resolving conflicts...

bcorrie commented 6 months ago

@bussec on second hand maybe you could... I don't like the squash/merge model I don't want to mess things up... The conflicts look minor but the changed files that it is showing when I try to merge are substantial so not what I would expect.

bcorrie commented 6 months ago

OK, I am tackling the merge again @bussec

bcorrie commented 6 months ago

OK, I think this is done, I will merge early next week unless issues are raised...

bussec commented 6 months ago

Besides the comment above looks good to me, changes regarding the decision to remove ReceptorReactivity will be handled in #705 . I can take a stab at the merge conflicts.

bcorrie commented 6 months ago

@bussec how many PhD's does it take to resolve a merge conflict... 8-)

I figured it out 8-)