Permalink
Fetching contributors…
Cannot retrieve contributors at this time
42 lines (36 sloc) 1.33 KB
#%RAML 1.0
title: "Sample-Module"
baseUri: http://github.com/org/folio/sample-module
version: v1
documentation:
- title: Sample Module
content: <b>CRUD API</b>
types:
renewal: !include acq-models/mod-orders-storage/schemas/renewal.json
renewal_collection: !include acq-models/mod-orders-storage/schemas/renewal_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
/renewal:
type:
collection:
exampleCollection: !include acq-models/mod-orders-storage/examples/renewal_collection.sample
exampleItem: !include acq-models/mod-orders-storage/examples/renewal_post.sample
schemaCollection: renewal_collection
schemaItem: renewal
get:
description: Get list of renewals
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/renewal_get.sample
schema: renewal