Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Regenerate docs #283

Merged
merged 7 commits into from
Nov 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions coralogix/resource_coralogix_dashboard_test.go
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
// Copyright 2024 Coralogix Ltd.
//
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//
// https://www.apache.org/licenses/LICENSE-2.0
//
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Expand Down Expand Up @@ -113,7 +113,7 @@ func TestAccCoralogixResourceDashboardFromJson(t *testing.T) {
panic(err)
}
parent := filepath.Dir(wd)
filePath := parent + "/examples/dashboard/dashboard.json"
filePath := parent + "/examples/resources/coralogix_hosted_dashboard/grafana_acc_updated_dashboard.json"
lootag marked this conversation as resolved.
Show resolved Hide resolved
resource.Test(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
Expand Down
13 changes: 5 additions & 8 deletions docs/data-sources/action.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,24 @@
---

# generated by https://github.com/hashicorp/terraform-plugin-docs

page_title: "coralogix_action Data Source - terraform-provider-coralogix"
subcategory: ""
description: "Coralogix action. For more info please review - https://coralogix.com/docs/coralogix-action-extension/."

description: |-
Coralogix action. For more info please review - https://coralogix.com/docs/coralogix-action-extension/.
---

# coralogix_action (Data Source)

Coralogix action. For more info please review - https://coralogix.com/docs/coralogix-action-extension/.

## Example Usage

```hcl
```terraform
data "coralogix_action" imported_action {
id = coralogix_action.action.id
}
```

<!-- schema generated by tfplugindocs -->

## Schema

### Required
Expand All @@ -36,5 +35,3 @@ data "coralogix_action" imported_action {
- `source_type` (String) By selecting the data type, you can make sure that the action will be displayed only in the relevant context. Can be one of ["Log" "DataMap"]
- `subsystems` (Set of String) Applies the action for specific subsystems.
- `url` (String) URL for the external tool.


17 changes: 6 additions & 11 deletions docs/data-sources/alert.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,15 @@
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "coralogix_alert Data Source - terraform-provider-coralogix"
subcategory: ""
description: "Coralogix Alert"
description: |-

---

# coralogix_alert (Data Source)
Coralogix alert. More info: https://coralogix.com/docs/alerts-api/ .

## Example Usage

```hcl
data "coralogix_alert" "imported_standard_alert" {
id = coralogix_alert.standard_alert.id
}
```



<!-- schema generated by tfplugindocs -->
## Schema
Expand All @@ -36,7 +31,7 @@ data "coralogix_alert" "imported_standard_alert" {
- `payload_filters` (Set of String) A list of log fields out of the log example which will be included with the alert notification.
- `ratio` (List of Object) Alert based on the ratio between queries. (see [below for nested schema](#nestedatt--ratio))
- `scheduling` (List of Object) Limit the triggering of this alert to specific time frames. Active always by default. (see [below for nested schema](#nestedatt--scheduling))
- `severity` (String) Determines the alert's severity. Can be one of ["Info" "Warning" "Critical" "Error"]
- `severity` (String) Determines the alert's severity. Can be one of ["Critical" "Error" "Info" "Warning"]
- `standard` (List of Object) Alert based on number of log occurrences. (see [below for nested schema](#nestedatt--standard))
- `time_relative` (List of Object) Alert based on ratio between timeframes. (see [below for nested schema](#nestedatt--time_relative))
- `tracing` (List of Object) Alert based on tracing latency. (see [below for nested schema](#nestedatt--tracing))
Expand Down Expand Up @@ -151,7 +146,7 @@ Read-Only:
- `time_window` (String)

<a id="nestedobjatt--metric--lucene--condition--manage_undetected_values"></a>
### Nested Schema for `metric.lucene.condition.time_window`
### Nested Schema for `metric.lucene.condition.manage_undetected_values`

Read-Only:

Expand Down Expand Up @@ -188,7 +183,7 @@ Read-Only:
- `time_window` (String)

<a id="nestedobjatt--metric--promql--condition--manage_undetected_values"></a>
### Nested Schema for `metric.promql.condition.time_window`
### Nested Schema for `metric.promql.condition.manage_undetected_values`

Read-Only:

Expand Down
28 changes: 11 additions & 17 deletions docs/data-sources/alerts_scheduler.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,7 @@ description: |-

Coralogix alerts-scheduler.

## Example Usage

```hcl
data "coralogix_alerts_scheduler" "example" {
id = "id"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down Expand Up @@ -89,7 +83,7 @@ Read-Only:
- `time_zone` (String)

<a id="nestedatt--schedule--one_time--time_frame--duration"></a>
### Nested Schema for `schedule.one_time.time_frame.time_zone`
### Nested Schema for `schedule.one_time.time_frame.duration`

Read-Only:

Expand Down Expand Up @@ -117,28 +111,28 @@ Read-Only:
- `time_frame` (Attributes) (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--time_frame))

<a id="nestedatt--schedule--recurring--dynamic--frequency"></a>
### Nested Schema for `schedule.recurring.dynamic.time_frame`
### Nested Schema for `schedule.recurring.dynamic.frequency`

Read-Only:

- `daily` (Attributes) (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--time_frame--daily))
- `monthly` (Attributes) (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--time_frame--monthly))
- `weekly` (Attributes) (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--time_frame--weekly))
- `daily` (Attributes) (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--frequency--daily))
- `monthly` (Attributes) (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--frequency--monthly))
- `weekly` (Attributes) (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--frequency--weekly))

<a id="nestedatt--schedule--recurring--dynamic--time_frame--daily"></a>
### Nested Schema for `schedule.recurring.dynamic.time_frame.daily`
<a id="nestedatt--schedule--recurring--dynamic--frequency--daily"></a>
### Nested Schema for `schedule.recurring.dynamic.frequency.daily`


<a id="nestedatt--schedule--recurring--dynamic--time_frame--monthly"></a>
### Nested Schema for `schedule.recurring.dynamic.time_frame.monthly`
<a id="nestedatt--schedule--recurring--dynamic--frequency--monthly"></a>
### Nested Schema for `schedule.recurring.dynamic.frequency.monthly`

Read-Only:

- `days` (Set of Number)


<a id="nestedatt--schedule--recurring--dynamic--time_frame--weekly"></a>
### Nested Schema for `schedule.recurring.dynamic.time_frame.weekly`
<a id="nestedatt--schedule--recurring--dynamic--frequency--weekly"></a>
### Nested Schema for `schedule.recurring.dynamic.frequency.weekly`

Read-Only:

Expand Down
5 changes: 3 additions & 2 deletions docs/data-sources/api_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ Coralogix Api keys.

## Example Usage

```hcl
```terraform
data "coralogix_api_key" "same_key_by_id" {
id = coralogix_api_key.example.id
}
```
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand All @@ -40,5 +40,6 @@ data "coralogix_api_key" "same_key_by_id" {

Read-Only:

- `organisation_id` (String)
- `team_id` (String)
- `user_id` (String)
7 changes: 2 additions & 5 deletions docs/data-sources/archive_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,8 @@ description: |-

# coralogix_archive_logs (Data Source)

# Example Usage
```hcl
data "coralogix_archive_logs" example {
}
```




<!-- schema generated by tfplugindocs -->
Expand Down
5 changes: 0 additions & 5 deletions docs/data-sources/archive_metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,7 @@ description: |-

# coralogix_archive_metrics (Data Source)

# Example Usage

```hcl
data "coralogix_archive_metrics" example {
}
```



Expand Down
5 changes: 5 additions & 0 deletions docs/data-sources/archive_retentions.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,12 @@ description: |-

Coralogix archive-retention. For more info please review - https://coralogix.com/docs/archive-setup-grpc-api/.

## Example Usage

```terraform
data "coralogix_archive_retentions" "example" {
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
Loading
Loading