Documented api_name for fields (GoogleCloudPlatform#10433)

pawelJas · May 16, 2024 · 113ab65 · 113ab65
1 parent 5133429
commit 113ab65
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/docs/content/develop/field-reference.md b/docs/content/develop/field-reference.md
@@ -225,6 +225,18 @@ Example:
   diff_suppress_func: 'tpgresource.CaseDiffSuppress'
 ```
 
+### `api_name`
+Specifies a name to use for communication with the API that is different than
+the name of the field in Terraform. In general, setting an `api_name` is not
+recommended, because it makes it more difficult for users and maintainers to
+understand how the resource maps to the underlying API.
+
+```yaml
+- !ruby/object:Api::Type::String
+  name: 'fieldOne'
+  api_name: 'otherFieldName'
+```
+
 ## `Enum` properties
 
 ### `values`