@team-supercharge/oasg 8.0.2 → 9.0.0

package/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [9.0.0](https://gitlab.com/team-supercharge/oasg/compare/v8.0.2...v9.0.0) (2023-02-24)
+
+
+### ⚠ BREAKING CHANGES
+
+* **spring-kotlin, spring, feign:** skip inline schema reusing by default
+
+### Features
+
+* **spring-kotlin, spring, feign:** skip inline schema reusing by default ([c125332](https://gitlab.com/team-supercharge/oasg/commit/c125332cbd59dbd31b2e257060a716950ed3f03a))
+
 ### [8.0.2](https://gitlab.com/team-supercharge/oasg/compare/v8.0.1...v8.0.2) (2023-02-24)
 
 

package/README.md

@@ -705,6 +705,66 @@ The **"project level"** customization can be configured using the `templateDir`
 
 This section covers the breaking changes and their migrations across major version upgrades.
 
+### From `8.x.x` to `9.0.0`
+
+#### Skip Reusing Schemas in `spring-kotlin`, `spring` and `feign`
+
+The newer versions of OpenAPI Generator adds the flag to skip the [automatic inline schema reusing](https://openapi-generator.tech/docs/customization/#inline-schema-naming) logic (see example what this means below).
+
+From _OASg_ 9.0.0 the **default and recommended behaviour is to skip schema reusing** for the targets above. If you wish to resume schema reusing for compatibility reasons, add `--inline-schema-name-defaults SKIP_SCHEMA_REUSE=false` to `generatorCustomArgs` in the project's `config.json`
+
+Take the following schema:
+
+  ```yaml
+  schemas:
+    Message:
+      type: object
+      properties:                 # messages have a topic and text
+        topic:
+          type: object
+          properties:             # topics have id and name
+            id:
+              type: string
+            name:
+              type: string
+        text:
+          type: string
+
+    User:
+      type: object
+      properties:                 # users have a company, and firstName and lastName
+        company:
+          type: object
+          properties:             # copmanies have id and name
+            id:
+              type: string
+            name:
+              type: string
+        firstName:
+          type: string
+        lastName:
+          type: string
+  ```
+
+Previously the following DTO objects were generated from this schema:
+
+```java
+Message(MessageTopic topic, String text)
+MessageTopic(String id, String name)
+User(MessageTopic company, String firstName, String lastName)
+```
+
+Previously the generator reused internal schemas which had the exact same fields, ending up with a `MessageTopic` object for the users' Company, just because both had `id` and `name` string properties.
+
+With defining `SKIP_SCHEMA_REUSE=true` the output will be more verbose, but schema names won't get mixed up:
+
+```java
+Message(MessageTopic topic, String text)
+MessageTopic(String id, String name)
+User(UserCompany company, String firstName, String lastName)
+UserCompany(String id, String name)
+```
+
 ### From `7.x.x` to `8.0.0`
 
 #### Linting

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@team-supercharge/oasg",
-  "version": "8.0.2",
+  "version": "9.0.0",
   "description": "Node-based tool to lint OpenAPI documents and generate clients, servers and documentation from them",
   "author": "Supercharge",
   "license": "MIT",

package/targets/feign/generator-config.json

@@ -19,6 +19,7 @@
   },
   "inlineSchemaNameDefaults": {
     "arrayItemSuffix": "",
-    "mapItemSuffix": ""
+    "mapItemSuffix": "",
+    "SKIP_SCHEMA_REUSE": "true"
   }
 }

package/targets/spring/generator-config.json

@@ -20,6 +20,7 @@
   },
   "inlineSchemaNameDefaults": {
     "arrayItemSuffix": "",
-    "mapItemSuffix": ""
+    "mapItemSuffix": "",
+    "SKIP_SCHEMA_REUSE": "true"
   }
 }

package/targets/spring-kotlin/generator-config.json

@@ -20,6 +20,7 @@
   },
   "inlineSchemaNameDefaults": {
     "arrayItemSuffix": "",
-    "mapItemSuffix": ""
+    "mapItemSuffix": "",
+    "SKIP_SCHEMA_REUSE": "true"
   }
 }