multivimbroker/multivimbroker/swagger/multivim.tenant.swagger.json

   1 {
   2     "swagger": "2.0",
   3     "info": {
   4         "version": "1.0.0",
   5         "title": "MultiVIM Service rest API"
   6     },
   7     "basePath": "/api/multicloud/v0/",
   8     "tags": [
   9         {
  10             "name": "MultiVIM services"
  11         }
  12     ],
  13     "paths": {
  14         "/{vimid}/tenants": {
  15             "get": {
  16                 "tags": [
  17                     "vim tenants"
  18                 ],
  19                 "summary": "query vim tenants list",
  20                 "description": "query vim tenants list",
  21                 "operationId": "query_vim_tenants",
  22                 "consumes": [
  23                     "application/json"
  24                 ],
  25                 "produces": [
  26                     "application/json"
  27                 ],
  28                 "parameters": [
  29                     {
  30                         "name": "vimid",
  31                         "in": "path",
  32                         "description": "vim instance id",
  33                         "required": true,
  34                         "type": "string"
  35                     },
  36                     {
  37                         "name": "name",
  38                         "in":  "query",
  39                         "description": "tenant name to filter tenant list",
  40                         "required": false,
  41                         "type": "string"
  42                     }
  43                 ],
  44                 "responses": {
  45                     "200": {
  46                         "description": "successful operation",
  47                         "schema": {
  48                             "$ref": "#/definitions/VimTenantsInfo"
  49                         }
  50                     },
  51                     "404": {
  52                         "description": "the vim id is wrong"
  53                     },
  54                     "500": {
  55                         "description": "the vim tenants is not accessable"
  56                     }
  57                 }
  58             }
  59         }
  60     },
  61     "definitions": {
  62         "VimTenantsInfo": {
  63             "type": "object",
  64             "required": [
  65                 "vimId",
  66                 "tenants"
  67             ],
  68             "properties": {
  69                 "vimId": {
  70                     "type": "string"
  71                 },
  72                 "vimName": {
  73                     "type": "string"
  74                 },
  75                 "tenants": {
  76                     "type": "array",
  77                     "description": "tenant list information",
  78                     "items": {
  79                        "$ref": "#/definitions/VimTenantInfo"
  80                     }
  81                 }
  82             }
  83         },
  84         "VimTenantInfo": {
  85             "type": "object",
  86             "required": [
  87                 "name",
  88                 "id"
  89             ],
  90             "properties": {
  91                 "name": {
  92                     "type": "string",
  93                     "description": "tenant name"
  94                 },
  95                 "id": {
  96                     "type": "string",
  97                     "description": "tenant UUID"
  98                 }
  99             }
 100         }
 101     }
 102 }