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
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions documentation/technical/metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ This is for the version of the 360Giving Data Standard being used, so not the ve

Find the details of the current version in the <a href="https://github.com/ThreeSixtyGiving/standard/releases" target="_blank" >Releases changelog</a>.

**Extensions**

This is a text field that can be used to declare a list of extensions used in the file. Each extension is represented by a short string &ndash; which is a piece of text like a code &ndash; and multiple extensions can be declared by separating them with a semicolon `;` character.

**Title and Description**

These are text fields that can be used to provide information about the name of the file and its contents, and provide further contextual information if appropriate.
Expand Down
1 change: 1 addition & 0 deletions documentation/technical/reference.md
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.

Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ The [Additional fields](additional-fields) section provides details of all other
We also provide a version of the <a href="../../_static/360-giving-schema-titles-with-meta-tab-2023.xlsx">360Giving Spreadsheet Template with the Metadata template included</a>. The 'Meta' sheet may be used to publish authoritative metadata about the publisher, the file or dataset. The term we use for this is a 'data package'. The 'Meta' sheet includes sections for:

* The version of the 360Giving Schema used for the file
* A list of 360Giving extensions used in the file
* The title and description of the file
* The dates when the file was first issued and last modified
* Information about the publisher such as name, logo, website and identifier
Expand Down
9 changes: 9 additions & 0 deletions schema/360-giving-package-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,15 @@
"type": "string",
"pattern": "^(\\d+\\.)(\\d+)$"
},
"extensions": {
"title": "Extensions",
"description": "An array of strings which refer to 360Giving Extensions in use by this data file. See the [360Giving Extensions guidance](https://standard.threesixtygiving.org/en/latest/technical/metadata/#field-guidance) for details.",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
mrshll1001 marked this conversation as resolved.
Show resolved Hide resolved
},
"title": {
"title": "Title",
"description": "The title of the 360Giving data package. Should be a human readable version of information contained in the filename of the data and should be unique ",
Expand Down
Loading