CLOUDP-219156: Add ability for SDK to flag readonly and write only fields (#253)

Author: lovisaberggren

admin/model_access_list_item.go

@@ -9,8 +9,10 @@ import (
 // AccessListItem struct for AccessListItem
 type AccessListItem struct {
 	// Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that found in this project's access list.
+	// Read only field.
 	CidrBlock *string `json:"cidrBlock,omitempty"`
 	// IP address included in the API access list.
+	// Read only field.
 	IpAddress string `json:"ipAddress"`
 }
 

admin/model_advanced_cluster_description.go

@@ -18,23 +18,28 @@ type AdvancedClusterDescription struct {
 	ClusterType       *string                   `json:"clusterType,omitempty"`
 	ConnectionStrings *ClusterConnectionStrings `json:"connectionStrings,omitempty"`
 	// Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.
+	// Read only field.
 	CreateDate *time.Time `json:"createDate,omitempty"`
 	// Storage capacity that the host's root volume possesses expressed in gigabytes. Increase this number to add capacity. MongoDB Cloud requires this parameter if you set **replicationSpecs**. If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value.  The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.
 	DiskSizeGB *float64 `json:"diskSizeGB,omitempty"`
 	// Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.
 	EncryptionAtRestProvider *string `json:"encryptionAtRestProvider,omitempty"`
 	// Unique 24-hexadecimal character string that identifies the project.
+	// Read only field.
 	GroupId *string `json:"groupId,omitempty"`
 	// Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Global Cluster. If you include existing zones in the request, you must specify this parameter. If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request.
+	// Read only field.
 	Id *string `json:"id,omitempty"`
 	// Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.  Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.
 	// Deprecated
 	Labels *[]ComponentLabel `json:"labels,omitempty"`
 	// 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.
+	// Read only field.
 	Links *[]Link `json:"links,omitempty"`
 	// Major MongoDB version of the cluster. MongoDB Cloud deploys the cluster with the latest stable release of the specified version.
 	MongoDBMajorVersion *string `json:"mongoDBMajorVersion,omitempty"`
 	// Version of MongoDB that the cluster runs.
+	// Read only field.
 	MongoDBVersion *string `json:"mongoDBVersion,omitempty"`
 	// Human-readable label that identifies the advanced cluster.
 	Name *string `json:"name,omitempty"`
@@ -47,6 +52,7 @@ type AdvancedClusterDescription struct {
 	// Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.
 	RootCertType *string `json:"rootCertType,omitempty"`
 	// Human-readable label that indicates the current operating condition of this cluster.
+	// Read only field.
 	StateName *string `json:"stateName,omitempty"`
 	// List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.
 	Tags *[]ResourceTag `json:"tags,omitempty"`

admin/model_alert_view_for_nds_group.go

@@ -14,41 +14,59 @@ type AlertViewForNdsGroup struct {
 	// Comment that a MongoDB Cloud user submitted when acknowledging the alert.
 	AcknowledgementComment *string `json:"acknowledgementComment,omitempty"`
 	// MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
+	// Read only field.
 	AcknowledgingUsername *string `json:"acknowledgingUsername,omitempty"`
 	// Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
+	// Read only field.
 	AlertConfigId *string `json:"alertConfigId,omitempty"`
 	// Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC.
+	// Read only field.
 	Created *time.Time `json:"created,omitempty"`
 	// Incident that triggered this alert.
+	// Read only field.
 	EventTypeName *string `json:"eventTypeName,omitempty"`
 	// Unique 24-hexadecimal digit string that identifies the project that owns this alert.
+	// Read only field.
 	GroupId *string `json:"groupId,omitempty"`
 	// Unique 24-hexadecimal digit string that identifies this alert.
+	// Read only field.
 	Id *string `json:"id,omitempty"`
 	// Date and time that any notifications were last sent for this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
+	// Read only field.
 	LastNotified *time.Time `json:"lastNotified,omitempty"`
 	// 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.
+	// Read only field.
 	Links *[]Link `json:"links,omitempty"`
 	// Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
+	// Read only field.
 	OrgId *string `json:"orgId,omitempty"`
 	// Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.
+	// Read only field.
 	Resolved *time.Time `json:"resolved,omitempty"`
 	// State of this alert at the time you requested its details.
+	// Read only field.
 	Status *string `json:"status,omitempty"`
 	// Date and time when someone last updated this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC.
+	// Read only field.
 	Updated *time.Time `json:"updated,omitempty"`
 	// Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.
+	// Read only field.
 	ClusterName *string `json:"clusterName,omitempty"`
 	// Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.
+	// Read only field.
 	HostnameAndPort *string `json:"hostnameAndPort,omitempty"`
 	// Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.
+	// Read only field.
 	ReplicaSetName *string            `json:"replicaSetName,omitempty"`
 	CurrentValue   *NumberMetricValue `json:"currentValue,omitempty"`
 	// Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.  To learn more about the available metrics, see <a href=\"https://www.mongodb.com/docs/atlas/reference/alert-host-metrics/#std-label-measurement-types\" target=\"_blank\">Host Metrics</a>.  **NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see <a href=\"https://dochub.mongodb.org/core/alert-config-serverless-measurements\" target=\"_blank\">Serverless Measurements</a>.
+	// Read only field.
 	MetricName *string `json:"metricName,omitempty"`
 	// List of unique 24-hexadecimal character strings that identify the replica set members that are not in PRIMARY nor SECONDARY state.
+	// Read only field.
 	NonRunningHostIds *[]string `json:"nonRunningHostIds,omitempty"`
 	// Unique 24-hexadecimal character string that identifies the parent cluster to which this alert applies. The parent cluster contains the sharded nodes. MongoDB Cloud returns this parameter only for alerts of events impacting sharded clusters.
+	// Read only field.
 	ParentClusterId *string `json:"parentClusterId,omitempty"`
 }
 

admin/model_api_atlas_checkpoint.go

@@ -10,22 +10,31 @@ import (
 // ApiAtlasCheckpoint struct for ApiAtlasCheckpoint
 type ApiAtlasCheckpoint struct {
 	// Unique 24-hexadecimal digit string that identifies the cluster that contains the checkpoint.
+	// Read only field.
 	ClusterId *string `json:"clusterId,omitempty"`
 	// Date and time when the checkpoint completed and the balancer restarted. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
+	// Read only field.
 	Completed *time.Time `json:"completed,omitempty"`
 	// Unique 24-hexadecimal digit string that identifies the project that owns the checkpoints.
+	// Read only field.
 	GroupId *string `json:"groupId,omitempty"`
 	// Unique 24-hexadecimal digit string that identifies checkpoint.
+	// Read only field.
 	Id *string `json:"id,omitempty"`
 	// 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.
+	// Read only field.
 	Links *[]Link `json:"links,omitempty"`
 	// Metadata that describes the complete snapshot.  - For a replica set, this array contains a single document. - For a sharded cluster, this array contains one document for each shard plus one document for the config host.
+	// Read only field.
 	Parts *[]ApiCheckpointPart `json:"parts,omitempty"`
 	// Flag that indicates whether MongoDB Cloud can use the checkpoint for a restore.
+	// Read only field.
 	Restorable *bool `json:"restorable,omitempty"`
 	// Date and time when the balancer stopped and began the checkpoint. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
+	// Read only field.
 	Started *time.Time `json:"started,omitempty"`
 	// Date and time to which the checkpoint restores. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
+	// Read only field.
 	Timestamp *time.Time `json:"timestamp,omitempty"`
 }
 

admin/model_api_atlas_snapshot_schedule.go

@@ -15,8 +15,10 @@ type ApiAtlasSnapshotSchedule struct {
 	// Quantity of time to keep daily snapshots. MongoDB Cloud expresses this value in days. Set this value to `0` to disable daily snapshot retention.
 	DailySnapshotRetentionDays int `json:"dailySnapshotRetentionDays"`
 	// Unique 24-hexadecimal digit string that identifies the project that contains the cluster.
+	// Read only field.
 	GroupId string `json:"groupId"`
 	// 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.
+	// Read only field.
 	Links *[]Link `json:"links,omitempty"`
 	// Number of months that MongoDB Cloud must keep monthly snapshots. Set this value to `0` to disable monthly snapshot retention.
 	MonthlySnapshotRetentionMonths int `json:"monthlySnapshotRetentionMonths"`

admin/model_api_bson_timestamp.go

@@ -10,8 +10,10 @@ import (
 // ApiBSONTimestamp BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.
 type ApiBSONTimestamp struct {
 	// Date and time when the oplog recorded this database operation. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
+	// Read only field.
 	Date *time.Time `json:"date,omitempty"`
 	// Order of the database operation that the oplog recorded at specific date and time.
+	// Read only field.
 	Increment *int `json:"increment,omitempty"`
 }
 

admin/model_api_checkpoint_part.go

@@ -9,13 +9,17 @@ import (
 // ApiCheckpointPart Metadata contained in one document that describes the complete snapshot taken for this node.
 type ApiCheckpointPart struct {
 	// Human-readable label that identifies the replica set to which this checkpoint applies.
+	// Read only field.
 	ReplicaSetName *string `json:"replicaSetName,omitempty"`
 	// Human-readable label that identifies the shard to which this checkpoint applies.
+	// Read only field.
 	ShardName *string `json:"shardName,omitempty"`
 	// Flag that indicates whether the token exists.
+	// Read only field.
 	TokenDiscovered *bool             `json:"tokenDiscovered,omitempty"`
 	TokenTimestamp  *ApiBSONTimestamp `json:"tokenTimestamp,omitempty"`
 	// Human-readable label that identifies the type of host that the part represents.
+	// Read only field.
 	TypeName *string `json:"typeName,omitempty"`
 }
 

admin/model_api_host_view_atlas.go

@@ -10,28 +10,40 @@ import (
 // ApiHostViewAtlas struct for ApiHostViewAtlas
 type ApiHostViewAtlas struct {
 	// Date and time when MongoDB Cloud created this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
+	// Read only field.
 	Created *time.Time `json:"created,omitempty"`
 	// Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.
+	// Read only field.
 	GroupId *string `json:"groupId,omitempty"`
 	// Hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`).
+	// Read only field.
 	Hostname *string `json:"hostname,omitempty"`
 	// Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.
+	// Read only field.
 	Id *string `json:"id,omitempty"`
 	// Date and time when MongoDB Cloud received the last ping for this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
+	// Read only field.
 	LastPing *time.Time `json:"lastPing,omitempty"`
 	// 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.
+	// Read only field.
 	Links *[]LinkAtlas `json:"links,omitempty"`
 	// Internet Assigned Numbers Authority (IANA) port on which the MongoDB process listens for requests.
+	// Read only field.
 	Port *int `json:"port,omitempty"`
 	// Human-readable label that identifies the replica set that contains this process. This resource returns this parameter if this process belongs to a replica set.
+	// Read only field.
 	ReplicaSetName *string `json:"replicaSetName,omitempty"`
 	// Human-readable label that identifies the shard that contains this process. This resource returns this value only if this process belongs to a sharded cluster.
+	// Read only field.
 	ShardName *string `json:"shardName,omitempty"`
 	// Type of MongoDB process that MongoDB Cloud tracks. MongoDB Cloud returns new processes as **NO_DATA** until MongoDB Cloud completes deploying the process.
+	// Read only field.
 	TypeName *string `json:"typeName,omitempty"`
 	// Human-readable label that identifies the cluster node. MongoDB Cloud sets this hostname usually to the standard hostname for the cluster node. It appears in the connection string for a cluster instead of the value of the hostname parameter.
+	// Read only field.
 	UserAlias *string `json:"userAlias,omitempty"`
 	// Version of MongoDB that this process runs.
+	// Read only field.
 	Version *string `json:"version,omitempty"`
 }
 

admin/model_api_key.go

@@ -9,12 +9,16 @@ import (
 // ApiKey Details contained in one API key.
 type ApiKey struct {
 	// List of network addresses granted access to this API using this API key.
+	// Read only field.
 	AccessList *[]AccessListItem `json:"accessList,omitempty"`
 	// Unique 24-hexadecimal digit string that identifies this organization API key.
+	// Read only field.
 	Id string `json:"id"`
 	// Public API key value set for the specified organization API key.
+	// Read only field.
 	PublicKey string `json:"publicKey"`
 	// List that contains roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the Cloud user.
+	// Read only field.
 	Roles *[]CloudAccessRoleAssignment `json:"roles,omitempty"`
 }
 

admin/model_api_key_user_details.go

@@ -11,12 +11,16 @@ type ApiKeyUserDetails struct {
 	// Purpose or explanation provided when someone created this organization API key.
 	Desc *string `json:"desc,omitempty"`
 	// Unique 24-hexadecimal digit string that identifies this organization API key assigned to this project.
+	// Read only field.
 	Id *string `json:"id,omitempty"`
 	// 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.
+	// Read only field.
 	Links *[]Link `json:"links,omitempty"`
 	// Redacted private key returned for this organization API key. This key displays unredacted when first created.
+	// Read only field.
 	PrivateKey *string `json:"privateKey,omitempty"`
 	// Public API key value set for the specified organization API key.
+	// Read only field.
 	PublicKey *string `json:"publicKey,omitempty"`
 	// List that contains the roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the API key.
 	Roles *[]CloudAccessRoleAssignment `json:"roles,omitempty"`