fix: Makes specified fields optional in their respective schemas (#557)

Author: oarbusi

admin/model_stream_processor_metric_threshold.go

@@ -5,7 +5,7 @@ package admin
 // StreamProcessorMetricThreshold Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in stream processors.
 type StreamProcessorMetricThreshold struct {
 	// Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**.
-	MetricName string `json:"metricName"`
+	MetricName *string `json:"metricName,omitempty"`
 	// MongoDB Cloud computes the current metric value as an average.
 	Mode *string `json:"mode,omitempty"`
 	// Comparison operator to apply when checking the current metric value.
@@ -20,9 +20,8 @@ type StreamProcessorMetricThreshold struct {
 // This constructor will assign default values to properties that have it defined,
 // and makes sure properties required by API are set, but the set of arguments
 // will change when the set of required properties is changed
-func NewStreamProcessorMetricThreshold(metricName string) *StreamProcessorMetricThreshold {
+func NewStreamProcessorMetricThreshold() *StreamProcessorMetricThreshold {
 	this := StreamProcessorMetricThreshold{}
-	this.MetricName = metricName
 	var units string = "RAW"
 	this.Units = &units
 	return &this
@@ -38,28 +37,37 @@ func NewStreamProcessorMetricThresholdWithDefaults() *StreamProcessorMetricThres
 	return &this
 }
 
-// GetMetricName returns the MetricName field value
+// GetMetricName returns the MetricName field value if set, zero value otherwise
 func (o *StreamProcessorMetricThreshold) GetMetricName() string {
-	if o == nil {
+	if o == nil || IsNil(o.MetricName) {
 		var ret string
 		return ret
 	}
-
-	return o.MetricName
+	return *o.MetricName
 }
 
-// GetMetricNameOk returns a tuple with the MetricName field value
+// GetMetricNameOk returns a tuple with the MetricName field value if set, nil otherwise
 // and a boolean to check if the value has been set.
 func (o *StreamProcessorMetricThreshold) GetMetricNameOk() (*string, bool) {
-	if o == nil {
+	if o == nil || IsNil(o.MetricName) {
 		return nil, false
 	}
-	return &o.MetricName, true
+
+	return o.MetricName, true
+}
+
+// HasMetricName returns a boolean if a field has been set.
+func (o *StreamProcessorMetricThreshold) HasMetricName() bool {
+	if o != nil && !IsNil(o.MetricName) {
+		return true
+	}
+
+	return false
 }
 
-// SetMetricName sets field value
+// SetMetricName gets a reference to the given string and assigns it to the MetricName field.
 func (o *StreamProcessorMetricThreshold) SetMetricName(v string) {
-	o.MetricName = v
+	o.MetricName = &v
 }
 
 // GetMode returns the Mode field value if set, zero value otherwise

internal/core/version.go

@@ -5,7 +5,7 @@ package core
 // For more information please see: https://github.com/mongodb/atlas-sdk-go/blob/main/docs/doc_1_concepts.md
 const (
 	// SDK release tag version.
-	Version = "v20250312001.0.0"
+	Version = "v20250312001.1.0"
 	// Resource Version.
 	Resource = "20250312"
 )

openapi/atlas-api-transformed.yaml

@@ -15349,8 +15349,6 @@ components:
           $ref: "#/components/schemas/RawMetricUnits"
           description: Element used to express the quantity. This can be an element of
             time, storage capacity, and the like.
-      required:
-        - metricName
       title: Stream Processor Metric Threshold
       type: object
     StreamsAWSConnectionConfig:

tools/transformer/src/atlasTransformations.js

@@ -9,6 +9,7 @@ const {
   applyRemoveNullableTransformations,
   removeRefsFromParameters,
   reorderResponseBodies,
+  applyFieldTransformations,
 } = require("./transformations");
 const { resolveOpenAPIReference } = require("./engine/transformers");
 
@@ -29,6 +30,7 @@ module.exports = function runTransformations(openapi) {
   openapi = applyRemoveNullableTransformations(openapi);
   openapi = applyRemoveObjectAdditionalProperties(openapi);
   openapi = reorderResponseBodies(openapi);
+  openapi = applyFieldTransformations(openapi);
 
   openapi = applyModelNameTransformations(
     openapi,

tools/transformer/src/field.transformations.json

@@ -0,0 +1,5 @@
+{
+  "optionalFields": {
+    "StreamProcessorMetricThreshold": ["metricName"]
+  }
+}

tools/transformer/src/transformations/fields.js

@@ -0,0 +1,29 @@
+const fieldTransformations = require("../field.transformations.json");
+
+/**
+ * Makes specified fields optional in their respective schemas
+ * @param {*} api OpenAPI JSON File
+ * @returns OpenAPI JSON File
+ */
+function applyFieldTransformations(api) {
+  const { optionalFields } = fieldTransformations;
+
+  // Make specified fields optional in their schemas
+  for (const [schemaName, fields] of Object.entries(optionalFields)) {
+    const schema = api.components.schemas[schemaName];
+    if (schema && schema.required) {
+      schema.required = schema.required.filter(
+        (field) => !fields.includes(field),
+      );
+      if (schema.required.length === 0) {
+        delete schema.required;
+      }
+    }
+  }
+
+  return api;
+}
+
+module.exports = {
+  applyFieldTransformations,
+};

tools/transformer/src/transformations/index.js

@@ -15,6 +15,7 @@ const { applyAnyOfTransformations } = require("./anyOf");
 const { applyRemoveNullableTransformations } = require("./removeNullable");
 const { removeRefsFromParameters } = require("./removeInvalidParams");
 const { reorderResponseBodies } = require("./reorderResponseBodies");
+const { applyFieldTransformations } = require("./fields");
 
 module.exports = {
   applyModelNameTransformations,
@@ -31,4 +32,5 @@ module.exports = {
   applyRemoveNullableTransformations,
   removeRefsFromParameters,
   reorderResponseBodies,
+  applyFieldTransformations,
 };