https://github.com/sballesteros/linked-data-registry
A CouchDB powered registry for linked data.
https://github.com/sballesteros/linked-data-registry
Last synced: about 1 month ago
JSON representation
A CouchDB powered registry for linked data.
- Host: GitHub
- URL: https://github.com/sballesteros/linked-data-registry
- Owner: sballesteros
- License: apache-2.0
- Created: 2013-11-11T21:35:33.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-01-12T02:13:19.000Z (over 10 years ago)
- Last Synced: 2024-04-15T03:00:25.633Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 2.11 MB
- Stars: 31
- Watchers: 8
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - sballesteros/linked-data-registry - A CouchDB powered registry for linked data. (others)
README
linked data registry
====================
A [CouchDB](http://couchdb.apache.org/) powered registry for [linked data](http://en.wikipedia.org/wiki/Linked_data).
[](https://nodei.co/npm/linked-data-registry/)
- documents are served as [JSON-LD](http://json-ld.org) or [JSON interpreted as JSON-LD](http://json-ld.org/spec/latest/json-ld/#interpreting-json-as-json-ld) and using the semantic of [schema.org](http://schema.org) and [hydra](http://www.hydra-cg.com/) (but favoring [schema.org/Action](http://schema.org/Action) over hydra when possible)
- documents are compatible with [linked data fragments](http://linkeddatafragments.org/) ([triple pattern fragment](http://linkeddatafragments.org/concept/#tpf))
A client is available [here](https://github.com/standard-analytics/dcat).
Registry API
============
### GET /
Return the [JSON-LD](http://www.w3.org/TR/json-ld)
[context](http://www.w3.org/TR/json-ld/#the-context) used by the
registry.
### GET /about
Return a [JSON-LD](http://www.w3.org/TR/json-ld) document describing
the registry and its potential [actions](http://schema.org/Action) using
[schema.org](http://schema.org).
### PUT /users/{username}
Register a user. A user has to be a [Person](http://schema.org/Person).
request body:
{
"@context": "https://dcat.io",
"@id": "users/{username}"
"@type": "Person",
"password": "secret"
"name": "John Markup",
"email": "mailto:[email protected]",
...
}
response body:
{
"@context": "https://dcat.io",
"@type": "RegisterAction",
"actionStatus": "CompletedActionStatus",
"agent": "users/{username}",
"object": ""
}
Note: relative URLs are relative to an ```@base``` of
```https://dcat.io``` specified in the
[context](https://dcat.io).
### DELETE /users/{username}
Unregister a user.
required header:
- Authorization
response body:
{
"@context": "https://dcat.io",
"@type": "UnRegisterAction",
"actionStatus": "CompletedActionStatus",
"agent": {
"@type": "Person",
"email": "mailto:[email protected]
},
"object": ""
}
### GET /users/{username}
Get a user's public profile.
### PUT /{namespace}
Create a new [JSON-LD](http://www.w3.org/TR/json-ld) document of
```@id``` ```{namespace}```.
If a [```version```](http://schema.org/version) property is specified in the
document, the document will be versioned, that is, each update will
require a new version value in order to be published. When appropriate, version
number SHOULD follow [semantic versioning](http://semver.org/).
If a [```version```](http://schema.org/version) property is not specified, the
new document will replace the previous version irreversibly.
required header:
- Authorization
request body:
{
"@context": "https://dcat.io",
"@id": "{namespace}",
...
}
Note, to be valid a document needs at least:
- a ```@context``` of value ```https://dcat.io```
- an ```@id```
response body:
{
"@context": "https://dcat.io",
"@type": "CreateAction",
"actionStatus": "CompletedActionStatus",
"agent": "users/{username}",
"result": "namespace"
}
### DELETE /{namespace}{?version}
Delete a document of ```@id``` ```{namespace}``` and version
```{version}```. If version is omitted all the versions will be
deleted.
required header:
- Authorization
response body:
{
"@context": "https://dcat.io",
"@type": "DeleteAction",
"actionStatus": "CompletedActionStatus",
"agent": "users/john",
"object": "{namespace}{?version}"
}
### GET /{namespace}/{+pathorurl}{?version}
Get a [JSON-LD](http://www.w3.org/TR/json-ld) document of ```@id```
```{namespace}``` or a node of this document of ```@id```
```{namespace}/{pathorurl}``` or ```{pathorurl}```. In the latter case,
```{pathorurl}``` has to be an absolute URL encoded as an Uniform
Resource Identifier (URI) component.
A specific version can be specified using a query string parameter
```version``` whose value is properly encoded as a Uniform Resource
Identifier (URI) component. In case the document is versioned
following [Semantic Versioning](http://semver.org/), a range (e.g.
```<0.0.1```) can be specified as ```version```.
If ```{?version}``` is omitted, the latest version of the document is
returned.
Depending on the ```Accept``` header, documents retrieved from the
registry can be served as
[JSON-LD](http://www.w3.org/TR/json-ld/#application-ld-json)
(expanded, compacted or flattened) or,
[JSON interpreted as JSON-LD](http://www.w3.org/TR/json-ld/#interpreting-json-as-json-ld).
### GET /maintainers/ls/{namespace}
List the maintainers of a [JSON-LD](http://www.w3.org/TR/json-ld) document with ```@id``` ```{namespace}```.
response body:
{
"@context": "https://dcat.io",
"@id": "{namespace}",
"accountablePerson": [
{ "@id": "users/john", "@type": "Person", "name": "John Markup", "email": "mailto:[email protected]", ... },
...
]
}
### POST /maintainers/add/{username}/{namespace}
Add a maintainer of ```@id``` ```users/{username}``` to the document of ```@id``` ```{namespace}```.
required header:
- Authorization
response body:
{
"@context": "https://dcat.io",
"@type": "GiveAction",
"actionStatus": "CompletedActionStatus",
"agent": "users/{me}",
"object": "{namespace}",
"recipient": "users/{username}"
}
### POST /maintainers/rm/{username}/{namespace}
Remove a maintainer of ```@id``` ```users/{username}``` to the document of ```@id``` ```{namespace}```.
required header:
- Authorization
response body:
{
"@context": "https://dcat.io",
"@type": "TakeAction",
"actionStatus": "CompletedActionStatus",
"agent": "users/{me}",
"object": "{namespace}",
"recipient": "users/{username}"
}
Raw data storage API
====================
### PUT /r/{sha1}
Publish a resource whose SHA-1 message digest (encoded in hex) is ```{sha1}```.
required headers:
- Authorization
- Content-MD5
- Content-Type
- Content-Length
- Encoding (if any)
response body:
{
"@context": "https://dcat.io",
"@type": "CreateAction",
"actionStatus": "CompletedActionStatus",
"agent": "users/{username}",
"result": "r/{sha1}"
}
### GET /r/{sha1}
Download raw data.
Search API
==========
### GET /search/{?keywords}
Search JSON-LD documents by [keywords](http://schema.org/keywords).
Tests
=====
You need couchdb running with an admin defined in ```env.sh``` (```COUCH_ADMIN_USER``` and ```COUCH_ADMIN_PASS```) (see ```env.sh```)
couchdb
source env.sh
npm run init
npm run push
npm start
npm test
License
=======
Apache 2.0.