mod-tlr/src/main/resources/swagger.api/allowed-service-points.yaml at master · folio-org/mod-tlr · 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
openapi: 3.0.0
info:
  title: Allowed service points API
  version: v1
tags:
  - name: AllowedServicePoints
paths:
  /tlr/allowed-service-points:
    get:
      description: Retrieve allowed service points
      operationId: getAllowedServicePoints
      parameters:
        - $ref: '#/components/parameters/operation'
        - $ref: '#/components/parameters/patronGroupId'
        - $ref: '#/components/parameters/requesterId'
        - $ref: '#/components/parameters/instanceId'
        - $ref: '#/components/parameters/requestId'
        - $ref: '#/components/parameters/itemId'
      tags:
        - allowedServicePoints
      responses:
        '200':
          $ref: '#/components/responses/success'
        '400':
          $ref: '#/components/responses/badRequest'
        '422':
          $ref: '#/components/responses/validationFailed'
        '500':
          $ref: '#/components/responses/internalServerError'
components:
  schemas:
    allowedServicePointsResponse:
      $ref: schemas/allowedServicePointsResponse.yaml#/AllowedServicePointsResponse
    errorResponse:
      $ref: schemas/errors.json
  parameters:
    operation:
      name: operation
      in: query
      required: true
      schema:
        type: string
        enum:
          - create
          - replace
    patronGroupId:
      name: patronGroupId
      in: query
      required: false
      schema:
        type: string
        format: uuid
    requesterId:
      name: requesterId
      in: query
      required: false
      schema:
        type: string
        format: uuid
    instanceId:
      name: instanceId
      in: query
      required: false
      schema:
        type: string
        format: uuid
    requestId:
      name: requestId
      in: query
      required: false
      schema:
        type: string
        format: uuid
    itemId:
      name: itemId
      in: query
      required: false
      schema:
        type: string
        format: uuid
  responses:
    success:
      description: Allowed service points grouped by request type
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/allowedServicePointsResponse'
    badRequest:
      description: Validation errors
      content:
        application/json:
          example:
            errors:
              - message: Request is invalid
            total_records: 1
          schema:
            $ref: "#/components/schemas/errorResponse"
    validationFailed:
      description: Validation errors
      content:
        application/json:
          example:
            errors:
              - message: Request is invalid
            total_records: 1
          schema:
            $ref: "#/components/schemas/errorResponse"
    internalServerError:
      description: When unhandled exception occurred during code execution, e.g. NullPointerException
      content:
        application/json:
          example:
            errors:
              - message: Unexpected error
            total_records: 1
          schema:
            $ref: "#/components/schemas/errorResponse"