-
Notifications
You must be signed in to change notification settings - Fork 13
/
waiver.raml
54 lines (48 loc) · 1.6 KB
/
waiver.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
#%RAML 1.0
title: Waives
version: v1
baseUri: http://github.com/org/folio/mod-feesfines
documentation:
- title: Waives API
content: This documents the API calls that can be made to query and manage waive of the system
types:
waiver: !include waivedata.json
waivedataCollection: !include waivedataCollection.json
errors: !include raml-util/schemas/errors.schema
traits:
orderable: !include raml-util/traits/orderable.raml
pageable: !include raml-util/traits/pageable.raml
searchable: !include raml-util/traits/searchable.raml
language: !include raml-util/traits/language.raml
validate: !include raml-util/traits/validation.raml
facets: !include raml-util/traits/facets.raml
resourceTypes:
collection: !include raml-util/rtypes/collection.raml
collection-item: !include raml-util/rtypes/item-collection.raml
get-only: !include raml-util/rtypes/get-only.raml
post-empty-body: !include raml-util/rtypes/post-empty-body.raml
/waives:
type:
collection:
exampleCollection: !include examples/waive_collection.sample
exampleItem: !include examples/waive.sample
schemaCollection: waivedataCollection
schemaItem: waiver
get:
is: [
searchable: {description: "with valid searchable fields", example: "active=true"},
orderable: {fieldsList: "field A, field B"},
pageable,
facets
]
description: Return a list of waive
post:
is: [validate]
description: Create a waive
/{waiveId}:
type:
collection-item:
exampleItem: !include examples/waive.sample
schema: waiver
get:
description: Get a single waive