Schema metadata #47
Merged
Schema metadata #47
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
spinillos
approved these changes
Oct 4, 2023
K-Phoen
force-pushed
the
schema-metadata
branch
from
e03ccc2
to
42abb83
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The first step towards supporting composability is being able to identify composable schemas.
This PR identifies three "metadata fields" that we need in that context:
This PR demonstrates how these fields can (mostly) be extracted from our current kindsys schemas. For jsonschema or OpenAPI, we would either need to include these somehow in the schemas or figure out an alternative way to access this metadata.
Other teams might also need more metadata.
This question of "where and how should we describe this metadata" is at the center of our discussions with other teams on how do we want to structure our schemas.
We should start a (design) doc to document our requirements and suggest solutions.