Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lee-dohm/execute-discourse-query

Executes a Discourse data-explorer query via the API
https://github.com/lee-dohm/execute-discourse-query

action discourse query

Last synced: about 2 months ago
JSON representation

Executes a Discourse data-explorer query via the API

Awesome Lists containing this project

README

        

# Execute Discourse Query

A GitHub Action to execute a Discourse query and return the results.

## Use

### Inputs

- `discourseKey` — **required** API key used to execute the query
- `format` — The format to store the results in: either `json` or `markdown` (_default:_ `json`)
- `hostname` — **required** Hostname of the Discourse instance to submit the query to
- `id` — **required** ID of the query to execute
- `params` — JSON object containing the parameters for the query
- `path` — **required** File path to store the results in

### Outputs

- `path` — File path where the results of the query were stored

## License

[MIT](LICENSE.md)