[OCaml] Fix encoding/decoding for free-form required fields

sir4ur0n · sir4ur0n · commit 10890a9ebb32 · 2025-08-26T12:10:23.000+02:00
diff --git a/.github/workflows/samples-ocaml.yaml b/.github/workflows/samples-ocaml.yaml
@@ -6,11 +6,13 @@ on:
       - 'samples/client/petstore/ocaml/**'
       - 'samples/client/petstore/ocaml-fake-petstore/**'
       - 'samples/client/petstore/ocaml-oneOf-primitive/**'
+      - 'samples/client/petstore/ocaml-additional-properties/**'
   pull_request:
     paths:
       - 'samples/client/petstore/ocaml/**'
       - 'samples/client/petstore/ocaml-fake-petstore/**'
       - 'samples/client/petstore/ocaml-oneOf-primitive/**'
+      - 'samples/client/petstore/ocaml-additional-properties/**'
 
 jobs:
   build:
@@ -23,6 +25,7 @@ jobs:
           - 'samples/client/petstore/ocaml/'
           - 'samples/client/petstore/ocaml-fake-petstore/'
           - 'samples/client/petstore/ocaml-oneOf-primitive/'
+          - 'samples/client/petstore/ocaml-additional-properties/'
     steps:
       - uses: actions/checkout@v5
       - name: Set-up OCaml
diff --git a/.gitignore b/.gitignore
@@ -298,6 +298,7 @@ samples/openapi3/client/petstore/go/privatekey.pem
 samples/client/petstore/ocaml/_build/
 samples/client/petstore/ocaml-fake-petstore/_build/
 samples/client/petstore/ocaml-oneOf-primitive/_build/
+samples/client/petstore/ocaml-additional-properties/_build/
 
 # jetbrain http client
 samples/client/jetbrains/adyen/checkout71/http/client/Apis/http-client.private.env.json
diff --git a/bin/configs/ocaml-additional-properties.yaml b/bin/configs/ocaml-additional-properties.yaml
@@ -0,0 +1,6 @@
+generatorName: ocaml
+outputDir: samples/client/petstore/ocaml-additional-properties
+inputSpec: modules/openapi-generator/src/test/resources/3_0/ocaml/additional-properties.yaml
+templateDir: modules/openapi-generator/src/main/resources/ocaml
+additionalProperties:
+  packageName: petstore_client
diff --git a/modules/openapi-generator/src/main/resources/ocaml/model-record.mustache b/modules/openapi-generator/src/main/resources/ocaml/model-record.mustache
@@ -28,7 +28,7 @@ type t = {
           {{^required}} option [@default None]{{/required}}
         {{/isContainer}}
         {{#isArray}}{{^required}} [@default []]{{/required}}{{/isArray}}
-        {{#isMap}}{{^required}} [@default []] [@to_yojson JsonSupport.of_map_of [%to_yojson: {{{items.datatypeWithEnum}}}]] [@of_yojson JsonSupport.to_map_of [%of_yojson: {{{items.datatypeWithEnum}}}]] {{/required}}{{/isMap}}
+        {{#isMap}}{{^required}} [@default []]{{/required}} [@to_yojson JsonSupport.of_map_of [%to_yojson: {{{items.datatypeWithEnum}}}]] [@of_yojson JsonSupport.to_map_of [%of_yojson: {{{items.datatypeWithEnum}}}]]{{/isMap}}
         ; [@key "{{{baseName}}}"]
     {{/isEnum}}
 {{/vars}}
diff --git a/modules/openapi-generator/src/test/resources/3_0/ocaml/additional-properties.yaml b/modules/openapi-generator/src/test/resources/3_0/ocaml/additional-properties.yaml
@@ -0,0 +1,52 @@
+# Test various flavors of additionalProperties
+openapi: 3.0.0
+info:
+  title: Test
+  version: 1.0.0
+paths: {}
+components:
+  schemas:
+    SomeObject:
+      required:
+        - required_field1
+        - required_field2
+        - required_field3
+      properties:
+        required_field1:
+          type: object
+          description: Required, free-form
+          additionalProperties: {}
+        required_field2:
+          type: object
+          description: Required, dictionary of strings
+          additionalProperties:
+            type: string
+        required_field3:
+          type: object
+          description: Required, dictionary of objects
+          additionalProperties:
+            type: object
+            properties:
+              sub_field1:
+                type: number
+              sub_field2:
+                type: boolean
+        optional_field1:
+          type: object
+          description: Optional, free-form
+          additionalProperties: {}
+        optional_field2:
+          type: object
+          description: Optional, dictionary of strings
+          additionalProperties:
+            type: string
+        optional_field3:
+          type: object
+          description: Optional, dictionary of objects
+          additionalProperties:
+            type: object
+            properties:
+              sub_field1:
+                type: number
+              sub_field2:
+                type: boolean
diff --git a/samples/client/petstore/ocaml-additional-properties/.ocamlformat b/samples/client/petstore/ocaml-additional-properties/.ocamlformat
@@ -0,0 +1,2 @@
+version=0.27.0
+ocaml-version=4.14.0
diff --git a/samples/client/petstore/ocaml-additional-properties/.openapi-generator-ignore b/samples/client/petstore/ocaml-additional-properties/.openapi-generator-ignore
@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
diff --git a/samples/client/petstore/ocaml-additional-properties/.openapi-generator/FILES b/samples/client/petstore/ocaml-additional-properties/.openapi-generator/FILES
@@ -0,0 +1,10 @@
+.ocamlformat
+README.md
+dune
+dune-project
+petstore_client.opam
+src/models/some_object.ml
+src/models/some_object_required_field3_value.ml
+src/support/enums.ml
+src/support/jsonSupport.ml
+src/support/request.ml
diff --git a/samples/client/petstore/ocaml-additional-properties/.openapi-generator/VERSION b/samples/client/petstore/ocaml-additional-properties/.openapi-generator/VERSION
@@ -0,0 +1 @@
+7.16.0-SNAPSHOT
diff --git a/samples/client/petstore/ocaml-additional-properties/README.md b/samples/client/petstore/ocaml-additional-properties/README.md
@@ -0,0 +1,33 @@
+# 
+No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+This OCaml package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Generator version: 7.16.0-SNAPSHOT
+- Build package: org.openapitools.codegen.languages.OCamlClientCodegen
+
+## Requirements.
+
+OCaml 5.x
+
+## Installation
+
+Please run the following commands to build the package `petstore_client`:
+
+```sh
+opam install . --deps-only --with-test
+eval $(opam env)
+dune build
+```
+
+## Getting Started
+
+The generated directory structure is:
+- `src/apis`: contains several modules, each with several functions. Each function is an API endpoint.
+- `src/models`: contains several modules. Each module contains:
+  - a type `t` representing an input and/or output schema of the OpenAPI spec
+  - a smart constructor `create` for this type
+- `src/support`: various modules used by the generated APIs and Models
+
diff --git a/samples/client/petstore/ocaml-additional-properties/dune b/samples/client/petstore/ocaml-additional-properties/dune
@@ -0,0 +1,9 @@
+(include_subdirs unqualified)
+(library
+   (name petstore_client)
+   (public_name petstore_client)
+   (flags (:standard -w -27))
+   (libraries str cohttp-lwt-unix lwt yojson ppx_deriving_yojson.runtime)
+   (preprocess (pps ppx_deriving_yojson ppx_deriving.std))
+   (wrapped true)
+)
diff --git a/samples/client/petstore/ocaml-additional-properties/dune-project b/samples/client/petstore/ocaml-additional-properties/dune-project
@@ -0,0 +1,2 @@
+(lang dune 2.0)
+(name petstore_client)
diff --git a/samples/client/petstore/ocaml-additional-properties/petstore_client.opam b/samples/client/petstore/ocaml-additional-properties/petstore_client.opam
@@ -0,0 +1,25 @@
+opam-version: "2.0"
+name: "petstore_client"
+version: "1.0.0"
+synopsis: ""
+description: """
+Longer description
+"""
+maintainer: "Name <email>"
+authors: "Name <email>"
+license: ""
+homepage: ""
+bug-reports: ""
+dev-repo: ""
+depends: [
+  "ocaml"
+  "ocamlfind"
+  "ocamlformat" {= "0.27.0"}
+  "dune"
+  "ppx_deriving_yojson"
+  "conf-libev"
+  "lwt"
+  "cohttp-lwt-unix" {< "6.0.0"}
+  "cohttp-async" {< "6.0.0"}
+]
+build: ["dune" "build" "-p" name]
diff --git a/samples/client/petstore/ocaml-additional-properties/src/models/some_object.ml b/samples/client/petstore/ocaml-additional-properties/src/models/some_object.ml
@@ -0,0 +1,53 @@
+(*
+ * This file has been generated by the OCamlClientCodegen generator for openapi-generator.
+ *
+ * Generated by: https://openapi-generator.tech
+ *
+ *)
+
+
+
+    
+        type t = {
+                    (* Required, free-form *)
+                              required_field1: (string * Yojson.Safe.t) list
+                
+                 [@to_yojson JsonSupport.of_map_of [%to_yojson: Yojson.Safe.t]] [@of_yojson JsonSupport.to_map_of [%of_yojson: Yojson.Safe.t]]
+                ; [@key "required_field1"]
+                            (* Required, dictionary of strings *)
+                              required_field2: (string * string) list
+                
+                 [@to_yojson JsonSupport.of_map_of [%to_yojson: string]] [@of_yojson JsonSupport.to_map_of [%of_yojson: string]]
+                ; [@key "required_field2"]
+                            (* Required, dictionary of objects *)
+                              required_field3: (string * Some_object_required_field3_value.t) list
+                
+                 [@to_yojson JsonSupport.of_map_of [%to_yojson: Some_object_required_field3_value.t]] [@of_yojson JsonSupport.to_map_of [%of_yojson: Some_object_required_field3_value.t]]
+                ; [@key "required_field3"]
+                            (* Optional, free-form *)
+                              optional_field1: (string * Yojson.Safe.t) list
+                
+                 [@default []] [@to_yojson JsonSupport.of_map_of [%to_yojson: Yojson.Safe.t]] [@of_yojson JsonSupport.to_map_of [%of_yojson: Yojson.Safe.t]]
+                ; [@key "optional_field1"]
+                            (* Optional, dictionary of strings *)
+                              optional_field2: (string * string) list
+                
+                 [@default []] [@to_yojson JsonSupport.of_map_of [%to_yojson: string]] [@of_yojson JsonSupport.to_map_of [%of_yojson: string]]
+                ; [@key "optional_field2"]
+                            (* Optional, dictionary of objects *)
+                              optional_field3: (string * Some_object_required_field3_value.t) list
+                
+                 [@default []] [@to_yojson JsonSupport.of_map_of [%to_yojson: Some_object_required_field3_value.t]] [@of_yojson JsonSupport.to_map_of [%of_yojson: Some_object_required_field3_value.t]]
+                ; [@key "optional_field3"]
+                } [@@deriving yojson { strict = false }, show, eq ];;
+        
+        let create (required_field1 : (string * Yojson.Safe.t) list) (required_field2 : (string * string) list) (required_field3 : (string * Some_object_required_field3_value.t) list) : t = {
+            required_field1 = required_field1;
+            required_field2 = required_field2;
+            required_field3 = required_field3;
+            optional_field1 = [];
+            optional_field2 = [];
+            optional_field3 = [];
+        }
+    
+
diff --git a/samples/client/petstore/ocaml-additional-properties/src/models/some_object_required_field3_value.ml b/samples/client/petstore/ocaml-additional-properties/src/models/some_object_required_field3_value.ml
@@ -0,0 +1,31 @@
+(*
+ * This file has been generated by the OCamlClientCodegen generator for openapi-generator.
+ *
+ * Generated by: https://openapi-generator.tech
+ *
+ *)
+
+
+
+    
+        type t = {
+                                      sub_field1: float
+                  
+                   option [@default None]
+                
+                
+                ; [@key "sub_field1"]
+                                              sub_field2: bool
+                  
+                   option [@default None]
+                
+                
+                ; [@key "sub_field2"]
+                } [@@deriving yojson { strict = false }, show, eq ];;
+        
+        let create () : t = {
+            sub_field1 = None;
+            sub_field2 = None;
+        }
+    
+
diff --git a/samples/client/petstore/ocaml-additional-properties/src/support/enums.ml b/samples/client/petstore/ocaml-additional-properties/src/support/enums.ml
@@ -0,0 +1,6 @@
+(*
+ * This file has been generated by the OCamlClientCodegen generator for openapi-generator.
+ *
+ * Generated by: https://openapi-generator.tech
+ *
+ *)
diff --git a/samples/client/petstore/ocaml-additional-properties/src/support/jsonSupport.ml b/samples/client/petstore/ocaml-additional-properties/src/support/jsonSupport.ml
@@ -0,0 +1,68 @@
+open Ppx_deriving_yojson_runtime
+
+let unwrap to_json json =
+    match to_json json with
+    | Result.Ok json -> json
+    | Result.Error s -> failwith s
+
+let to_int json =
+    match json with
+    | `Int x -> x
+    | `Intlit s -> int_of_string s
+    | _ -> failwith "JsonSupport.to_int"
+
+let to_bool json =
+    match json with
+    | `Bool x -> x
+    | _ -> failwith "JsonSupport.to_bool"
+
+let to_float json =
+    match json with
+    | `Float x -> x
+    | _ -> failwith "JsonSupport.to_float"
+
+let to_string json =
+    match json with
+    | `String s -> s
+    | _ -> failwith "JsonSupport.to_string"
+
+let to_int32 json : int32 =
+    match json with
+    | `Int x -> Int32.of_int x
+    | `Intlit s -> Int32.of_string s
+    | _ -> failwith "JsonSupport.to_int32"
+
+let to_int64 json : int64 =
+    match json with
+    | `Int x -> Int64.of_int x
+    | `Intlit s -> Int64.of_string s
+    | _ -> failwith "JsonSupport.to_int64"
+
+let of_int x = `Int x
+
+let of_bool b = `Bool b
+
+let of_float x = `Float x
+
+let of_string s = `String s
+
+let of_int32 x = `Intlit (Int32.to_string x)
+
+let of_int64 x = `Intlit (Int64.to_string x)
+
+let of_list_of of_f l = `List (Stdlib.List.map of_f l)
+
+let of_map_of of_f l = `Assoc (Stdlib.List.map (fun (k, v) -> (k, of_f v)) l)
+
+let to_map_of of_f json =
+  match json with
+  | `Assoc l ->
+    Stdlib.List.fold_right
+      (fun (k, json) acc ->
+        match (of_f json, acc) with
+        | Stdlib.Result.Ok parsed_v, Stdlib.Result.Ok tl ->
+          Stdlib.Result.Ok ((k, parsed_v) :: tl)
+        | Stdlib.Result.Error e, _ -> Stdlib.Result.Error e
+        | _, Stdlib.Result.Error e -> Stdlib.Result.Error e)
+      l (Stdlib.Result.Ok [])
+  | _ -> Stdlib.Result.Error "Expected"
diff --git a/samples/client/petstore/ocaml-additional-properties/src/support/request.ml b/samples/client/petstore/ocaml-additional-properties/src/support/request.ml
diff --git a/samples/client/petstore/ocaml-fake-petstore/src/models/additional_properties_class.ml b/samples/client/petstore/ocaml-fake-petstore/src/models/additional_properties_class.ml
diff --git a/samples/client/petstore/ocaml-fake-petstore/src/models/fake_big_decimal_map_200_response.ml b/samples/client/petstore/ocaml-fake-petstore/src/models/fake_big_decimal_map_200_response.ml
diff --git a/samples/client/petstore/ocaml-fake-petstore/src/models/map_test.ml b/samples/client/petstore/ocaml-fake-petstore/src/models/map_test.ml
diff --git a/samples/client/petstore/ocaml-fake-petstore/src/models/mixed_properties_and_additional_properties_class.ml b/samples/client/petstore/ocaml-fake-petstore/src/models/mixed_properties_and_additional_properties_class.ml
diff --git a/samples/client/petstore/ocaml-fake-petstore/src/models/nullable_class.ml b/samples/client/petstore/ocaml-fake-petstore/src/models/nullable_class.ml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+version=0.27.0`
	`2`	`+ocaml-version=4.14.0`