Update walkapi to support 3.2 additionalOperations

Author: BlakeTheAwesome

openapi/testdata/walk.additionaloperations.openapi.yaml

@@ -0,0 +1,107 @@
+openapi: 3.2.0
+info:
+  title: AdditionalOperations Test API
+  version: 1.0.0
+  description: API for testing additionalOperations walk functionality
+
+paths:
+  /custom/{id}:
+    summary: Custom operations path
+    description: Path with custom HTTP methods in additionalOperations
+    parameters:
+      - name: id
+        in: path
+        description: Resource ID
+        required: true
+        schema:
+          type: string
+    get:
+      operationId: getCustomResource
+      summary: Get custom resource
+      description: Standard GET operation
+      responses:
+        "200":
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  id:
+                    type: string
+                  name:
+                    type: string
+    additionalOperations:
+      COPY:
+        operationId: copyCustomResource
+        summary: Copy custom resource
+        description: Custom COPY operation to duplicate a resource
+        tags:
+          - custom
+        parameters:
+          - name: destination
+            in: header
+            description: Destination for copy operation
+            required: true
+            schema:
+              type: string
+        responses:
+          "201":
+            description: Resource copied successfully
+            content:
+              application/json:
+                schema:
+                  type: object
+                  properties:
+                    id:
+                      type: string
+                    originalId:
+                      type: string
+                    message:
+                      type: string
+          "400":
+            description: Invalid copy request
+        x-custom: copy-operation-extension
+      PURGE:
+        operationId: purgeCustomResource
+        summary: Purge custom resource
+        description: Custom PURGE operation to completely remove a resource
+        tags:
+          - custom
+        responses:
+          "204":
+            description: Resource purged successfully
+          "404":
+            description: Resource not found
+        x-custom: purge-operation-extension
+    x-custom: custom-path-item-extension
+
+  /standard:
+    get:
+      operationId: getStandardResource
+      summary: Get standard resource
+      description: Standard operation without additionalOperations
+      responses:
+        "200":
+          description: Success
+
+components:
+  schemas:
+    CustomResource:
+      type: object
+      description: Custom resource object
+      properties:
+        id:
+          type: string
+          description: Resource identifier
+        name:
+          type: string
+          description: Resource name
+        data:
+          type: object
+          description: Resource data
+      required:
+        - id
+        - name
+
+x-custom: root-extension

openapi/walk.go

@@ -275,6 +275,15 @@ func walkPathItem(ctx context.Context, pathItem *PathItem, parent MatchFunc, loc
 		}
 	}
 
+	// Walk through additional operations (OpenAPI 3.2+)
+	if pathItem.AdditionalOperations != nil {
+		for method, operation := range pathItem.AdditionalOperations.All() {
+			if !walkOperation(ctx, operation, append(loc, LocationContext{ParentMatchFunc: parent, ParentField: "additionalOperations", ParentKey: pointer.From(method)}), openAPI, yield) {
+				return false
+			}
+		}
+	}
+
 	// Visit PathItem Extensions
 	return yield(WalkItem{Match: getMatchFunc(pathItem.Extensions), Location: append(loc, LocationContext{ParentMatchFunc: parent, ParentField: ""}), OpenAPI: openAPI})
 }

openapi/walk_test.go

@@ -1084,3 +1084,67 @@ func TestWalk_Terminate_Success(t *testing.T) {
 
 	assert.Equal(t, 1, visits, "expected only one visit before terminating")
 }
+
+func TestWalkAdditionalOperations_Success(t *testing.T) {
+	t.Parallel()
+
+	// Load OpenAPI document with additionalOperations
+	f, err := os.Open("testdata/walk.additionaloperations.openapi.yaml")
+	require.NoError(t, err)
+	defer f.Close()
+
+	openAPIDoc, validationErrs, err := openapi.Unmarshal(t.Context(), f)
+	require.NoError(t, err)
+	require.Empty(t, validationErrs, "Document should be valid")
+
+	matchedLocations := []string{}
+	expectedAssertions := map[string]func(*openapi.Operation){
+		"/paths/~1custom~1{id}/get": func(op *openapi.Operation) {
+			assert.Equal(t, "getCustomResource", op.GetOperationID())
+			assert.Equal(t, "Get custom resource", op.GetSummary())
+		},
+		"/paths/~1custom~1{id}/additionalOperations/COPY": func(op *openapi.Operation) {
+			assert.Equal(t, "copyCustomResource", op.GetOperationID())
+			assert.Equal(t, "Copy custom resource", op.GetSummary())
+			assert.Equal(t, "Custom COPY operation to duplicate a resource", op.GetDescription())
+			assert.Contains(t, op.GetTags(), "custom")
+		},
+		"/paths/~1custom~1{id}/additionalOperations/PURGE": func(op *openapi.Operation) {
+			assert.Equal(t, "purgeCustomResource", op.GetOperationID())
+			assert.Equal(t, "Purge custom resource", op.GetSummary())
+			assert.Equal(t, "Custom PURGE operation to completely remove a resource", op.GetDescription())
+			assert.Contains(t, op.GetTags(), "custom")
+		},
+		"/paths/~1standard/get": func(op *openapi.Operation) {
+			assert.Equal(t, "getStandardResource", op.GetOperationID())
+			assert.Equal(t, "Get standard resource", op.GetSummary())
+		},
+	}
+
+	for item := range openapi.Walk(t.Context(), openAPIDoc) {
+		err := item.Match(openapi.Matcher{
+			Operation: func(op *openapi.Operation) error {
+				operationLoc := string(item.Location.ToJSONPointer())
+				matchedLocations = append(matchedLocations, operationLoc)
+
+				if assertFunc, exists := expectedAssertions[operationLoc]; exists {
+					assertFunc(op)
+				}
+
+				return nil
+			},
+		})
+		require.NoError(t, err)
+	}
+
+	// Verify all expected operations were visited
+	for expectedLoc := range expectedAssertions {
+		assert.Contains(t, matchedLocations, expectedLoc, "Should visit operation at location: %s", expectedLoc)
+	}
+
+	// Verify we found both standard and additional operations
+	assert.Contains(t, matchedLocations, "/paths/~1custom~1{id}/get", "Should visit standard GET operation")
+	assert.Contains(t, matchedLocations, "/paths/~1custom~1{id}/additionalOperations/COPY", "Should visit additional COPY operation")
+	assert.Contains(t, matchedLocations, "/paths/~1custom~1{id}/additionalOperations/PURGE", "Should visit additional PURGE operation")
+	assert.Contains(t, matchedLocations, "/paths/~1standard/get", "Should visit standard operation on path without additionalOperations")
+}