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

V4 FilterTermsResponseContent #25

Open
pabloalarconm opened this issue May 24, 2024 · 0 comments
Open

V4 FilterTermsResponseContent #25

pabloalarconm opened this issue May 24, 2024 · 0 comments
Assignees

Comments

@pabloalarconm
Copy link
Member

FilterTermsResponseContent:
  required:
    - filteringTerms
  properties:
    filteringTerms:
      $ref: "#/components/schemas/FilterTermsResponse"
    resources:
       $ref: "#/components/schemas/FilterTermsResourceResponse"

Based on the specification, only FilterTermsResponse is required, however when you check FilterTermsResourceResponse, id is required, breaking the chain of requirements in the specification.

FilterTermsResourceResponse:
  type: array
  description: |
    Description of an ontology resource defined externally to this beacon implementation, such as MeSH or EFO, based on the phenopackets resource object (https://phenopacket-schema.readthedocs.io/en/latest/resource.html)
  items:
    type: object
    required:
      - id
    properties:
      id:
        type: string
        description: |
          Preferably OBO ID representing the resource; alternatively a URI pointing towards the definitions may be used if not in OBO.

Also, the use of "resource" tagname in order to the name the CURIE syntax for the terms used, could led to confusion, they are not resources, only vocabulary and terminology, i would recommend to change the name to something like "vocabulary" or "terminology"

Bests!

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