mod-orders-storage/ramls/pieces-batch.raml at master · folio-org/mod-orders-storage · 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
#%RAML 1.0
title: "mod-orders"
baseUri: http://github.com/folio-org/mod-orders-storage
version: v1.0

documentation:
  - title: Pieces batch API
    content: This module implements the Pieces batch processing interface. This API is intended for internal use only.

types:
  pieces-collection: !include acq-models/mod-orders-storage/schemas/piece_collection.json
  errors: !include raml-util/schemas/errors.schema

traits:
  validate: !include raml-util/traits/validation.raml

/orders-storage/pieces-batch:
  displayName: Process list of Pieces in a batch
  description: Process list of Pieces in a batch APIs
  is: [ validate ]
  post:
    description: Create batch pieces
    body:
      application/json:
        type: pieces-collection
        example:
          strict: false
          value: !include acq-models/mod-orders-storage/examples/piece_collection.sample
    responses:
      200:
        description: "Returns processing result of the piece collection"
        body:
          application/json:
            type: pieces-collection
            example:
              strict: false
              value: !include acq-models/mod-orders-storage/examples/piece_collection.sample
      422:
        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."
        body:
          application/json:
            example:
              strict: false
              value: !include raml-util/examples/errors.sample
          text/plain:
            example: |
              "unable to process object -- malformed JSON at 13:4"
      500:
        description: "Internal server error, e.g. due to misconfiguration"
        body:
          application/json:
            example:
              strict: false
              value: !include raml-util/examples/errors.sample
          text/plain:
            example: "internal server error, contact administrator"
  put:
    description: "Update the list of Pieces in a batch"
    body:
      application/json:
        type: pieces-collection
        example:
          strict: false
          value: !include acq-models/mod-orders-storage/examples/piece_collection.sample
    responses:
      204:
        description: "Collection successfully updated"
      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."
        body:
          text/plain:
            example: "unable to update <<resourcePathName|!singularize>> -- malformed JSON at 13:4"
      500:
        description: "Internal server error, e.g. due to misconfiguration"
        body:
          text/plain:
            example: "internal server error, contact administrator"