mod-kb-ebsco-java/ramls/resources.raml at master · folio-org/mod-kb-ebsco-java · GitHub

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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
#%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:
  resourcePostRequest: !include types/resources/resourcePostRequest.json
  resource: !include types/resources/resource.json
  jsonapiError: !include types/jsonapiError.json
  resourcePutRequest: !include types/resources/resourcePutRequest.json
  resourceTagsPutRequest: !include types/resources/resourceTagsPutRequest.json
  resourceTags: !include types/resources/resourceTags.json
  resourcePostBulkFetchRequest: !include types/resources/resourcePostBulkFetchRequest.json
  resourceBulkFetchCollection:  !include types/resources/resourceBulkFetchCollection.json

/eholdings/resources:
  displayName: Resources
  post:
    description: Create a relation between an existing custom package and an existing custom/managed title.
    headers:
      Content-Type:
        example: application/vnd.api+json
    body:
      application/vnd.api+json:
        description: The server has successfully fulfilled the POST request.
        type: resourcePostRequest
        example:
          strict: false
          value: !include examples/resources/resources_post_request.json
    responses:
      200:
        description: OK
        body:
          application/vnd.api+json:
            description: The server has successfully fulfilled the POST request.
            type: resource
            example:
              strict: false
              value: !include examples/resources/resources_post_200_response.json
      400:
        description: Bad Request
        body:
          application/vnd.api+json:
            type: jsonapiError
            example:
              strict: false
              value: !include examples/resources/resources_post_400_response.json
      404:
        description: Not Found
        body:
          application/vnd.api+json:
            type: jsonapiError
            example:
              strict: false
              value: !include examples/resources/resources_post_404_response.json
      422:
        description: Unprocessable Entity
        body:
          application/vnd.api+json:
            type: jsonapiError
            example:
              strict: false
              value: !include examples/resources/resources_post_422_response.json
  /{resourceId}:
    displayName: Get resource by resourceId
    description: Instance of a resource given resourceId
    uriParameters:
      resourceId:
        description: Identifier of the resource formed from Provider Id, Package Id, Title Id (see example)
        type: string
        example: 22-1887786-1440285
    get:
      description: |
        Retrieve a specific resource given resourceId.
        Note that a resource is a managed/custom title associated with a managed/custom package.
        resourceId is providerId-packageId-titleId
      queryParameters:
        include:
          displayName: Nested provider, package or title
          type: string
          description: |
            Include provider, package or title in response
            Possible values are
             - provider
             - package
             - title
          example: provider
          required: false
      responses:
        200:
          description: OK
          body:
            application/vnd.api+json:
              description: Resource details from KB for a given resource Id
              type: resource
              example:
               strict: false
               value: !include examples/resources/resources_resourceId_get_200_response.json
        400:
          description: Bad Request
          body:
            application/vnd.api+json:
              type: jsonapiError
              example:
                strict: false
                value: !include examples/resources/resources_resourceId_get_400_response.json
        404:
          description: Not Found
          body:
            application/vnd.api+json:
              type: jsonapiError
              example:
                strict: false
                value: !include examples/resources/resources_resourceId_get_404_response.json
    put:
      description: |
        Update a managed or custom resource using resourceId
        Note that resourceId is providerId-packageId-titleId
      headers:
        Content-Type:
          example: application/vnd.api+json
      body:
        application/vnd.api+json:
          type: resourcePutRequest
          example:
            strict: false
            value: !include examples/resources/resources_put_request.json
      responses:
        200:
          description: OK
          body:
            application/vnd.api+json:
              description: The server has successfully fulfilled the PUT request.
              type: resource
              example:
                strict: false
                value: !include examples/resources/resources_resourceId_put_200_response.json
        400:
          description: Bad Request
          body:
            application/vnd.api+json:
              type: jsonapiError
              example:
                strict: false
                value: !include examples/resources/resources_resourceId_put_400_response.json
        404:
          description: Not Found
          body:
            application/vnd.api+json:
              type: jsonapiError
              example:
                strict: false
                value: !include examples/resources/resources_resourceId_put_404_response.json
        422:
          description: Unprocessable Entity
          body:
            application/vnd.api+json:
              type: jsonapiError
              example:
                strict: false
                value: !include examples/resources/resources_resourceId_put_422_response.json
    delete:
      description: |
        Delete the association between a custom/managed title and a custom package using resourceId.
        Note that resourceId is providerId-packageId-titleId
        If the title is custom and is not associated with any other package, then the title will be deleted from the knowledge base.
      responses:
        204:
          description: No Content
        400:
          description: Bad Request
          body:
            application/vnd.api+json:
              type: jsonapiError
              example:
                strict: false
                value: !include examples/resources/resources_resourceId_delete_400_response.json
        404:
          description: Not Found
          body:
            application/vnd.api+json:
              type: jsonapiError
              example:
                strict: false
                value: !include examples/resources/resources_resourceId_delete_404_response.json
    /tags:
      put:
        description: Update tags assigned to resource
        headers:
          Content-Type:
            example: application/vnd.api+json
        body:
          application/vnd.api+json:
            type: resourceTagsPutRequest
            example:
              strict: false
              value: !include examples/resources/resource_tags_put_request.json
        responses:
          200:
            description: OK
            body:
              application/vnd.api+json:
                description: Updated list of tags
                type: resourceTags
                example:
                  strict: false
                  value: !include examples/resources/resource_tags_put_200_response.json
          422:
            description: Unprocessable Entity
            body:
              application/vnd.api+json:
                type: jsonapiError
                example:
                  strict: false
                  value: !include examples/resources/resource_tags_put_422_response.json
  /bulk/fetch:
    post:
      description:
      headers:
        Content-Type:
          example: application/vnd.api+json
      body:
        application/vnd.api+json:
          type: resourcePostBulkFetchRequest
          example:
            strict: false
            value:  !include examples/resources/resource_bulk_fetch_post_request.json
      responses:
        200:
          description: OK
          body:
            application/vnd.api+json:
              description:
              type: resourceBulkFetchCollection
              example:
                strict: false
                value: !include examples/resources/resource_bulk_fetch_post_200_response.json
        422:
          description: Unprocessable Entity
          body:
            application/vnd.api+json:
              type: jsonapiError
              example:
                strict: false
                value: !include examples/resources/resource_bulk_post_422_response.json