Skip to content

docs: Updating ApiConfig to reference .api_id instead of .id #2963

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

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

docs: Updating ApiConfig to reference .api_id instead of .id #2963

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
11 changes: 11 additions & 0 deletions provider/doc_edits.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ func editRules(defaults []tfbridge.DocsEdit) []tfbridge.DocsEdit {
removeBetaFromDescriptionField,
substituteRandomSuffix,
rewritemembersField,
apiConfigAPIID,
)
}

Expand Down Expand Up @@ -145,3 +146,13 @@ var fixUpKmsCryptoKey = targetedSimpleReplace(
"to the resource to prevent accidental destruction.",
"For this reason, it is strongly recommended that you use "+
"Pulumi's [protect resource option](https://www.pulumi.com/docs/concepts/options/protect/).")

var apiConfigAPIIDStr = "Identifier to assign to the API Config. Must be unique within scope of the parent resource(api)."
var apiConfigAPIIDRegexp = regexp.MustCompile(regexp.QuoteMeta(apiConfigAPIIDStr))
var apiConfigAPIID = tfbridge.DocsEdit{
Path: "*api_gateway_api_config.html.markdown",
Edit: func(_ string, content []byte) ([]byte, error) {
content = apiConfigAPIIDRegexp.ReplaceAllLiteral(content, []byte(apiConfigAPIIDStr+" **Note: use apiId if calling a resource**"))
return content, nil
},
}