Skip to main content

generate_yaml_specs

Generate OpenAPI specs for the YAML interface.

Module​

Functions​

generate_yaml_specs​

def generate_yaml_specs(    output_directory: str = 'task_templates',    breaking_changes_check: bool = False,    specs: Optional[str] = None,    templated: bool = True,    *modules_to_import: str,) ‑> None:

Generate OpenAPI specs for the YAML interface.

Arguments

  • output_directory: Directory to store the generated specs, will be created if it doesn't already exist.
  • breaking_changes_check: Whether this is run for checking for breaking changes.
  • specs: Whether to generate "pod" or "task" spec. If not provided, generates both.
  • templated: Whether to generate the templated modeller config spec or regular modeller config spec.
  • modules_to_import: Module paths to be imported, this is used so that any plugins can be loaded and included in the specs.