Skip to content

Commit

Permalink
generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lambcode committed Jan 19, 2024
1 parent 34e5078 commit 67b37ad
Show file tree
Hide file tree
Showing 4 changed files with 118 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/data-sources/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,5 @@ Use this data source to retrieve information about an existing stream for use in
- `id` (String) The ID of this resource.
- `stream_name` (String)
- `stream_query` (String) Stream query


57 changes: 57 additions & 0 deletions docs/resources/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ Required:

Optional:

- `alerts_list_panel` (Block Set) A dashboard panel to view a list of your alerts and their status (see [below for nested schema](#nestedblock--group--alerts_list_panel))
- `chart` (Block Set) (see [below for nested schema](#nestedblock--group--chart))
- `service_health_panel` (Block Set) A dashboard panel to view the health of your services (see [below for nested schema](#nestedblock--group--service_health_panel))
- `text_panel` (Block List) (see [below for nested schema](#nestedblock--group--text_panel))
Expand All @@ -168,6 +169,62 @@ Read-Only:

- `id` (String) The ID of this resource.

<a id="nestedblock--group--alerts_list_panel"></a>
### Nested Schema for `group.alerts_list_panel`

Optional:

- `filter_by` (Block Set, Max: 1) a list of predicates that are implicitly ANDed together to filter alerts (see [below for nested schema](#nestedblock--group--alerts_list_panel--filter_by))
- `height` (Number)
- `name` (String)
- `panel_options` (Block Set, Max: 1) custom options for the service health panel (see [below for nested schema](#nestedblock--group--alerts_list_panel--panel_options))
- `width` (Number)
- `x_pos` (Number)
- `y_pos` (Number)

Read-Only:

- `id` (String) The ID of this resource.

<a id="nestedblock--group--alerts_list_panel--filter_by"></a>
### Nested Schema for `group.alerts_list_panel.filter_by`

Optional:

- `predicate` (Block Set) a single predicate (see [below for nested schema](#nestedblock--group--alerts_list_panel--filter_by--predicate))

<a id="nestedblock--group--alerts_list_panel--filter_by--predicate"></a>
### Nested Schema for `group.alerts_list_panel.filter_by.predicate`

Optional:

- `label` (Block Set) Labels can be key/value pairs or standalone values. (see [below for nested schema](#nestedblock--group--alerts_list_panel--filter_by--predicate--label))
- `operator` (String)

<a id="nestedblock--group--alerts_list_panel--filter_by--predicate--label"></a>
### Nested Schema for `group.alerts_list_panel.filter_by.predicate.label`

Required:

- `value` (String)

Optional:

- `key` (String)




<a id="nestedblock--group--alerts_list_panel--panel_options"></a>
### Nested Schema for `group.alerts_list_panel.panel_options`

Optional:

- `sort_by` (String)
- `sort_direction` (String)



<a id="nestedblock--group--chart"></a>
### Nested Schema for `group.chart`

Expand Down
57 changes: 57 additions & 0 deletions docs/resources/metric_dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,7 @@ Required:

Optional:

- `alerts_list_panel` (Block Set) A dashboard panel to view a list of your alerts and their status (see [below for nested schema](#nestedblock--group--alerts_list_panel))
- `chart` (Block Set) (see [below for nested schema](#nestedblock--group--chart))
- `service_health_panel` (Block Set) A dashboard panel to view the health of your services (see [below for nested schema](#nestedblock--group--service_health_panel))
- `text_panel` (Block List) (see [below for nested schema](#nestedblock--group--text_panel))
Expand All @@ -208,6 +209,62 @@ Read-Only:

- `id` (String) The ID of this resource.

<a id="nestedblock--group--alerts_list_panel"></a>
### Nested Schema for `group.alerts_list_panel`

Optional:

- `filter_by` (Block Set, Max: 1) a list of predicates that are implicitly ANDed together to filter alerts (see [below for nested schema](#nestedblock--group--alerts_list_panel--filter_by))
- `height` (Number)
- `name` (String)
- `panel_options` (Block Set, Max: 1) custom options for the service health panel (see [below for nested schema](#nestedblock--group--alerts_list_panel--panel_options))
- `width` (Number)
- `x_pos` (Number)
- `y_pos` (Number)

Read-Only:

- `id` (String) The ID of this resource.

<a id="nestedblock--group--alerts_list_panel--filter_by"></a>
### Nested Schema for `group.alerts_list_panel.filter_by`

Optional:

- `predicate` (Block Set) a single predicate (see [below for nested schema](#nestedblock--group--alerts_list_panel--filter_by--predicate))

<a id="nestedblock--group--alerts_list_panel--filter_by--predicate"></a>
### Nested Schema for `group.alerts_list_panel.filter_by.predicate`

Optional:

- `label` (Block Set) Labels can be key/value pairs or standalone values. (see [below for nested schema](#nestedblock--group--alerts_list_panel--filter_by--predicate--label))
- `operator` (String)

<a id="nestedblock--group--alerts_list_panel--filter_by--predicate--label"></a>
### Nested Schema for `group.alerts_list_panel.filter_by.predicate.label`

Required:

- `value` (String)

Optional:

- `key` (String)




<a id="nestedblock--group--alerts_list_panel--panel_options"></a>
### Nested Schema for `group.alerts_list_panel.panel_options`

Optional:

- `sort_by` (String)
- `sort_direction` (String)



<a id="nestedblock--group--chart"></a>
### Nested Schema for `group.chart`

Expand Down
2 changes: 2 additions & 0 deletions docs/resources/user_role_binding.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,3 +94,5 @@ resource "lightstep_user_role_binding" "proj_viewer" {
### Read-Only

- `id` (String) The ID of this resource.


0 comments on commit 67b37ad

Please sign in to comment.