Update Swagger with Cell Axes

Cells now have axes which represent their visualization's viewport. This
updates the Swagger documentation to reflect this.

Things to be aware of
=====================

The form of "axes" is that of a map<string,object>, which is represented
in Swagger by an "additionalProperties" key (search for "string to model
mapping" here: https://swagger.io/specification/).
pull/1797/head
Tim Raymond 2017-07-19 11:18:01 -04:00
parent e513e61481
commit bab28c7271
No known key found for this signature in database
GPG Key ID: 221ADC45076A48C0
1 changed files with 23 additions and 0 deletions

View File

@ -3999,6 +3999,13 @@
"$ref": "#/definitions/DashboardQuery"
}
},
"axes": {
"description": "The viewport for a cell's visualizations",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/DashboardRange"
}
},
"type": {
"description": "Cell visualization type",
"type": "string",
@ -4080,6 +4087,22 @@
}
}
},
"DashboardRange": {
"type": "object",
"description": "A description of a particular axis for a visualization",
"properties": {
"bounds": {
"type": "array",
"minItems": 0,
"maxItems": 2,
"description": "The extents of an axis in the form [lower, upper]. Clients determine whether bounds are to be inclusive or exclusive of their limits",
"items": {
"type": "integer",
"format": "int32"
}
}
}
},
"Routes": {
"type": "object",
"properties": {