From 4f6de052d74e9e3697c9687306d45c4cfa540087 Mon Sep 17 00:00:00 2001 From: Iris Scholten Date: Tue, 27 Mar 2018 11:45:57 -0700 Subject: [PATCH] update swagger.json with tableOptions info --- server/swagger.json | 62 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) diff --git a/server/swagger.json b/server/swagger.json index 8a109a2c7..6bd0f5e39 100644 --- a/server/swagger.json +++ b/server/swagger.json @@ -3988,6 +3988,47 @@ } } }, + "tableOptions": { + "description": + "options for visualization of a cell with table type", + "type": "object", + "properties": { + "timeFormat": { + "description": + "timeFormat is the momentjs format of time in a cell of type table", + "type": "string" + }, + "verticalTimeAxis": { + "description": + "verticalTimeAxis defines the orientation of the table and whether or not time is a column or row", + "type": "boolean" + }, + "sortBy": { + "description": + "sortBy defines the column or row that a table should be sorted by", + "type": "object", + "$ref": "#/definitions/RenamableField" + }, + "wrapping": { + "description": + "wrapping defines the text wrapping format for tables", + "type": "string" + }, + "fieldNames": { + "description": + "fieldNames represent the fields retrieved by the query with customization options", + "type": "array", + "items": { + "$ref": "#/definitions/RenamableField" + } + }, + "fixFirstColumn": { + "description": + "fixFirstColumn represents locking or freezing the first column of the table", + "type": "boolean" + } + } + }, "links": { "type": "object", "properties": { @@ -4129,6 +4170,27 @@ } } }, + "RenamableField": { + "description": + "renamableField represents a field that can be renamed and toggled visible or not", + "type": "object", + "properties": { + "internalName": { + "description": "internalName is the calculated name of a field", + "type": "string" + }, + "displayName": { + "description": + "displayName is the name that a field is renamed to by the user", + "type": "string" + }, + "visible": { + "description": + "visible defines whether or not this field row or column should be visible within the table", + "type": "boolean" + } + } + }, "Routes": { "type": "object", "properties": {