mod-finance/ramls/release-encumbrance.raml at master · folio-org/mod-finance · 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
#%RAML 1.0

title: Release encumbrance
version: v1
protocols: [ HTTP, HTTPS ]
baseUri: https://github.com/folio-org/mod-finance

documentation:
  - title: Release encumbrance API
    content: |
      This documents the API calls that release any remaining money encumbered back to the budget's available pool.
      It should only be used by the UI, and only to release a single encumbrance - batch-all-or-nothing should be used otherwise.

types:
  errors: !include raml-util/schemas/errors.schema
  UUID:
    type: string
    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}$

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

/finance/release-encumbrance/{id}:
    uriParameters:
      id:
        description: The UUID of an encumbrance
        type: UUID
    displayName: Finance release encumbrance
    description: |
      Finance release encumbrance APIs.
      It should only be used by the UI, and only to release a single encumbrance - batch-all-or-nothing should be used otherwise.
    post:
      is: [validate]
      description: Release encumbrance (use only in UI for a single encumbrance - use batch-all-or-nothing otherwise)
      responses:
        204:
          description: "Encumbrance successfully released"
        400:
          description: "Bad request, malformed 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: "Transaction type is not encumbrance"
            application/json:
              example:
                strict: false
                value: !include raml-util/examples/errors.sample
        404:
          description: "Encumbrance with a given ID not found"
          body:
            text/plain:
              example: "Encumbrance not found"
            application/json:
              example:
                strict: false
                value: !include raml-util/examples/errors.sample
        500:
          description: "Internal server error, e.g. due to misconfiguration"
          body:
            text/plain:
              example: "internal server error, contact administrator"
            application/json:
              example:
                strict: false
                value: !include raml-util/examples/errors.sample