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

Split out the record and record package schemas #716

Closed
duncandewhurst opened this issue May 24, 2018 · 5 comments · Fixed by #1640
Closed

Split out the record and record package schemas #716

duncandewhurst opened this issue May 24, 2018 · 5 comments · Fixed by #1640
Assignees
Labels
Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues Focus - Packages Relating to release packages and record packages Schema Relating to other changes in the JSON Schema (renamed fields, schema properties, etc.)
Milestone

Comments

@duncandewhurst
Copy link
Contributor

Currently the standard has the following schema files:

  • release-schema.json
  • release-package-schema.json
  • record-package-schema.json

The record schema is embedded within the record package schema.

Since the structure of a record is an important concept and to make the distinction clearer between releases and records and their packages, I think it would be preferable if the record schema was split into a separate record-schema.json file.

The documentation could be updated too so that there are separate record schema and record package schema viewers, as with releases.

This would mean the docs and the schema files were consistently structured across both releases and records.

@duncandewhurst duncandewhurst added Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues Schema Relating to other changes in the JSON Schema (renamed fields, schema properties, etc.) labels May 24, 2018
@jpmckinney
Copy link
Member

An issue that should perhaps be resolved at the same time: #330

@jpmckinney jpmckinney added this to the 1.2 milestone Sep 18, 2018
@jpmckinney jpmckinney added the Focus - Packages Relating to release packages and record packages label Dec 10, 2018
@jpmckinney jpmckinney self-assigned this Jun 7, 2023
@duncandewhurst
Copy link
Contributor Author

@jpmckinney are you still planning to action this issue or should I address it as part of #1640?

@jpmckinney jpmckinney removed their assignment Oct 12, 2023
@jpmckinney
Copy link
Member

@duncandewhurst You can go ahead. Thank you!

@duncandewhurst
Copy link
Contributor Author

An issue that should perhaps be resolved at the same time: #330

Since #1640 now groups a bunch of package-related changes, I figure it makes sense to do #330 separately. Let me know if you think differently.

@jpmckinney
Copy link
Member

Yes, we can do it separately

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues Focus - Packages Relating to release packages and record packages Schema Relating to other changes in the JSON Schema (renamed fields, schema properties, etc.)
Projects
Status: Done
2 participants