theneo-inc/Theneo API Documentation
Generate Stripe-like API Documentation
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| FILE_PATH | API documentation file path | yes | — |
| PATH | API documentation file path (deprecated) | no | — |
| PROJECT_KEY | Unique Key for the project | no | — |
| PROJECT_SLUG | Unique Key for the project | no | — |
| VERSION_SLUG | Project version slug to import the update data into, if not provided, the default version will be used | no | — |
| WORKSPACE_SLUG | Workspace slug where project is located, if not provided it will search for the project in all workspaces | no | — |
| SECRET | API Key from Theneo website | yes | — |
| IMPORT_OPTION | Import option should be one of (overwrite, merge, endpoints, append) | no | overwrite |
| AUTO_PUBLISH | Indicates if the documentation should be published automatically or not after importing | no | true |
| INCLUDE_GITHUB_METADATA | Include GitHub metadata - such as GitHub actor username for import metadata | no | false |
| PARAMETER_DESCRIPTION_MERGE_STRATEGY | Merging strategy for parameter descriptions to keep old descriptions from theneo editor if needed, valid values are keep_new or keep_old | no | — |
| SECTION_DESCRIPTION_MERGE_STRATEGY | Merging strategy for section descriptions to keep old descriptions from theneo editor if needed, valid values are keep_new or keep_old | no | — |
Outputs
no outputs