OCaml let string_of_p x = y and let string_to_p y = x printer of Parameter object serialization functions.

Each OpenAPI Parameter Object has an optional schema field that has complex rules on how to serialize it.

Confer Parameter Serialization and OpenAPI Specification Style Examples.

Be aware that the examples from the first "https://swagger.io" conflict with the OpenAPI specification (Swagger has commas where the OpenAPI spec has dots). We consider the OpenAPI specification examples to be canonical.

loc argument

The location where the Parameter object needs to be rendered.

One of:

  • `Path
  • `Query
  • `Header
  • `Cookie

style argument

The OpenAPI style property.

Confer OpenAPI Specification Style Examples.

One of:

  • `Matrix
  • `Form
  • `Simple
  • `Label
  • `SpaceDelimited
  • `PipeDelimited
  • `DeepObject

explode argument

The OpenAPI explode property.

Confer OpenAPI Specification Style Examples.

Sourceval serializername : (module OaDocument.STANDARD) -> [< `PrimitiveType of string | `TypeAlias of string ] -> string
include DkCoder_Std.SCRIPT
Sourceval __init : DkCoder_Std.Context.t -> unit

__init context is the entry point for running a script module. The DkCoder compiler will inject this function at the top and bottom of the script module. The top __init does nothing, while the bottom __init calls the prior __init.

That means:

  1. calling the __init function guarantees that the script module is initialized; that is, all of the script module's side-effects (ex. let () = Format.printf "Hello world@.") are executed before the __init returns to the caller.
  2. you can override the __init function by simply defining the __init idempotently. That will shadow the top __init and when the bottom __init is executed your __init will be called instead of the do-nothing top __init.

Future versions of DkCoder will call __init in dependency order for all `You script modules. Your __init function may be called several times.

Sourceval __repl : DkCoder_Std.Context.t -> unit

__repl context is the entry point for debugging a script module in a REPL. The DkCoder compiler will inject this function at the top and bottom of the script module. The top __repl does nothing, while the bottom __repl calls the prior __repl.

That means:

  1. you can override the __repl function by simply defining the __repl idempotently. That will shadow the top __repl and when the bottom __repl is executed your __repl will be called instead of the do-nothing top __repl.
Sourceval __module_info : unit -> DkCoder_Std.ModuleInfo.t

The run-time module information for the script module.