url.raml

#%RAML 1.0
title: "Vendors"
baseUri: https://github.com/folio-org/mod-vendors
version: v2.0

documentation:
  - title: URLs
    content: <b>CRUD APIs used to manage URLs.</b>

types:
    url: !include acq-models/mod-vendors/schemas/url.json
    url_collection: !include acq-models/mod-vendors/schemas/url_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/urls:
  type:
    collection:
      exampleCollection: !include acq-models/mod-vendors/examples/url_collection.sample
      exampleItem: !include acq-models/mod-vendors/examples/url_post.sample
      schemaCollection: url_collection
      schemaItem: url
  get:
    description: Get list of URLs
    is: [
      searchable: {description: "with valid searchable fields: for example code", example: "[\"code\", \"MEDGRANT\", \"=\"]"},
      pageable
    ]
  /{id}:
    uriParameters:
      id:
        description: The UUID of a URL
        type: UUID
    type:
      collection-item:
        exampleItem: !include acq-models/mod-vendors/examples/url_get.sample
        schema: url