ireceptor-plus / issues

0 stars 0 forks source link

IPA info endpoint returns incomplete info object #6

Closed schristley closed 1 year ago

schristley commented 3 years ago
$ curl -k https://ipa1.ireceptor.org/airr/v1/info | jq
{
  "name": "airr-api-ireceptor",
  "version": "0.1.0",
  "last_update": "2020-04-22"
}

I guess version and last_update are correct. I think name probably should be title. While not mandatory, description and contact would be very useful for showing info about the repository in a GUI. Also api and schema are good to know what versions of the ADC API and AIRR Schema are provided by the service.

$ curl -k https://vdjserver.org/airr/v1/info | jq
{
  "title": "api-js-tapis",
  "description": "AIRR Data Commons API for VDJServer Community Data Portal",
  "version": "0.1.0",
  "contact": {
    "name": "VDJServer",
    "url": "http://vdjserver.org/",
    "email": "vdjserver@utsouthwestern.edu"
  },
  "license": {
    "name": "GNU AGPL V3"
  },
  "api": {
    "title": "AIRR Data Commons API",
    "version": "1.0.0",
    "contact": {
      "name": "AIRR Community",
      "url": "http://www.airr-community.org/",
      "email": "join@airr-community.org"
    },
    "description": "Major Version 1 of the Adaptive Immune Receptor Repertoire (AIRR) data repository web service application programming interface (API).\n",
    "license": {
      "name": "Creative Commons Attribution 4.0 International",
      "url": "https://creativecommons.org/licenses/by/4.0/"
    }
  },
  "schema": {
    "title": "AIRR Schema",
    "description": "Schema definitions for AIRR standards objects",
    "version": "1.3",
    "contact": {
      "name": "AIRR Community",
      "url": "https://github.com/airr-community"
    },
    "license": {
      "name": "Creative Commons Attribution 4.0 International",
      "url": "https://creativecommons.org/licenses/by/4.0/"
    }
  },
  "max_size": 1000,
  "max_query_size": 2097152
}
bcorrie commented 3 years ago

@bzimonja can you have a look at this? We should at least have contact info about iReceptor I suspect.

bzimonja commented 3 years ago

Will do! Can we hash out what return values we want? I think this can be added to the database for more flexibility, or maybe a config file - I'm not quite sure which would be more appropriate. Last update belongs to the database, but version number maybe not...

bcorrie commented 3 years ago

For api and schema we can steal what @schristley has, as we are running the same AIRR API and schema.

Contact: iReceptor, www.ireceptor.org, support@ireceptor.org Version: I think we should be 3.0 as that maps to the correct branch Leave the name as is but change to "title" as per the spec Description: "iReceptor AIRR Data Commons API" License: LGPL-3.0 License

What do you think?

schristley commented 1 year ago

done