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

Add examples to data and resource documentation blocks #192

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

obs-gh-maxhahn
Copy link
Contributor

Documented most of the non-deprecated data sources that are still missing examples, and some of the resources.

Documented most of the non-deprecated data sources that are still
missing examples, and some of the resources.
Comment on lines +1 to +3
data "observe_workspace" "default" {
name = "Default"
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unnecessary, remove

@@ -0,0 +1,3 @@
data "observe_default_dashboard" "example" {
dataset = "41000100"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add dashboard field


# lookup by name
data "observe_monitor_v2" "name_lookup" {
workspace = data.observe_workspace.default.oid
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this looks good, but need to update monitor v2 validation


# lookup by name
data "observe_monitor_v2_action" "name_lookup" {
workspace = data.observe_workspace.default.oid
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same thing here, looks fine, need to update monitor v2 action validation

}

# construct an OID from components
data "observe_oid" "workspace" {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: rename resource to something else so file is valid as is (currently has duplicate resource name)

@@ -0,0 +1,3 @@
data "observe_default_dashboard" "lookup_by_name" {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wrong type

@@ -0,0 +1 @@
terraform import observe_correlation_tag.example 1414010
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove, correlation tags don't support import

}

resource "observe_correlation_tag" "example" {
name = "%[1]s-key.name"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

%[1]s?

id = "stage-nkeju1il"
input = [
{
datasetId = "41000014"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use a data source reference instead?

@@ -0,0 +1 @@
terraform import observe_dashboard.example 1414010
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wrong type

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants