-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy patheholdings.raml
125 lines (120 loc) · 3.91 KB
/
eholdings.raml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
#%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:
configurationStatus: !include types/status/status.json
holdingsLoadingStatus: !include types/loadHoldings/loadingHoldingsStatus.json
jsonapiError: !include types/jsonapiError.json
/eholdings/status:
displayName: Status
description: Gives status of currently set KB configuration.
get:
description: Gives status of currently set KB configuration.
responses:
200:
body:
application/vnd.api+json:
description: Status of currently set KB configuration.
type: configurationStatus
example:
strict: false
value: !include examples/status/status_get_200_response.json
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error, contact administrator"
/eholdings/cache:
displayName: Cache
delete:
description: |
Invalidate configuration cache for tenant
responses:
204:
description: No Content
/eholdings/loading/kb-credentials:
displayName: Run load holdings job
post:
description: Run load holdings job.
headers:
Content-Type:
example: application/json
responses:
204:
description: No Content
409:
description: "Process of loading holdings is already running"
body:
text/plain:
example: "Process of loading holdings is already running"
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error, contact administrator"
/{id}:
displayName: Run load holdings for provided credentials id
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}$"
post:
description: Run load holdings job by credentials id.
headers:
Content-Type:
example: application/json
responses:
204:
description: No Content
404:
description: Not Found
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/loadHoldings/load-holdings-by-id-post-404-response.json
409:
description: "Process of loading holdings is already running"
body:
text/plain:
example: "Process of loading holdings is already running"
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error, contact administrator"
/status:
displayName: Get current status of load holdings job.
get:
description: Get current status of load holdings job.
headers:
Content-Type:
example: application/json
responses:
200:
body:
application/json:
description: Get current status of load holdings job.
type: holdingsLoadingStatus
example:
strict: false
value: !include examples/loadHoldings/loading_completed_200_response.json
404:
description: Not Found
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/loadHoldings/load-holdings-by-id-post-404-response.json
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error, contact administrator"