Skip to content
Permalink
Browse files

Merge pull request #2161 from nickanderson/ENT-4796/3.12

ENT-4796: Fixups for docs on extending the report builder (3.12)
  • Loading branch information...
nickanderson committed Jul 10, 2019
2 parents 69d1250 + 486dc9a commit 3045cba5af36e22768a8354cfe0ef6c81aaad746
Showing with 6 additions and 5 deletions.
  1. +6 −5 enterprise-cfengine-guide/hub_administration/extending-query-builder.markdown
@@ -89,13 +89,14 @@ Below you can see an example of hosts table representation as JSON element.

**Structure:**

Each element has a key and a value. When you create your own JSON element please use a unique key. The value is a
JSON object, please see explanations below.
Each element has a key and a value. When you create your own JSON element please use a unique key. The value is a
JSON object, please see explanations below. The element's key should be equal to `TableID`.

* **TableID** *(string)*
Table id, can be the same as main element key, should be unique.
* **Keys** *(json)*
Table keys, describe there primary key, emp.: `{'primary_key': 'HostKey'}`
Table keys, describe there primary key, emp.: `{'primary_key': 'HostKey'}`.
Primary key is case-sensitive. `primary_key` is the only possible key in `Keys` structure.
* **Label** *(string)*
Label contains a table's name that will be shown on the UI. Not necessary to use a real table name,
it can be an alias for better representation.
@@ -104,8 +105,8 @@ JSON object, please see explanations below.

**Fields structure:**

Fields object is presented as JSON, where key is unique table's key and value is JSON representation of
table column properties:
Fields object is presented as JSON, where key is unique table's key and value is JSON representation of table column properties.
The element's key should be equal to `sqlField`

* **name** *(string)*
Field's name

0 comments on commit 3045cba

Please sign in to comment.
You can’t perform that action at this time.