diff --git a/docs/reference/domains/api-domain.md b/docs/reference/domains/api-domain.md index 415ecb24..3005ee89 100644 --- a/docs/reference/domains/api-domain.md +++ b/docs/reference/domains/api-domain.md @@ -8,35 +8,37 @@ The API domain Specification accepts a list of `Requests` and an `Options` block ```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 ... + type: api + api-spec: + # Options specified at this level will apply to all requests except those with an embedded options block. + options: + # Timeout configures the request timeout. The default timeout is 30 seconds (30s). The timeout string is a number followed by a unit suffix (ms, s, m, h, d), such as 30s or 1m. + timeout: 30s + # Proxy specifies a proxy server for all requests. + proxy: "https://my.proxy" + # Headers is a map of key value pairs to send with all requests. + headers: + key: "value" + my-customer-header: "my-custom-value" + # Requests is a list of URLs to query. The request name is the map key used when referencing the resources returned by the API. + requests: + # A descriptive name for the request. + - name: "healthcheck" + # The URL of the request. The API domain supports any rfc3986-formatted URI. Lula also supports URL parameters as a separate argument. + url: "https://example.com/health/ready" + # 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: + # Configure the request timeout. The default timeout is 30 seconds (30s). The timeout string is a number followed by a unit suffix (ms, s, m, h, d), such as 30s or 1m. + timeout: 30s + # Proxy specifies a proxy server for this request. + proxy: "https://my.proxy" + # Headers is a map of key value pairs to send with this request. + headers: + key: "value" + my-customer-header: "my-custom-value" + - name: "readycheck" + # etc ... ```