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

Agree needed varieties of metadata schema #116

Open
mvahowe opened this issue Jan 16, 2020 · 5 comments
Open

Agree needed varieties of metadata schema #116

mvahowe opened this issue Jan 16, 2020 · 5 comments
Labels
Defining Feature or Fix We have a rough idea that needs refining before implementation

Comments

@mvahowe
Copy link
Contributor

mvahowe commented Jan 16, 2020

In part related to #211 and #206

From the processing model:

Template

A template is not strictly an entry, since it does not have an entry id. Templates, by their nature, are incomplete. However, whatever structure is present should be consistent with a metadata-valid document. The template schema also expects additional fields to identify the template, such as an id, name and description. (These should be stored differently to entry ids etc to avoid confusion when the template is instantiated.)

Catalog Valid

This is the lowest level of validity, which is required for all entries. Fields that are used for presenting summary information about the entry must be present and valid.

Archivist Valid

This level of validity includes catalog validity. All fields that can reasonably be human-maintained must be present and valid. (This notably excludes ingredients and publication structure.)

Metadata Valid

This level of validity includes detail validity. The entire metadata document must be valid.

Burrito Valid

This level of validity includes metadata validity. The entire metadata document must be valid and, in addition, the metadata and ingredients must conform to any conventions listed in the metadata. (This level of validation is only viable for owned entries, or for the first revision of a delegated entry, since, in other cases, the ingredients may not be present locally.)

@mvahowe mvahowe added the Defining Feature or Fix We have a rough idea that needs refining before implementation label Feb 20, 2020
@mvahowe
Copy link
Contributor Author

mvahowe commented Mar 4, 2020

I think we can get back to this once we have recipes in derived variants. The next big thing in the schema is recipeSpecs, the first part of which is effectively embedding metadata templates in other metadata documents.

@mvahowe
Copy link
Contributor Author

mvahowe commented Apr 2, 2020

I'm going to get back to this very soon, having worked out how to create families of schema without massive duplication. The place to start is templates, since we need them as part of recipeSpecs.

@mvahowe
Copy link
Contributor Author

mvahowe commented Apr 14, 2020

I just added a very lax template option to the schema which is implemented in PR #177

@mvahowe mvahowe added this to the SB 0.3.0-beta milestone Apr 14, 2020
@jag3773 jag3773 added the Talk About This! Consider putting this issue on the agenda for an SB meeting label Oct 8, 2020
@jag3773
Copy link
Collaborator

jag3773 commented Oct 8, 2020

Need a clear set of use cases before trying to implement this.

@jag3773 jag3773 removed the Talk About This! Consider putting this issue on the agenda for an SB meeting label Oct 8, 2020
@jag3773 jag3773 removed this from the SB 0.3.0-beta milestone Oct 8, 2020
@jag3773
Copy link
Collaborator

jag3773 commented Nov 5, 2020

This came up again in our discussion related to #96 and #223 .

@jag3773 jag3773 added this to the Validation Libraries milestone Nov 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Defining Feature or Fix We have a rough idea that needs refining before implementation
Projects
None yet
Development

No branches or pull requests

2 participants