Skip to content

Compute Pods interfaces

This directory describes the ComputePods MajorDomo client/server interfaces.

These interfaces are generated by the ComputePods interface generator (cpig).

The JSON on the client side of this interface will be checked using AJV while the server side will use Python's dataclass.

The cpig uses description format based on Markdown/YAML files from which both the AJV and dataclass descriptions can be automatically generated.

The Markdown will be used for any general descriptions targeted at human programmers. These Markdown files will contain YAML code blocks which the Python cpig will extract, load as YAML and use to produce the required interfaces descriptions for use by the appropriate code.

Interfaces

We require the following interfaces: