Skip to content
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.

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

Updated typos #12278

Merged
merged 2 commits into from
Dec 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/content/contribute/review-pr.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ This page provides guidelines for reviewing a Magic Modules pull request (PR).
{{< /hint >}}
1. a significant number of preexisting tests have not been modified. Changing old tests often indicates a change is backwards incompatible.
1. Check documentation to ensure
1. resouce-level and field-level documentation are generated correctly for MMv1-based resource
1. resource-level and field-level documentation are generated correctly for MMv1-based resource
1. documentation is added manually for handwritten resources.
1. Check if release notes capture all changes in the PR, and are correctly formatted following the guidance in [write release notes]({{< ref "release-notes" >}}) before merging the PR.
2 changes: 1 addition & 1 deletion docs/content/reference/make-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ make provider VERSION=ga OUTPUT_PATH="$GOPATH/src/github.com/hashicorp/terraform

- `OUTPUT_PATH`: Required. The location you are generating provider code into.
- `VERSION`: Required. The version of the provider you are building into. Valid values are `ga` and `beta`.
- `PRODUCT`: Limits generations to the specified folder within `mmv1/products` or `tpgtools/api`. Handwritten files from `mmv1/third_party/terraform` are always generated into the downstream regardless of this setting, so you can provide a non-existant product name to generate only handwritten code. Required if `RESOURCE` is specified.
- `PRODUCT`: Limits generations to the specified folder within `mmv1/products` or `tpgtools/api`. Handwritten files from `mmv1/third_party/terraform` are always generated into the downstream regardless of this setting, so you can provide a non-existent product name to generate only handwritten code. Required if `RESOURCE` is specified.
- `RESOURCE`: Limits generation to the specified resource within a particular product. For `mmv1` resources, matches the resource's `name` field (set in its configuration file).For `tpgtools` resources, matches the terraform resource name.
- `ENGINE`: Modifies `make provider` to only generate code using the specified engine. Valid values are `mmv1` or `tpgtools`. (Providing `tpgtools` will still generate any prerequisite mmv1 files required for tpgtools.)

Expand Down
8 changes: 4 additions & 4 deletions mmv1/products/accesscontextmanager/ServicePerimeter.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ properties:
- 'ANY_IDENTITY'
- 'ANY_USER_ACCOUNT'
- 'ANY_SERVICE_ACCOUNT'
diff_suppress_func: AccessContextManagerServicePerimeterIdentityTypeDiffSupressFunc
diff_suppress_func: AccessContextManagerServicePerimeterIdentityTypeDiffSuppressFunc
- name: 'identities'
type: Array
description: |
Expand Down Expand Up @@ -381,7 +381,7 @@ properties:
- 'ANY_IDENTITY'
- 'ANY_USER_ACCOUNT'
- 'ANY_SERVICE_ACCOUNT'
diff_suppress_func: AccessContextManagerServicePerimeterIdentityTypeDiffSupressFunc
diff_suppress_func: AccessContextManagerServicePerimeterIdentityTypeDiffSuppressFunc
- name: 'sources'
type: Array
description: 'Sources that this EgressPolicy authorizes access from.'
Expand Down Expand Up @@ -572,7 +572,7 @@ properties:
- 'ANY_IDENTITY'
- 'ANY_USER_ACCOUNT'
- 'ANY_SERVICE_ACCOUNT'
diff_suppress_func: AccessContextManagerServicePerimeterIdentityTypeDiffSupressFunc
diff_suppress_func: AccessContextManagerServicePerimeterIdentityTypeDiffSuppressFunc
- name: 'identities'
type: Array
description: |
Expand Down Expand Up @@ -690,7 +690,7 @@ properties:
- 'ANY_IDENTITY'
- 'ANY_USER_ACCOUNT'
- 'ANY_SERVICE_ACCOUNT'
diff_suppress_func: AccessContextManagerServicePerimeterIdentityTypeDiffSupressFunc
diff_suppress_func: AccessContextManagerServicePerimeterIdentityTypeDiffSuppressFunc
- name: 'sources'
type: Array
description: 'Sources that this EgressPolicy authorizes access from.'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ properties:
- 'ANY_IDENTITY'
- 'ANY_USER_ACCOUNT'
- 'ANY_SERVICE_ACCOUNT'
diff_suppress_func: AccessContextManagerServicePerimeterIdentityTypeDiffSupressFunc
diff_suppress_func: AccessContextManagerServicePerimeterIdentityTypeDiffSuppressFunc
- name: 'identities'
type: Array
description: |
Expand Down Expand Up @@ -152,7 +152,7 @@ properties:
then this `EgressTo` rule will authorize access to all resources outside
the perimeter.
custom_flatten: templates/terraform/custom_flatten/accesscontextmanager_egress_policy_resources_custom_flatten.go.tmpl
diff_suppress_func: AccessContextManagerServicePerimeterDryRunEgressPolicyEgressToResourcesDiffSupressFunc
diff_suppress_func: AccessContextManagerServicePerimeterDryRunEgressPolicyEgressToResourcesDiffSuppressFunc
item_type:
type: String
- name: 'externalResources'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ properties:
- 'ANY_IDENTITY'
- 'ANY_USER_ACCOUNT'
- 'ANY_SERVICE_ACCOUNT'
diff_suppress_func: AccessContextManagerServicePerimeterIdentityTypeDiffSupressFunc
diff_suppress_func: AccessContextManagerServicePerimeterIdentityTypeDiffSuppressFunc
- name: 'identities'
type: Array
description: |
Expand Down Expand Up @@ -169,7 +169,7 @@ properties:
resources inside the perimeter, provided that the request
also matches the `operations` field.
custom_flatten: templates/terraform/custom_flatten/accesscontextmanager_ingress_policy_resources_custom_flatten.go.tmpl
diff_suppress_func: AccessContextManagerServicePerimeterDryRunIngressPolicyIngressToResourcesDiffSupressFunc
diff_suppress_func: AccessContextManagerServicePerimeterDryRunIngressPolicyIngressToResourcesDiffSuppressFunc
item_type:
type: String
- name: 'operations'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ properties:
- 'ANY_IDENTITY'
- 'ANY_USER_ACCOUNT'
- 'ANY_SERVICE_ACCOUNT'
diff_suppress_func: AccessContextManagerServicePerimeterIdentityTypeDiffSupressFunc
diff_suppress_func: AccessContextManagerServicePerimeterIdentityTypeDiffSuppressFunc
- name: 'identities'
type: Array
description: |
Expand Down Expand Up @@ -150,7 +150,7 @@ properties:
then this `EgressTo` rule will authorize access to all resources outside
the perimeter.
custom_flatten: templates/terraform/custom_flatten/accesscontextmanager_egress_policy_resources_custom_flatten.go.tmpl
diff_suppress_func: AccessContextManagerServicePerimeterEgressPolicyEgressToResourcesDiffSupressFunc
diff_suppress_func: AccessContextManagerServicePerimeterEgressPolicyEgressToResourcesDiffSuppressFunc
item_type:
type: String
- name: 'externalResources'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ properties:
- 'ANY_IDENTITY'
- 'ANY_USER_ACCOUNT'
- 'ANY_SERVICE_ACCOUNT'
diff_suppress_func: AccessContextManagerServicePerimeterIdentityTypeDiffSupressFunc
diff_suppress_func: AccessContextManagerServicePerimeterIdentityTypeDiffSuppressFunc
- name: 'identities'
type: Array
description: |
Expand Down Expand Up @@ -169,7 +169,7 @@ properties:
resources inside the perimeter, provided that the request
also matches the `operations` field.
custom_flatten: templates/terraform/custom_flatten/accesscontextmanager_ingress_policy_resources_custom_flatten.go.tmpl
diff_suppress_func: AccessContextManagerServicePerimeterIngressPolicyIngressToResourcesDiffSupressFunc
diff_suppress_func: AccessContextManagerServicePerimeterIngressPolicyIngressToResourcesDiffSuppressFunc
item_type:
type: String
- name: 'operations'
Expand Down
2 changes: 1 addition & 1 deletion mmv1/products/apigee/AppGroup.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ properties:
- name: "channelId"
type: String
description: |
Channel identifier identifies the owner maintaing this grouping.
Channel identifier identifies the owner maintaining this grouping.
- name: "displayName"
type: String
description: |
Expand Down
4 changes: 2 additions & 2 deletions mmv1/products/billingbudget/Budget.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ properties:
this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See a list of acceptable credit type values.
If creditTypesTreatment is not INCLUDE_SPECIFIED_CREDITS, this field must be empty.

**Note:** If the field has a value in the config and needs to be removed, the field has to be an emtpy array in the config.
**Note:** If the field has a value in the config and needs to be removed, the field has to be an empty array in the config.
default_from_api: true
at_least_one_of:
- 'budget_filter.0.projects'
Expand All @@ -236,7 +236,7 @@ properties:
If the field is omitted, the report will include usage from the parent
account and all subaccounts, if they exist.

**Note:** If the field has a value in the config and needs to be removed, the field has to be an emtpy array in the config.
**Note:** If the field has a value in the config and needs to be removed, the field has to be an empty array in the config.
default_from_api: true
at_least_one_of:
- 'budget_filter.0.projects'
Expand Down
4 changes: 2 additions & 2 deletions mmv1/products/cloudfunctions2/Function.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -593,7 +593,7 @@ properties:
- name: 'projectId'
type: String
description: |
Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function.
Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function.
required: true
- name: 'secret'
type: String
Expand All @@ -619,7 +619,7 @@ properties:
- name: 'projectId'
type: String
description: |
Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function.
Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function.
required: true
- name: 'secret'
type: String
Expand Down
2 changes: 1 addition & 1 deletion mmv1/products/cloudrunv2/Job.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ properties:
- name: 'expireTime'
type: Time
description: |-
For a deleted resource, the time after which it will be permamently deleted.
For a deleted resource, the time after which it will be permanently deleted.
output: true
- name: 'creator'
type: String
Expand Down
2 changes: 1 addition & 1 deletion mmv1/products/cloudrunv2/Service.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ properties:
- name: 'expireTime'
type: Time
description: |-
For a deleted resource, the time after which it will be permamently deleted.
For a deleted resource, the time after which it will be permanently deleted.
output: true
- name: 'creator'
type: String
Expand Down
4 changes: 2 additions & 2 deletions mmv1/products/compute/Disk.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ custom_code:
pre_delete: 'templates/terraform/pre_delete/detach_disk.tmpl'
custom_diff:
- 'customdiff.ForceNewIfChange("size", IsDiskShrinkage)'
- 'hyperDiskIopsUpdateDiffSupress'
- 'hyperDiskIopsUpdateDiffSuppress'
examples:
- name: 'disk_basic'
primary_resource_id: 'default'
Expand Down Expand Up @@ -366,7 +366,7 @@ properties:
* projects/{project}/regions/{region}/disks/{disk}
* zones/{zone}/disks/{disk}
* regions/{region}/disks/{disk}
diff_suppress_func: 'sourceDiskDiffSupress'
diff_suppress_func: 'sourceDiskDiffSuppress'
- name: 'sourceDiskId'
type: String
description: |
Expand Down
4 changes: 2 additions & 2 deletions mmv1/products/compute/RegionDisk.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ custom_code:
pre_delete: 'templates/terraform/pre_delete/detach_disk.tmpl'
custom_diff:
- 'customdiff.ForceNewIfChange("size", IsDiskShrinkage)'
- 'hyperDiskIopsUpdateDiffSupress'
- 'hyperDiskIopsUpdateDiffSuppress'
examples:
- name: 'region_disk_basic'
primary_resource_id: 'regiondisk'
Expand Down Expand Up @@ -313,7 +313,7 @@ properties:
* projects/{project}/regions/{region}/disks/{disk}
* zones/{zone}/disks/{disk}
* regions/{region}/disks/{disk}
diff_suppress_func: 'sourceDiskDiffSupress'
diff_suppress_func: 'sourceDiskDiffSuppress'
- name: 'sourceDiskId'
type: String
description: |
Expand Down
2 changes: 1 addition & 1 deletion mmv1/products/dialogflowcx/Flow.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -587,7 +587,7 @@ properties:
- name: 'useTimeoutBasedEndpointing'
type: Boolean
description: |
Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
- name: 'models'
type: KeyValuePairs
description: |
Expand Down
2 changes: 1 addition & 1 deletion mmv1/products/gkehub2/Feature.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,7 @@ properties:
type: Enum
description: 'Configures the manner in which the template library is installed on the cluster.'
enum_values:
- 'INSTALATION_UNSPECIFIED'
- 'INSTALLATION_UNSPECIFIED'
- 'NOT_INSTALLED'
- 'ALL'
- name: 'bundles'
Expand Down
18 changes: 9 additions & 9 deletions mmv1/products/integrationconnectors/Connection.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -215,12 +215,12 @@ properties:
- name: 'encryptionKeyValue'
type: NestedObject
description: |
Encription key value of configVariable.
Encryption key value of configVariable.
properties:
- name: 'type'
type: Enum
description: |
Type of Encription Key
Type of Encryption Key
required: true
enum_values:
- 'GOOGLE_MANAGED'
Expand Down Expand Up @@ -287,12 +287,12 @@ properties:
- name: 'encryptionKeyValue'
type: NestedObject
description: |
Encription key value of configVariable.
Encryption key value of configVariable.
properties:
- name: 'type'
type: Enum
description: |
Type of Encription Key
Type of Encryption Key
required: true
enum_values:
- 'GOOGLE_MANAGED'
Expand Down Expand Up @@ -691,12 +691,12 @@ properties:
- name: 'encryptionKeyValue'
type: NestedObject
description: |
Encription key value of configVariable
Encryption key value of configVariable
properties:
- name: 'type'
type: Enum
description: |
Type of Encription Key
Type of Encryption Key
enum_values:
- 'GOOGLE_MANAGED'
- 'CUSTOMER_MANAGED'
Expand Down Expand Up @@ -810,12 +810,12 @@ properties:
- name: 'encryptionKeyValue'
type: NestedObject
description: |
Encription key value of configVariable
Encryption key value of configVariable
properties:
- name: 'type'
type: Enum
description: |
Type of Encription Key
Type of Encryption Key
enum_values:
- 'GOOGLE_MANAGED'
- 'CUSTOMER_MANAGED'
Expand Down Expand Up @@ -890,7 +890,7 @@ properties:
- name: 'encryptionKeyValue'
type: NestedObject
description: |
Encription key value of configVariable.
Encryption key value of configVariable.
properties:
- name: 'type'
type: Enum
Expand Down
2 changes: 1 addition & 1 deletion mmv1/products/netapp/ActiveDirectory.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ properties:
- name: 'kdcHostname'
type: String
description: |
Hostname of the Active Directory server used as Kerberos Key Distribution Center. Only requried for volumes using kerberized NFSv4.1
Hostname of the Active Directory server used as Kerberos Key Distribution Center. Only required for volumes using kerberized NFSv4.1
required: false
- name: 'kdcIp'
type: String
Expand Down
6 changes: 3 additions & 3 deletions mmv1/products/netapp/Volume.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ properties:
- name: 'storagePool'
type: String
description: |
Name of the storage pool to create the volume in. Pool needs enough spare capacity to accomodate the volume.
Name of the storage pool to create the volume in. Pool needs enough spare capacity to accommodate the volume.
required: true
- name: 'network'
type: String
Expand All @@ -123,7 +123,7 @@ properties:
- name: 'serviceLevel'
type: String
description: |
Service level of the volume. Inherited from storage pool. Supported values are : PREMIUM, EXTERME, STANDARD, FLEX.
Service level of the volume. Inherited from storage pool. Supported values are : PREMIUM, EXTREME, STANDARD, FLEX.
output: true
- name: 'capacityGib'
type: String
Expand All @@ -146,7 +146,7 @@ properties:
- name: 'allowedClients'
type: String
description: |-
Defines the client ingress specification (allowed clients) as a comma seperated list with IPv4 CIDRs or IPv4 host addresses.
Defines the client ingress specification (allowed clients) as a comma separated list with IPv4 CIDRs or IPv4 host addresses.
- name: 'hasRootAccess'
type: String
description: |-
Expand Down
2 changes: 1 addition & 1 deletion mmv1/products/privateca/Certificate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1111,7 +1111,7 @@ properties:
properties:
- name: 'keyId'
type: String
description: The value of the KeyId in lowercase hexidecimal.
description: The value of the KeyId in lowercase hexadecimal.
immutable: true
- name: 'publicKey'
type: NestedObject
Expand Down
2 changes: 1 addition & 1 deletion mmv1/products/privateca/CertificateAuthority.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ properties:
properties:
- name: 'keyId'
type: String
description: The value of the KeyId in lowercase hexidecimal.
description: The value of the KeyId in lowercase hexadecimal.
immutable: true
- name: 'x509Config'
type: NestedObject
Expand Down
2 changes: 1 addition & 1 deletion mmv1/products/redis/Cluster.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,7 @@ properties:
description: |
Optional. Available fsync modes.

- NO - Do not explicilty call fsync(). Rely on OS defaults.
- NO - Do not explicitly call fsync(). Rely on OS defaults.
- EVERYSEC - Call fsync() once per second in a background thread. A balance between performance and durability.
- ALWAYS - Call fsync() for earch write command.
enum_values:
Expand Down
2 changes: 1 addition & 1 deletion mmv1/products/vertexai/IndexEndpointDeployedIndex.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ properties:
description: |
A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration.

# Note: Having the fields within automaticResouces not being marked as immutable was done in order to support the ability to update such fields. See : https://github.com/GoogleCloudPlatform/magic-modules/pull/11039#issuecomment-2209316648
# Note: Having the fields within automaticResources not being marked as immutable was done in order to support the ability to update such fields. See : https://github.com/GoogleCloudPlatform/magic-modules/pull/11039#issuecomment-2209316648
default_from_api: true
properties:
- name: 'minReplicaCount'
Expand Down
Loading
Loading