grid-x/OpenAPI Discourse Upload Action
Uploads an OpenAPI specification to a Discourse topic for rendering using https://github.com/wwerner/discourse-rapidoc-theme-component
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| discourse_url | your discourse instance domain, e.g. "community.acme.com | yes | — |
| discourse_post_id | the ID of the Discourse post to update | yes | — |
| discourse_api_key | your discourse API key. It needs `posts - edit` and `uploads - create` permissions | yes | — |
| discourse_user | the discourse user on whose behalf the action should be executed | yes | — |
| spec_file | the OAS file to upload | yes | — |
| github_sha | short commit hash to be put into to post for traceability | yes | — |
| body_template | Custom post body template. Supports placeholders: {ORIGINAL_FILENAME}, {DISCOURSE_URL}, {UPLOAD_PATH}, {UPLOAD_URL}, {DATE}, {COMMIT} | no | API Documentation/Specification `{ORIGINAL_FILENAME}` ```apidoc https://{DISCOURSE_URL}/{UPLOAD_PATH} ``` [{ORIGINAL_FILENAME}|attachment]({UPLOAD_URL}) *last updated*: {DATE} (sha {COMMIT}) |
Outputs
no outputs