DXCDT-363: Fix connection docs #471
Conversation
| @@ -29,8 +29,6 @@ Data source to retrieve a specific Auth0 connection by `connection_id` or `name` | |||
| - `realms` (List of String) Defines the realms for which the connection will be used (e.g., email domains). If not specified, the connection name is added as the realm. | |||
| - `show_as_button` (Boolean) Display connection as a button. Only available on enterprise connections. | |||
| - `strategy` (String) Type of the connection, which indicates the identity provider. | |||
| - `strategy_version` (String) | |||
There was a problem hiding this comment.
These 2 properties shouldn't have been neither in the data source or the resource connection docs. These are part of the current state upgraders only and are old remnants of past provider versions.
| @@ -774,7 +776,7 @@ var resourceSchema = map[string]*schema.Schema{ | |||
| } | |||
|
|
|||
| func connectionSchemaV0() *schema.Resource { | |||
| s := resourceSchema | |||
| s := internalSchema.Clone(resourceSchema) | |||
There was a problem hiding this comment.
Because the resourceSchema is a map (pointer), we were modifying the same current schema with the old schema version attributes causing the generated docs as well to display these properties that were removed in v2. We're making a clone of the resource schema instead and then safely modifying it.
| @@ -48,3 +48,17 @@ func SetExistingAttributesAsOptional(schema map[string]*schema.Schema, keys ...s | |||
| schema[attribute].Required = false | |||
| } | |||
| } | |||
|
|
|||
| // Clone returns a shallow clone of m. | |||
There was a problem hiding this comment.
For our use case a shallow clone is perfectly fine as the attributes are top-level.
Codecov ReportBase: 87.16% // Head: 87.17% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## feature/DXCDT-363-connection-data-source #471 +/- ##
============================================================================
+ Coverage 87.16% 87.17% +0.01%
============================================================================
Files 48 48
Lines 9387 9396 +9
============================================================================
+ Hits 8182 8191 +9
Misses 921 921
Partials 284 284
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. |
🔧 Changes
This PR aims at fixing some small issues with the connection resource and data source docs.
However, the issue where computed properties don't have descriptions set on the data source docs, e.g. https://registry.terraform.io/providers/auth0/auth0/latest/docs/data-sources/client#nested-schema-for-addonssamlp is not caused by the
schema.TransformResourceToDataSourcehelper func, but instead originates from hashicorp/terraform-plugin-docs#66.📚 References
🔬 Testing
📝 Checklist