mirror of
https://github.com/jwetzell/showbridge-docs.git
synced 2026-08-12 17:13:39 +00:00
work on auto-generating parts of docs from JSONSchema
This commit is contained in:
@@ -4,13 +4,11 @@ sidebar:
|
||||
label: Make Request
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
|
||||
|
||||
This process will make an HTTP request to the specified URL using the specified method. The response will be passed through to the next processor in the chain. This processor will return an error if the request fails for any reason (e.g. network error, invalid URL, etc.).
|
||||
|
||||
- **type**: `http.request.do`
|
||||
- **params**:
|
||||
- **method**: the HTTP method to use for the request (e.g. `GET`, `POST`, `PUT`, etc.)
|
||||
- **url**: the URL to send the request to
|
||||
<SchemaInfo type="processor" id="http.request.do"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,13 +4,11 @@ sidebar:
|
||||
label: Create
|
||||
order: 2
|
||||
---
|
||||
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will create a new HTTP response with the specified status code and body template. The created response will be passed through to the next processor in the chain. If the response is subsequently sent to an HTTP server module using the [module.output](../module/output.md) processor, the status code and body template set by this processor will be used for the response sent to the client. This processor will return an error if there is an issue executing the body template.
|
||||
|
||||
- **type**: `http.response.create`
|
||||
- **params**:
|
||||
- **status**: the HTTP status code to set for the response (e.g. `200`, `404`, etc.)
|
||||
- **bodyTemplate**: the body template to set for the response
|
||||
<SchemaInfo type="processor" id="http.response.create"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
Reference in New Issue
Block a user