Skip to content

Commit de1253b

Browse files
committed
docs: Allow additional description to be specified
This allows us to add helpful hints like: ``` The aws_ec2_vpc_endpoint_services table shows data for Amazon Elastic Compute Cloud (EC2) VPC Endpoint Services. Note: You will usually want to use `WHERE owner != 'amazon'` when querying this table. ``` The second line is the additional description.
1 parent c72190f commit de1253b

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

schema/table.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,9 @@ type Table struct {
7272
Title string `json:"title"`
7373
// table description
7474
Description string `json:"description"`
75+
// AdditionalDescription is an optional field that can be used to provide more context after the basic preamble and
76+
// permissions information.
77+
AdditionalDescription string `json:"additionalDescription"`
7578
// List of permissions needed to access this table, if any. For example ["Microsoft.Network/dnsZones/read"] or ["storage.buckets.list"]
7679
PermissionsNeeded []string `json:"permissions_needed"`
7780
// List of columns that may contain sensitive or secret data

0 commit comments

Comments
 (0)