Skip to content

Add JSON Schema Documentation for SEPEX Processes#123

Open
sclaw wants to merge 1 commit intomainfrom
documentation/process-config-yaml
Open

Add JSON Schema Documentation for SEPEX Processes#123
sclaw wants to merge 1 commit intomainfrom
documentation/process-config-yaml

Conversation

@sclaw
Copy link
Copy Markdown
Collaborator

@sclaw sclaw commented Apr 10, 2026

This PR resolves #120 by adding JSON schema and human-readable documentation for SEPEX process YAML files.

Changes

  1. Added process.json schema definition covering all process fields (info, host, command, config, inputs, outputs)
  2. Added build-time generation of HTML documentation using json-schema-for-humans
  3. Added API endpoints:
    • /schemas/process - serves human-readable HTML documentation
    • /schemas/process.json - serves machine-readable JSON schema
  4. Updated Dockerfile to install Python tools and run schema generation during build

Demo of new endpoint at /schemas/process

image image image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add and maintain schema for plugin yamls

1 participant