Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time
128 lines (125 sloc) 4.39 KB
#%RAML 1.0
title: mod-kb-ebsco-java
baseUri: https://github.com/folio-org/mod-kb-ebsco-java
protocols: [ HTTPS ]
version: v1
mediaType: "application/vnd.api+json"
documentation:
- title: mod-kb-ebsco-java
content: Implements the eholdings interface using EBSCO KB as backend.
types:
proxyTypes: !include types/proxies/proxyTypes.json
rootProxy: !include types/proxies/rootProxy.json
rootProxyPutRequest: !include types/proxies/rootProxyPutRequest.json
jsonapiError: !include types/jsonapiError.json
/eholdings/proxy-types:
displayName: Proxy Types
description: List of supported proxy types for a given customer.
get:
description: Get a list of supported proxy types.
responses:
200:
description: OK
body:
application/vnd.api+json:
description: List of supported proxy types for a given customer.
type: proxyTypes
example:
strict: false
value: !include examples/proxies/proxy_types_get_200_response.json
/eholdings/kb-credentials/{id}/proxy-types:
displayName: Proxy Types
description: List of supported proxy types.
uriParameters:
id:
pattern : "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
get:
description: Get a list of supported proxy types for KB Credentials.
responses:
200:
description: OK
body:
application/vnd.api+json:
description: List of supported proxy types for a given customer.
type: proxyTypes
example:
strict: false
value: !include examples/proxies/proxy_types_get_200_response.json
404:
description: Not Found
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/proxies/proxy_types_by_credentials_id_get_404_response.json
/eholdings/root-proxy:
displayName: Root Proxy
description: Root Proxy that is currently selected from proxy-type list.
get:
description: Get the ID of root proxy that is currently selected from proxy-type list.
responses:
200:
description: OK
body:
application/vnd.api+json:
description: Get the ID of root proxy that is currently selected from proxy-type list.
type: rootProxy
example:
strict: false
value: !include examples/proxies/root_proxy_get_200_response.json
/eholdings/kb-credentials/{id}/root-proxy:
displayName: Root Proxy
description: Root Proxy that is currently selected from proxy-type list for KB Credentials.
uriParameters:
id:
pattern : "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
get:
description: Get the ID of root proxy that is currently selected from proxy-type list.
responses:
200:
description: OK
body:
application/vnd.api+json:
description: Get the ID of root proxy that is currently selected from proxy-type list.
type: rootProxy
example:
strict: false
value: !include examples/proxies/root_proxy_get_200_response.json
404:
description: Not Found
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/proxies/root_proxy_by_credentials_id_get_404_response.json
put:
description: Update root-proxy for a Kb Credentials.
headers:
Content-Type:
example: application/vnd.api+json
body:
application/vnd.api+json:
type: rootProxyPutRequest
example:
strict: false
value: !include examples/proxies/root_proxy_put_request.json
responses:
200:
description: OK
body:
application/vnd.api+json:
description: The server has successfully fulfilled the PUT request.
type: rootProxy
example:
strict: false
value: !include examples/proxies/root_proxy_put_200_response.json
422:
description: Unprocessable Entity
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/proxies/root_proxy_put_422_response.json