-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
api domain docs and some minor nearby cleanup
- Loading branch information
1 parent
344636b
commit 3ace518
Showing
3 changed files
with
42 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,42 @@ | ||
# API Domain | ||
|
||
The API Domain allows for collection of data generically from API endpoints. | ||
The API Domain allows for collection of data (via HTTP Get Requests) generically from API endpoints. | ||
|
||
# Specification | ||
The API domain Specification accepts a list of `Requests` and an `Options` block. `Options` can be configured at the top-level and will apply to all requests except those which have embedded `Options`. `Request`-level options will *override* top-level `Options`. | ||
|
||
|
||
```yaml | ||
domain: | ||
type: api | ||
api-spec: | ||
# Options specified at this level will apply to all requests except those with an Options block of their own. | ||
Options: | ||
# Timeout configures the Request Timeout. Default is no timeout. The Timeout string is a number followed by a unit suffix (ms, s, m, h, d), such as 30s or 1m. | ||
Timeout: 30s | ||
# Configure a Proxy server for all requests. | ||
Proxy: "https://my.proxy" | ||
Headers: | ||
key: "value" | ||
my-customer-header: "my-custom-value" | ||
# Requests is a list of requests. The Request Name is the key used when referencing the resources returned from the API in the provider. | ||
Requests: | ||
# User-defined descriptive name | ||
- Name: "healthcheck" | ||
# The URL of the Request. The API domain supports be any rfc3986-formatted URI. Lula also supports url `Parameters` as a separate argument. | ||
Url: "https://example.com/health/ready" | ||
# Url Parameters to append to the URL. Lula also supports full URIs in the `Url`. | ||
Parameters: | ||
key: "value" | ||
# Request-level Options have the same specification as the api-spec-level Options. These options apply only to this request. | ||
Options: | ||
# Timeout configures the Request Timeout. Default is no timeout. The Timeout string is a number followed by a unit suffix (ms, s, m, h, d), such as 30s or 1m. | ||
Timeout: 30s | ||
# Configure a Proxy server for all requests. | ||
Proxy: "https://my.proxy" | ||
Headers: | ||
key: "value" | ||
my-customer-header: "my-custom-value" | ||
- Name: "readycheck" | ||
# etc ... | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters