Permalink
Fetching contributors…
Cannot retrieve contributors at this time
81 lines (75 sloc) 2.32 KB
#%RAML 0.8
title: Request Storage
version: v2.2
protocols: [ HTTP, HTTPS ]
baseUri: http://localhost:9130
documentation:
- title: Request Storage API
content: <b>Storage for requests</b>
schemas:
- request.json: !include request.json
- requests: !include requests.json
- errors: !include raml-util/schemas/errors.schema
- error.schema: !include raml-util/schemas/error.schema
- parameters.schema: !include raml-util/schemas/parameters.schema
- raml-util/schemas/metadata.schema: !include raml-util/schemas/metadata.schema
traits:
- secured: !include raml-util/traits/auth.raml
- 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
/request-storage:
/requests:
displayName: Requests
type:
collection:
exampleCollection: !include examples/requests.json
exampleItem: !include examples/request.json
schemaCollection: requests
schemaItem: request.json
get:
is: [pageable,
searchable: {description: "by using CQL",
example: "requesterId=\"cf23adf0-61ba-4887-bf82-956c4aae2260\""}
]
responses:
501:
description: "Not implemented yet"
post:
is: [validate]
responses:
501:
description: "Not implemented yet"
delete:
responses:
204:
description: "All requests 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"
/{requestId}:
type:
collection-item:
exampleItem: !include examples/request.json
schema: request.json
get:
responses:
501:
description: "Not implemented yet"
put:
is: [validate]
responses:
501:
description: "Not implemented yet"
delete:
responses:
501:
description: "Not implemented yet"