-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathaccess-types.raml
219 lines (216 loc) · 7.51 KB
/
access-types.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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
#%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:
accessType: !include types/accessTypes/accessType.json
accessTypeCollection: !include types/accessTypes/accessTypesCollection.json
accessTypePostRequest: !include types/accessTypes/accessTypePostRequest.json
accessTypePutRequest: !include types/accessTypes/accessTypePutRequest.json
jsonapiError: !include types/jsonapiError.json
/eholdings/access-types:
displayName: Access Types
get:
description: Get a list of access types.
responses:
200:
description: OK
body:
application/vnd.api+json:
description: List of Access Types available.
type: accessTypeCollection
example:
strict: false
value: !include examples/accessTypes/access_type_collection_get_200_response.json
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error, contact administrator"
/{id}:
displayName: Get Access Type by Id
description: Instance of a Access Type by given 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}$"
get:
description: Retrieve specific Access Types by Id
responses:
200:
description: OK
body:
application/vnd.api+json:
type: accessType
example:
strict: false
value: !include examples/accessTypes/access_type_item_get_200_response.json
400:
description: Bad Request
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/accessTypes/access_type_item_get_400_response.json
404:
description: Not Found
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/accessTypes/access_type_item_get_404_response.json
/eholdings/kb-credentials/{id}/access-types:
displayName: Access Types
description: Access Types belongs to specific 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 a list of access types related to specific KB credentials.
responses:
200:
description: OK
body:
application/vnd.api+json:
description: List of Access Types available.
type: accessTypeCollection
example:
strict: false
value: !include examples/accessTypes/access_type_collection_get_200_response.json
post:
description: Create an access type in specific KB Credentials
body:
application/vnd.api+json:
description: Create an access type in specific KB Credentials
type: accessTypePostRequest
example:
strict: false
value: !include examples/accessTypes/access_type_post_request.json
responses:
201:
description: Created
body:
application/vnd.api+json:
type: accessType
example:
strict: false
value: !include examples/accessTypes/access_type_post_201_response.json
400:
description: Bad Request
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/accessTypes/access_type_post_400_response.json
404:
description: Not Found
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/accessTypes/access_type_post_404_response.json
422:
description: Unprocessable Entity
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/accessTypes/access_type_post_422_response.json
/{accessTypeId}:
displayName: Get Access Type by Id related to specific KB credentials
description: Instance of a Access Type by given Id related to specific KB credentials
uriParameters:
accessTypeId:
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: Retrieve specific Access Types by Id related to specific KB credentials
responses:
200:
description: OK
body:
application/vnd.api+json:
type: accessType
example:
strict: false
value: !include examples/accessTypes/access_type_item_get_200_response.json
400:
description: Bad Request
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/accessTypes/access_type_item_get_400_response.json
404:
description: Not Found
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/accessTypes/access_type_item_get_404_response.json
put:
description: Update a Access Type by Id related to specific KB credentials
body:
application/vnd.api+json:
type: accessTypePutRequest
example:
strict: false
value: !include examples/accessTypes/access_type_put_request.json
responses:
204:
description: "Item successfully updated"
400:
description: Bad Request
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/accessTypes/access_type_put_by_id_400_response.json
404:
description: Not Found
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/accessTypes/access_type_put_by_id_404_response.json
422:
description: Unprocessable Entity
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/accessTypes/access_type_put_by_id_422_response.json
delete:
description: Delete a Access Type by Id
responses:
204:
description: No Content
400:
description: Bad Request
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/accessTypes/access_type_delete_by_id_400_response.json
422:
description: Unprocessable Entity
body:
application/vnd.api+json:
type: jsonapiError
example:
strict: false
value: !include examples/accessTypes/access_type_delete_by_id_422_response.json