This repository has been archived by the owner on May 29, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
agreement.raml
49 lines (43 loc) · 1.58 KB
/
agreement.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
#%RAML 1.0
title: "Vendors"
baseUri: https://github.com/folio-org/mod-vendors
version: v2.0
documentation:
- title: Agreements
content: <b>CRUD APIs used to manage alerts.</b>
types:
agreement: !include acq-models/mod-vendors/schemas/agreement.json
agreement_collection: !include acq-models/mod-vendors/schemas/agreement_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:
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
resourceTypes:
collection: !include raml-util/rtypes/collection.raml
collection-item: !include raml-util/rtypes/item-collection.raml
/vendor-storage/agreements:
type:
collection:
exampleCollection: !include acq-models/mod-vendors/examples/agreement_collection.sample
exampleItem: !include acq-models/mod-vendors/examples/agreement_post.sample
schemaCollection: agreement_collection
schemaItem: agreement
get:
description: Get list of agreements
is: [
searchable: {description: "with valid searchable fields: for example code", example: "[\"code\", \"MEDGRANT\", \"=\"]"},
pageable
]
/{id}:
uriParameters:
id:
description: The UUID of a Agreement
type: UUID
type:
collection-item:
exampleItem: !include acq-models/mod-vendors/examples/agreement_get.sample
schema: agreement