Skip to content

Commit ab42313

Browse files
committed
docs: Updating ApiConfig to reference .api_id instead of .id
1 parent 695277b commit ab42313

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

provider/doc_edits.go

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ func editRules(defaults []tfbridge.DocsEdit) []tfbridge.DocsEdit {
1717
removeBetaFromDescriptionField,
1818
substituteRandomSuffix,
1919
rewritemembersField,
20+
apiConfigApiId,
2021
)
2122
}
2223

@@ -145,3 +146,13 @@ var fixUpKmsCryptoKey = targetedSimpleReplace(
145146
"to the resource to prevent accidental destruction.",
146147
"For this reason, it is strongly recommended that you use "+
147148
"Pulumi's [protect resource option](https://www.pulumi.com/docs/concepts/options/protect/).")
149+
150+
var apiConfigApiIdStr = " Identifier to assign to the API Config. Must be unique within scope of the parent resource(api)."
151+
var apiConfigApiIdRegexp = regexp.MustCompile(apiConfigApiIdStr)
152+
var apiConfigApiId = tfbridge.DocsEdit{
153+
Path: "*api_gateway_api_config.html.markdown",
154+
Edit: func(_ string, content []byte) ([]byte, error) {
155+
content = effectiveLabelsRegexp.ReplaceAllLiteral(content, []byte(apiConfigApiIdStr+" **Note: use apiId if calling a resource**"))
156+
return content, nil
157+
},
158+
}

0 commit comments

Comments
 (0)