-
Notifications
You must be signed in to change notification settings - Fork 0
add package schema and documentation #89
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
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
947eef8
add package schema and documentation@
duncandewhurst 381b67b
update packaging documentation
duncandewhurst 3e4ef5d
package schema fixes, add version key
duncandewhurst 9c694db
refine language in project packaging documentation
duncandewhurst 85a38bb
update version key to use major.minor format, update schema id to ref…
duncandewhurst c7df5e8
rename project_package.md, update language in reference.md
duncandewhurst f02b112
merge master into branch
duncandewhurst File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| ## Packaging data | ||
|
|
||
| OC4IDS data must be published as part of project package, which acts as a container for data on multiple projects and adds important metadata about the publication. The project package schema describes this container. | ||
|
|
||
| You can view an interactive version of the project package schema below (requires JavaScript) or [download it here](../../../../project-package-schema.json). | ||
|
|
||
| Click on schema elements to expand the tree, or use the '+' icon to expand all elements. Use { } to view the underlying schema for any section. | ||
|
|
||
| <script src="../../_static/docson/widget.js" data-schema="../../_static/project-level/project-package-schema.json"></script> |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| { | ||
| "id": "http://standard.open-contracting.org/infrastructure/beta/project-package-schema.json", | ||
| "$schema": "http://json-schema.org/draft-04/schema#", | ||
| "title": "Schema for an OC4IDS project package", | ||
| "description": "A package of OC4IDS projects. Note that all projects within a package must have a unique project identifier.", | ||
| "type": "object", | ||
| "required": [ | ||
| "uri", | ||
| "publisher", | ||
| "publishedDate", | ||
| "projects", | ||
| "version" | ||
| ], | ||
| "properties": { | ||
| "uri": { | ||
| "title": "Package identifier", | ||
| "description": "The URI of this package that identifies it uniquely in the world. Recommended practice is to use a dereferenceable URI, where a persistent copy of this package is available.", | ||
| "type": "string", | ||
| "format": "uri" | ||
| }, | ||
| "publishedDate": { | ||
| "title": "Published date", | ||
| "description": "The date that this package was published. If this package is generated 'on demand', this date should reflect the date of the last change to the underlying contents of the package.", | ||
| "type": "string", | ||
| "format": "date-time" | ||
| }, | ||
| "version": { | ||
| "title": "OC4IDS schema version", | ||
| "description": "The version of the OC4IDS schema used in this package, expressed as major.minor. For example: 0.9", | ||
| "type": "string", | ||
| "pattern": "^(\\d+\\.)(\\d+)$" | ||
| }, | ||
| "projects": { | ||
| "title": "Projects", | ||
| "description": "A list of projects included in this package, in OC4IDS format.", | ||
| "type": "array", | ||
| "minItems": 1, | ||
| "items": { | ||
| "$ref": "http://standard.open-contracting.org/infrastructure/beta/project-schema.json" | ||
| }, | ||
| "uniqueItems": true | ||
| }, | ||
| "publisher": { | ||
| "title": "Publisher", | ||
| "description": "Information to uniquely identify the publisher of this package.", | ||
| "type": "object", | ||
| "properties": { | ||
| "name": { | ||
| "title": "Name", | ||
| "description": "The name of the organization or department responsible for publishing this data.", | ||
| "type": "string" | ||
| }, | ||
| "scheme": { | ||
| "title": "Scheme", | ||
| "description": "The scheme that holds the unique identifiers used to identify the item being identified.", | ||
| "type": [ | ||
| "string", | ||
| "null" | ||
| ] | ||
| }, | ||
| "uid": { | ||
| "title": "uid", | ||
| "description": "The unique ID for this entity under the given ID scheme.", | ||
| "type": [ | ||
| "string", | ||
| "null" | ||
| ] | ||
| }, | ||
| "uri": { | ||
| "title": "URI", | ||
| "description": "A URI to identify the publisher.", | ||
| "type": [ | ||
| "string", | ||
| "null" | ||
| ], | ||
| "format": "uri" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "name" | ||
| ] | ||
| }, | ||
| "license": { | ||
| "title": "License", | ||
| "description": "A link to the license that applies to the data in this package. A Public Domain Dedication or [Open Definition Conformant](http://opendefinition.org/licenses/) license is strongly recommended. The canonical URI of the license should be used. Documents linked from this file may be under other license conditions. ", | ||
| "type": [ | ||
| "string", | ||
| "null" | ||
| ], | ||
| "format": "uri" | ||
| }, | ||
| "publicationPolicy": { | ||
| "title": "Publication policy", | ||
| "description": "A link to a document describing the publisher's [publication policy](http://standard.open-contracting.org/latest/en/implementation/publication_policy/).", | ||
| "type": [ | ||
| "string", | ||
| "null" | ||
| ], | ||
| "format": "uri" | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.