diff --git a/CHANGELOG.md b/CHANGELOG.md index 0f3ae8c..6ff1519 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,16 +1,29 @@ # Changelog -## [v5.9.0](https://github.com/fastly/fastly-py/releases/tag/release/v5.9.0) (2024-09-13) +## [v5.10.0](https://github.com/fastly/fastly-py/releases/tag/release/v5.10.0) (2024-10-23) **Bug fixes:** - bugfix(rust): Implement std::fmt::Display instead of std::string::ToString for enum models. +- bugfix(py): Add dependencies to pyproject.toml. - fix(contact): Corrected endpoint called by `delete-contact` operation - fix(origin-inspector, domain-inspector): Use integer type for Timestamp. - fix(billing): Make all fields on billing list item data nullable +- fix(billing): make rate-per-unit nullable +- fix(billing): Adjust type of regional data to help the generator +- fix(billing): Correct type of invoice_id field +- fix(logging): For several endpoints, correct use_tls to be string +- fix(backend): Correct tcp_keepalive_enable to be nullable +- 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 +- bugfix(resource): Correct `type_resource` accepted values +- bugfix(sudo): Mark API to require authentication token +- bugfix(alerts-definitions): For Origin derived metrics, correct `all_bandwidth` type to `integer` **Enhancements:** +- feat(generator): The API Client Generator now uses a new automatic changelog generation process. - feat(acls-in-compute): Add ACLs in Compute API - feat(enabled-products): Updated to use `v1` versioned endpoints. - feat(enabled-products): Added `get-product-configuration`, `set-product-configuration` operations. @@ -18,55 +31,25 @@ - feat(tls): Add definitions for values of sort parameter - feat(staging): Add activate/deactivate endpoints for staging - feat(customer-addresses): Add Customer Addresses API - -**Documentation:** - -- doc(enabled-products): Added support for product IDs `bot_management` and `ngwaf`. - -## [v5.8.0](https://github.com/fastly/fastly-py/releases/tag/release/v5.8.0) (2024-08-21) - -**Bug fixes:** - -- bugfix(py): Add dependencies to pyproject.toml. -- fix(billing): make rate-per-unit nullable - -## [v5.7.0](https://github.com/fastly/fastly-py/releases/tag/release/v5.7.0) (2024-08-08) - -**Bug fixes:** - -- fix(billing): Adjust type of regional data to help the generator -- fix(billing): Correct type of invoice_id field - -## [v5.6.0](https://github.com/fastly/fastly-py/releases/tag/release/v5.6.0) (2024-08-04) - -**Enhancements:** - - feat(observability): Adds new Observability Custom Dashboards API - feat(billing-invoices): Adds month-to-date invoice information - feat(billing-usage-metrics): Adds information on service-level usage. - feat(tls): Adds an endpoint to get a TLS certificate blob (Limited Availability) - feat(stats): Add `origin_offload` metric - -## [v5.5.0](https://github.com/fastly/fastly-py/releases/tag/release/v5.5.0) (2024-07-01) - -**Bug fixes:** - -- fix(logging): For several endpoints, correct use_tls to be string - -**Enhancements:** - - feat(content): `/content/edge_check` endpoint now returns informational values in `hash` when a timeout occurs or when an object is too large. - feat(logging-datalog): Added additional regions - -## [v5.4.0](https://github.com/fastly/fastly-py/releases/tag/release/v5.4.0) (2024-06-27) - -**Bug fixes:** - -- bugfix(alerts-definitions): For Origin derived metrics, correct `all_bandwidth` type to `integer` - -**Enhancements:** - +- 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. +- feat(image-optimizer-default-settings): Add Image Optimizer Default Settings APIs +- feat(tls-subscriptions): Add `certificate_authority` filter parameter - feat(logging-s3): Add `file_max_bytes` configuration field - feat(alerts-definitions): Add `integration_id` parameter to the List Alert Definitions endpoint - feat(alerts-definitions): For Origin derived metrics, add `all_status_4xx_excl_404_rate` and `all_status_404_rate` properties @@ -77,415 +60,15 @@ **Documentation:** +- docs(generator): Update links in docs and comments with unified docs site URL structure +- docs(generator): Clean up README by using GitHub alert icons and collapsible sections +- doc(backend): Correct spelling in `connect_timeout` and `first_byte_timeout` field descriptions. +- doc(enabled-products): Added support for product IDs `bot_management` and `ngwaf`. +- doc(realtime): Correct description of miss_histogram structure in real-time stats. +- doc(logging-kinesis): Update description of `format` field. +- doc(tls-subscriptions): Update descriptions of `certificate_authority` and `tls_subscription_include` fields. - doc(billing-invoices): "Billing Invoices API" relabeled to "Invoices API" - doc(billing-invoices): Updated documentation of `billing_start_date` and `billing_end_date` query parameters of List of invoices endpoint - doc(alerts-definitions): Updated documentation of several fields - doc(notification-service): Updated documentation examples for several fields - -## [v5.3.0](https://github.com/fastly/fastly-py/releases/tag/release/v5.3.0) (2024-05-24) - -**Bug fixes:** - -- fix(backend): Correct tcp_keepalive_enable to be nullable -- bugfix(resource): Correct `type_resource` accepted values -- bugfix(sudo): Mark API to require authentication token - -**Enhancements:** - -- feat(image-optimizer-default-settings): Add Image Optimizer Default Settings APIs -- feat(tls-subscriptions): Add `certificate_authority` filter parameter - -**Documentation:** - -- docs(generator): Update links in docs and comments with unified docs site URL structure -- docs(generator): Clean up README by using GitHub alert icons and collapsible sections -- doc(logging-kinesis): Update description of `format` field. -- doc(tls-subscriptions): Update descriptions of `certificate_authority` and `tls_subscription_include` fields. - -## [v5.2.0](https://github.com/fastly/fastly-py/releases/tag/release/v5.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. - -## [v5.1.0](https://github.com/fastly/fastly-py/releases/tag/release/v5.1.0) (2024-02-28) - -**Enhancements:** - -- feat(billing): add 'get invoice by invoice ID' endpoint. -- feat(billing): add 'list invoices' endpoint. -- feat(image_opto): add 'shield' and 'transform' methods and fields. -- feat(secret_store): add 'name' filter. -- feat(tls): add 'create CSR' endpoint. -- feat(tls_subscription): add 'active order' methods and fields. - -**Documentation:** - -- doc(backend) fix openssl link. -- doc(director,domain_inspector,pool,realtime) fix POPs link. -- doc(service) fix service version link. -- doc(tls) fix activation link. - -## [v5.0.1](https://github.com/fastly/fastly-py/releases/tag/release/v5.0.1) (2024-02-16) - -**Bug fixes:** - -- fix(response_object): strongly type response_object create_update requests -- fix(tls_configurations): fix `tls_protocols` field to be a string array type -- fix(generator): fix `str, none_type` in generated code - -## [v5.0.0](https://github.com/fastly/fastly-py/releases/tag/release/v5.0.0) (2023-11-29) - -**Breaking:** - -- breaking(historical): restructure OpenAPI schema to avoid duplicated data rendering. - -**Bug fixes:** - -- fix: no longer display Markdown syntax in code comments. - -**Enhancements:** - -- feat(stats): expose new `service_id` and `start_time` fields. - -## [v4.2.2](https://github.com/fastly/fastly-py/releases/tag/release/v4.2.2) (2023-11-07) - -**Enhancements:** - -- feat(config_store): add `name` query param to list endpoint. - -## [v4.2.1](https://github.com/fastly/fastly-py/releases/tag/release/v4.2.1) (2023-10-27) - -**Documentation:** - -- docs: rename Compute@Edge to Compute. - -## [v4.2.0](https://github.com/fastly/fastly-py/releases/tag/release/v4.2.0) (2023-10-24) - -**Enhancements:** - -- feat(stats): add historical DDoS metrics. -- feat(stats): add bot challenges. - -**Bug fixes:** - -- fix(snippets): ensure POST response's dynamic field is numerical. - -## [v4.1.1](https://github.com/fastly/fastly-py/releases/tag/release/v4.1.1) (2023-09-01) - -**Enhancements:** - -- feat(events): support extra created_at filters. - -## [v4.1.0](https://github.com/fastly/fastly-py/releases/tag/release/v4.1.0) (2023-09-01) - -**Enhancements:** - -- feat(backend): support share_key field. -- feat(events): support extra created_at filters. -- feat(logging/newrelic): add OTLP endpoints. -- feat(tls/subscriptions): support self_managed_http_challenge field. - -**Documentation:** - -- doc(secretstore): correct description for GET endpoint. - -## [v4.0.0](https://github.com/fastly/fastly-py/releases/tag/release/v4.0.0) (2023-07-31) - -**Breaking:** - -The following restructures have helped resolve some issues with our OpenAPI schemas but as a side-effect this has resulted in a break to our API client interface as different types are now being generated. - -- refactor: general restructure OpenAPI schemas. -- refactor(domain): remove explicit schema type for 'any'. - -**Bug fixes:** - -- fix: change response `version` type to string. -- fix(cache_settings): change response `stale_ttl` and `ttl` types to strings. -- fix(header): change response `ignore_if_set` and `priority` types to strings. -- fix(logging): change response `period` and `gzip_level` types to strings. -- fix(pool): change response `use_tls`, `max_conn_default`, `first_byte_timeout`, `quorum` and `tls_check_cert` types to strings. -- fix(request_settings): change response `bypass_busy_wait`, `force_miss`, `force_ssl`, `geo_headers`, `max_stale_age` and `timer_support` types to strings. -- fix(response_object): change response `status` type to string. - -## [v3.0.2](https://github.com/fastly/fastly-py/releases/tag/release/v3.0.2) (2023-07-13) - -**Bug fixes:** - -- fix(logging_gcs): set expected default value for 'path'. -- fix(origin_inspector_historical): use correct type for 'values'. -- fix(tls_subscriptions): fix argument order for deleting globalsign email challenge. - -## [v3.0.1](https://github.com/fastly/fastly-py/releases/tag/release/v3.0.1) (2023-07-12) - -**Bug fixes:** - -- fix(billing): rename response field 'lines' to 'line_items'. -- fix(billing): restructure response models like 'aria_invoice_id'. -- fix(billing): make 'sent_at', 'locked', 'require_new_password', 'two_factor_auth_enabled' nullable. - -## [v3.0.0](https://github.com/fastly/fastly-py/releases/tag/release/v3.0.0) (2023-07-06) - -Substantial changes were made to the underlying OpenAPI specification that produces this API client. These changes have resulted in multiple new endpoints being supported as well as multiple breaking type changes and so we're publishing these changes as a new major release. - -**Enhancements:** - -- feat(apex_redirect): support all endpoints. -- feat(contact): support 'create' endpoint. -- feat(director): support 'update' endpoint. -- feat(domain_inspector): support all endpoints. -- feat(iam_roles): support 'add permissions' endpoint. -- feat(iam_roles): support 'create role' endpoint. -- feat(iam_roles): support 'delete permissions' endpoint. -- feat(iam_roles): support 'update role' endpoint. -- feat(iam_services): support 'add services' endpoint. -- feat(iam_services): support 'create service group' endpoint. -- feat(iam_services): support 'remove services' endpoint. -- feat(iam_services): support 'update service group' endpoint. -- feat(iam_users): support 'add members' endpoint. -- feat(iam_users): support 'add roles' endpoint. -- feat(iam_users): support 'add service groups' endpoint. -- feat(iam_users): support 'create user group' endpoint. -- feat(iam_users): support 'remove members' endpoint. -- feat(iam_users): support 'remove roles' endpoint. -- feat(iam_users): support 'remove service groups' endpoint. -- feat(iam_users): support 'update user group' endpoint. -- feat(legacy_waf): support all endpoints. -- feat(logging_kafka): support 'update' endpoint. -- feat(logging_kinesis): support 'update' endpoint. -- feat(origin_inspector): support all endpoints. -- feat(request_settings): support 'create' endpoint. -- feat(response_object): support 'create' endpoint. -- feat(response_object): support 'update' endpoint. -- feat(secret_store): support all endpoints. -- feat(service_authorizations): support 'delete' endpoint. -- feat(service_authorizations): support 'update' endpoint. -- feat(snippet): support 'update versioned snippet' endpoint. -- feat(sudo): support 'request sudo access' endpoint. -- feat(tokens): support 'revoke multiple tokens' endpoint. -- feat(tokens): support 'create token' endpoint. -- feat(waf_active_rules): support 'delete' endpoint. - -**Bug fixes:** - -- fix(content): update request/response types. -- fix(events): update metadata type. -- fix(realtime_entry): update recorded/aggregated type. -- fix(realtime_measurements): update miss_histogram type. - -## [v2.4.0](https://github.com/fastly/fastly-py/releases/tag/release/v2.4.0) (2023-07-05) - -**Enhancements:** - -- feat(purge): support purge of multiple surrogate keys. -- feat(vcl): support vcl content endpoints. - -**Bug fixes:** - -- fix(snippet): dynamic field switched from int to string. -- fix(vcl): implement correct response models. - -**Documentation:** - -- docs: remove deprecated docs endpoints from README 'issues' list. - -## [v2.3.0](https://github.com/fastly/fastly-py/releases/tag/release/v2.3.0) (2023-06-27) - -**Enhancements:** - -- feat(rate_limiter): implement POST/PUT endpoints. - -**Bug fixes:** - -- fix(historical_stats): extract primitive into custom type. - -## [v2.2.2](https://github.com/fastly/fastly-py/releases/tag/release/v2.2.2) (2023-06-23) - -**Bug fixes:** - -- fix(historical_stats): generate missing models. -- fix(historical_stats): apply upstream fix to partial models. - -## [v2.2.1](https://github.com/fastly/fastly-py/releases/tag/release/v2.2.1) (2023-06-21) - -**Bug fixes:** - -- fix(tls_activation): add tls_configuration and tls_domains. -- fix(tls_subscription): add tls_configuration and common name. - -## [v2.2.0](https://github.com/fastly/fastly-py/releases/tag/release/v2.2.0) (2023-06-20) - -**Enhancements:** - -- feat(realtime_measurements): add billable request processing time. -- feat(tokens): add support for the 'get token' endpoint. - -**Bug fixes:** - -- fix(config): add realtime hostname. -- fix(historical_stats): generate field results model. -- fix(kv_store): remove the 'force' property from the 'delete store' endpoint. -- feat(realtime_measurements): rename object store to kv store. - -## [v2.1.1](https://github.com/fastly/fastly-py/releases/tag/release/v2.1.1) (2023-05-22) - -**Bug fixes:** - -- fix(acl): change `version` from int to string. -- fix(acl): add missing methods for `service_id` and `service_version` properties. -- fix(backend): make `ssl_check_cert` nullable. -- fix(purge): skip URL escape for `surrogate_key` param. -- fix(snippets): change `priority` and `version` from int to string. -- fix(snippets): add missing methods for `service_id` and `service_version` properties. - -## [v2.1.0](https://github.com/fastly/fastly-py/releases/tag/release/v2.1.0) (2023-05-17) - -**Enhancements:** - -- feat(config_store): add Config Store endpoints. - -## [v2.0.0](https://github.com/fastly/fastly-py/releases/tag/release/v2.0.0) (2023-05-16) - -**Breaking changes:** - -- breaking(object_store): rename to kv_store - -**Enhancements:** - -- feat(dictionary_item): add 'bulk' PATCH endpoint. -- feat(package): add `files_hash` metadata property. -- feat(tls_certificates): add `filter[in_use]` parameter. - -## [v1.3.1](https://github.com/fastly/fastly-py/releases/tag/release/v1.3.1) (2023-04-26) - -**Bug fixes:** - -- fix(object-store-item): use correct type for key value -- fix(tls-csrs): remove internal endpoint - -## [v1.3.0](https://github.com/fastly/fastly-py/releases/tag/release/v1.3.0) (2023-04-03) - -**Bug fixes:** - -- fix(purge): avoid escaping URL parameter - -**Enhancements:** - -- feat(domain-ownership): list API endpoint -- feat(object-store): items API endpoints -- feat(object-store): add 'location' property to 'create_store' -- feat(object-store): add 'force' property to 'delete_store' -- feat(realtime): additional DDoS properties - -**Documentation:** - -- docs(acl-entries): document batch updating -- docs(resource): terminology + 'config_store' support. - -## [v1.2.0](https://github.com/fastly/fastly-py/releases/tag/release/v1.2.0) (2023-03-20) - -[Full Changelog](https://github.com/fastly/fastly-py/compare/v1.1.0...v1.2.0) - -**Bug fixes:** - -- fix(purge): switch authentication type to 'token' - -**Enhancements:** - -- feat(events): implement 'filter_created_at' property -- feat(mutual-authentication): implement 'include' property -- feat(object-store): implement new Object Store API endpoints -- feat(settings): implement Service Settings 'update' endpoint - -**Documentation:** - -- docs(backend): keepalive_time -- docs(pop): region, shield, latitude, longitude -- docs(product-enablement): brotli_compression -- docs(resource): terminology -- docs(results): fanout properties -- docs(tls/subscriptions): new 'failed' state -- docs(user): 'login' modification note removed - -## [v1.0.0](https://github.com/fastly/fastly-py/releases/tag/v1.0.0) (2022-12-15) - -[Full Changelog](https://github.com/fastly/fastly-py/compare/v0.5.1...v1.0.0) - -**Enhancements:** - -- New interface from code-generated API client [#82](https://github.com/fastly/fastly-py/pull/82) - - [Blog post: Better Fastly API clients with OpenAPI Generator](https://dev.to/fastly/better-fastly-api-clients-with-openapi-generator-3lno) - - [Documentation](https://github.com/fastly/fastly-py#documentation-for-api-endpoints) - - [Unsupported API endpoints](https://github.com/fastly/fastly-py#issues) - -## \[0.5.1\] - March 26, 2021 - -### Fixed - -- Boolean values in attributes now properly lower-cased during save - -## \[0.5.0\] - September 30, 2020 - -### Breaking - -- Removed support for password authentication because the API no longer supports it. -- Fixed how the `FASTLY_SECURE` environment variable is processed so as to convert it to a boolean - -## \[0.4.0\] - January 6, 2020 - -### Added - -- new command-line interface: `fastly` using argparse, thanks to the work of @dcmoore-gd - -## \[0.3.1\] - January 6, 2020: - -### Fixed - -- Fixed [unused imports](https://github.com/fastly/fastly-py/pull/47) -- Fixed [compatibility with python \< 3.6](https://github.com/fastly/fastly-py/pull/46) - -## \[0.3.0\] - July 10, 2019: - -### Added - -- This `CHANGELOG.md` file -- `create` and `delete` methods to Model base -- Convenience methods to Service for fetching details and active version number - -### Fixed - -- Updated Service.version and Version.vcl to use new Model.create -- Compare `attrs` and `_original_attrs` before saving. (Without this check, calling .save() on an instance without changed attributes makes a PUT call with no data. Then instance.attrs is set to the error response for an incomplete API call, e.g. {"msg": "Missing parameter", "detail": "param is missing or the value is empty: item_value"}) - Added missing VCL import to fastly.py - -## \[0.2.3\] - August 2019 - -## Added - -- Custom errors -- Backwards compatibility with Python 3.4 - -## Fixed - -- Updates API models diff --git a/docs/Backend.md b/docs/Backend.md index 2fb09a8..8027a38 100644 --- a/docs/Backend.md +++ b/docs/Backend.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes **between_bytes_timeout** | **int** | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`. | [optional] **client_cert** | **str, none_type** | Unused. | [optional] **comment** | **str, none_type** | A freeform descriptive note. | [optional] -**connect_timeout** | **int** | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. | [optional] -**first_byte_timeout** | **int** | Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. | [optional] +**connect_timeout** | **int** | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. | [optional] +**first_byte_timeout** | **int** | Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. | [optional] **healthcheck** | **str, none_type** | The name of the healthcheck to use with this backend. | [optional] **hostname** | **str, none_type** | The hostname of the backend. May be used as an alternative to `address` to set the backend location. | [optional] **ipv4** | **str, none_type** | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] diff --git a/docs/BackendApi.md b/docs/BackendApi.md index 3d8188f..0c1e607 100644 --- a/docs/BackendApi.md +++ b/docs/BackendApi.md @@ -57,8 +57,8 @@ with fastly.ApiClient(configuration) as api_client: between_bytes_timeout = 1 # int | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`. (optional) client_cert = "client_cert_example" # str, none_type | Unused. (optional) comment = "" # str, none_type | A freeform descriptive note. (optional) - connect_timeout = 1 # int | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. (optional) - first_byte_timeout = 1 # int | Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. (optional) + connect_timeout = 1 # int | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. (optional) + first_byte_timeout = 1 # int | Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. (optional) healthcheck = "healthcheck_example" # str, none_type | The name of the healthcheck to use with this backend. (optional) hostname = "hostname_example" # str, none_type | The hostname of the backend. May be used as an alternative to `address` to set the backend location. (optional) ipv4 = "ipv4_example" # str, none_type | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. (optional) @@ -118,8 +118,8 @@ Name | Type | Description | Notes **between_bytes_timeout** | **int**| Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`. | [optional] **client_cert** | **str, none_type**| Unused. | [optional] **comment** | **str, none_type**| A freeform descriptive note. | [optional] - **connect_timeout** | **int**| Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. | [optional] - **first_byte_timeout** | **int**| Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. | [optional] + **connect_timeout** | **int**| Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. | [optional] + **first_byte_timeout** | **int**| Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. | [optional] **healthcheck** | **str, none_type**| The name of the healthcheck to use with this backend. | [optional] **hostname** | **str, none_type**| The hostname of the backend. May be used as an alternative to `address` to set the backend location. | [optional] **ipv4** | **str, none_type**| IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] @@ -461,8 +461,8 @@ with fastly.ApiClient(configuration) as api_client: between_bytes_timeout = 1 # int | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`. (optional) client_cert = "client_cert_example" # str, none_type | Unused. (optional) comment = "" # str, none_type | A freeform descriptive note. (optional) - connect_timeout = 1 # int | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. (optional) - first_byte_timeout = 1 # int | Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. (optional) + connect_timeout = 1 # int | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. (optional) + first_byte_timeout = 1 # int | Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. (optional) healthcheck = "healthcheck_example" # str, none_type | The name of the healthcheck to use with this backend. (optional) hostname = "hostname_example" # str, none_type | The hostname of the backend. May be used as an alternative to `address` to set the backend location. (optional) ipv4 = "ipv4_example" # str, none_type | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. (optional) @@ -523,8 +523,8 @@ Name | Type | Description | Notes **between_bytes_timeout** | **int**| Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`. | [optional] **client_cert** | **str, none_type**| Unused. | [optional] **comment** | **str, none_type**| A freeform descriptive note. | [optional] - **connect_timeout** | **int**| Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. | [optional] - **first_byte_timeout** | **int**| Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. | [optional] + **connect_timeout** | **int**| Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. | [optional] + **first_byte_timeout** | **int**| Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. | [optional] **healthcheck** | **str, none_type**| The name of the healthcheck to use with this backend. | [optional] **hostname** | **str, none_type**| The hostname of the backend. May be used as an alternative to `address` to set the backend location. | [optional] **ipv4** | **str, none_type**| IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] diff --git a/docs/BackendResponse.md b/docs/BackendResponse.md index 261c057..b8c9858 100644 --- a/docs/BackendResponse.md +++ b/docs/BackendResponse.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes **between_bytes_timeout** | **int** | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`. | [optional] **client_cert** | **str, none_type** | Unused. | [optional] **comment** | **str, none_type** | A freeform descriptive note. | [optional] -**connect_timeout** | **int** | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. | [optional] -**first_byte_timeout** | **int** | Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. | [optional] +**connect_timeout** | **int** | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. | [optional] +**first_byte_timeout** | **int** | Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. | [optional] **healthcheck** | **str, none_type** | The name of the healthcheck to use with this backend. | [optional] **hostname** | **str, none_type** | The hostname of the backend. May be used as an alternative to `address` to set the backend location. | [optional] **ipv4** | **str, none_type** | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] diff --git a/fastly/__init__.py b/fastly/__init__.py index a309cef..a2ecc24 100644 --- a/fastly/__init__.py +++ b/fastly/__init__.py @@ -10,7 +10,7 @@ """ -__version__ = "5.9.0" +__version__ = "5.10.0" # import ApiClient from fastly.api_client import ApiClient diff --git a/fastly/api/backend_api.py b/fastly/api/backend_api.py index 3761114..4df2088 100644 --- a/fastly/api/backend_api.py +++ b/fastly/api/backend_api.py @@ -814,8 +814,8 @@ def create_backend( between_bytes_timeout (int): Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`.. [optional] client_cert (str, none_type): Unused.. [optional] comment (str, none_type): A freeform descriptive note.. [optional] - connect_timeout (int): Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.. [optional] - first_byte_timeout (int): Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`.. [optional] + connect_timeout (int): Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.. [optional] + first_byte_timeout (int): Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`.. [optional] healthcheck (str, none_type): The name of the healthcheck to use with this backend.. [optional] hostname (str, none_type): The hostname of the backend. May be used as an alternative to `address` to set the backend location.. [optional] ipv4 (str, none_type): IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.. [optional] @@ -1187,8 +1187,8 @@ def update_backend( between_bytes_timeout (int): Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`.. [optional] client_cert (str, none_type): Unused.. [optional] comment (str, none_type): A freeform descriptive note.. [optional] - connect_timeout (int): Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.. [optional] - first_byte_timeout (int): Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`.. [optional] + connect_timeout (int): Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.. [optional] + first_byte_timeout (int): Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`.. [optional] healthcheck (str, none_type): The name of the healthcheck to use with this backend.. [optional] hostname (str, none_type): The hostname of the backend. May be used as an alternative to `address` to set the backend location.. [optional] ipv4 (str, none_type): IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.. [optional] diff --git a/fastly/api_client.py b/fastly/api_client.py index 4cafe07..a73e004 100644 --- a/fastly/api_client.py +++ b/fastly/api_client.py @@ -79,7 +79,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'fastly-py/5.9.0' + self.user_agent = 'fastly-py/5.10.0' # The last observed value of http header Fastly-RateLimit-Remaining self.rate_limit_remaining = DEFAULT_RATELIMIT diff --git a/fastly/configuration.py b/fastly/configuration.py index 8a14a59..5e407b9 100644 --- a/fastly/configuration.py +++ b/fastly/configuration.py @@ -446,7 +446,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: 1.0.0\n"\ - "SDK Package Version: 5.9.0".\ + "SDK Package Version: 5.10.0".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/fastly/model/backend.py b/fastly/model/backend.py index 2026f35..14a36f5 100644 --- a/fastly/model/backend.py +++ b/fastly/model/backend.py @@ -210,8 +210,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 between_bytes_timeout (int): Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`.. [optional] # noqa: E501 client_cert (str, none_type): Unused.. [optional] # noqa: E501 comment (str, none_type): A freeform descriptive note.. [optional] # noqa: E501 - connect_timeout (int): Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.. [optional] # noqa: E501 - first_byte_timeout (int): Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`.. [optional] # noqa: E501 + connect_timeout (int): Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.. [optional] # noqa: E501 + first_byte_timeout (int): Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`.. [optional] # noqa: E501 healthcheck (str, none_type): The name of the healthcheck to use with this backend.. [optional] # noqa: E501 hostname (str, none_type): The hostname of the backend. May be used as an alternative to `address` to set the backend location.. [optional] # noqa: E501 ipv4 (str, none_type): IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.. [optional] # noqa: E501 @@ -326,8 +326,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 between_bytes_timeout (int): Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`.. [optional] # noqa: E501 client_cert (str, none_type): Unused.. [optional] # noqa: E501 comment (str, none_type): A freeform descriptive note.. [optional] # noqa: E501 - connect_timeout (int): Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.. [optional] # noqa: E501 - first_byte_timeout (int): Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`.. [optional] # noqa: E501 + connect_timeout (int): Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.. [optional] # noqa: E501 + first_byte_timeout (int): Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`.. [optional] # noqa: E501 healthcheck (str, none_type): The name of the healthcheck to use with this backend.. [optional] # noqa: E501 hostname (str, none_type): The hostname of the backend. May be used as an alternative to `address` to set the backend location.. [optional] # noqa: E501 ipv4 (str, none_type): IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.. [optional] # noqa: E501 diff --git a/fastly/model/backend_response.py b/fastly/model/backend_response.py index 4b1d459..53be9ce 100644 --- a/fastly/model/backend_response.py +++ b/fastly/model/backend_response.py @@ -238,8 +238,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 between_bytes_timeout (int): Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`.. [optional] # noqa: E501 client_cert (str, none_type): Unused.. [optional] # noqa: E501 comment (str, none_type): A freeform descriptive note.. [optional] # noqa: E501 - connect_timeout (int): Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.. [optional] # noqa: E501 - first_byte_timeout (int): Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`.. [optional] # noqa: E501 + connect_timeout (int): Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.. [optional] # noqa: E501 + first_byte_timeout (int): Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`.. [optional] # noqa: E501 healthcheck (str, none_type): The name of the healthcheck to use with this backend.. [optional] # noqa: E501 hostname (str, none_type): The hostname of the backend. May be used as an alternative to `address` to set the backend location.. [optional] # noqa: E501 ipv4 (str, none_type): IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.. [optional] # noqa: E501 @@ -378,8 +378,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 between_bytes_timeout (int): Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`.. [optional] # noqa: E501 client_cert (str, none_type): Unused.. [optional] # noqa: E501 comment (str, none_type): A freeform descriptive note.. [optional] # noqa: E501 - connect_timeout (int): Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.. [optional] # noqa: E501 - first_byte_timeout (int): Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`.. [optional] # noqa: E501 + connect_timeout (int): Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.. [optional] # noqa: E501 + first_byte_timeout (int): Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`.. [optional] # noqa: E501 healthcheck (str, none_type): The name of the healthcheck to use with this backend.. [optional] # noqa: E501 hostname (str, none_type): The hostname of the backend. May be used as an alternative to `address` to set the backend location.. [optional] # noqa: E501 ipv4 (str, none_type): IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.. [optional] # noqa: E501 diff --git a/setup.py b/setup.py index d9d2bd8..1403d70 100644 --- a/setup.py +++ b/setup.py @@ -12,7 +12,7 @@ from pathlib import Path NAME = "fastly" -VERSION = "5.9.0" +VERSION = "5.10.0" # To install the library, run the following # # python setup.py install diff --git a/sig.json b/sig.json index d9facb9..12052e1 100644 --- a/sig.json +++ b/sig.json @@ -1 +1 @@ -{"G": "1827dbb1", "D": "1f27800e"} +{"G": "dbe8e713", "D": "4061d4ec"}