loan-policy-storage.raml

#%RAML 1.0
title: Loan Policy Storage
version: v2.1
protocols: [ HTTP, HTTPS ]
baseUri: http://localhost:9130

documentation:
  - title: Loan Policy Storage API
    content: <b>Storage for loan policies</b>

types:
  loan-policy: !include loan-policy.json
  loan-policies: !include loan-policies.json
  errors: !include raml-util/schemas/errors.schema

traits:
  language: !include raml-util/traits/language.raml
  pageable: !include raml-util/traits/pageable.raml
  searchable: !include raml-util/traits/searchable.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

/loan-policy-storage:
  /loan-policies:
    displayName: Loan Policies
    type:
      collection:
        exampleCollection: !include examples/loan-policies.json
        exampleItem: !include examples/loan-policy.json
        schemaCollection: loan-policies
        schemaItem: loan-policy
    get:
      is: [pageable,
        searchable: {description: "searchable using CQL",
                        example: "id=\"cf23adf0-61ba-4887-bf82-956c4aae2260\""},
        ]
      responses:
        501:
          description: "Not implemented yet"
    post:
      is: [validate]
      responses:
        501:
          description: "Not implemented yet"
    delete:
      is: [language]
      responses:
        204:
          description: "All loans deleted"
        500:
          description: "Internal server error, e.g. due to misconfiguration"
          body:
            text/plain:
              example: "Internal server error, contact administrator"
        501:
          description: "Not implemented yet"
    /{loanPolicyId}:
      type:
        collection-item:
          exampleItem: !include examples/loan-policy.json
          schema: loan-policy
      get:
        responses:
          501:
            description: "Not implemented yet"
      put:
        responses:
          501:
            description: "Not implemented yet"
      delete:
        responses:
          501:
            description: "Not implemented yet"