heiervang-technologies/am-i-openai-compatible
Probe an OpenAI-compatible HTTP server in CI and report per-endpoint pass/warn/fail/skip.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| base-url | Root URL of the target server (e.g. http://127.0.0.1:8080). | yes | — |
| name | Label for the report. Defaults to the host of base-url. | no | "" |
| aioc-version | Which build to install. Not on PyPI yet — accepts 'main' (latest commit on the default branch) or any pip-installable git spec, e.g. 'git+https://github.com/heiervang-technologies/am-i-openai-compatible.git@v0.4.3' to pin to a tag. Default 'main'. | no | main |
| python-version | Python version for the probe runtime. | no | 3.12 |
| skip-phase-b | If true, only run Phase A (existence checks). Faster smoke run. | no | false |
| endpoints-filter | Optional regex applied to endpoint paths. When set, only matching endpoints are probed. Use to skip the audio/image arm in fast-path PR runs. | no | "" |
| profile | Which catalog rows to probe: 'openai' (default; core/optional/ext) or 'ht' (adds HT-compat extensions per docs/spec/ht-compat.md and FAILs on 404 there). | no | openai |
| model | Pin a specific model id for Phase B bodies (e.g. 'borealis-4b'). Default behavior picks the first model from /v1/models, which is arbitrary on router-mode servers. Falls back to kind-based selection for endpoints whose required kind the override can't serve. | no | "" |
| openai-api-key | Bearer token for WebSocket upgrades on /v1/realtime-style rows (ignored for REST endpoints). OSS servers usually accept the empty default; OpenAI-hosted targets require a real key. Use a GitHub Secret. | no | "" |
| fail-on | Threshold that fails the action: 'FAIL' (any FAIL row), 'WARN' (any WARN or FAIL), or 'none' (always succeed). Default 'FAIL'. | no | FAIL |
| report-path | Where to write the JSON report inside the workspace. | no | aioc-report.json |
| upload-artifact | If true, upload the report as a workflow artifact named 'aioc-report-<name>'. | no | true |
| step-summary | If true, append a per-endpoint markdown table to GITHUB_STEP_SUMMARY in catalog order. | no | true |
Outputs
| name | description |
|---|---|
| report-path | Path to the generated JSON report. |
| report-url | URL of the uploaded artifact (empty if upload-artifact is false). |
| pass-count | Number of PASS events. |
| warn-count | Number of WARN events. |
| fail-count | Number of FAIL events. |
| skip-count | Number of SKIP events. |