Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
54 lines (47 sloc) 1.71 KB
#%RAML 1.0
title: "Organizations"
baseUri: https://github.com/folio-org/mod-organizations-storage
version: v1.0
documentation:
- title: Contacts
content: <b>CRUD APIs used to manage contacts.</b>
types:
contact: !include acq-models/mod-orgs/schemas/contact.json
contact_collection: !include acq-models/mod-orgs/schemas/contact_collection.json
errors: !include raml-util/schemas/errors.schema
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
validate: !include raml-util/traits/validation.raml
resourceTypes:
collection: !include raml-util/rtypes/collection.raml
collection-item: !include raml-util/rtypes/item-collection.raml
/organizations-storage/contacts:
type:
collection:
exampleCollection: !include acq-models/mod-orgs/examples/contact_collection.sample
exampleItem: !include acq-models/mod-orgs/examples/contact_post.sample
schemaCollection: contact_collection
schemaItem: contact
is: [validate]
get:
description: Get list of contact persons
is: [
searchable: {description: "with valid searchable fields: for example code", example: "[\"code\", \"MEDGRANT\", \"=\"]"},
pageable
]
/{id}:
uriParameters:
id:
description: The UUID of a Contact
type: UUID
type:
collection-item:
exampleItem: !include acq-models/mod-orgs/examples/contact_get.sample
schema: contact
is: [validate]
You can’t perform that action at this time.