overlay: overlay object (#120)

Author: hauner

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

@@ -110,6 +110,9 @@ public interface Keywords {
 
     Set<String> OPERATIONS = Set.of(DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE);
 
+    // overlay
+    String OVERLAY = "overlay";
+
     static Collection<String> getProperties(Collection<Keyword> keywords) {
         return keywords
             .stream ()

openapi-parser/src/main/java/io/openapiparser/model/ov10/Extensions.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 https://github.com/openapi-processor/openapi-parser
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiparser.model.ov10;
+
+import java.util.Map;
+
+/**
+ * the <em>Specification Extensions</em> object.
+ *
+ * <p>See specification:
+ * <a href="https://spec.openapis.org/overlay/v1.0.0.html#specification-extensions">
+ *   4.6 Specification Extensions
+ * </a>
+ */
+public interface Extensions {
+
+    /**
+     * map of all extension properties.
+     *
+     * @return map of extension properties
+     */
+    Map<String, Object> getExtensions ();
+
+}

openapi-parser/src/main/java/io/openapiparser/model/ov10/Overlay.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2024 https://github.com/openapi-processor/openapi-parser
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiparser.model.ov10;
+
+import io.openapiparser.Context;
+import io.openapiparser.Properties;
+import io.openapiparser.support.Required;
+import io.openapiprocessor.jsonschema.schema.Bucket;
+
+import java.util.Map;
+
+import static io.openapiparser.Keywords.OVERLAY;
+
+/**
+ * the <em>Overlay</em> object.
+ *
+ * <p>See specification:
+ * <a href="https://spec.openapis.org/overlay/v1.0.0.html#overlay-object">4.4.1 Overlay Object</a>
+ */
+public class Overlay extends Properties implements Extensions {
+
+    public Overlay (Context context, Bucket bucket) {
+        super (context, bucket);
+    }
+
+    @Required
+    public String getOverlay () {
+        return getStringOrThrow (OVERLAY);
+    }
+
+    @Override
+    public Map<String, Object> getExtensions() {
+        return super.getExtensions ();
+    }
+}

openapi-parser/src/test/kotlin/io/openapiparser/model/ov10/OverlaySpec.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2024 https://github.com/openapi-processor/openapi-parser
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiparser.model.ov10
+
+import io.kotest.assertions.throwables.shouldThrow
+import io.kotest.core.spec.style.StringSpec
+import io.kotest.matchers.shouldBe
+import io.openapiparser.model.v30.overlay
+import io.openapiprocessor.jsonschema.converter.NoValueException
+
+class OverlaySpec: StringSpec({
+
+    "get overlay version" {
+        overlay("overlay: 1.0.0").overlay shouldBe "1.0.0"
+    }
+
+    "get overlay version throws if it is missing" {
+        shouldThrow<NoValueException> { overlay().overlay }
+    }
+})

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

@@ -5,6 +5,7 @@
 
 package io.openapiparser.model.v30
 
+import io.openapiparser.model.ov10.Overlay
 import io.openapiparser.support.buildObject
 
 fun callback(content: String = "{}"): Callback {
@@ -98,3 +99,7 @@ fun serverVariable(content: String = "{}"): ServerVariable {
 fun xml(content: String = "{}"): Xml {
     return buildObject(Xml::class.java, content)
 }
+
+fun overlay(content: String = "{}"): Overlay {
+    return buildObject(Overlay::class.java, content)
+}