Merge pull request #675 from Azquelt/add-json-schema-dialect

Add json schema dialect property
eclipse · Jan 23, 2025 · 06f3db7 · 06f3db7
2 parents e80e76c + f245695
commit 06f3db7
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 0 deletions.
diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/OpenAPI.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/OpenAPI.java
@@ -327,6 +327,36 @@ default OpenAPI webhooks(Map<String, PathItem> webhooks) {
      */
     void removeWebhook(String name);
 
+    /**
+     * Returns the default JSON Schema dialect for schemas in this document.
+     *
+     * @return the identifier of the default schema dialect for schemas in this document
+     * @since 4.1
+     */
+    String getJsonSchemaDialect();
+
+    /**
+     * Sets the default JSON Schema dialect for schemas in this document.
+     *
+     * @param jsonSchemaDialect
+     *            the identifier of the default schema dialect for schemas in this document
+     * @since 4.1
+     */
+    void setJsonSchemaDialect(String jsonSchemaDialect);
+
+    /**
+     * Sets the default JSON Schema dialect for schemas in this document.
+     *
+     * @param jsonSchemaDialect
+     *            the identifier of the default schema dialect for schemas in this document
+     * @return the current OpenAPI object
+     * @since 4.1
+     */
+    default OpenAPI jsonSchemaDialect(String jsonSchemaDialect) {
+        setJsonSchemaDialect(jsonSchemaDialect);
+        return this;
+    }
+
     /**
      * Returns the components property from an OpenAPI instance.
      *

diff --git a/tck/src/main/java/org/eclipse/microprofile/openapi/reader/MyOASModelReaderImpl.java b/tck/src/main/java/org/eclipse/microprofile/openapi/reader/MyOASModelReaderImpl.java
@@ -308,6 +308,7 @@ public OpenAPI buildModel() {
                 .externalDocs(OASFactory.createObject(ExternalDocumentation.class)
                         .description("instructions for how to deploy this app")
                         .url("https://github.com/microservices-api/oas3-airlines/blob/master/README.md"))
+                .jsonSchemaDialect("https://json-schema.org/draft/2020-12/schema")
                 .addWebhook("bookingEvent", OASFactory.createPathItem()
                         .PUT(OASFactory.createOperation()
                                 .summary("Notifies that a booking has been created")

diff --git a/tck/src/main/java/org/eclipse/microprofile/openapi/tck/ModelReaderAppTest.java b/tck/src/main/java/org/eclipse/microprofile/openapi/tck/ModelReaderAppTest.java
@@ -427,4 +427,10 @@ public void testRequestBodyInOperations(String type) {
 
         vr.body("paths.'/zepplins'.delete.requestBody.content", notNullValue());
     }
+
+    @Test(dataProvider = "formatProvider")
+    public void testSchemaDialect(String type) {
+        ValidatableResponse vr = callEndpoint(type);
+        vr.body("jsonSchemaDialect", equalTo("https://json-schema.org/draft/2020-12/schema"));
+    }
 }