-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathfund.raml
51 lines (45 loc) · 1.55 KB
/
fund.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
#%RAML 1.0
title: "mod-finance-storage"
baseUri: https://github.com/folio-org/mod-finance-storage
version: v3
documentation:
- title: mod-finance-storage (Funds)
content: <b>CRUD APIs used to manage funds.</b>
types:
errors: !include raml-util/schemas/errors.schema
fund: !include acq-models/mod-finance/schemas/fund.json
fund_collection: !include acq-models/mod-finance/schemas/fund_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/funds:
type:
collection:
exampleCollection: !include acq-models/mod-finance/examples/fund_collection.sample
exampleItem: !include acq-models/mod-finance/examples/fund.sample
schemaCollection: fund_collection
schemaItem: fund
is: [validate]
get:
description: Get list of funds
is: [
searchable: {description: "with valid searchable fields: for example code", example: "[\"code\", \"MEDGRANT\", \"=\"]"},
pageable
]
/{id}:
uriParameters:
id:
description: The UUID of a fund
type: UUID
type:
collection-item:
exampleItem: !include acq-models/mod-finance/examples/fund.sample
schema: fund
is: [validate]