search

ga4gh-beacon / specification-v2

GA4GH Beacon v2 specification.
Apache License 2.0
3 stars 6 forks source link

Add /access_levels endpoint #14

Closed sdelatorrep closed 3 years ago

sdelatorrep commented 4 years ago

This endpoint should describe the access level (public, registered, controlled) for each field and if something is not supported in this Beacon. Something similar to:

{
  "id": "demo-beacon",
  "name": "Demo Beacon",
  "apiVersion": "2.0.0",
  "fields": {
    "beacon": "PUBLIC",
    "beaconOrganization": "PUBLIC",
    "beaconDataset": "PUBLIC",
    "beaconAlleleRequest": "PUBLIC",
    "beaconAlleleResponse": "PUBLIC",
    "datasetAlleleResponse": "PUBLIC",
    "beaconError": "PUBLIC",
    "dataUseConditions": "NOT_SUPPORTED",
    "consentCodeDataUse": "NOT_SUPPORTED",
    "consentCodeCategory": "NOT_SUPPORTED",
    "beaconHandover": "PUBLIC",
    "datasetHandover": "PUBLIC",
    "resultsHandover": "PUBLIC",
    "handoverType": "PUBLIC",
    "beaconGenomicSnpRequest": "PUBLIC",
    "beaconGenomicSnpResponse": "PUBLIC",
    "beaconGenomicRegionRequest": "PUBLIC",
    "beaconGenomicRegionResponse": "PUBLIC",
    "variant": "PUBLIC",
    "variantHandover": "PUBLIC"
  },
  "datasets": {
    "EGAD112233": "PUBLIC"
  }
}
jrambla commented 3 years ago

We need to figure out a mechanism that includes the alternative schemas.

jrambla commented 3 years ago

Referenced in https://github.com/ga4gh-beacon/beacon-framework-v2/issues/5