Permalink
Fetching contributors…
Cannot retrieve contributors at this time
42 lines (36 sloc) 1.4 KB
#%RAML 1.0
title: "Orders-Module"
baseUri: http://github.com/folio-org/mod-orders-storage
version: v1
documentation:
- title: mod-orders (Adjustment)
content: <b>CRUD APIs used to manage adjustments.</b>
types:
adjustment: !include acq-models/mod-orders-storage/schemas/adjustment.json
adjustment_collection: !include acq-models/mod-orders-storage/schemas/adjustment_collection.json
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
/adjustment:
type:
collection:
exampleCollection: !include acq-models/mod-orders-storage/examples/adjustment_collection.sample
exampleItem: !include acq-models/mod-orders-storage/examples/adjustment_get.sample
schemaCollection: adjustment_collection
schemaItem: adjustment
get:
description: Get list of alerts
is: [
searchable: {description: "with valid searchable fields: for example code", example: "[\"code\", \"MEDGRANT\", \"=\"]"},
pageable
]
/{id}:
type:
collection-item:
exampleItem: !include acq-models/mod-orders-storage/examples/adjustment_get.sample
schema: adjustment