Allow summary and description alongside $ref

smallrye · May 23, 2024 · 8a211e0 · 8a211e0
1 parent a8eb108
commit 8a211e0
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 0 deletions.
diff --git a/core/src/main/java/io/smallrye/openapi/runtime/io/headers/HeaderIO.java b/core/src/main/java/io/smallrye/openapi/runtime/io/headers/HeaderIO.java
@@ -69,6 +69,7 @@ public Optional<O> write(Header model) {
         return optionalJsonObject(model).map(node -> {
             if (isReference(model)) {
                 setReference(node, model);
+                setIfPresent(node, PROP_DESCRIPTION, jsonIO().toJson(model.getDescription()));
             } else {
                 setIfPresent(node, PROP_DESCRIPTION, jsonIO().toJson(model.getDescription()));
                 setIfPresent(node, PROP_REQUIRED, jsonIO().toJson(model.getRequired()));

diff --git a/core/src/main/java/io/smallrye/openapi/runtime/io/links/LinkIO.java b/core/src/main/java/io/smallrye/openapi/runtime/io/links/LinkIO.java
@@ -61,6 +61,7 @@ public Optional<O> write(Link model) {
         return optionalJsonObject(model).map(node -> {
             if (isReference(model)) {
                 setReference(node, model);
+                setIfPresent(node, PROP_DESCRIPTION, jsonIO().toJson(model.getDescription()));
             } else {
                 setIfPresent(node, PROP_OPERATION_REF, jsonIO().toJson(model.getOperationRef()));
                 setIfPresent(node, PROP_OPERATION_ID, jsonIO().toJson(model.getOperationId()));

diff --git a/core/src/main/java/io/smallrye/openapi/runtime/io/media/ExampleObjectIO.java b/core/src/main/java/io/smallrye/openapi/runtime/io/media/ExampleObjectIO.java
@@ -56,6 +56,8 @@ public Optional<O> write(Example model) {
         return optionalJsonObject(model).map(node -> {
             if (isReference(model)) {
                 setReference(node, model);
+                setIfPresent(node, PROP_SUMMARY, jsonIO().toJson(model.getSummary()));
+                setIfPresent(node, PROP_DESCRIPTION, jsonIO().toJson(model.getDescription()));
             } else {
                 setIfPresent(node, PROP_SUMMARY, jsonIO().toJson(model.getSummary()));
                 setIfPresent(node, PROP_DESCRIPTION, jsonIO().toJson(model.getDescription()));

diff --git a/core/src/main/java/io/smallrye/openapi/runtime/io/parameters/ParameterIO.java b/core/src/main/java/io/smallrye/openapi/runtime/io/parameters/ParameterIO.java
@@ -165,6 +165,7 @@ public Optional<O> write(Parameter model) {
         return optionalJsonObject(model).map(node -> {
             if (isReference(model)) {
                 setReference(node, model);
+                setIfPresent(node, PROP_DESCRIPTION, jsonIO().toJson(model.getDescription()));
             } else {
                 setIfPresent(node, PROP_NAME, jsonIO().toJson(model.getName()));
                 setIfPresent(node, PROP_IN, jsonIO().toJson(model.getIn()));

diff --git a/core/src/main/java/io/smallrye/openapi/runtime/io/parameters/RequestBodyIO.java b/core/src/main/java/io/smallrye/openapi/runtime/io/parameters/RequestBodyIO.java
@@ -113,6 +113,7 @@ public Optional<O> write(RequestBody model) {
         return optionalJsonObject(model).map(node -> {
             if (isReference(model)) {
                 setReference(node, model);
+                setIfPresent(node, PROP_DESCRIPTION, jsonIO().toJson(model.getDescription()));
             } else {
                 setIfPresent(node, PROP_DESCRIPTION, jsonIO().toJson(model.getDescription()));
                 setIfPresent(node, PROP_CONTENT, contentIO().write(model.getContent()));

diff --git a/core/src/main/java/io/smallrye/openapi/runtime/io/responses/APIResponseIO.java b/core/src/main/java/io/smallrye/openapi/runtime/io/responses/APIResponseIO.java
@@ -118,6 +118,7 @@ public Optional<O> write(APIResponse model) {
         return optionalJsonObject(model).map(node -> {
             if (isReference(model)) {
                 setReference(node, model);
+                setIfPresent(node, PROP_DESCRIPTION, jsonIO().toJson(model.getDescription()));
             } else {
                 setIfPresent(node, PROP_DESCRIPTION, jsonIO().toJson(model.getDescription()));
                 setIfPresent(node, PROP_HEADERS, headerIO().write(model.getHeaders()));

diff --git a/core/src/main/java/io/smallrye/openapi/runtime/io/security/SecuritySchemeIO.java b/core/src/main/java/io/smallrye/openapi/runtime/io/security/SecuritySchemeIO.java
@@ -74,6 +74,7 @@ public Optional<O> write(SecurityScheme model) {
         return optionalJsonObject(model).map(node -> {
             if (isReference(model)) {
                 setReference(node, model);
+                setIfPresent(node, PROP_DESCRIPTION, jsonIO().toJson(model.getDescription()));
             } else {
                 setIfPresent(node, PROP_TYPE, jsonIO().toJson(model.getType()));
                 setIfPresent(node, PROP_DESCRIPTION, jsonIO().toJson(model.getDescription()));