Permalink
Fetching contributors…
Cannot retrieve contributors at this time
69 lines (65 sloc) 1.85 KB
#%RAML 0.8
title: Tenant API
baseUri: http://localhost:8081/{version}
version: v1
traits:
- secured: !include ../traits/auth.raml
- validate: !include ../traits/validation.raml
schemas:
- tenantAttributes: !include ../schemas/moduleInfo.schema
- errors: !include ../schemas/errors.schema
- error.schema: !include ../schemas/error.schema
- parameters.schema: !include ../schemas/parameters.schema
/_/tenant:
post:
description: Provision a new / update an existing tenant
is: [secured, validate]
body:
application/json:
schema: tenantAttributes
example: !include ../examples/moduleInfo.sample
responses:
201:
description: "tenant id added successfully, returns a list of commands that have failed while initializing the tenant"
body:
application/json:
204:
description: "tenant id exists, nothing will be added"
400:
description: "Bad request"
body:
text/plain:
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error, contact administrator"
get:
description: Does tenant id already exist
is: [secured]
responses:
200:
description: "true or false indicator"
body:
text/plain:
example: "Text....."
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error, contact administrator"
delete:
description: drop tenant id
is: [secured]
responses:
204:
description: "Delete succeeded"
400:
description: "Bad request"
body:
text/plain:
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error, contact administrator"