share/newton_base/swagger/multivim.tenant.swagger.json


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
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"
                }
            }
        }
    }
}