v32: new properties

Author: hauner

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

@@ -53,6 +53,7 @@ public interface Keywords {
     String ITEM_ENCODING = "itemEncoding";
     String ITEMS = "items";
     String JSON_SCHEMA_DIALECT = "jsonSchemaDialect";
+    String KIND = "kind";
     String LICENSE = "license";
     String LINKS = "links";
     String MAPPING = "mapping";
@@ -76,6 +77,7 @@ public interface Keywords {
     String OPERATION_ID = "operationId";
     String OPTIONS = "options";
     String PARAMETERS = "parameters";
+    String PARENT = "parent";
     String PATCH = "patch";
     String PATHS = "paths";
     String PATH_ITEMS = "pathItems";

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

@@ -6,11 +6,14 @@
 package io.openapiparser.model.v31;
 
 import io.openapiparser.*;
+import io.openapiparser.support.Required;
 import io.openapiprocessor.jsonschema.schema.Bucket;
 import org.checkerframework.checker.nullness.qual.Nullable;
 
 import java.util.Map;
 
+import static io.openapiparser.Keywords.*;
+
 /**
  * the <em>Tag</em> object.
  *
@@ -23,6 +26,19 @@ public Tag (Context context, Bucket bucket) {
         super (context, bucket);
     }
 
+    @Required
+    public String getName() {
+        return getStringOrThrow(NAME);
+    }
+
+    public @Nullable String getDescription () {
+        return getStringOrNull (DESCRIPTION);
+    }
+
+    public @Nullable ExternalDocumentation getExternalDocs () {
+        return getObjectOrNull (EXTERNAL_DOCS, ExternalDocumentation.class);
+    }
+
     @Override
     public Map<String, @Nullable Object> getExtensions () {
         return super.getExtensions ();

openapi-parser/src/main/java/io/openapiparser/model/v32/Tag.java

@@ -7,11 +7,15 @@
 
 import io.openapiparser.Context;
 import io.openapiparser.Properties;
+import io.openapiparser.model.v31.ExternalDocumentation;
+import io.openapiparser.support.Required;
 import io.openapiprocessor.jsonschema.schema.Bucket;
 import org.checkerframework.checker.nullness.qual.Nullable;
 
 import java.util.Map;
 
+import static io.openapiparser.Keywords.*;
+
 /**
  * the <em>Tag</em> object.
  *
@@ -24,6 +28,31 @@ public Tag (Context context, Bucket bucket) {
         super (context, bucket);
     }
 
+    @Required
+    public String getName() {
+        return getStringOrThrow(NAME);
+    }
+
+    public @Nullable String getSummary () {
+        return getStringOrNull (SUMMARY);
+    }
+
+    public @Nullable String getDescription () {
+        return getStringOrNull (DESCRIPTION);
+    }
+
+    public @Nullable ExternalDocumentation getExternalDocs () {
+        return getObjectOrNull (EXTERNAL_DOCS, ExternalDocumentation.class);
+    }
+
+    public @Nullable String getParent () {
+        return getStringOrNull (PARENT);
+    }
+
+    public @Nullable String getKind () {
+        return getStringOrNull (KIND);
+    }
+
     @Override
     public Map<String, @Nullable Object> getExtensions () {
         return super.getExtensions ();

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

@@ -95,6 +95,10 @@ fun serverVariable(content: String = "{}"): ServerVariable {
     return buildObject(ServerVariable::class.java, content)
 }
 
+fun tag(content: String = "{}"): Tag {
+    return buildObject(Tag::class.java, content)
+}
+
 fun xml(content: String = "{}"): Xml {
     return buildObject(Xml::class.java, content)
 }

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

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2025 https://github.com/openapi-processor/openapi-parser
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiparser.model.v31
+
+import io.kotest.assertions.throwables.shouldThrow
+import io.kotest.core.spec.style.StringSpec
+import io.kotest.matchers.nulls.shouldBeNull
+import io.kotest.matchers.nulls.shouldNotBeNull
+import io.kotest.matchers.shouldBe
+import io.openapiprocessor.jsonschema.converter.NoValueException
+import io.openapiparser.model.v31.tag as tag31
+import io.openapiparser.model.v32.tag as tag32
+
+class TagSpec: StringSpec({
+
+    "gets tag name" {
+        tag31("name: the name").name shouldBe "the name"
+        tag32("name: the name").name shouldBe "the name"
+    }
+
+    "gets tag name is null if missing" {
+        shouldThrow<NoValueException> { tag31().name }
+        shouldThrow<NoValueException> { tag32().name }
+    }
+
+    "gets tag description" {
+        tag31("description: a description").description shouldBe "a description"
+        tag32("description: a description").description shouldBe "a description"
+    }
+
+    "gets tag description is null if missing" {
+        tag31().description.shouldBeNull()
+        tag32().description.shouldBeNull()
+    }
+
+    "gets external docs object" {
+        tag31("externalDocs: {}").externalDocs.shouldNotBeNull()
+        tag32("externalDocs: {}").externalDocs.shouldNotBeNull()
+    }
+
+    "gets external docs object is null if it missing" {
+        tag31().externalDocs.shouldBeNull()
+        tag32().externalDocs.shouldBeNull()
+    }
+})

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

@@ -95,6 +95,10 @@ fun serverVariable(content: String = "{}"): ServerVariable {
     return buildObject(ServerVariable::class.java, content)
 }
 
+fun tag(content: String = "{}"): Tag {
+    return buildObject(Tag::class.java, content)
+}
+
 fun xml(content: String = "{}"): Xml {
     return buildObject(Xml::class.java, content)
 }

openapi-parser/src/test/kotlin/io/openapiparser/model/v32/TagSpec.kt

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2025 https://github.com/openapi-processor/openapi-parser
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiparser.model.v32
+
+import io.kotest.core.spec.style.StringSpec
+import io.kotest.matchers.nulls.shouldBeNull
+import io.kotest.matchers.shouldBe
+import io.openapiparser.model.v32.tag as tag32
+
+class TagSpec: StringSpec({
+
+    "gets tag summary" {
+        tag32("summary: a summary").summary shouldBe "a summary"
+    }
+
+    "gets tag summary is null if missing" {
+        tag32().summary.shouldBeNull()
+    }
+
+    "gets tag parent" {
+        tag32("parent: the parent").parent shouldBe "the parent"
+    }
+
+    "gets tag name is null if missing" {
+        tag32().parent.shouldBeNull()
+    }
+
+    "gets tag kind" {
+        tag32("kind: the kind").kind shouldBe "the kind"
+    }
+
+    "gets tag kind is null if missing" {
+        tag32().kind.shouldBeNull()
+    }
+})