mod-quick-marc/src/main/resources/swagger.api/records-editor-async.yaml at master · folio-org/mod-quick-marc · 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
openapi: 3.0.0
info:
  title: quickMARC Record Editor
  version: 5.0
servers:
  - url: /records-editor/
paths:
  /records/{id}:
    put:
      tags:
        - records-editor-async
      responses:
        '202':
          description: MARC record accepted for updating
        '400':
          description:
            Bad request, e.g. malformed request body or query parameter.
            Details of the error (e.g. name of the parameter or line/character number
            with malformed data) provided in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '409':
          description: Update failed due to optimistic locking
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '422':
          description: MARC Record validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validationResult'
        '500':
          description: Internal server error, e.g. due to misconfiguration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      description: Edit MARC record
      operationId: putRecord
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/quickMarcEdit'
        required: true
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: The UUID of a record

components:
  schemas:
    quickMarcEdit:
      $ref: 'schemas/common.yaml#/quickMarcEdit'
    validationResult:
      $ref: 'schemas/common.yaml#/validationResult'
    error:
      type: object