get all operations of a path item

Author: hauner

openapi-parser/src/main/java/io/openapiparser/Keywords.java

@@ -6,6 +6,7 @@
 package io.openapiparser;
 
 import java.util.Collection;
+import java.util.Set;
 import java.util.stream.Collectors;
 
 public interface Keywords {
@@ -107,6 +108,8 @@ public interface Keywords {
     String WRITE_ONLY = "writeOnly";
     String XML = "xml";
 
+    Set<String> OPERATIONS = Set.of(DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE);
+
     static Collection<String> getProperties(Collection<Keyword> keywords) {
         return keywords
             .stream ()

openapi-parser/src/main/java/io/openapiparser/model/v30/PathItem.java

@@ -6,11 +6,11 @@
 package io.openapiparser.model.v30;
 
 import io.openapiparser.*;
+import io.openapiparser.Properties;
 import io.openapiprocessor.jsonschema.schema.Bucket;
 import org.checkerframework.checker.nullness.qual.Nullable;
 
-import java.util.Collection;
-import java.util.Map;
+import java.util.*;
 
 import static io.openapiparser.Keywords.*;
 
@@ -80,6 +80,16 @@ public PathItem getRefObject () {
         return getOperation (TRACE);
     }
 
+    public Map<String, Operation> getOperations () {
+        Map<String, Operation> operations = new LinkedHashMap<>();
+        bucket.forEach ((operation, value) -> {
+            if (OPERATIONS.contains (operation)) {
+                operations.put(operation, getOperation (operation));
+            }
+        });
+        return Collections.unmodifiableMap (operations);
+    }
+
     public Collection<Server> getServers () {
         return getObjectsOrEmpty (SERVERS, Server.class);
     }

openapi-parser/src/main/java/io/openapiparser/model/v31/PathItem.java

@@ -6,11 +6,11 @@
 package io.openapiparser.model.v31;
 
 import io.openapiparser.*;
+import io.openapiparser.Properties;
 import io.openapiprocessor.jsonschema.schema.Bucket;
 import org.checkerframework.checker.nullness.qual.Nullable;
 
-import java.util.Collection;
-import java.util.Map;
+import java.util.*;
 
 import static io.openapiparser.Keywords.*;
 
@@ -82,6 +82,16 @@ public PathItem getRefObject () {
         return getOperation (TRACE);
     }
 
+    public Map<String, Operation> getOperations () {
+        Map<String, Operation> operations = new LinkedHashMap<>();
+        bucket.forEach ((operation, value) -> {
+            if (OPERATIONS.contains (operation)) {
+                operations.put(operation, getOperation (operation));
+            }
+        });
+        return Collections.unmodifiableMap (operations);
+    }
+
     public Collection<Server> getServers () {
         return getObjectsOrEmpty (SERVERS, Server.class);
     }

openapi-parser/src/test/kotlin/io/openapiparser/model/v30/PathItemSpec.kt

@@ -7,6 +7,8 @@ package io.openapiparser.model.v30
 
 import io.kotest.core.spec.style.StringSpec
 import io.kotest.matchers.booleans.shouldBeFalse
+import io.kotest.matchers.collections.shouldContainExactly
+import io.kotest.matchers.maps.shouldHaveSize
 import io.kotest.matchers.nulls.shouldNotBeNull
 import io.kotest.matchers.shouldBe
 import io.openapiparser.support.ApiBuilder
@@ -88,4 +90,29 @@ class PathItemSpec : StringSpec({
         path?.description shouldBe "a description"
     }
 
+    "gets operations map in source order" {
+        val api = ApiBuilder()
+            .withApi("""
+                paths:
+                  /foo:
+                    get: {}
+                    put: {}
+                    post: {}
+                    delete: {}
+                    options: {}
+                    head: {}
+                    patch: {}
+                    trace: {}
+            """.trimIndent())
+            .buildOpenApi30()
+
+        val path = api.paths.getPathItem("/foo")
+
+        val operations = path?.operations
+        operations?.shouldHaveSize(8)
+
+        operations?.keys.shouldContainExactly(linkedSetOf(
+            "get", "put", "post", "delete", "options", "head", "patch", "trace"
+        ))
+    }
 })

openapi-parser/src/test/kotlin/io/openapiparser/model/v31/PathItemSpec.kt

@@ -0,0 +1,40 @@
+package io.openapiparser.model.v31
+
+/*
+ * Copyright 2021 https://github.com/openapi-processor/openapi-parser
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+import io.kotest.core.spec.style.StringSpec
+import io.kotest.matchers.collections.shouldContainExactly
+import io.kotest.matchers.maps.shouldHaveSize
+import io.openapiparser.support.ApiBuilder
+
+class PathItemSpec : StringSpec({
+
+    "gets operations map in source order" {
+        val api = ApiBuilder()
+            .withApi("""
+                paths:
+                  /foo:
+                    get: {}
+                    put: {}
+                    post: {}
+                    delete: {}
+                    options: {}
+                    head: {}
+                    patch: {}
+                    trace: {}
+            """.trimIndent())
+            .buildOpenApi30()
+
+        val path = api.paths.getPathItem("/foo")
+
+        val operations = path?.operations
+        operations?.shouldHaveSize(8)
+
+        operations?.keys.shouldContainExactly(linkedSetOf(
+            "get", "put", "post", "delete", "options", "head", "patch", "trace"
+        ))
+    }
+})