Skip to content

Commit 6f88ade

Browse files
authored
CLOUDP-195428: merge descriptions of oneOf fields (#166)
1 parent e1cfd02 commit 6f88ade

21 files changed

+363
-88
lines changed

admin/model_cloud_provider_access_role.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ type CloudProviderAccessRole struct {
1717
AtlasAssumedRoleExternalId *string `json:"atlasAssumedRoleExternalId,omitempty"`
1818
// Date and time when someone authorized this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
1919
AuthorizedDate *time.Time `json:"authorizedDate,omitempty"`
20-
// Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
20+
// Date and time when someone created this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Alternatively: Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
2121
CreatedDate *time.Time `json:"createdDate,omitempty"`
22-
// List that contains application features associated with this Azure Service Principal.
22+
// List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role. Alternatively: List that contains application features associated with this Azure Service Principal.
2323
FeatureUsages []CloudProviderAccessFeatureUsage `json:"featureUsages,omitempty"`
2424
// Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.
2525
IamAssumedRoleArn *string `json:"iamAssumedRoleArn,omitempty"`

admin/model_cloud_provider_container.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ type CloudProviderContainer struct {
1414
ProviderName *string `json:"providerName,omitempty"`
1515
// Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container.
1616
Provisioned *bool `json:"provisioned,omitempty"`
17-
// IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. These CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges. To modify the CIDR block, the target project cannot have: - Any M10 or greater clusters - Any other VPC peering connections You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.
17+
// IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. These CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges. To modify the CIDR block, the target project cannot have: - Any M10 or greater clusters - Any other VPC peering connections You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. Alternatively: IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range. To modify the CIDR block, the target project cannot have: - Any M10 or greater clusters - Any other VPC peering connections You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. Alternatively: IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. These CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges. To modify the CIDR block, the target project cannot have: - Any M10 or greater clusters - Any other VPC peering connections You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.
1818
AtlasCidrBlock *string `json:"atlasCidrBlock,omitempty"`
1919
// Unique string that identifies the Azure subscription in which the MongoDB Cloud VNet resides.
2020
AzureSubscriptionId *string `json:"azureSubscriptionId,omitempty"`

admin/model_cluster_provider_settings.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ type ClusterProviderSettings struct {
1515
// Flag that indicates whether the Amazon Elastic Block Store (EBS) encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Clusters always have this setting enabled.
1616
// Deprecated
1717
EncryptEBSVolume *bool `json:"encryptEBSVolume,omitempty"`
18-
// Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set **providerSettings.providerName** to `TENANT` and specify the cloud service provider in **providerSettings.backingProviderName**.
18+
// Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. Alternatively: Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set **providerSettings.providerName** to `TENANT` and specify the cloud service provider in **providerSettings.backingProviderName**.
1919
InstanceSizeName *string `json:"instanceSizeName,omitempty"`
20-
// Human-readable label that identifies the geographic location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). For multi-region clusters, see **replicationSpec.{region}**.
20+
// Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts. Alternatively: Microsoft Azure Regions. Alternatively: Google Compute Regions. Alternatively: Human-readable label that identifies the geographic location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). For multi-region clusters, see **replicationSpec.{region}**.
2121
RegionName *string `json:"regionName,omitempty"`
2222
// Disk Input/Output Operations per Second (IOPS) setting for Amazon Web Services (AWS) storage that you configure only for abbr title=\"Amazon Web Services\">AWS</abbr>. Specify whether Disk Input/Output Operations per Second (IOPS) must not exceed the default Input/Output Operations per Second (IOPS) rate for the selected volume size (`STANDARD`), or must fall within the allowable Input/Output Operations per Second (IOPS) range for the selected volume size (`PROVISIONED`).
2323
VolumeType *string `json:"volumeType,omitempty"`

admin/model_data_lake_store_settings.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ type DataLakeStoreSettings struct {
2727
Region *string `json:"region,omitempty"`
2828
// ID of the Cluster the Online Archive belongs to.
2929
ClusterId *string `json:"clusterId,omitempty"`
30-
// Human-readable label of the MongoDB Cloud cluster on which the store is based.
30+
// Name of the Cluster the Online Archive belongs to. Alternatively: Human-readable label of the MongoDB Cloud cluster on which the store is based.
3131
ClusterName *string `json:"clusterName,omitempty"`
32-
// Unique 24-hexadecimal digit string that identifies the project.
32+
// ID of the Project the Online Archive belongs to. Alternatively: Unique 24-hexadecimal digit string that identifies the project.
3333
ProjectId *string `json:"projectId,omitempty"`
3434
ReadPreference *DataLakeAtlasStoreReadPreference `json:"readPreference,omitempty"`
3535
// Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only.

admin/model_group_alerts_config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ type GroupAlertsConfig struct {
2121
Id *string `json:"id,omitempty"`
2222
// List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
2323
Links []Link `json:"links,omitempty"`
24-
// No matchers are available for these alert types. The list is always empty.
24+
// No matchers are available for these alert types. The list is always empty. Alternatively: List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. Alternatively: List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. Alternatively: No matchers are available for these alert types. The list is always empty. Alternatively: List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. Alternatively: No matchers are available for these alert types. The list is always empty. Alternatively: No matchers are available for these alert types. The list is always empty. Alternatively: List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. Alternatively: List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. Alternatively: No matchers are available for these alert types. The list is always empty. Alternatively: List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. Alternatively: List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. Alternatively: No matchers are available for these alert types. The list is always empty.
2525
Matchers []map[string]interface{} `json:"matchers,omitempty"`
2626
// List that contains the targets that MongoDB Cloud sends notifications.
2727
Notifications []AlertsNotificationRootForGroup `json:"notifications,omitempty"`

admin/model_private_link_endpoint.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ type PrivateLinkEndpoint struct {
2222
EndpointGroupName *string `json:"endpointGroupName,omitempty"`
2323
// List of individual private endpoints that comprise this endpoint group.
2424
Endpoints []GCPConsumerForwardingRule `json:"endpoints,omitempty"`
25-
// State of the Azure Private Link Service connection when MongoDB Cloud received this request.
25+
// State of the Google Cloud network endpoint group when MongoDB Cloud received this request. Alternatively: State of the Azure Private Link Service connection when MongoDB Cloud received this request.
2626
Status *string `json:"status,omitempty"`
2727
// Human-readable label that MongoDB Cloud generates that identifies the private endpoint connection.
2828
PrivateEndpointConnectionName *string `json:"privateEndpointConnectionName,omitempty"`

admin/model_serverless_tenant_endpoint.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ import (
1010
type ServerlessTenantEndpoint struct {
1111
// Unique 24-hexadecimal digit string that identifies the private endpoint.
1212
Id *string `json:"_id,omitempty"`
13-
// Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.
13+
// Unique string that identifies the private endpoint's network interface. Alternatively: Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.
1414
CloudProviderEndpointId *string `json:"cloudProviderEndpointId,omitempty"`
1515
// Human-readable comment associated with the private endpoint.
1616
Comment *string `json:"comment,omitempty"`
17-
// Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.
17+
// Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service. Alternatively: Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service. Alternatively: Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.
1818
EndpointServiceName *string `json:"endpointServiceName,omitempty"`
1919
// Human-readable error message that indicates error condition associated with establishing the private endpoint connection.
2020
ErrorMessage *string `json:"errorMessage,omitempty"`

admin/model_serverless_tenant_endpoint_update.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ type ServerlessTenantEndpointUpdate struct {
1111
// Human-readable comment associated with the private endpoint.
1212
Comment *string `json:"comment,omitempty"`
1313
ProviderName string `json:"providerName"`
14-
// Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.
14+
// Unique string that identifies the private endpoint's network interface. Alternatively: Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.
1515
CloudProviderEndpointId *string `json:"cloudProviderEndpointId,omitempty"`
1616
// IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.
1717
PrivateEndpointIpAddress *string `json:"privateEndpointIpAddress,omitempty"`

0 commit comments

Comments
 (0)