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.

Sign up for GitHub

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

document event orchestration attribute type for integration #722

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

document event orchestration attribute type for integration #722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions website/docs/d/event_orchestrations.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ The following arguments are supported:
* `name_filter` - The list of the Event Orchestrations which name match `name_filter` argument.
Copy link
Author

@margueritepd margueritepd Aug 4, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

I don't see name_filter in the docs on the registry, so I'm not sure why it says name_filter in the code definition for the event orchestration data source so I'm not sure why this markdown file says name_filter. Maybe I'm editing the wrong markdown file?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, this is a bit confusing because we have two data sources that look very similar:

  • pagerduty_event_orchestrations: lets you pull a list of orchestrations matching the given name filter. This is where it's documented and defined in the code
  • pagerduty_event_orchestration: returns a single orchestration matching the given name. It's documented and defined in the links that you posted.

* `id` - The ID of the found Event Orchestration.
* `name` - The name of the found Event Orchestration.
* `integration` - An integration for the Event Orchestration.
* `integration` - A list of integrations for the Event Orchestration.
* `id` - ID of the integration
* `parameters`
* `parameters` - A list of parameters.
* `routing_key` - Routing key that routes to this Orchestration.
* `type` - Type of the routing key. `global` is the default type.

Expand Down
4 changes: 2 additions & 2 deletions website/docs/r/event_orchestration.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ The following arguments are supported:
The following attributes are exported:

* `id` - The ID of the Event Orchestration.
* `integration` - An integration for the Event Orchestration.
* `integration` - A list of integrations for the Event Orchestration.
* `id` - ID of the integration
* `parameters`
* `parameters` - A list of parameters
* `routing_key` - Routing key that routes to this Orchestration.
* `type` - Type of the routing key. `global` is the default type.
Copy link
Author

Choose a reason for hiding this comment

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

In the terraform registry docs, the last two bullets are not displaying as being nested under parameters. Any idea how to fix?

Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you for fixing this! Hmm not sure why it's not nested properly, but I think there is a TF doc preview tool, let me see if I can find it.

Copy link
Contributor

Choose a reason for hiding this comment

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

@imjaroiswebdev I'm sorry to be tagging you everywhere today but wasn't it you who showed me a markdown preview tool specifically for Terraform docs? Or am I making things up?


Expand Down