Use title for oneOf union strategy

Use `title` to improve generated documentation for the `oneOf` union strategy. Without `title` tools see an inlined (unnamed) object.
smithy-lang · Jul 7, 2020 · 1eb18cd · 1eb18cd
1 parent 986b389
commit 1eb18cd
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/...hy-jsonschema/src/main/java/software/amazon/smithy/jsonschema/JsonSchemaShapeVisitor.java b/...hy-jsonschema/src/main/java/software/amazon/smithy/jsonschema/JsonSchemaShapeVisitor.java
@@ -195,6 +195,7 @@ public Schema unionShape(UnionShape shape) {
                     String memberName = converter.toPropertyName(member);
                     schemas.add(Schema.builder()
                             .type("object")
+                            .title(memberName)
                             .required(ListUtils.of(memberName))
                             .putProperty(memberName, createRef(member))
                             .build());

diff --git a/...nschema/src/test/resources/software/amazon/smithy/jsonschema/test-service.jsonschema.json b/...nschema/src/test/resources/software/amazon/smithy/jsonschema/test-service.jsonschema.json
@@ -114,6 +114,7 @@
       "oneOf": [
         {
           "type": "object",
+          "title": "a",
           "required": [
             "a"
           ],
@@ -125,6 +126,7 @@
         },
         {
           "type": "object",
+          "title": "b",
           "required": [
             "b"
           ],

diff --git a/...pi/src/test/resources/software/amazon/smithy/openapi/fromsmithy/test-service.openapi.json b/...pi/src/test/resources/software/amazon/smithy/openapi/fromsmithy/test-service.openapi.json
@@ -203,6 +203,7 @@
         "oneOf": [
           {
             "type": "object",
+            "title": "a",
             "properties": {
               "a": {
                 "type": "string"
@@ -214,6 +215,7 @@
           },
           {
             "type": "object",
+            "title": "b",
             "properties": {
               "b": {
                 "type": "string"