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

Add Extensions Feature #361

Merged
merged 5 commits into from
Aug 23, 2023
Merged

Add Extensions Feature #361

merged 5 commits into from
Aug 23, 2023

Conversation

mrshll1001
Copy link
Contributor

This PR responds to the latest SC approval that an extensions array is added to the 360Giving Package Schema (where metadata is):

Property Title Description Type
extensions Extensions An array of strings which refer to Extensions in use by this 360Giving data file. Please see the Guidance for details. Array of Strings

Each item in the array must be a string. I have also used uniqueItems: true to enforce that a publisher cannot accidentally input the same extension twice, this is to support tooling resolving things. If this is out of scope from the SC mandate, I am happy to remove this before merging.

I have confirmed:

  • The changes are valid JSON
  • The changes are valid JSON Schema (draft 04)
  • The JSON schema behaves as expected
    • extensions is not required
    • any non-string element of the array is invalid
    • duplicate elements are invalid e.g. ["dei", "dei"] will throw an error

@mrshll1001 mrshll1001 self-assigned this Jun 8, 2023
@mrshll1001 mrshll1001 changed the base branch from master to 1.4-staging July 5, 2023 13:35
@mrshll1001
Copy link
Contributor Author

I have changed the base branch to be 1.4-staging which represents a staging area. #363 (removing unused weight properties from the schema) would represent a PATCH level fix, which would be superseded by this MINOR level change adding new features.

To avoid having to make two separate releases (ie 1.3.1 and then 1.4, or 1.4 and then 1.4.1); if we merge both of these into the staging branch we can merge 1.4-staging into master and then make a single release for 1.4.

Copy link
Contributor

@KDuerden KDuerden left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've raised a question about the short extensions description on the Meta page with potential rewording. I've also suggested a potential rewording of the description, which could wait for the update we will need to make once the Extensions guidance is ready and available to link.

This update to the schema matches what was outlined in the Proposal that was approved by the SC and notice period.

Pending a decision on the suggested rewordings, I'm will be happy to approve this for merging.

schema/360-giving-package-schema.json Outdated Show resolved Hide resolved
schema/360-giving-package-schema.json Show resolved Hide resolved
documentation/technical/metadata.md Outdated Show resolved Hide resolved
@mrshll1001 mrshll1001 merged commit dd03b83 into 1.4-staging Aug 23, 2023
2 checks passed
@mrshll1001 mrshll1001 deleted the feature-extensions branch August 23, 2023 08:22
@mrshll1001 mrshll1001 mentioned this pull request Aug 23, 2023
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just realising we link to a static version of the template with meta sheet. If we're still not able to generate the template with meta, this will need to be updated.

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

Successfully merging this pull request may close these issues.

2 participants