Compatibility test WriteOnly

Author: westse

core/src/test/java/org/openapitools/openapidiff/core/backcompat/WriteOnlyBCTest.java

@@ -0,0 +1,32 @@
+package org.openapitools.openapidiff.core.backcompat;
+
+import static org.openapitools.openapidiff.core.TestUtils.assertOpenApiBackwardIncompatible;
+import static org.openapitools.openapidiff.core.TestUtils.assertSpecChangedButCompatible;
+import static org.openapitools.openapidiff.core.TestUtils.assertSpecUnchanged;
+
+import org.junit.jupiter.api.Test;
+
+public class WriteOnlyBCTest {
+  private final String BASE = "bc_writeonly_base.yaml";
+
+  @Test
+  public void unchanged() {
+    assertSpecUnchanged(BASE, BASE);
+  }
+
+  @Test
+  public void changedButCompatible() {
+    assertSpecChangedButCompatible(BASE, "bc_writeonly_changed_but_compatible.yaml");
+  }
+
+  @Test
+  public void responseWriteOnlyIncreased() {
+    assertOpenApiBackwardIncompatible(BASE, "bc_response_writeonly_increased.yaml");
+  }
+
+  @Test
+  public void responseWriteOnlyRequiredDecreased() {
+    // TODO: Document why desired or remove support (test added to avoid unintentional regression)
+    assertOpenApiBackwardIncompatible(BASE, "bc_response_writeonly_required_decreased.yaml");
+  }
+}

core/src/test/resources/bc_response_writeonly_increased.yaml

@@ -0,0 +1,34 @@
+openapi: 3.0.0
+info:
+  description: myDesc
+  title: myTitle
+  version: 1.0.0
+paths:
+  /widgets:
+    post:
+      operationId: widgetCreate
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                prop1:
+                  type: string
+                  writeOnly: true
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  prop1:
+                    type: string
+                    writeOnly: true
+                  prop2:
+                    type: string
+                    writeOnly: true
+                required:
+                  - prop1

core/src/test/resources/bc_response_writeonly_required_decreased.yaml

@@ -0,0 +1,32 @@
+openapi: 3.0.0
+info:
+  description: myDesc
+  title: myTitle
+  version: 1.0.0
+paths:
+  /widgets:
+    post:
+      operationId: widgetCreate
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                prop1:
+                  type: string
+                  writeOnly: true
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  prop1:
+                    type: string
+                  prop2:
+                    type: string
+                required:
+                  - prop1

core/src/test/resources/bc_writeonly_base.yaml

@@ -0,0 +1,33 @@
+openapi: 3.0.0
+info:
+  description: myDesc
+  title: myTitle
+  version: 1.0.0
+paths:
+  /widgets:
+    post:
+      operationId: widgetCreate
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                prop1:
+                  type: string
+                  writeOnly: true
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  prop1:
+                    type: string
+                    writeOnly: true
+                  prop2:
+                    type: string
+                required:
+                  - prop1

core/src/test/resources/bc_writeonly_changed_but_compatible.yaml

@@ -0,0 +1,32 @@
+openapi: 3.0.0
+info:
+  description: myDesc
+  title: myTitle
+  version: 1.0.0
+paths:
+  /widgets:
+    post:
+      operationId: widgetCreate
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                prop1:
+                  type: string
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  prop1:
+                    type: string
+                    writeOnly: true
+                  prop2:
+                    type: string
+                required:
+                  - prop1