sailpoint-oss/Telescope

All-in-one OpenAPI platform: lint, validate, diff, test, and document.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
modeComma-separated modes: lint, validate, ci, diff, contract, docs, generate, generate-and-lintci
generate-rootgenerate mode: path to the repo to extract from.
generate-langgenerate mode: language override (go/java/ts); auto-detected when empty""
generate-outputgenerate mode: spec output pathopenapi.yaml
generate-configgenerate mode: cartographer config directory""
generate-sourcemapgenerate mode: also emit an openapi.sourcemap.json alongside outputfalse
go-versionGo version used to build Telescope1.25.x
working-directoryWorkspace directory to analyze.
pathsSpace-separated file or directory paths to analyze.
configOptional Telescope config path""
rulesetOptional ruleset path""
lint-engineLint engine: barrelman, vacuum, or bothbarrelman
vacuum-rulesetOptional vacuum-compatible ruleset path""
diff-baseBase ref for ci modemain
diff-headHead ref for ci modeHEAD
report-scopeCI report scope: changed (graph-expanded impact) or all configured fileschanged
severityOptional minimum severity filter""
fail-onFailure threshold: error or warnerror
no-external-lspDeprecated no-op; retained for compatibilityfalse
comment-prPost PR comment in ci modetrue
report-mdMarkdown report output pathtelescope-report.md
report-jsonJSON report output pathtelescope-report.json
report-sarifSARIF report output path""
fail-on-breakingCI/diff: exit 1 when libopenapi finds breaking API changestrue
breaking-configOptional path to openapi-changes-style breaking rules YAML""
diff-leftdiff mode: original spec (file path or REF:path)""
diff-rightdiff mode: updated spec (file path or REF:path)""
diff-formatdiff mode output format: text, json, markdown, sarifjson
diff-outputdiff mode: write report to this path (under workspace)telescope-breaking.json
contract-base-urlBase URL for contract test mode""
contract-specSpec path for contract test mode""
contract-wiretapEnable wiretap proxy validation in contract modefalse
docs-outputOutput directory for docs modetelescope-docs
docs-publishBuild documentation for static hostingfalse
namedescription
report-mdMarkdown report path
report-jsonJSON report path
report-sarifSARIF report path
lint-findingsTotal lint and validation findings
breaking-changesTotal breaking changes detected
contract-passedPassing contract tests
contract-failedFailing contract tests
exit-codeOverall exit code
errorError message if the action run failed