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

Change beaconFilterinTermsResults type to enum #77

Closed
SergiAguilo opened this issue Apr 26, 2023 · 3 comments
Closed

Change beaconFilterinTermsResults type to enum #77

SergiAguilo opened this issue Apr 26, 2023 · 3 comments

Comments

@SergiAguilo
Copy link

In the beaconFilteringTermsResults.json the "type" property of the FilteringTerm is ambiguous as it only requires an string.

I suggest to enumerate the three types of filtering terms to constrain the property.

Currently, the property is the following:

"type":{
    "description": "Either \"custom\", \"alphanumeric\" or ontology/terminology full name. TODO: An ontology ... with a registered prefix does not need a full name so one may better use CURIE to indicate that the resource can be retrieved from the id. This also will allow to provide an enum here.",
    "examples": [
        "Human Phenotype Ontology",
        "alphanumeric"
    ],
    "type": "string"
}

My suggestion is:

"type":{
    "description": "Either \"custom\", \"alphanumeric\" or \"ontology\" .",
    "enum": [
        "custom",
        "alphanumeric",
        "ontology"
    ]
    "example": "alphanumeric",
    "type": "string"
}

The "custom" type already includes any other type of filters. This enumeration will help to standardize the filters endpoint in the different instances of Beacon, specially when gathering them in the Beacon Network.

@costero-e
Copy link
Collaborator

+1 to this @SergiAguilo

@mbaudis
Copy link
Member

mbaudis commented Apr 27, 2023

+1

@costero-e
Copy link
Collaborator

I addressed this issue by creating this new PR #90 . @SergiAguilo I couldn't add you as reviewer because I couldn't tag you, so I added @redmitry instead

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants