request-preference-storage.raml

#%RAML 1.0
title: Request Preference Storage
version: v1.0
protocols: [ HTTP, HTTPS ]
baseUri: http://localhost:9130

documentation:
  - title: Request Preference Storage API
    content: <b>Storage for request oreferences</b>

types:
  request-preference: !include request-preference.json
  request-preferences: !include request-preferences.json
  errors: !include raml-util/schemas/errors.schema

traits:
  validate: !include raml-util/traits/validation.raml
  pageable: !include raml-util/traits/pageable.raml
  searchable: !include raml-util/traits/searchable.raml

resourceTypes:
  collection: !include raml-util/rtypes/collection.raml
  collection-item: !include raml-util/rtypes/item-collection.raml

/request-preference-storage:
  /request-preference:
    displayName: Request Preferences
    type:
      collection:
        exampleCollection: !include examples/request-preference.json
        exampleItem: !include examples/request-preferences.json
        schemaCollection: request-preferences
        schemaItem: request-preference
    get:
      is: [
      pageable,
      searchable: {description: "searchable using CQL", example: "userId==1e425b93-501e-44b0-a4c7-b3e66a25c42e"},
        ]
    post:
      is: [validate]
    /{id}:
      type:
        collection-item:
          exampleItem: !include examples/request-preference.json
          schema: request-preference
      put:
        is: [validate]