fix: upgraded boolean

Author: TristanSpeakEasy

openapi/openapi_examples_test.go

@@ -924,10 +924,13 @@ components:
 	}
 
 	// Upgrade the document to the latest version
-	err = openapi.Upgrade(ctx, doc)
+	upgraded, err := openapi.Upgrade(ctx, doc)
 	if err != nil {
 		panic(err)
 	}
+	if !upgraded {
+		panic("upgrade should have been performed")
+	}
 
 	fmt.Printf("Upgraded OpenAPI Version: %s\n", doc.OpenAPI)
 

openapi/upgrade.go

@@ -23,9 +23,9 @@ func WithUpgradeSamePatchVersion() Option[UpgradeOptions] {
 
 // Upgrade upgrades any OpenAPI 3x document to OpenAPI 3.1.1 (the latest version currently supported).
 // It currently won't resolve any external references, so only this document itself will be upgraded.
-func Upgrade(ctx context.Context, doc *OpenAPI, opts ...Option[UpgradeOptions]) error {
+func Upgrade(ctx context.Context, doc *OpenAPI, opts ...Option[UpgradeOptions]) (bool, error) {
 	if doc == nil {
-		return nil
+		return false, nil
 	}
 
 	o := UpgradeOptions{}
@@ -42,7 +42,7 @@ func Upgrade(ctx context.Context, doc *OpenAPI, opts ...Option[UpgradeOptions])
 		// Upgrade 3.1.x versions to 3.1.1 if option is set and not already 3.1.1
 	} else {
 		// Don't upgrade other versions
-		return nil
+		return false, nil
 	}
 
 	for item := range Walk(ctx, doc) {
@@ -59,7 +59,7 @@ func Upgrade(ctx context.Context, doc *OpenAPI, opts ...Option[UpgradeOptions])
 	}
 
 	_, err := marshaller.Sync(ctx, doc)
-	return err
+	return true, err
 }
 
 func upgradeSchema(js *oas3.JSONSchema[oas3.Referenceable]) {

openapi/upgrade_test.go

@@ -70,8 +70,9 @@ func TestUpgrade_Success(t *testing.T) {
 			require.Empty(t, validationErrs, "original document should not have validation errors")
 
 			// Perform upgrade with options
-			err = openapi.Upgrade(ctx, originalDoc, tt.options...)
+			upgraded, err := openapi.Upgrade(ctx, originalDoc, tt.options...)
 			require.NoError(t, err, "upgrade should not fail: %s", tt.description)
+			assert.True(t, upgraded, "upgrade should have been performed")
 
 			// Marshal the upgraded document
 			var actualBuf bytes.Buffer
@@ -165,8 +166,9 @@ func TestUpgrade_NoUpgradeNeeded(t *testing.T) {
 			}
 
 			// Perform upgrade with options
-			err := openapi.Upgrade(ctx, doc, tt.options...)
+			upgraded, err := openapi.Upgrade(ctx, doc, tt.options...)
 			require.NoError(t, err, "upgrade should not fail")
+			require.Equal(t, tt.shouldUpgrade, upgraded)
 
 			// Check expected version
 			assert.Equal(t, tt.expectedVersion, doc.OpenAPI, "version should match expected for %s", tt.name)
@@ -228,9 +230,10 @@ components:
 	assert.Equal(t, "3.0.1", doc1.OpenAPI, "original version should be 3.0.1")
 
 	// Upgrade (no options needed for 3.0.x documents)
-	err = openapi.Upgrade(ctx, doc1)
+	upgraded, err := openapi.Upgrade(ctx, doc1)
 	require.NoError(t, err, "upgrade should not fail")
 	assert.Equal(t, openapi.Version, doc1.OpenAPI, "upgraded version should be 3.1.1")
+	assert.True(t, upgraded, "upgrade should have been performed")
 
 	// Marshal back
 	var buf1 bytes.Buffer