get document uri (#115)

Author: hauner

gradle/libs.versions.toml

@@ -1,6 +1,6 @@
 [versions]
 processor = "2025.3-SNAPSHOT"
-parser = "2025.2"
+parser = "2025.3-SNAPSHOT"
 api = "2024.2"
 
 kotlin = "2.1.20"

openapi-processor-core-parser-api/src/main/kotlin/io/openapiprocessor/core/parser/Schema.kt

@@ -5,6 +5,8 @@
 
 package io.openapiprocessor.core.parser
 
+import java.net.URI
+
 /**
  * OpenAPI Schema abstraction.
  */
@@ -65,4 +67,6 @@ interface Schema {
     val extensions: Map<String, *>
 
     val title: String?
+
+    val documentUri: URI
 }

openapi-processor-core-parser-openapi4j/src/main/kotlin/io/openapiprocessor/core/parser/openapi4j/Schema.kt

@@ -5,6 +5,7 @@
 
 package io.openapiprocessor.core.parser.openapi4j
 
+import java.net.URI
 import io.openapiprocessor.core.parser.Schema as ParserSchema
 import org.openapi4j.parser.model.v3.Schema as O4jSchema
 
@@ -128,4 +129,7 @@ class Schema(val schema: O4jSchema) : ParserSchema {
 
     override val title: String?
         get() = schema.title
+
+    override val documentUri: URI
+        get() = TODO("deriving the package name from the document location is not supported with the openapi4j parser.")
 }

openapi-processor-core-parser-swagger/src/main/kotlin/io/openapiprocessor/core/parser/swagger/Schema.kt

@@ -6,6 +6,7 @@
 package io.openapiprocessor.core.parser.swagger
 
 import io.swagger.v3.oas.models.SpecVersion
+import java.net.URI
 import io.openapiprocessor.core.parser.Schema as ParserSchema
 import io.swagger.v3.oas.models.media.ComposedSchema as SwaggerComposedSchema
 import io.swagger.v3.oas.models.media.Schema as SwaggerSchema
@@ -153,4 +154,7 @@ class Schema(private val schema: SwaggerSchema<*>): ParserSchema {
 
     override val title: String?
         get() = schema.title
+
+    override val documentUri: URI
+        get() = TODO("deriving the package name from the document location is not supported with the swagger parser.")
 }

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/SchemaInfo.kt

@@ -10,6 +10,7 @@ import io.openapiprocessor.core.model.datatypes.DataTypeConstraints
 import io.openapiprocessor.core.parser.HttpMethod
 import io.openapiprocessor.core.parser.Schema
 import io.openapiprocessor.core.support.capitalizeFirstChar
+import java.net.URI
 import io.openapiprocessor.core.parser.RefResolver as ParserRefResolver
 
 /**
@@ -444,4 +445,8 @@ open class SchemaInfo(
     private fun getNestedTypeName(nestedName: String): String {
         return name + nestedName.capitalizeFirstChar()
     }
+
+    fun getDocumentUri(): URI {
+        return schema.documentUri
+    }
 }

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/parser/NullSchema.kt

@@ -5,6 +5,8 @@
 
 package io.openapiprocessor.core.parser
 
+import java.net.URI
+
 object NullSchema: Schema {
 
     override fun getType(): String? {
@@ -108,4 +110,7 @@ object NullSchema: Schema {
 
     override val title: String?
         get() = null
+
+    override val documentUri: URI
+        get() = URI.create("should/not/be/called")
 }

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/parser/openapi/v30/Schema.kt

@@ -5,6 +5,7 @@
 
 package io.openapiprocessor.core.parser.openapi.v30
 
+import java.net.URI
 import io.openapiparser.model.v30.Schema as Schema30
 import io.openapiprocessor.core.parser.Schema as ParserSchema
 
@@ -157,4 +158,7 @@ class Schema(val schema: Schema30) : ParserSchema {
 
     override val title: String?
         get() = schema.title
+
+    override val documentUri: URI
+        get() = schema.documentUri
 }

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/parser/openapi/v31/Schema.kt

@@ -5,6 +5,7 @@
 
 package io.openapiprocessor.core.parser.openapi.v31
 
+import java.net.URI
 import io.openapiparser.model.v31.Schema as Schema31
 import io.openapiprocessor.core.parser.Schema as ParserSchema
 
@@ -159,4 +160,7 @@ class Schema(val schema: Schema31) : ParserSchema {
 
     override val title: String?
         get() = schema.title
+
+    override val documentUri: URI
+        get() = schema.documentUri
 }

openapi-processor-core/src/test/groovy/io/openapiprocessor/core/writer/java/TestSchema.groovy

@@ -83,4 +83,9 @@ class TestSchema implements Schema {
     String getTitle() {
         return null
     }
+
+    @Override
+    URI getDocumentUri() {
+        return URI.create("null")
+    }
 }

openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/support/Schema.kt

@@ -6,6 +6,7 @@
 package io.openapiprocessor.core.support
 
 import io.openapiprocessor.core.parser.Schema
+import java.net.URI
 import io.openapiprocessor.core.parser.Schema as ParserSchema
 
 /**
@@ -117,4 +118,7 @@ class Schema(
 
     override val title: String?
         get() = TODO("Not yet implemented")
+
+    override val documentUri: URI
+        get() = TODO("Not yet implemented")
 }