parallelvirtualcluster
/
pvc
1
0
Fork 0
Code Issues 15 Pull Requests Projects Releases 106 Wiki Activity

Fix bad metadata documentation

This commit is contained in:
Joshua Boniface 2019-12-29 20:58:02 -05:00
parent 4af95ecfcb
commit 6de65378ca
2 changed files with 57 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
client-api/pvc-api.py
View File

@ -345,44 +345,38 @@ class API_Status(Resource):
description: The cluster upstream IP address in CIDR format description: The cluster upstream IP address in CIDR format
example: 10.0.0.254/24 example: 10.0.0.254/24
nodes: nodes:
type: array type: object
items: properties:
type: object total:
properties: type: integer
total: description: The total number of nodes in the cluster
type: integer example: 3
description: The total number of nodes in the cluster state-combination:
example: 3 type: integer
state-combination: description: The total number of nodes in {state-combination} state, where {state-combination} is the node daemon and domain states in CSV format, e.g. "run,ready", "stop,flushed", etc.
type: integer
description: The total number of nodes in {state-combination} state, where {state-combination} is the node daemon and domain states in CSV format, e.g. "run,ready", "stop,flushed", etc.
vms: vms:
type: array type: object
items: properties:
type: object total:
properties: type: integer
total: description: The total number of VMs in the cluster
type: integer example: 6
description: The total number of VMs in the cluster state:
example: 6 type: integer
state: description: The total number of VMs in {state} state, e.g. "start", "stop", etc.
type: integer
description: The total number of VMs in {state} state, e.g. "start", "stop", etc.
networks: networks:
type: integer type: integer
description: The total number of networks in the cluster description: The total number of networks in the cluster
osds: osds:
type: array type: object
items: properties:
type: object total:
properties: type: integer
total: description: The total number of OSDs in the storage cluster
type: integer example: 3
description: The total number of OSDs in the storage cluster state-combination:
example: 3 type: integer
state-combination: description: The total number of OSDs in {state-combination} state, where {state-combination} is the OSD up and in states in CSV format, e.g. "up,in", "down,out", etc.
type: integer
description: The total number of OSDs in {state-combination} state, where {state-combination} is the OSD up and in states in CSV format, e.g. "up,in", "down,out", etc.
pools: pools:
type: integer type: integer
description: The total number of pools in the storage cluster description: The total number of pools in the storage cluster

69
docs/manuals/swagger.json
View File

@ -22,38 +22,32 @@
"type": "integer" "type": "integer"
}, },
"nodes": { "nodes": {
"items": { "properties": {
"properties": { "state-combination": {
"state-combination": { "description": "The total number of nodes in {state-combination} state, where {state-combination} is the node daemon and domain states in CSV format, e.g. \"run,ready\", \"stop,flushed\", etc.",
"description": "The total number of nodes in {state-combination} state, where {state-combination} is the node daemon and domain states in CSV format, e.g. \"run,ready\", \"stop,flushed\", etc.", "type": "integer"
"type": "integer"
},
"total": {
"description": "The total number of nodes in the cluster",
"example": 3,
"type": "integer"
}
}, },
"type": "object" "total": {
"description": "The total number of nodes in the cluster",
"example": 3,
"type": "integer"
}
}, },
"type": "array" "type": "object"
}, },
"osds": { "osds": {
"items": { "properties": {
"properties": { "state-combination": {
"state-combination": { "description": "The total number of OSDs in {state-combination} state, where {state-combination} is the OSD up and in states in CSV format, e.g. \"up,in\", \"down,out\", etc.",
"description": "The total number of OSDs in {state-combination} state, where {state-combination} is the OSD up and in states in CSV format, e.g. \"up,in\", \"down,out\", etc.", "type": "integer"
"type": "integer"
},
"total": {
"description": "The total number of OSDs in the storage cluster",
"example": 3,
"type": "integer"
}
}, },
"type": "object" "total": {
"description": "The total number of OSDs in the storage cluster",
"example": 3,
"type": "integer"
}
}, },
"type": "array" "type": "object"
}, },
"pools": { "pools": {
"description": "The total number of pools in the storage cluster", "description": "The total number of pools in the storage cluster",
@ -74,21 +68,18 @@
"type": "string" "type": "string"
}, },
"vms": { "vms": {
"items": { "properties": {
"properties": { "state": {
"state": { "description": "The total number of VMs in {state} state, e.g. \"start\", \"stop\", etc.",
"description": "The total number of VMs in {state} state, e.g. \"start\", \"stop\", etc.", "type": "integer"
"type": "integer"
},
"total": {
"description": "The total number of VMs in the cluster",
"example": 6,
"type": "integer"
}
}, },
"type": "object" "total": {
"description": "The total number of VMs in the cluster",
"example": 6,
"type": "integer"
}
}, },
"type": "array" "type": "object"
}, },
"volumes": { "volumes": {
"description": "The total number of volumes in the storage cluster", "description": "The total number of volumes in the storage cluster",