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 section on recommended server documentation #22

Open
nichtich opened this issue Dec 21, 2015 · 3 comments
Open

Add section on recommended server documentation #22

nichtich opened this issue Dec 21, 2015 · 3 comments
Milestone

Comments

@nichtich
Copy link
Member

A DAIA server SHOULD be publicly available and documented with information such as

  • which kind of request identifiers are supported
  • a list of expected service type URIs
  • a list of expected institution, department, and storage URIs
  • a list of expected limitation type URIs
  • supported languages

The lists could be provided as part of a DAIA response if and only if no query parameter id is given:

{
  "document": [ ],
  "entities": {
    "institutions": [ ... ],
    "departments": [ ... ],
    "storages": [ ...],
    "services": [ ... ],
    "limitations": [ ... ],
  }
}

each entry as entity with mandatory id.

  • whether and how patron-specific availability is supported (a list of patron types)
  • which database that identifiers come from
@nichtich nichtich modified the milestone: 1.0.0 Jan 26, 2016
@nichtich
Copy link
Member Author

The server could also show what kind of identifiers it expects (e.g. publish a URI prefix)

@nichtich
Copy link
Member Author

Such doument could be referenced with a HTTP Link header.

nichtich added a commit that referenced this issue Feb 26, 2016
@nichtich nichtich modified the milestones: 1.1.0, 1.0.0 Feb 14, 2017
@nichtich
Copy link
Member Author

The server documentation could be a JSON Hyper-Schema document or similar with Link Description Objects (LDO) that link to the actual entities

{
    "storages": [{
      "href": "/storages",
      "rel": "related"
    }]
}

However, as I understand JSON Hyperschema, the "links" element should be part of JSON Schema so it is not applicable here (?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant