domoapps/OpenAPI TOC Generator for Mintlify
Generate Mintlify docs.json navigation entries from OpenAPI YAML specifications
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| yaml_input_path | Path to directory containing OpenAPI YAML files | no | ./yaml |
| docs_json_path | Path to Mintlify docs.json file to update | yes | — |
| openapi_base_path | Base path for OpenAPI references in docs.json (e.g., "openapi/product") | no | openapi/product |
| yaml_copy_destination | Optional directory to copy YAML files to after processing | no | "" |
| process_changed_only | Only process YAML files that have changed (requires git history) | no | false |
| changed_files | Newline-separated list of changed files to process (overrides internal change detection) | no | "" |
| base_ref | Base reference for change detection (default: main branch or PR base) | no | "" |
| create_pull_request | Create a pull request with the updated docs.json | no | false |
| pr_title | Title for the pull request | no | Update API navigation in docs.json |
| pr_branch_name | Name for the PR branch | no | docs/update-api-navigation |
Outputs
| name | description |
|---|---|
| files_processed | Number of YAML files processed |
| groups_updated | Number of API groups updated in docs.json |