Permalink
Fetching contributors…
Cannot retrieve contributors at this time
60 lines (54 sloc) 1.71 KB
#%RAML 1.0
title: Loan Types API
version: v2.2
protocols: [ HTTP, HTTPS ]
baseUri: http://localhost
documentation:
- title: Loan Types API
content: This documents the API calls that can be made to query and manage loan types of the system
types:
loantype: !include loantype.json
loantypes: !include loantypes.json
errors: !include raml-util/schemas/errors.schema
traits:
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
get-delete-only: !include raml-util/rtypes/get-delete.raml
/loan-types:
type:
collection:
exampleCollection: !include examples/loantypes.json
exampleItem: !include examples/loantype.json
schemaCollection: loantypes
schemaItem: loantype
get:
is: [
searchable: {description: "with valid searchable fields", example: "name=aaa"},
pageable
]
description: Return a list of loan types
delete:
is: [language]
description: "Delete all loan types"
responses:
204:
description: "All loan types deleted"
500:
description: "Internal server error, e.g. due to misconfiguration"
body:
text/plain:
example: "Internal server error, contact administrator"
post:
description: Create a new loan type
is: [validate]
/{loantypeId}:
description: Pass in the loan type code
type:
collection-item:
exampleItem: !include examples/loantype.json
schema: loantype