Skip to content

Latest commit

 

History

History
464 lines (306 loc) · 18 KB

CHANGELOG.md

File metadata and controls

464 lines (306 loc) · 18 KB

Changelog

v8.0.0 (2024-12-05)

Breaking Changes:

  • fix(udm-domains): Use v1 versioned HTTP endpoints for UDM domains
  • fix(historical): Remove references to VCL on Compute metrics
  • fix(realtime): Remove references to VCL on Compute metrics
  • feat(billing-usage-metrics): Updated to v3 of the API

Bug fixes:

  • fix(acls-in-compute): Corrected shape of compute-acl-update model.

Enhancements:

  • feat(object-storage-access-keys): Added Object Storage Access Keys API
  • feat(logging-grafanacloudlogs): Added Grafana Cloud Logs Loggin API
  • feat(log-explorer): Added Log Explorer API
  • feat(insights): Added Insights API
  • feat(kv-store-item): Added consistency parameter to get-keys operation.
  • feat(enabled-products): Added mode property to set-configuration.

Documentation:

  • doc(observability-custom-dashboards): Fix bad link in custom dashboard documentation
  • doc(observability-custom-dashboards): Reformat some enums to fix docs rendering
  • doc(acls-in-compute): Corrections to descriptions of compute-acl-lookup, compute-acl-list-entries, compute-acl-update-entry, and compute-acl-update structures
  • doc(enabled-products): Added support for product ID log_explorer_insights.
  • doc(enabled-products): Added support for product ID ddos_protection.

v7.10.0 (2024-10-23)

Documentation:

  • doc(javascript): Add example and note to README to help with initialization.
  • doc(backend): Correct spelling in connect_timeout and first_byte_timeout field descriptions.

v7.9.0 (2024-09-13)

Bug fixes:

  • bugfix(rust): Implement std::fmt::Display instead of std::string::ToString for enum models.
  • 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

Enhancements:

  • 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.
  • feat(realtime, historical): Added request_denied_get_head_body metric.
  • 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.

v7.8.0 (2024-08-21)

Bug fixes:

  • fix(billing): make rate-per-unit nullable

v7.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

v7.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

v7.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

v7.4.0 (2024-06-27)

Bug fixes:

  • bugfix(alerts-definitions): For Origin derived metrics, correct all_bandwidth type to integer

Enhancements:

  • 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
  • feat(alerts-definitions): For Domain derived metrics, add status_4xx_excl_404_rate and status_404_rate properties
  • feat(alerts-definitions): For Stats derived metrics, add status_4xx_excl_404_rate, status_404_rate, all_status_5xx_rate, all_status_4xx_rate, all_status_gte_400_rate, and all_status_lt_500_rate properties
  • feat(billing-invoices): For invoice line items, added ProductLine property

Documentation:

  • 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

v7.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.

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 (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.

v7.0.1 (2024-02-19)

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

v7.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.

v6.2.2 (2023-11-07)

Enhancements:

  • feat(config_store): add name query param to list endpoint.

v6.2.1 (2023-10-27)

Documentation:

  • docs: rename Compute@Edge to Compute.

v6.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.

v6.1.1 (2023-09-01)

Enhancements:

  • feat(events): support extra created_at filters.

v6.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.

v6.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.

v5.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.

v5.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.

v5.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.

v4.4.0 (2023-07-05)

Enhancements:

  • feat(vcl): support all vcl endpoints.

Bug fixes:

  • fix(snippet): dynamic field switched from int to string.

v4.3.0 (2023-06-27)

Enhancements:

  • feat(rate_limiter): implement POST/PUT endpoints.

Bug fixes:

  • fix(automation_tokens): generate explicit error response type.
  • fix(historical_stats): extract primitive into custom type.

v4.2.2 (2023-06-23)

Bug fixes:

  • fix(historical_stats): generate missing models.

v4.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.

v4.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.

v4.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.

v4.1.0 (2023-05-17)

Enhancements:

  • feat(config_store): add Config Store endpoints.

v4.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.

v3.3.1 (2023-04-26)

Bug fixes:

  • fix(object-store-item): use correct type for key value.
  • fix(tls-csrs): remove internal endpoint.

v3.3.0 (2023-04-05)

Bug fixes:

  • fix(purge): avoid encodeURIComponent with x-allow-reserved

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

v3.2.0 (2023-03-21)

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

v3.0.0 (2022-12-15)

Breaking: