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

Bioschemas descriptions missing #649

Open
23 tasks
ljgarcia opened this issue May 19, 2023 · 5 comments
Open
23 tasks

Bioschemas descriptions missing #649

ljgarcia opened this issue May 19, 2023 · 5 comments
Assignees

Comments

@ljgarcia
Copy link
Contributor

ljgarcia commented May 19, 2023

@gtsueng @nsjuty you worked on the addition of sameAs, right? The Bioschemas descriptions got lost in the process, we need them back.

Affected drafts:

  • ChemicalSubstance
  • ComputationalTool
  • ComputationalWorkflow
  • Course
    • also check range of coursePrerequisites
  • CourseInstance
    • also check range of offers
  • DataCatalog
  • Dataset
  • Disease
  • FormalParameter
  • Gene
  • Journal
  • LabProtocol
  • Phenotype (possibly going to deprecation)
  • ProteinStructure
  • PublicationIssue
  • PublicationVolume
  • Sample
  • ScholarlyArticle
  • SemanticTextAnnotation (possibly going to deprecation)
  • Study (possibly going to deprecation)
  • TrainingMaterial
@gtsueng
Copy link
Contributor

gtsueng commented May 22, 2023

@ljgarcia I can add them using the schema.org property 'disambiguatingDescription' in the jsonschema validation for profiles. Should I increase the version number for this fix? @albangaignard may need to update the profile generation script for it to actually display on the webpages

@ljgarcia
Copy link
Contributor Author

Hi @gtsueng sounds good. It is a mistake that they were taken off so I would not increase the version.
@albangaignard please check that the profile generation GitHub action takes care of this.

@gtsueng
Copy link
Contributor

gtsueng commented Jun 8, 2023

@ljgarcia The $validation portion of the JSON file (where the disambiguatingDescription is to be added) follows JSON schema formatting. Although we can add descriptors like schema:disambiguatingDescription here for our purposes, be aware that most JSON-schema validators will simply ignore these descriptors. Third party tools for viewing JSON schema (including the DDE) may also ignore these descriptors in effect hiding the bioschemas description. To bypass this, we originally went with simply merging the Bioschemas description into the schema.org description for the JSON Schema description field. That's why they appear to be missing for many files, but upon closer inspection the Bioschemas descriptions are there, just no longer delineated.

@ljgarcia
Copy link
Contributor Author

@nsjuty @albangaignard @ivanmicetic @sneumann @egonw thoughts? I would be in favor of keeping the Bioschemas description separated from the original schema description. So schema:disambiguatingDescription looks good to me even if it is ignored by validators... I am not even sure what a validator would do with the property description or disambiguating description.

@nsjuty
Copy link
Contributor

nsjuty commented Feb 26, 2024

It would be good to at least reference the original schema.org description. I think the shortest answer would be to keep the Bioschemas description and point back to the schema.org one? Whether thats in the "description" or in the disambiguation, I don't mind actually. I aslo would not increase version number here..

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