search

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

Make ADC V1.2 release #579

Closed schristley closed 2 years ago

schristley commented 2 years ago

We need to decide what we want to put in the ADC V1.2 release. This issue is to keep track of all of the decisions we make as we need to decide what AIRR Schema version and what entry points to support. These decisions might imply additional tasks to be performed with the release.

schristley commented 2 years ago

AIRR Schema V1.4 or V1.3?

This is important because it implies additional tasks we need to consider. With V1.4, we can include new entry points for the new draft AIRR objects, but this also implies that we have significant schema changes that will affect queries. The queries for V1.3 schema will not necessarily work against V1.4 schema. Will clients be required to support both V1.3 and V1.4 schemas? In theory, this is possible, because the info endpoint indicates the schema version, and the client could adjust queries appropriately.

If we stick with V1.3, this simplifies many things, and we can release the ADC API V1.1 before waiting for the V1.4 schema to be finished, but it also means we cannot take advantage of the new stuff in V1.4.

schristley commented 2 years ago

A newer VDJServer ADC API service is based upon the OpenAPI V3 spec, and also has the async API. In order to do this properly, I needed to backport the changes to the ADC API V1 and V1.3 schema, so #570 is to make a V1.3.2 release with those changes.

schristley commented 2 years ago

Actually, looking back at the tags, we sorta already made a V1.1 release with Schema V1.3.1, as the clone object and entry point was added, though documentation was never added. So I guess this should be V1.2 or stick with V1.1?

bcorrie commented 2 years ago

I would go with v1.2. And it should probably be linked to v1.4 of the schema since we have API v1.1 -> Spec v1.3.1?

schristley commented 2 years ago

I would go with v1.2. And it should probably be linked to v1.4 of the schema since we have API v1.1 -> Spec v1.3.1?

That seems reasonable. I'm thinking the openapiv3 and async API will be V1.1.1 then.

What do you think about using ADC specific tags for the repository (e.g. adc-v1.0.0, adc-v1.1.0, etc)? These are primarily convenience, but it does let us (and users) track changes a bit easier versus having to remember the associated schema version.

schristley commented 2 years ago

I've made a separate issue #583 for V1.1 release and changed this to be V1.2. I've also removed the items about OpenAPI V3 and the Async API as they will be in V1.1 release

bcorrie commented 2 years ago

For endpoints in the current spec on master we have added:

/clone /cell /expression

bcorrie commented 2 years ago

@schristley WRT new operators/parameters - I don't believe we have any other than what is in the spec - new fields from v1.4 of course, but nothing other than that?

Unless perhaps you are talking about the adc_ fields?

bcorrie commented 2 years ago

Created #605 for documentation.

bcorrie commented 2 years ago

@bussec any comment on this.

bussec commented 2 years ago

@bcorrie Hoping that we can merge #404 rather soon, so including a /receptor endpoint would be good.

bcorrie commented 2 years ago

@bussec I thought Receptor was a v2.0 release (not v1.4). The ADC v1.2 API is in sync with the v1.4 release, with endpoints for the objects in the v1.4 release.

So based on that, we would not have a /receptor endpoint in ADC v1.2 API.

schristley commented 2 years ago

WRT new operators/parameters - I don't believe we have any other than what is in the spec - new fields from v1.4 of course, but nothing other than that?

No new operators/parameters that I'm aware of.

bcorrie commented 2 years ago

In discussions with @bussec (see #404) I think we can add the /receptor endpoint, assuming it is merged in to the v1.4 AIRR Spec.

bcorrie commented 2 years ago

WRT new operators/parameters - I don't believe we have any other than what is in the spec - new fields from v1.4 of course, but nothing other than that?

No new operators/parameters that I'm aware of.

Checked off Task 3 above.

bcorrie commented 2 years ago

Checked off Task 4 - through #605

bcorrie commented 2 years ago

@schristley any objection to marking this issue as closed - as Task 5 above is subsumed by #607 - and this can't be completed until we have a v1.4 version of the Spec tagged. But we don't need both open...

bcorrie commented 2 years ago

Closing - need to resolve #612 once we have a v1.4 tag, but the tasks here are done