-
Notifications
You must be signed in to change notification settings - Fork 7
/
rollover.raml
55 lines (50 loc) · 1.89 KB
/
rollover.raml
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
#%RAML 1.0
title: Rollover
baseUri: https://github.com/folio-org/mod-orders
version: v1
protocols: [ HTTP, HTTPS ]
documentation:
- title: Orders Business Logic API
content: <b>API for running Orders rollover</b>
types:
ledger-fiscal-year-rollover: !include acq-models/mod-finance/schemas/ledger_fiscal_year_rollover.json
ledger-fiscal-year-rollover-collection: !include acq-models/mod-finance/schemas/ledger_fiscal_year_rollover_collection.json
errors: !include raml-util/schemas/errors.schema
traits:
language: !include raml-util/traits/language.raml
validate: !include raml-util/traits/validation.raml
resourceTypes:
post-with-200: !include rtypes/post-json-200.raml
/orders/rollover:
displayName: Rollover orders
description: Start Orders rollover process
is: [language]
post:
body:
application/json:
type: ledger-fiscal-year-rollover
example:
strict: false
value: !include acq-models/mod-finance/examples/ledger_fiscal_year_rollover.sample
responses:
204:
description: "Rollover completed successfully"
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:
application/json:
example:
strict: false
value: !include raml-util/examples/errors.sample
text/plain:
example: |
"unable to add <<resourcePathName|!singularize>> -- malformed JSON at 13:3"
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"