diff options
Diffstat (limited to 'share/newton_base/swagger/multivim.tenant.swagger.json')
-rw-r--r-- | share/newton_base/swagger/multivim.tenant.swagger.json | 102 |
1 files changed, 102 insertions, 0 deletions
diff --git a/share/newton_base/swagger/multivim.tenant.swagger.json b/share/newton_base/swagger/multivim.tenant.swagger.json new file mode 100644 index 00000000..ed0c6c45 --- /dev/null +++ b/share/newton_base/swagger/multivim.tenant.swagger.json @@ -0,0 +1,102 @@ +{ + "swagger": "2.0", + "info": { + "version": "1.0.0", + "title": "MultiVIM Service rest API" + }, + "basePath": "/api/multicloud-newton/v0/", + "tags": [ + { + "name": "MultiVIM services" + } + ], + "paths": { + "/{vimid}/tenants": { + "get": { + "tags": [ + "vim tenants" + ], + "summary": "query vim tenants list", + "description": "query vim tenants list", + "operationId": "query_vim_tenants", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "vimid", + "in": "path", + "description": "vim instance id", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "query", + "description": "tenant name to filter tenant list", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/VimTenantsInfo" + } + }, + "404": { + "description": "the vim id is wrong" + }, + "500": { + "description": "the vim tenants is not accessable" + } + } + } + } + }, + "definitions": { + "VimTenantsInfo": { + "type": "object", + "required": [ + "vimId", + "tenants" + ], + "properties": { + "vimId": { + "type": "string" + }, + "vimName": { + "type": "string" + }, + "tenants": { + "type": "array", + "description": "tenant list information", + "items": { + "$ref": "#/definitions/VimTenantInfo" + } + } + } + }, + "VimTenantInfo": { + "type": "object", + "required": [ + "name", + "id" + ], + "properties": { + "name": { + "type": "string", + "description": "tenant name" + }, + "id": { + "type": "string", + "description": "tenant UUID" + } + } + } + } +} |