[Fix][OCaml] Incorrect encoding/decoding for required free-form objects; Odoc for record fields (#21819)

* [OCaml] Fix inconsistent oneOf primitive sample name

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

* [OCaml] Change field comment to Odoc, move it after the field

As per Odoc documentation, record field documentation should be *after* the
field, not before.
See https://ocaml.github.io/odoc/odoc/odoc_for_authors.html#special_comments
type `my_record`

* [OCaml] Cleanup non-generated files for ocaml sample

Author: sir4ur0n

.github/workflows/samples-ocaml.yaml

@@ -5,12 +5,14 @@ on:
     paths:
       - 'samples/client/petstore/ocaml/**'
       - 'samples/client/petstore/ocaml-fake-petstore/**'
-      - 'samples/client/petstore/ocaml-oneOf/**'
+      - '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/**'
+      - 'samples/client/petstore/ocaml-oneOf-primitive/**'
+      - 'samples/client/petstore/ocaml-additional-properties/**'
 
 jobs:
   build:
@@ -22,7 +24,8 @@ jobs:
         sample:
           - 'samples/client/petstore/ocaml/'
           - 'samples/client/petstore/ocaml-fake-petstore/'
-          - 'samples/client/petstore/ocaml-oneOf/'
+          - 'samples/client/petstore/ocaml-oneOf-primitive/'
+          - 'samples/client/petstore/ocaml-additional-properties/'
     steps:
       - uses: actions/checkout@v5
       - name: Set-up OCaml

.gitignore

@@ -297,7 +297,8 @@ samples/openapi3/client/petstore/go/privatekey.pem
 ## OCaml
 samples/client/petstore/ocaml/_build/
 samples/client/petstore/ocaml-fake-petstore/_build/
-samples/client/petstore/ocaml-oneOf/_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

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

bin/configs/ocaml-oneOf.yaml renamed to bin/configs/ocaml-oneOf-primitive.yaml

@@ -1,5 +1,5 @@
 generatorName: ocaml
-outputDir: samples/client/petstore/ocaml-oneOf
+outputDir: samples/client/petstore/ocaml-oneOf-primitive
 inputSpec: modules/openapi-generator/src/test/resources/3_0/oneOf_primitive.yaml
 templateDir: modules/openapi-generator/src/main/resources/ocaml
 additionalProperties:

modules/openapi-generator/src/main/resources/ocaml/model-record.mustache

@@ -1,8 +1,5 @@
 type t = {
 {{#vars}}
-    {{#description}}
-    (* {{{.}}} *)
-    {{/description}}
     {{#isEnum}}
       {{{name}}}: {{^isMap}}Enums.{{/isMap}}{{{datatypeWithEnum}}}
         {{^isContainer}}
@@ -28,9 +25,12 @@ 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}}
+    {{#description}}
+    (** {{{.}}} *)
+    {{/description}}
 {{/vars}}
 } [@@deriving yojson { strict = false }, show, eq ];;
 

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

samples/client/petstore/ocaml-oneOf/.ocamlformat renamed to samples/client/petstore/ocaml-additional-properties/.ocamlformat

@@ -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