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

Document the type values for the auth0 log stream resource #462

Merged
merged 1 commit into from
Mar 3, 2023

Conversation

ginman86
Copy link
Contributor

@ginman86 ginman86 commented Feb 1, 2023

🔧 Changes

Document the possible type values for the auth0 log stream resource.

@ginman86 ginman86 requested a review from a team as a code owner February 1, 2023 23:26
@@ -60,7 +60,7 @@ resource "auth0_log_stream" "example_aws" {

- `name` (String) Name of the log stream.
- `sink` (Block List, Min: 1, Max: 1) The sink configuration for the log stream. (see [below for nested schema](#nestedblock--sink))
- `type` (String) Type of the log stream, which indicates the sink provider.
- `type` (String) Type of the log stream, which indicates the sink provider. Possible values are: `eventbridge`, `eventgrid`, `http`, `datadog`, `splunk`, `sumo`, `mixpanel`.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

i pulled these from the provider's validation response: Error: expected type to be one of [eventbridge eventgrid http datadog splunk sumo mixpanel], got

Copy link
Contributor

Choose a reason for hiding this comment

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

Hey @ginman86 👋🏻

Thanks for the contribution! This is definitely a good addition!

Would you mind updating the description for this here

Description: "Type of the log stream, which indicates the sink provider.",
and then run make docs ? As the content within the docs folder is completely generated and shouldn't be modified manually. Additionally, we also included support for segment log stream.

To give better guiding on how to contribute we updated as well our CONTRIBUTING.md docs: https://github.com/auth0/terraform-provider-auth0/blob/patch/contributing/CONTRIBUTING.md#documentation (pending to be merged in).

@codecov-commenter
Copy link

Codecov Report

Base: 87.47% // Head: 87.47% // No change to project coverage 👍

Coverage data is based on head (dd60b56) compared to base (01d9b9e).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #462   +/-   ##
=======================================
  Coverage   87.47%   87.47%           
=======================================
  Files          42       42           
  Lines        9289     9289           
=======================================
  Hits         8126     8126           
  Misses        884      884           
  Partials      279      279           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@@ -60,7 +60,7 @@ resource "auth0_log_stream" "example_aws" {

- `name` (String) Name of the log stream.
- `sink` (Block List, Min: 1, Max: 1) The sink configuration for the log stream. (see [below for nested schema](#nestedblock--sink))
- `type` (String) Type of the log stream, which indicates the sink provider.
- `type` (String) Type of the log stream, which indicates the sink provider. Possible values are: `eventbridge`, `eventgrid`, `http`, `datadog`, `splunk`, `sumo`, `mixpanel`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Hey @ginman86 👋🏻

Thanks for the contribution! This is definitely a good addition!

Would you mind updating the description for this here

Description: "Type of the log stream, which indicates the sink provider.",
and then run make docs ? As the content within the docs folder is completely generated and shouldn't be modified manually. Additionally, we also included support for segment log stream.

To give better guiding on how to contribute we updated as well our CONTRIBUTING.md docs: https://github.com/auth0/terraform-provider-auth0/blob/patch/contributing/CONTRIBUTING.md#documentation (pending to be merged in).

Copy link
Contributor

@sergiught sergiught left a comment

Choose a reason for hiding this comment

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

Hey @ginman86 👋🏻 Thanks for the contribution! I had some time to rebase this and add the ammendments.

@sergiught sergiught changed the title Document the possible type values for the auth0 log stream resource. Document the type values for the auth0 log stream resource Mar 3, 2023
@sergiught sergiught merged commit 49d388d into auth0:main Mar 3, 2023
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

3 participants