mod-finance/ramls/group-fund-fiscal-year.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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
#%RAML 1.0

title: Finance group fund fiscal year
version: v1
protocols: [ HTTP, HTTPS ]
baseUri: https://github.com/folio-org/mod-finance

documentation:
  - title: Group Fund Fiscal Year API
    content: This documents the API calls that can be made to manage group-fund-fiscal-years

types:
  groupFundFiscalYear: !include acq-models/mod-finance/schemas/group_fund_fiscal_year.json
  groupFundFiscalYearCollection: !include acq-models/mod-finance/schemas/group_fund_fiscal_year_collection.json
  groupFundFiscalYearBatchRequest: !include acq-models/mod-finance/schemas/group_fund_fiscal_year_batch_request.json
  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
  pageable:  !include raml-util/traits/pageable.raml
  searchable: !include raml-util/traits/searchable.raml

resourceTypes:
  collection: !include raml-util/rtypes/collection-with-json-response.raml

/finance/group-fund-fiscal-years:
  displayName: Finance group fund fiscal year
  description: Finance group fund fiscal year APIs
  type:
    collection:
      schemaCollection: groupFundFiscalYearCollection
      schemaItem: groupFundFiscalYear
      exampleCollection: !include acq-models/mod-finance/examples/group_fund_fiscal_year_collection.sample
      exampleItem: !include acq-models/mod-finance/examples/group_fund_fiscal_year.sample
  post:
    is: [validate]
  get:
    is: [
      pageable,
      searchable: {description: "with valid searchable fields: for example fundId", example: "[\"fundId\", \"6e2fbba3-d557-4480-bca3-b6f5c645de04\", \"=\"]"}
    ]
  /batch:
    post:
      description: Query group-fund-fiscal-year records by multiple fundIds in a single request
      is: [validate]
      body:
        application/json:
          type: groupFundFiscalYearBatchRequest
      responses:
        200:
          description: "Returns matching group-fund-fiscal-year records"
          body:
            application/json:
              type: groupFundFiscalYearCollection
        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 group fund fiscal year
        type: UUID
    delete:
      is: [validate]
      displayName: Budget
      description: Delete a group fund fiscal year
      responses:
        204:
         description: "Item deleted successfully"
        404:
          description: "Item with a given ID not found"
          body:
            text/plain:
              example: |
                "group fund fiscal year not found"
            application/json:
              example:
                strict: false
                value: !include raml-util/examples/errors.sample
        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 delete group fund fiscal year -- constraint violation"
            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