flipdishbytes/Publish API Docs
Publish API Docs to ReadMe, including validation
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| openapi_file_path | Path to the OpenAPI specification file | yes | — |
| readme_slug | Slug to use for the API definition in ReadMe, see https://docs.readme.com/main/docs/rdme#specifying-page-slugs | yes | — |
| readme_api_key | API key for ReadMe (pass secrets.README_API_KEY from your workflow) | yes | — |
| spectral_rules_url | URL to the Spectral rules file | no | https://raw.githubusercontent.com/flipdishbytes/spectral-rules/main/.spectral.yaml |
| readme_version | Version to use when uploading to ReadMe | no | v3.0 |
| skip_readme_publish | Skip publishing to ReadMe (useful for validation-only runs) | no | false |
| skip_spectral | Skip Spectral linting (useful for validation-only runs) | no | false |
| skip_validate_readme | Skip ReadMe OpenAPI validation (useful for linting-only runs) | no | false |
Outputs
no outputs