mod-finance-storage/ramls/budget.raml at master · folio-org/mod-finance-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
78
79
#%RAML 1.0
title: "mod-finance-storage"
baseUri: https://github.com/folio-org/mod-finance-storage
version: v3

documentation:
  - title: mod-finance-storage (Budgets)
    content: <b>CRUD APIs used to manage budgets.</b>

types:
  errors: !include raml-util/schemas/errors.schema
  budget: !include acq-models/mod-finance/schemas/budget.json
  budget-collection: !include acq-models/mod-finance/schemas/budget_collection.json
  batch-id-collection: !include acq-models/common/schemas/batch_id_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: !include raml-util/rtypes/collection.raml
  collection-item: !include raml-util/rtypes/item-collection.raml


/finance-storage/budgets:
  type:
    collection:
      exampleCollection: !include acq-models/mod-finance/examples/budget_collection.sample
      exampleItem: !include acq-models/mod-finance/examples/budget.sample
      schemaCollection: budget-collection
      schemaItem: budget
  is: [validate]
  get:
    description: Get list of budgets
    is: [
      searchable: {description: "with valid searchable fields: e.g.", example: "[\"code\", \"MEDGRANT\", \"=\"]"},
      pageable
    ]
  /batch:
    post:
      description: Query budget records by multiple IDs in a single request
      is: [validate]
      body:
        application/json:
          type: batch-id-collection
      responses:
        200:
          description: "Returns matching budget records"
          body:
            application/json:
              type: budget-collection
        400:
          description: "Bad request"
          body:
            text/plain:
              example: "Bad request"
            application/json:
              type: errors
        500:
          description: "Internal server error"
          body:
            text/plain:
              example: "Internal server error, contact administrator"
            application/json:
              type: errors
  /{id}:
    uriParameters:
      id:
        description: The UUID of a budget
        type: UUID
    type:
      collection-item:
        exampleItem: !include acq-models/mod-finance/examples/budget.sample
        schema: budget
    is: [validate]