ComputePods interface generator configuration

The ComputePods interface generator is primarily configured using a YAML configuration file.

By default this configuration file is called cpigConfig.yaml in the directory in which the tool is started. Alternatively you can use the -c or --config command line option to specify a different configuration file.

This configuration file works by having or not having one or more hierarchies of values located as sub-hierarchies of one of the top-level keys: genSchema, genExamples, genHttpRoutes, options.

Controlling where the output code files go

To specify the directory in which to place output code add the following key:

options:
  output: <aPath>

where <aPath is either an absolute path in your file system, or a path relative to the current working directory (in which you run the tool).

Producing Pydantic/Python classes

To produce Pydantic data classes for use in Python code add the following keys:

genSchema:
  pydantic:
    <aCollectionOfKey>: <valuePairs>

You can use any of the datamodel-code-generator command line options in the above collection of key/value pairs. If the option takes no arguments, then simply leave the value empty. (Note that any of the "input" options will be ignored as the input is controlled by the interface generator itself).

If you just want to use the standard defaults they add the following keys:

genSchema:
  pydantic: {}

Producing AJV/JavaScript classes

To produce AJV parsing / validation / serialisation code for use in JavaScript (either on the server or in the browser) add the following keys:

genSchema:
  ajv:
    jinja2: ./templates/ajv.j2
    ajvOptions:
      strict: True
      allErrors: True

You can use either or both of the parse or serialize keywords.

The you can use any of the AJV options in the options dictionary.

Producing JSON examples for use in JavaScript

To produce JSON examples for use in JavaScript add the following keys:

genExamples:
  javaScriptExamples: 
    jinja2: ./templates/jsExamples.j2
    options:
      key: value

Producing JSON examples for use in Python

To produce JSON examples for use in Python add the following keys:

genExamples:
  pythonExamples:
    jinja2: ./templates/pyExamples.j2
    options:
      key: value

Producing Mock Service Workers for use in JavaScript

To produce Mock Service Workers code from the httpRoutes and jsonExamples then add the following keys:

genExamples:
  mockServiceWorkers:
    jinja2: ./templates/msw.j2
    options:
      key: value

Producing Mithril connector mixin components for use in JavaScript

To produce Mithril connector mixin components code from the httpRoutes then add the following keys:

genHttpRoutes:
  mithrilConnectors:
    jinja2: ./templates/mithrilConnectors.j2
    options:
      key: value

Full example with Pydantic defaults

To produce all of the output using the Pydantic defaults use the following configuration file:

options:
  output: aPath

genSchema:
  pydantic: {}
  ajv:
    ajvOptions:
      strict: True
      allErrors: True

genExamples:
  javaScriptExamples: {}
  pythonExamples: {}
  mockServiceWorkers: {}

genHttpRoutes:
  mithrilConnectors: {}