mod-kb-ebsco-java/ramls/proxies.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
#%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