Skip to content

Commit

Permalink
Generated v7.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Apr 26, 2024
1 parent 685f962 commit f969fe5
Show file tree
Hide file tree
Showing 785 changed files with 1,697 additions and 791 deletions.
25 changes: 25 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,30 @@
# Changelog

## [v7.2.0](https://github.com/fastly/fastly-js/releases/tag/release/v7.2.0) (2024-04-25)

**Bug fixes:**

- bugfix(billing_address, invitations): Correct customer relationship schema to be single entry rather than array
- bugfix(request_settings): Mark request_settings fields as nullable: bypass_busy_wait, force_miss, geo_headers,
max_stale_age, timer_support, and xff

**Enhancements:**

- feat(generator): The API Client Generator now uses a new automatic changelog generation process.
- feat(historical, realtime): Add the following new metrics: `ddos_action_downgrade`,
`ddos_action_downgraded_connections`, `vcl_on_compute_hit_requests`, `vcl_on_compute_miss_requests`,
`vcl_on_compute_pass_requests`, `vcl_on_compute_error_requests`, `vcl_on_compute_synth_requests`,
`vcl_on_compute_edge_hit_requests`, `vcl_on_compute_edge_miss_requests`, `all_hit_requests`,
`all_miss_requests`, `all_pass_requests`, `all_error_requests`, `all_synth_requests`, `all_edge_hit_requests`,
`all_edge_miss_requests`, `all_status_1xx`, `all_status_2xx`, `all_status_3xx`, `all_status_4xx`, and
`all_status_5xx`.
- feat(backend): Add `tcp_keepalive_*` properties to the Backend API, which allow configuring TCP keepalives for
backend connections.

**Documentation:**

- doc(realtime): Correct description of miss_histogram structure in real-time stats.

## [v7.1.0](https://github.com/fastly/fastly-js/releases/tag/release/v7.1.0) (2024-02-28)

**Enhancements:**
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,12 @@ The fastly-js API client currently does not support the following endpoints:
- [`/alerts/definitions/{definition_id}`](https://www.fastly.com/documentation/reference/api/observability/alerts/definitions) (DELETE, GET, PUT)
- [`/alerts/definitions`](https://www.fastly.com/documentation/reference/api/observability/alerts/definitions) (GET, POST)
- [`/alerts/history`](https://www.fastly.com/documentation/reference/api/observability/alerts/history) (GET)
- [`/notifications/integration-types`](https://developer.fastly.com/reference/api/observability/notification) (GET)
- [`/notifications/integrations/{integration_id}/rotateSigningKey`](https://developer.fastly.com/reference/api/observability/notification) (POST)
- [`/notifications/integrations/{integration_id}/signingKey`](https://developer.fastly.com/reference/api/observability/notification) (GET)
- [`/notifications/integrations/{integration_id}`](https://developer.fastly.com/reference/api/observability/notification) (DELETE, GET, PATCH)
- [`/notifications/integrations`](https://developer.fastly.com/reference/api/observability/notification) (GET, POST)
- [`/notifications/mailinglist-confirmations`](https://developer.fastly.com/reference/api/observability/notification) (POST)
- [`/resources/stores/kv/{store_id}/batch`](https://www.fastly.com/documentation/reference/api/services/resources/kv-store-item) (PUT)
- [`/tls/activations/{tls_activation_id}`](https://www.fastly.com/documentation/reference/api/tls/mutual-tls/activations) (GET, PATCH)
- [`/tls/activations`](https://www.fastly.com/documentation/reference/api/tls/mutual-tls/activations) (GET)
Expand Down
4 changes: 4 additions & 0 deletions docs/Backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ Name | Type | Description | Notes
**ssl_client_key** | **String** | Client key attached to origin. | [optional]
**ssl_hostname** | **String** | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | [optional]
**ssl_sni_hostname** | **String** | Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all. | [optional]
**tcp_keepalive_enable** | **Boolean** | Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. | [optional]
**tcp_keepalive_interval** | **Number** | Interval in seconds between subsequent keepalive probes. | [optional]
**tcp_keepalive_probes** | **Number** | Number of unacknowledged probes to send before considering the connection dead. | [optional]
**tcp_keepalive_time** | **Number** | Interval in seconds between the last data packet sent and the first keepalive probe. | [optional]
**use_ssl** | **Boolean** | Whether or not to require TLS for connections to this backend. | [optional]
**weight** | **Number** | Weight used to load balance this backend against others. May be any positive integer. If `auto_loadbalance` is true, the chance of this backend being selected is equal to its own weight over the sum of all weights for backends that have `auto_loadbalance` set to true. | [optional]

Expand Down
20 changes: 18 additions & 2 deletions docs/BackendApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Method | Fastly API endpoint | Description
## `createBackend`

```javascript
createBackend({ service_id, version_id, [address, ][auto_loadbalance, ][between_bytes_timeout, ][client_cert, ][comment, ][connect_timeout, ][first_byte_timeout, ][healthcheck, ][hostname, ][ipv4, ][ipv6, ][keepalive_time, ][max_conn, ][max_tls_version, ][min_tls_version, ][name, ][override_host, ][port, ][request_condition, ][share_key, ][shield, ][ssl_ca_cert, ][ssl_cert_hostname, ][ssl_check_cert, ][ssl_ciphers, ][ssl_client_cert, ][ssl_client_key, ][ssl_hostname, ][ssl_sni_hostname, ][use_ssl, ][weight] })
createBackend({ service_id, version_id, [address, ][auto_loadbalance, ][between_bytes_timeout, ][client_cert, ][comment, ][connect_timeout, ][first_byte_timeout, ][healthcheck, ][hostname, ][ipv4, ][ipv6, ][keepalive_time, ][max_conn, ][max_tls_version, ][min_tls_version, ][name, ][override_host, ][port, ][request_condition, ][share_key, ][shield, ][ssl_ca_cert, ][ssl_cert_hostname, ][ssl_check_cert, ][ssl_ciphers, ][ssl_client_cert, ][ssl_client_key, ][ssl_hostname, ][ssl_sni_hostname, ][tcp_keepalive_enable, ][tcp_keepalive_interval, ][tcp_keepalive_probes, ][tcp_keepalive_time, ][use_ssl, ][weight] })
```

Create a backend for a particular service and version.
Expand Down Expand Up @@ -57,6 +57,10 @@ const options = {
ssl_client_key: "ssl_client_key_example",
ssl_hostname: "ssl_hostname_example",
ssl_sni_hostname: "ssl_sni_hostname_example",
tcp_keepalive_enable: true,
tcp_keepalive_interval: 56,
tcp_keepalive_probes: 56,
tcp_keepalive_time: 56,
use_ssl: true,
weight: 56,
};
Expand Down Expand Up @@ -105,6 +109,10 @@ Name | Type | Description | Notes
**ssl_client_key** | **String** | Client key attached to origin. | [optional]
**ssl_hostname** | **String** | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | [optional]
**ssl_sni_hostname** | **String** | Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all. | [optional]
**tcp_keepalive_enable** | **Boolean** | Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. | [optional]
**tcp_keepalive_interval** | **Number** | Interval in seconds between subsequent keepalive probes. | [optional]
**tcp_keepalive_probes** | **Number** | Number of unacknowledged probes to send before considering the connection dead. | [optional]
**tcp_keepalive_time** | **Number** | Interval in seconds between the last data packet sent and the first keepalive probe. | [optional]
**use_ssl** | **Boolean** | Whether or not to require TLS for connections to this backend. | [optional]
**weight** | **Number** | Weight used to load balance this backend against others. May be any positive integer. If `auto_loadbalance` is true, the chance of this backend being selected is equal to its own weight over the sum of all weights for backends that have `auto_loadbalance` set to true. | [optional]

Expand Down Expand Up @@ -231,7 +239,7 @@ Name | Type | Description | Notes
## `updateBackend`

```javascript
updateBackend({ service_id, version_id, backend_name, [address, ][auto_loadbalance, ][between_bytes_timeout, ][client_cert, ][comment, ][connect_timeout, ][first_byte_timeout, ][healthcheck, ][hostname, ][ipv4, ][ipv6, ][keepalive_time, ][max_conn, ][max_tls_version, ][min_tls_version, ][name, ][override_host, ][port, ][request_condition, ][share_key, ][shield, ][ssl_ca_cert, ][ssl_cert_hostname, ][ssl_check_cert, ][ssl_ciphers, ][ssl_client_cert, ][ssl_client_key, ][ssl_hostname, ][ssl_sni_hostname, ][use_ssl, ][weight] })
updateBackend({ service_id, version_id, backend_name, [address, ][auto_loadbalance, ][between_bytes_timeout, ][client_cert, ][comment, ][connect_timeout, ][first_byte_timeout, ][healthcheck, ][hostname, ][ipv4, ][ipv6, ][keepalive_time, ][max_conn, ][max_tls_version, ][min_tls_version, ][name, ][override_host, ][port, ][request_condition, ][share_key, ][shield, ][ssl_ca_cert, ][ssl_cert_hostname, ][ssl_check_cert, ][ssl_ciphers, ][ssl_client_cert, ][ssl_client_key, ][ssl_hostname, ][ssl_sni_hostname, ][tcp_keepalive_enable, ][tcp_keepalive_interval, ][tcp_keepalive_probes, ][tcp_keepalive_time, ][use_ssl, ][weight] })
```

Update the backend for a particular service and version.
Expand Down Expand Up @@ -272,6 +280,10 @@ const options = {
ssl_client_key: "ssl_client_key_example",
ssl_hostname: "ssl_hostname_example",
ssl_sni_hostname: "ssl_sni_hostname_example",
tcp_keepalive_enable: true,
tcp_keepalive_interval: 56,
tcp_keepalive_probes: 56,
tcp_keepalive_time: 56,
use_ssl: true,
weight: 56,
};
Expand Down Expand Up @@ -321,6 +333,10 @@ Name | Type | Description | Notes
**ssl_client_key** | **String** | Client key attached to origin. | [optional]
**ssl_hostname** | **String** | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | [optional]
**ssl_sni_hostname** | **String** | Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all. | [optional]
**tcp_keepalive_enable** | **Boolean** | Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. | [optional]
**tcp_keepalive_interval** | **Number** | Interval in seconds between subsequent keepalive probes. | [optional]
**tcp_keepalive_probes** | **Number** | Number of unacknowledged probes to send before considering the connection dead. | [optional]
**tcp_keepalive_time** | **Number** | Interval in seconds between the last data packet sent and the first keepalive probe. | [optional]
**use_ssl** | **Boolean** | Whether or not to require TLS for connections to this backend. | [optional]
**weight** | **Number** | Weight used to load balance this backend against others. May be any positive integer. If `auto_loadbalance` is true, the chance of this backend being selected is equal to its own weight over the sum of all weights for backends that have `auto_loadbalance` set to true. | [optional]

Expand Down
4 changes: 4 additions & 0 deletions docs/BackendResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ Name | Type | Description | Notes
**ssl_client_key** | **String** | Client key attached to origin. | [optional]
**ssl_hostname** | **String** | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | [optional]
**ssl_sni_hostname** | **String** | Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all. | [optional]
**tcp_keepalive_enable** | **Boolean** | Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. | [optional]
**tcp_keepalive_interval** | **Number** | Interval in seconds between subsequent keepalive probes. | [optional]
**tcp_keepalive_probes** | **Number** | Number of unacknowledged probes to send before considering the connection dead. | [optional]
**tcp_keepalive_time** | **Number** | Interval in seconds between the last data packet sent and the first keepalive probe. | [optional]
**use_ssl** | **Boolean** | Whether or not to require TLS for connections to this backend. | [optional]
**weight** | **Number** | Weight used to load balance this backend against others. May be any positive integer. If `auto_loadbalance` is true, the chance of this backend being selected is equal to its own weight over the sum of all weights for backends that have `auto_loadbalance` set to true. | [optional]
**created_at** | **Date** | Date and time in ISO 8601 format. | [optional] [readonly]
Expand Down
2 changes: 1 addition & 1 deletion docs/InvitationsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Create an invitation.

```javascript
const options = {
invitation: {"data":{"type":"invitation","attributes":{"email":"thelma@example.com","limit_services":true,"role":"engineer"},"relationships":{"customer":{"data":[{"id":"44tb1D3asjhhuh2SH8e8YD","type":"customer"}]},"service_invitations":{"data":[{"type":"service_invitation","attributes":{"permission":"purge_all"},"relationships":{"service":{"data":{"type":"service","id":"6yrrdleXQ9QDtum9rMB0nr"}}}}]}}}},
invitation: {"data":{"type":"invitation","attributes":{"email":"thelma@example.com","limit_services":true,"role":"engineer"},"relationships":{"customer":{"data":{"id":"44tb1D3asjhhuh2SH8e8YD","type":"customer"}},"service_invitations":{"data":[{"type":"service_invitation","attributes":{"permission":"purge_all"},"relationships":{"service":{"data":{"type":"service","id":"6yrrdleXQ9QDtum9rMB0nr"}}}}]}}}},
};

apiInstance.createInvitation(options)
Expand Down
23 changes: 22 additions & 1 deletion docs/RealtimeEntryAggregated.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Name | Type | Description | Notes
**errors** | **Number** | Number of cache errors. | [optional]
**hits_time** | **Number** | Total amount of time spent processing cache hits (in seconds). | [optional]
**miss_time** | **Number** | Total amount of time spent processing cache misses (in seconds). | [optional]
**miss_histogram** | **{String: Object}** | A histogram. Each key represents the upper bound of a span of 10 milliseconds and the values represent the number of requests to origin during that 10ms period. Any origin request that takes more than 60 seconds to return will be in the 60000 bucket. | [optional]
**miss_histogram** | **{String: Object}** | A histogram. The value in each bucket is the number of requests to the origin whose responses arrived during the time period represented by the bucket. The key of each bucket represents the upper bound (in response time) of that bucket. The buckets vary in width and cover the time periods 0-10ms (in 1ms increments), 10-250ms (in 10ms increments), 250-1,000ms (in 50ms increments), 1,000-3,000ms (in 100ms increments), 3,000-10,000ms (in 500 ms increments), 10,000-20,000ms (in 1,000ms increments), 20,000-60,000ms (in 5,000ms increments), and 60,000ms through infinity (in a single bucket). | [optional]
**compute_requests** | **Number** | The total number of requests that were received for your service by Fastly. | [optional]
**compute_execution_time_ms** | **Number** | The amount of active CPU time used to process your requests (in milliseconds). | [optional]
**compute_ram_used** | **Number** | The amount of RAM used for your service by Fastly (in bytes). | [optional]
Expand Down Expand Up @@ -231,6 +231,27 @@ Name | Type | Description | Notes
**bot_challenges_succeeded** | **Number** | The number of successful challenge solutions processed. For example, a correct CAPTCHA solution. | [optional]
**bot_challenges_failed** | **Number** | The number of failed challenge solutions processed. For example, an incorrect CAPTCHA solution. | [optional]
**bot_challenge_complete_tokens_issued** | **Number** | The number of challenge-complete tokens issued. For example, issuing a challenge-complete token after a series of CAPTCHA challenges ending in success. | [optional]
**ddos_action_downgrade** | **Number** | The number of times the downgrade action was taken. The downgrade action restricts the client to http1. | [optional]
**ddos_action_downgraded_connections** | **Number** | The number of connections the downgrade action was applied to. The downgrade action restricts the connection to http1. | [optional]
**vcl_on_compute_hit_requests** | **Number** | Number of cache hits for a VCL service running on Compute. | [optional]
**vcl_on_compute_miss_requests** | **Number** | Number of cache misses for a VCL service running on Compute. | [optional]
**vcl_on_compute_pass_requests** | **Number** | Number of requests that passed through the CDN without being cached for a VCL service running on Compute. | [optional]
**vcl_on_compute_error_requests** | **Number** | Number of cache errors for a VCL service running on Compute. | [optional]
**vcl_on_compute_synth_requests** | **Number** | Number of requests that returned a synthetic response (i.e., response objects created with the `synthetic` VCL statement) for a VCL service running on Compute. | [optional]
**vcl_on_compute_edge_hit_requests** | **Number** | Number of requests sent by end users to Fastly that resulted in a hit at the edge for a VCL service running on Compute. | [optional]
**vcl_on_compute_edge_miss_requests** | **Number** | Number of requests sent by end users to Fastly that resulted in a miss at the edge for a VCL service running on Compute. | [optional]
**all_hit_requests** | **Number** | Number of cache hits for a VCL service. | [optional]
**all_miss_requests** | **Number** | Number of cache misses for a VCL service. | [optional]
**all_pass_requests** | **Number** | Number of requests that passed through the CDN without being cached for a VCL service. | [optional]
**all_error_requests** | **Number** | Number of cache errors for a VCL service. | [optional]
**all_synth_requests** | **Number** | Number of requests that returned a synthetic response (i.e., response objects created with the `synthetic` VCL statement) for a VCL service. | [optional]
**all_edge_hit_requests** | **Number** | Number of requests sent by end users to Fastly that resulted in a hit at the edge for a VCL service. | [optional]
**all_edge_miss_requests** | **Number** | Number of requests sent by end users to Fastly that resulted in a miss at the edge for a VCL service. | [optional]
**all_status_1xx** | **Number** | Number of \"Informational\" category status codes delivered for all sources. | [optional]
**all_status_2xx** | **Number** | Number of \"Success\" status codes delivered for all sources. | [optional]
**all_status_3xx** | **Number** | Number of \"Redirection\" codes delivered for all sources. | [optional]
**all_status_4xx** | **Number** | Number of \"Client Error\" codes delivered for all sources. | [optional]
**all_status_5xx** | **Number** | Number of \"Server Error\" codes delivered for all sources. | [optional]


[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
Loading

0 comments on commit f969fe5

Please sign in to comment.