Merge remote-tracking branch 'upstream/master' into joscha/issue-arra…

…y-of-lists
joscha · Sep 17, 2024 · 2bbdb9c · 2bbdb9c
2 parents dbffb8c + fd85359
commit 2bbdb9c
Show file tree

Hide file tree

Showing 507 changed files with 11,910 additions and 42,834 deletions.
diff --git a/.github/workflows/samples-erlang.yaml b/.github/workflows/samples-erlang.yaml
@@ -3,33 +3,33 @@ name: Samples Erlang
 on:
   push:
     paths:
-      # comment out due to errors
-      # ===> Compiling src/openapi_pet_handler.erl failed
-      # src/openapi_pet_handler.erl:278: function is_authorized/2 already defined
-      #- samples/server/petstore/erlang-server/**
+      - samples/server/echo_api/erlang-server/**
+      - samples/server/petstore/erlang-server/**
       - samples/client/petstore/erlang-client/**
       - samples/client/petstore/erlang-proper/**
   pull_request:
     paths:
-      #- samples/server/petstore/erlang-server/**
+      - samples/server/echo_api/erlang-server/**
+      - samples/server/petstore/erlang-server/**
       - samples/client/petstore/erlang-client/**
       - samples/client/petstore/erlang-proper/**
 jobs:
   build:
     name: Build Erlang projects
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     strategy:
       fail-fast: false
       matrix:
         sample:
-          #- samples/server/petstore/erlang-server/
+          - samples/server/echo_api/erlang-server/
+          - samples/server/petstore/erlang-server/
           - samples/client/petstore/erlang-client/
           - samples/client/petstore/erlang-proper/
     steps:
       - uses: actions/checkout@v4
       - uses: erlef/setup-beam@v1
         with:
-          otp-version: '22.2'
-          rebar3-version: '3.14.3'
+          otp-version: '27'
+          rebar3-version: '3.23.0'
       - run: rebar3 compile
         working-directory: ${{ matrix.sample }}
diff --git a/.github/workflows/samples-go.yaml b/.github/workflows/samples-go.yaml
@@ -35,3 +35,27 @@ jobs:
       - name: Run test
         working-directory: ${{ matrix.sample }}
         run: go test -mod=mod -v
+
+  verify:
+    name: Verify generated Go files with Go tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        sample:
+          - samples/server/petstore/go-api-server/
+        go-version:
+          - "1.18"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.go-version }}
+      - name: Install Dependencies
+        working-directory: ${{ matrix.sample }}
+        run: |
+          go mod tidy
+      - name: Run tests
+        working-directory: ${{ matrix.sample }}
+        run: go test ./samples_tests -v
diff --git a/README.md b/README.md
@@ -72,6 +72,7 @@ If you find OpenAPI Generator useful for work, please consider asking your compa
 [<img src="https://openapi-generator.tech/img/companies/itm.png" width="128" height="128">](https://opensource.muenchen.de?utm_source=openapi-generator&utm_medium=sponsorship&utm_campaign=oss-sponsorship)
 [<img src="https://openapi-generator.tech/img/companies/kong.png" width="128" height="128">](https://konghq.com/products/kong-konnect?utm_medium=referral&utm_source=github&utm_campaign=platform&utm_content=openapi-generator)
 [<img src="https://openapi-generator.tech/img/companies/route4me.png" width="128" height="128">](https://route4me.com/?utm_source=openapi-generator&utm_medium=sponsorship&utm_campaign=oss-sponsorship)
+[<img src="https://openapi-generator.tech/img/companies/dm.png" width="128" height="128">](https://www.dotcom-monitor.com/sponsoring-open-source-projects/?utm_source=openapi-generator&utm_medium=sponsorship&utm_campaign=oss-sponsorship)
 
 #### Thank you GoDaddy for sponsoring the domain names, Linode for sponsoring the VPS, Checkly for sponsoring the API monitoring and Gradle for sponsoring Develocity
 
@@ -446,41 +447,7 @@ npm install @openapitools/openapi-generator-cli -D
 ```
 <!-- /RELEASE_VERSION -->
 
-#### Use locally built JAR
-In order to use a locally built jar of the generator CLI, you can copy the jar from your local build (i.e. if you were to `build` this repository it would be in `~/openapi-generator/modules/openapi-generator-cli/target/openapi-generator-cli.jar`) into `./node_modules/@openapitools/openapi-generator-cli/versions/` and change the `version` in the `openapitools.json` file to the base name of the jar file.
-E.g.:
-```sh
-cd openapi-generator
-./mvnw clean package
-cp ./modules/openapi-generator-cli/target/openapi-generator-cli.jar /your/project/node_modules/@openapitools/openapi-generator-cli/versions/my-local-snapshot.jar
-```
-and then:
-```json
-{
-  "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
-  "spaces": 2,
-  "generator-cli": {
-    "version": "my-local-snapshot",
-  }
-}
-```
-
-#### Use nightly `SNAPSHOT` build
-Change your `openapitools.json` to:
-
-```json
-{
-  "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
-  "spaces": 2,
-  "generator-cli": {
-    "version": "7.9.0-20240829.123431-22",
-    "repository": {
-      "downloadUrl": "https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/7.9.0-SNAPSHOT/openapi-generator-cli-${versionName}.jar"
-    }
-  }
-}
-```
-(example is with a snapshot of `7.9.0`, please change the `version` and `downloadUrl` accordingly)
+You can use [locally built JARs](https://github.com/OpenAPITools/openapi-generator-cli?tab=readme-ov-file#use-locally-built-jar) or [`SNAPSHOT` versions](https://github.com/OpenAPITools/openapi-generator-cli?tab=readme-ov-file#use-nightly-snapshot-build) as well.
 
 ## [2 - Getting Started](#table-of-contents)
 
@@ -1107,7 +1074,7 @@ Here is a list of template creators:
    * C++ (Qt5 QHttpEngine): @etherealjoy
    * C++ Pistache: @sebymiano
    * C++ Restbed: @stkrwork
-   * Erlang Server: @galaxie
+   * Erlang Server: @galaxie @nelsonvides
    * F# (Giraffe) Server: @nmfisher
    * Go Server: @guohuang
    * Go Server (refactored in 7.0.0): @lwj5
@@ -1218,7 +1185,7 @@ If you want to join the committee, please kindly apply by sending an email to te
 | Eiffel                | @jvelilla (2017/09)                                                                                                                                                                                                                                   |
 | Elixir                | @mrmstn (2018/12)                                                                                                                                                                                                                                     |
 | Elm                   | @eriktim (2018/09)                                                                                                                                                                                                                                    |
-| Erlang                | @tsloughter (2017/11) @jfacorro (2018/10) @robertoaloi (2018/10)                                                                                                                                                                                      |
+| Erlang                | @tsloughter (2017/11) @jfacorro (2018/10) @robertoaloi (2018/10) @nelsonvides (2024/09)                                                                                                                                                               |
 | F#                    | @nmfisher (2019/05)                                                                                                                                                                                                                                   |
 | Go                    | @antihax (2017/11) @grokify (2018/07) @kemokemo (2018/09) @jirikuncar (2021/01) @ph4r5h4d (2021/04) @lwj5 (2023/04)                                                                                                                                                   |
 | GraphQL               | @renepardon (2018/12)                                                                                                                                                                                                                                 |

diff --git a/bin/configs/avro-schema-enums.yaml b/bin/configs/avro-schema-enums.yaml
@@ -0,0 +1,4 @@
+generatorName: avro-schema
+outputDir: samples/openapi3/schema/valid-enums/avro-schema-enum
+inputSpec: modules/openapi-generator/src/test/resources/3_0/avro-schema/valid-enums.yaml
+templateDir: modules/openapi-generator/src/main/resources/avro-schema
diff --git a/bin/configs/erlang-server-echo.yaml b/bin/configs/erlang-server-echo.yaml
@@ -0,0 +1,4 @@
+generatorName: erlang-server
+outputDir: samples/server/echo_api/erlang-server
+inputSpec: modules/openapi-generator/src/test/resources/3_0/echo_api.yaml
+templateDir: modules/openapi-generator/src/main/resources/erlang-server
diff --git a/docs/debugging.md b/docs/debugging.md
@@ -201,6 +201,23 @@ The steps are shown here for a specific version of the generator, but apply the
   ```
 * Set breakpoints in code, and then attach your remote debugger from your IDE (see above). The generator will automatically unblock once the remote debugger is attached. You can now step through the code.
 
+    For VSCode you can use the following launch configuration (`launch.json`):
+    ```json
+    {
+        "version": "0.2.0",
+        "configurations": [
+            {
+                "type": "java",
+                "name": "Debug (Attach)",
+                "request": "attach",
+                "hostName": "localhost",
+                "port": 5005
+            }
+        ]
+    }
+    ```
+    to attach the the suspended process above.
+
 ## Logs
 
 You can try to enable debugging log with `-Dlog.level=debug` option to the `JAVA_OPTS` environment variable to see more information:

diff --git a/docs/generators.md b/docs/generators.md
@@ -89,6 +89,7 @@ The following generators are available:
 * [cpp-restbed-server-deprecated](generators/cpp-restbed-server-deprecated.md)  
 * [csharp-functions](generators/csharp-functions.md)  
 * [erlang-server](generators/erlang-server.md)  
+* [erlang-server-deprecated (deprecated)](generators/erlang-server-deprecated.md)  
 * [fsharp-functions (beta)](generators/fsharp-functions.md)  
 * [fsharp-giraffe-server (beta)](generators/fsharp-giraffe-server.md)  
 * [go-echo-server (beta)](generators/go-echo-server.md)  

diff --git a/docs/generators/erlang-server-deprecated.md b/docs/generators/erlang-server-deprecated.md
@@ -0,0 +1,190 @@
+---
+title: Documentation for the erlang-server-deprecated Generator
+---
+
+## METADATA
+
+| Property | Value | Notes |
+| -------- | ----- | ----- |
+| generator name | erlang-server-deprecated | pass this to the generate command after -g |
+| generator stability | DEPRECATED | |
+| generator type | SERVER | |
+| generator language | Erlang | |
+| generator default templating engine | mustache | |
+| helpTxt | Generates an Erlang server library (deprecated) using OpenAPI Generator (https://openapi-generator.tech). By default, it will also generate service classes, which can be disabled with the `-Dnoservice` environment variable. | |
+
+## CONFIG OPTIONS
+These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
+
+| Option | Description | Values | Default |
+| ------ | ----------- | ------ | ------- |
+|openAPISpecName|Openapi Spec Name.| |openapi|
+|packageName|Erlang package name (convention: lowercase).| |openapi|
+
+## IMPORT MAPPING
+
+| Type/Alias | Imports |
+| ---------- | ------- |
+
+
+## INSTANTIATION TYPES
+
+| Type/Alias | Instantiated By |
+| ---------- | --------------- |
+
+
+## LANGUAGE PRIMITIVES
+
+<ul class="column-ul">
+</ul>
+
+## RESERVED WORDS
+
+<ul class="column-ul">
+<li>after</li>
+<li>and</li>
+<li>andalso</li>
+<li>band</li>
+<li>begin</li>
+<li>bnot</li>
+<li>bor</li>
+<li>bsl</li>
+<li>bsr</li>
+<li>bxor</li>
+<li>case</li>
+<li>catch</li>
+<li>cond</li>
+<li>div</li>
+<li>end</li>
+<li>fun</li>
+<li>if</li>
+<li>let</li>
+<li>not</li>
+<li>of</li>
+<li>or</li>
+<li>orelse</li>
+<li>receive</li>
+<li>rem</li>
+<li>try</li>
+<li>when</li>
+<li>xor</li>
+</ul>
+
+## FEATURE SET
+
+
+### Client Modification Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|BasePath|✗|ToolingExtension
+|Authorizations|✗|ToolingExtension
+|UserAgent|✗|ToolingExtension
+|MockServer|✗|ToolingExtension
+
+### Data Type Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Custom|✗|OAS2,OAS3
+|Int32|✓|OAS2,OAS3
+|Int64|✓|OAS2,OAS3
+|Float|✓|OAS2,OAS3
+|Double|✓|OAS2,OAS3
+|Decimal|✓|ToolingExtension
+|String|✓|OAS2,OAS3
+|Byte|✓|OAS2,OAS3
+|Binary|✓|OAS2,OAS3
+|Boolean|✓|OAS2,OAS3
+|Date|✓|OAS2,OAS3
+|DateTime|✓|OAS2,OAS3
+|Password|✓|OAS2,OAS3
+|File|✓|OAS2
+|Uuid|✗|
+|Array|✓|OAS2,OAS3
+|Null|✗|OAS3
+|AnyType|✗|OAS2,OAS3
+|Object|✓|OAS2,OAS3
+|Maps|✓|ToolingExtension
+|CollectionFormat|✓|OAS2
+|CollectionFormatMulti|✓|OAS2
+|Enum|✓|OAS2,OAS3
+|ArrayOfEnum|✓|ToolingExtension
+|ArrayOfModel|✓|ToolingExtension
+|ArrayOfCollectionOfPrimitives|✓|ToolingExtension
+|ArrayOfCollectionOfModel|✓|ToolingExtension
+|ArrayOfCollectionOfEnum|✓|ToolingExtension
+|MapOfEnum|✓|ToolingExtension
+|MapOfModel|✓|ToolingExtension
+|MapOfCollectionOfPrimitives|✓|ToolingExtension
+|MapOfCollectionOfModel|✓|ToolingExtension
+|MapOfCollectionOfEnum|✓|ToolingExtension
+
+### Documentation Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Readme|✓|ToolingExtension
+|Model|✓|ToolingExtension
+|Api|✓|ToolingExtension
+
+### Global Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Host|✓|OAS2,OAS3
+|BasePath|✓|OAS2,OAS3
+|Info|✓|OAS2,OAS3
+|Schemes|✗|OAS2,OAS3
+|PartialSchemes|✓|OAS2,OAS3
+|Consumes|✓|OAS2
+|Produces|✓|OAS2
+|ExternalDocumentation|✓|OAS2,OAS3
+|Examples|✓|OAS2,OAS3
+|XMLStructureDefinitions|✗|OAS2,OAS3
+|MultiServer|✗|OAS3
+|ParameterizedServer|✗|OAS3
+|ParameterStyling|✗|OAS3
+|Callbacks|✗|OAS3
+|LinkObjects|✗|OAS3
+
+### Parameter Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Path|✓|OAS2,OAS3
+|Query|✓|OAS2,OAS3
+|Header|✓|OAS2,OAS3
+|Body|✓|OAS2
+|FormUnencoded|✓|OAS2
+|FormMultipart|✓|OAS2
+|Cookie|✗|OAS3
+
+### Schema Support Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Simple|✓|OAS2,OAS3
+|Composite|✓|OAS2,OAS3
+|Polymorphism|✗|OAS2,OAS3
+|Union|✗|OAS3
+|allOf|✗|OAS2,OAS3
+|anyOf|✗|OAS3
+|oneOf|✗|OAS3
+|not|✗|OAS3
+
+### Security Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|BasicAuth|✗|OAS2,OAS3
+|ApiKey|✓|OAS2,OAS3
+|OpenIDConnect|✗|OAS3
+|BearerToken|✗|OAS3
+|OAuth2_Implicit|✓|OAS2,OAS3
+|OAuth2_Password|✗|OAS2,OAS3
+|OAuth2_ClientCredentials|✗|OAS2,OAS3
+|OAuth2_AuthorizationCode|✗|OAS2,OAS3
+|SignatureAuth|✗|OAS3
+|AWSV4Signature|✗|ToolingExtension
+
+### Wire Format Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|JSON|✓|OAS2,OAS3
+|XML|✗|OAS2,OAS3
+|PROTOBUF|✗|ToolingExtension
+|Custom|✗|OAS2,OAS3
diff --git a/docs/generators/erlang-server.md b/docs/generators/erlang-server.md
@@ -59,6 +59,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 <li>fun</li>
 <li>if</li>
 <li>let</li>
+<li>maybe</li>
 <li>not</li>
 <li>of</li>
 <li>or</li>

diff --git a/docs/generators/kotlin.md b/docs/generators/kotlin.md
@@ -25,6 +25,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |collectionType|Option. Collection type to use|<dl><dt>**array**</dt><dd>kotlin.Array</dd><dt>**list**</dt><dd>kotlin.collections.List</dd></dl>|list|
 |dateLibrary|Option. Date library to use|<dl><dt>**threetenbp-localdatetime**</dt><dd>Threetenbp - Backport of JSR310 (jvm only, for legacy app only)</dd><dt>**kotlinx-datetime**</dt><dd>kotlinx-datetime (preferred for multiplatform)</dd><dt>**string**</dt><dd>String</dd><dt>**java8-localdatetime**</dt><dd>Java 8 native JSR310 (jvm only, for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (jvm only, preferred for jdk 1.8+)</dd><dt>**threetenbp**</dt><dd>Threetenbp - Backport of JSR310 (jvm only, preferred for jdk &lt; 1.8)</dd></dl>|java8|
 |enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |original|
+|failOnUnknownProperties|Fail Jackson de-serialization on unknown properties| |false|
 |generateOneOfAnyOfWrappers|Generate oneOf, anyOf schemas as wrappers.| |false|
 |generateRoomModels|Generate Android Room database models in addition to API models (JVM Volley library only)| |false|
 |groupId|Generated artifact package's organization (i.e. maven groupId).| |org.openapitools|