Web Service – Dataset Errata

Web Service – Dataset Errata

Description

Persists & manages access to errata information stored in a PostgreSQL database.

Users

data-provider

Clients

errata-client

Open Endpoints

GET https://errata.api.es-doc.org/1/issue/retrieve

GET https://errata.api.es-doc.org/1/issue/search

GET https://errata.api.es-doc.org/1/issue/search-setup

GET https://errata.api.es-doc.org/1/resolve/issue

GET https://errata.api.es-doc.org/1/resolve/pid

Secure Endpoints

POST https://errata.api.es-doc.org/1/issue/close

POST https://errata.api.es-doc.org/1/issue/create

POST https://errata.api.es-doc.org/1/issue/update

Request Authentication

Credentials extracted from ‘Authorisation’ HTTP header

Credentials authenticated with GitHub User API

Request Authorization

Assert user’s GitHub account is member of: ES-DOC-OPS/errata-publication-XXXX where XXXX=institution id

Assert user’s GitHub access token scope >= read.org

Request Validation

Request headers, body & parameters are validated with JSON schema

Daemon process

Requires access to PostGreSQL dB with dedicated PostGreSQL account