README.md

PeriodO Server

A web server for serving and accepting patches for PeriodO data.

Setup

Running make by itself will install required packages, initialize the database if it does not yet exist, and generate the RDF representing the vocabulary terms and SHACL shapes used in PeriodO data.

Working with bags

You can create a "bag" of period URIs by sending an authenticated PUT request to http://n2t.net/ark:/99152/p0bags/[UUID], where [UUID] is a UUID (universally unique identifier) that you generate. The body of the request should be a JSON object with at least the keys title and items. The value of the items key must be either a list of PeriodO period identifiers, or an objects with PeriodO period identifiers as keys:

$ export BAG_UUID=$(uuid)
$ export AUTH_TOKEN=$(get_token_somehow)
$ curl -L -X PUT\
  -H "Authorization: Bearer $AUTH_TOKEN"
  -H "Content-Type: application/json"\
  -d '{"title": "my bag of periods", "items": ["p03377fkhrv", "p0d39r7d5km"]}'\
  "http://n2t.net/ark:/99152/p0bags/$BAG_UUID"

A GET request for a bag returns a JSON-LD representation including the full details of the bag's periods:

$ curl -L -X GET "http://n2t.net/ark:/99152/p0bags/$BAG_UUID" | jq .

{
  "@context": { ... },
  "@id": "p0bags/...",
  "creator": "https://orcid.org/...",
  "title": "my bag of periods",
  "items": {
    "p03377fkhrv": { ... full JSON-LD for period ... },
    "p0d39r7d5km": { ... full JSON-LD for period ... }
    }
  }
}

Bags are versioned. When initially created a bag has version 0. Subsequent PUTs to a bag URL will increment the version. GET requests can be made for specific versions by appending a version query parameter. Bags also support conditional requests using Etag headers.