-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
More proper data-access description support
Major changes are: - more useful and accurate `distribution` schema description - more complete `DataService` class - new `Parameter` concept - examples that document the capabilities While most changes more-or-less reflect the continued adoption of `DCAT` concepts and properties, the introduction of `Parameter` is noteworthy. `Parameter` is a variant of `Property` and serves a similar purpose (declare arbitrary additional aspects without prescribing a vocabulary to do so) with only a change in semantics of the class itself. In contrast to `Property` (observed or measured, fixed), `Parameter` is a variable with impact on a system or function. Closes #171 Via the property `has_parameter` particular parameters can be declared as supported/needed (e.g., `DataService`), or provided (`QualifiedAccess`). Examples are included. `QualifiedAccess` is no longer derived from `EntityInfluence` -- it has been too much of a stretch. It is now focused on access, and no longer requires a role specification. Closes #156
- Loading branch information
Showing
12 changed files
with
339 additions
and
140 deletions.
There are no files selected for viewing
This file contains 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
46 changes: 46 additions & 0 deletions
46
src/distribution/unreleased/examples/DataService-annexremote.json
This file contains 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,46 @@ | ||
| { | ||
| "id": "https://concepts.datalad.org/ns/annex-uuid/0a8713ca-ef42-11ee-a805-d3e9a774e795", | ||
| "identifier": [ | ||
| { | ||
| "notation": "0a8713ca-ef42-11ee-a805-d3e9a774e795", | ||
| "schema_agency": "https://git-annex.branchable.com" | ||
| } | ||
| ], | ||
| "meta_type": "dldist:DataService", | ||
| "name": "box.com", | ||
| "has_property": [ | ||
| { | ||
| "name": "type", | ||
| "value": "webdav", | ||
| "meta_type": "dlthing:Property" | ||
| }, | ||
| { | ||
| "name": "url", | ||
| "type": "DCAT:endpointURL", | ||
| "value": "https://dav.box.com/dav/git-annex", | ||
| "meta_type": "dlthing:Property" | ||
| }, | ||
| { | ||
| "name": "chunk", | ||
| "value": "10mb", | ||
| "meta_type": "dlthing:Property" | ||
| }, | ||
| { | ||
| "name": "keyid", | ||
| "value": "[email protected]", | ||
| "meta_type": "dlthing:Property" | ||
| } | ||
| ], | ||
| "type": "https://git-annex.branchable.com/special_remotes", | ||
| "endpoint_description": "https://git-annex.branchable.com/special_remotes/webdav/", | ||
| "endpoint_url": "https://dav.box.com/dav/git-annex", | ||
| "has_parameter": [ | ||
| { | ||
| "description": "git-annex key", | ||
| "name": "key", | ||
| "type": "obo:NCIT_C99023", | ||
| "range": "https://git-annex.branchable.com/internals/key_format" | ||
| } | ||
| ], | ||
| "@type": "DataService" | ||
| } |
39 changes: 39 additions & 0 deletions
39
src/distribution/unreleased/examples/DataService-annexremote.yaml
This file contains 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,39 @@ | ||
| # specification of a git-annex special remote as a DataService | ||
| id: https://concepts.datalad.org/ns/annex-uuid/0a8713ca-ef42-11ee-a805-d3e9a774e795 | ||
| meta_type: dldist:DataService | ||
| name: box.com | ||
| # TODO have a definition of a generic annex remote | ||
| type: https://git-annex.branchable.com/special_remotes | ||
| identifier: | ||
| - notation: 0a8713ca-ef42-11ee-a805-d3e9a774e795 | ||
| schema_agency: https://git-annex.branchable.com | ||
| endpoint_url: https://dav.box.com/dav/git-annex | ||
| # we are using a box.com WebDAV endpoint, but through a git-annex special remote, | ||
| # hence its documentation is the more appropriate description | ||
| endpoint_description: https://git-annex.branchable.com/special_remotes/webdav/ | ||
| # as a generic approach specify init/enableremote parameters | ||
| # as key-value pairs. each of them could have associated | ||
| # definitions to communicate the semantics in a more commonly | ||
| # understood way. | ||
| # These are modeled as properties of the dataservice, because the dataservice | ||
| # is a generic git-annex special remote, and only these (fixed) properties | ||
| # define protocol/layout/content of the dataservice | ||
| has_property: | ||
| - name: type | ||
| value: webdav | ||
| - name: url | ||
| value: https://dav.box.com/dav/git-annex | ||
| type: DCAT:endpointURL | ||
| - name: chunk | ||
| value: 10mb | ||
| - name: keyid | ||
| value: [email protected] | ||
| # identification of parameters that have to be provided in order to perform | ||
| # content retrieval | ||
| has_parameter: | ||
| - name: key | ||
| description: git-annex key | ||
| # content identifier | ||
| type: obo:NCIT_C99023 | ||
| # (ab)use design document on annex keys as range identifier | ||
| range: https://git-annex.branchable.com/internals/key_format |
Oops, something went wrong.