Get extra nested docs from schema map #1650
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| // Copyright 2016-2022, Pulumi Corporation. | ||
| // | ||
| // 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 | ||
| // | ||
| // http://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. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package testprovider | ||
|
|
||
| import ( | ||
| "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" | ||
| ) | ||
|
|
||
| // Subset of pulumi-cloudflare provider. | ||
| func ProviderNestedDescriptions() *schema.Provider { | ||
| resourceRuleset := func() *schema.Resource { | ||
| return &schema.Resource{ | ||
| Description: "Deploy a ruleset for cloudflare", | ||
| Schema: resourceNestedDescriptionsSchema(), | ||
| } | ||
| } | ||
|
|
||
| return &schema.Provider{ | ||
| Schema: map[string]*schema.Schema{}, | ||
| ResourcesMap: map[string]*schema.Resource{ | ||
| "cloudflare_ruleset": resourceRuleset(), | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| // An aggressively cut down version of cloudflare_ruleset. | ||
| func resourceNestedDescriptionsSchema() map[string]*schema.Schema { | ||
| return map[string]*schema.Schema{ | ||
| "name": { | ||
| Type: schema.TypeString, | ||
| Required: true, | ||
| ForceNew: true, | ||
| Description: "Name of the ruleset.", | ||
| }, | ||
| "description": { | ||
| Type: schema.TypeString, | ||
| Optional: true, | ||
| Description: "Brief summary of the ruleset and its intended use.", | ||
| }, | ||
| "rules": { | ||
| Type: schema.TypeList, | ||
| Optional: true, | ||
| Description: "List of rules to apply to the ruleset.", | ||
| Elem: &schema.Resource{ | ||
| Schema: map[string]*schema.Schema{ | ||
| "id": { | ||
| Type: schema.TypeString, | ||
| Computed: true, | ||
| Description: "Unique rule identifier.", | ||
| }, | ||
| "version": { | ||
| Type: schema.TypeString, | ||
| Computed: true, | ||
| Description: "Version of the ruleset to deploy.", | ||
| }, | ||
| "action_parameters": { | ||
| Type: schema.TypeList, | ||
| // MaxItems: 1, | ||
| Optional: true, | ||
| Description: "List of parameters that configure the behavior of the ruleset rule action.", | ||
| Elem: &schema.Resource{ | ||
| Schema: map[string]*schema.Schema{ | ||
| "id": { | ||
| Type: schema.TypeString, | ||
| Optional: true, | ||
| Description: "Identifier of the action parameter to modify. " + | ||
| "When Terraform is mentioned here, the description should be dropped.", | ||
| }, | ||
| "translateField": { | ||
| Type: schema.TypeString, | ||
| Optional: true, | ||
| Description: "When cloudflare_ruleset is mentioned, it should be translated.", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.