@team-supercharge/oasg 8.0.1 → 8.0.2

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 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.
 
+### [8.0.2](https://gitlab.com/team-supercharge/oasg/compare/v8.0.1...v8.0.2) (2023-02-24)
+
+
+### Bug Fixes
+
+* config for inline schema naming, extend migration guide ([e589430](https://gitlab.com/team-supercharge/oasg/commit/e589430a00687c41e725fcef0285cf4af4fb61d6))
+
 ### [8.0.1](https://gitlab.com/team-supercharge/oasg/compare/v8.0.0...v8.0.1) (2023-02-23)
 
 

package/README.md

@@ -707,7 +707,7 @@ This section covers the breaking changes and their migrations across major versi
 
 ### From `7.x.x` to `8.0.0`
 
-**Linting**
+#### Linting
 
 If you plan to use the _OASg_ base image with the preinstalled `oasg` binary without installing npm dependencies on CI, make sure you update your `.spectral.yaml` from the previously recommended syntax which picked up the rules directly from the file system:
 
@@ -721,7 +721,7 @@ to use the syntax which picks up rules from the npm package wherever it's instal
   extends: '@team-supercharge/oasg/rules/default.yaml'
   ```
 
-**Generators: `spring-kotlin`, `spring` and `feign`**
+#### Spring Boot 3 support in `spring-kotlin`, `spring` and `feign`
 
 Spring Boot 3 version is the default for these generators. To generate Spring Boot 2 libraries, add `-puseSpringBoot3=false` to `generatorCustomArgs` in the projects `config.json`
 
@@ -732,6 +732,49 @@ From **OASg 8.0.0** the recommended way is to use the base image matching OASg v
     - update-java-alternatives -s temurin-11-jdk-amd64
   ```
 
+#### Inline Schema Naming in `spring-kotlin`, `spring` and `feign`
+
+Generating names of inline schemas works differently in the updated [openapi-generator](https://openapi-generator.tech/) version `6.3.0` which is now used in the targets above. If you used inline and/or nested schemas the generated artifact **might break** you project and you need to rename your schemas.
+
+Take the following schema:
+
+```yaml
+schemas:
+  Message:
+    type: object
+    properties:                 # messages have topics and a text
+      topic:
+        type: object
+        properties:             # topics have id and array of tags
+          id:
+            type: string
+          tags:
+            type: array
+            items:
+              type: object
+              properties:       # tags have a name
+                name:
+                  type: string
+      text:
+        type: string
+```
+
+Previously the following DTO objects were generated from this schema:
+
+```java
+Message(MessageTopic topic, String text)
+MessageTopic(String id, List<MessageTags> tags)
+MessageTags(String name)
+```
+
+With the updated (correct) schema naming convention the result will be the following:
+
+```java
+Message(MessageTopic topic, String text)
+MessageTopic(String id, List<MessageTopicTags> tags)
+MessageTopicTags(String name)
+```
+
 ### From `6.x.x` to `7.0.0`
 
 Only effects the `stubby` target. Whether a Docker image is needed to be generated from the output, it needs to be explicitly configured using the new `generateWithDocker` parameter.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@team-supercharge/oasg",
-  "version": "8.0.1",
+  "version": "8.0.2",
   "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

@@ -16,5 +16,9 @@
   "importMappings": {
     "java.time.OffsetDateTime": "java.time.Instant",
     "java.util.Date": "java.time.LocalDate"
+  },
+  "inlineSchemaNameDefaults": {
+    "arrayItemSuffix": "",
+    "mapItemSuffix": ""
   }
 }

package/targets/spring/generator-config.json

@@ -17,5 +17,9 @@
   },
   "importMappings": {
     "java.time.OffsetDateTime": "java.time.Instant"
+  },
+  "inlineSchemaNameDefaults": {
+    "arrayItemSuffix": "",
+    "mapItemSuffix": ""
   }
 }

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

@@ -17,5 +17,9 @@
     "DateTime": "java.time.Instant",
     "java.time.OffsetDateTime": "java.time.Instant",
     "org.springframework.core.io.Resource": "org.springframework.web.multipart.MultipartFile"
+  },
+  "inlineSchemaNameDefaults": {
+    "arrayItemSuffix": "",
+    "mapItemSuffix": ""
   }
 }