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

Provide element schemata #2

Open
odungern opened this issue Nov 10, 2021 · 0 comments
Open

Provide element schemata #2

odungern opened this issue Nov 10, 2021 · 0 comments

Comments

@odungern
Copy link
Collaborator

The idea is to provide separate schemata for the SpecIF elements, such as 'dataType', 'resourceClass' or 'resource'. Separate schemata can be used by an API to check incoming data.

There are two alternatives:

  • JSON Schema allows to separate a schema into multiple files. Then, a schema for each SpecIF element is provided and the SpecIF schema references them.
  • Keep the SpecIF schema as it is and to provide element-schemata in addition. Advantage is that a single schema file is quicker to load and disadvantage is that duplicate definitions need to be maintained in parallel.

Further thoughts:

  • the partial element schemata could be used in the API definition, rather than appending separate schema definitions (@oalt )
  • While a segmented schema with references is preferrable in terms of redundancy avoidance (DRY principle), it is perhaps more difficult to handle, as the complete schema consists of multiple files.
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

1 participant