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

Psych-DS and JSON-LD/Schema.org validation should be separate #27

Open
bleonar5 opened this issue Sep 14, 2023 · 1 comment
Open

Psych-DS and JSON-LD/Schema.org validation should be separate #27

bleonar5 opened this issue Sep 14, 2023 · 1 comment
Assignees
Labels
Scoping Discussion regarding the scope, design, and features of the Psych-DS validator Validation for issues concerning the validation process, and how it is implemented algorithmically

Comments

@bleonar5
Copy link
Contributor

TL;DR

We propose to create separate, self-contained functions for validation psych-DS vs JSON-LD/Schema.org criteria.

Detailed View

In order to ensure that our system is sufficiently modular and extensible, we propose that psych-DS and JSON-LD/Schema.org criteria should be validated by separate, self contained components. Part of the reasoning for this is that we predict that changes could arise in either set of criteria at any point, and that these changes will arise independently, since the two standards are managed by different organizations, and so it would make sense to separate the structures in which those criteria are stored/referenced by the app. Naturally, our goal will be to integrate the modules to the maximum extent possible, sharing as much schema-agnostic functionality and architecture as possible.

@bleonar5 bleonar5 added Scoping Discussion regarding the scope, design, and features of the Psych-DS validator Validation for issues concerning the validation process, and how it is implemented algorithmically labels Sep 14, 2023
@bleonar5 bleonar5 self-assigned this Sep 14, 2023
@mekline
Copy link
Collaborator

mekline commented Sep 14, 2023

Another point: the rules that Psych-DS metadata enforces over & above schema.org metadata can be thought of as the "base extension" for Psych-DS - if communities build on top of Psych-DS in the future, they would be adding additional extensions in a similar way - e.g. by adding rules such as "variableMeasured must include age" or "countryOfOrigin must be present and must be a 3-letter ISO country code"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Scoping Discussion regarding the scope, design, and features of the Psych-DS validator Validation for issues concerning the validation process, and how it is implemented algorithmically
Projects
None yet
Development

No branches or pull requests

2 participants