Permalink
Fetching contributors…
Cannot retrieve contributors at this time
72 lines (64 sloc) 3.2 KB
#%RAML 0.8
title: "Vendor-Module"
baseUri: http://github.com/org/folio/lsp-apis
version: v1
documentation:
- title: Vendors Module
content: <b>This module implements the Vendor-CRUD interface.</b>
schemas:
- account.json: !include acq-models/mod-vendors/schemas/account.json
- address.json: !include acq-models/mod-vendors/schemas/address.json
- agreement.json: !include acq-models/mod-vendors/schemas/agreement.json
- alias.json: !include acq-models/mod-vendors/schemas/alias.json
- category.json: !include acq-models/mod-vendors/schemas/category.json
- changelog.json: !include acq-models/mod-vendors/schemas/changelog.json
- contact_person.json: !include acq-models/mod-vendors/schemas/contact_person.json
- edi.json: !include acq-models/mod-vendors/schemas/edi.json
- edi_ftp.json: !include acq-models/mod-vendors/schemas/edi_ftp.json
- edi_job.json: !include acq-models/mod-vendors/schemas/edi_job.json
- email.json: !include acq-models/mod-vendors/schemas/email.json
- error.json: !include acq-models/mod-vendors/schemas/error.json
- interface.json: !include acq-models/mod-vendors/schemas/interface.json
- phone_number.json: !include acq-models/mod-vendors/schemas/phone_number.json
- url.json: !include acq-models/mod-vendors/schemas/url.json
- vendor.json: !include acq-models/mod-vendors/schemas/vendor.json
- vendor_address.json: !include acq-models/mod-vendors/schemas/vendor_address.json
- vendor_contact_person.json: !include acq-models/mod-vendors/schemas/vendor_contact_person.json
- vendor_email.json: !include acq-models/mod-vendors/schemas/vendor_email.json
- vendor_phone.json: !include acq-models/mod-vendors/schemas/vendor_phone.json
- vendor_url.json: !include acq-models/mod-vendors/schemas/vendor_url.json
- vendorCollection: !include acq-models/mod-vendors/schemas/vendorCollection.json
- contactCategoryCollection: !include acq-models/mod-vendors/schemas/categoryCollection.json
- categoryCollection: !include acq-models/mod-vendors/schemas/categoryCollection.json
traits:
- secured: !include raml-util/traits/auth.raml
- 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:
type:
collection:
exampleCollection: !include acq-models/mod-vendors/examples/vendor_collection.sample
exampleItem: !include acq-models/mod-vendors/examples/vendor_post.sample
schemaCollection: vendorCollection
schemaItem: vendor.json
get:
description: Get list of vendors
is: [
searchable: {description: "with valid searchable fields: for example code", example: "[\"code\", \"MEDGRANT\", \"=\"]"},
pageable
]
/{id}:
type:
collection-item:
exampleItem: !include acq-models/mod-vendors/examples/vendor_get.sample
schema: vendor.json
put:
description: Update vendor with 'vendor_id'
body:
application/json:
example: !include acq-models/mod-vendors/examples/vendor_get.sample