mod-finance/ramls/finance-data.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
65
66
67
68
69
#%RAML 1.0
title: Finance - finance data
version: v1
protocols: [ HTTP, HTTPS ]
baseUri: https://github.com/folio-org/mod-finance

documentation:
  - title: Finance data APIs
    content: This documents the API calls that can be made to manage finance data

types:
  errors: !include raml-util/schemas/errors.schema
  batch-id-collection: !include acq-models/common/schemas/batch_id_collection.json
  fy-finance-data-collection: !include acq-models/mod-finance/schemas/fy_finance_data_collection.json
  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:
  pageable:  !include raml-util/traits/pageable.raml
  searchable: !include raml-util/traits/searchable.raml
  validate: !include raml-util/traits/validation.raml

resourceTypes:
  collection-get: !include raml-util/rtypes/collection-get.raml

/finance/finance-data:
  type:
    collection-get:
      exampleCollection: !include acq-models/mod-finance/examples/fy_finance_data_collection_get.sample
      schemaCollection: fy-finance-data-collection
  get:
    description: Get finance data
    is: [
      searchable: { description: "with valid searchable fields: for example fiscalYearId", example: "[\"fiscalYearId\", \"7a4c4d30-3b63-4102-8e2d-3ee5792d7d02\", \"=\"]" },
      pageable
    ]
  put:
    description: Update finance, budget as a bulk
    is: [ validate ]
    body:
      application/json:
        type: fy-finance-data-collection
        example: !include acq-models/mod-finance/examples/fy_finance_data_collection_put.sample
    responses:
      204:
        description: "Items successfully updated"
      404:
        description: "One or more items not found"
        body:
          text/plain:
            example: |
              "One or more items not found"
      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 items -- malformed JSON at 13:4"
      409:
        description: "Optimistic locking version conflict"
        body:
          text/plain:
            example: "version conflict"
      500:
        description: "Internal server error, e.g. due to misconfiguration"
        body:
          text/plain:
            example: "internal server error, contact administrator"