CHANGELOG.md

Changelog

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

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

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

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

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

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

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

v7.2.2 (2023-11-07)

Enhancements:

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

v7.2.1 (2023-10-27)

Documentation:

• docs: rename Compute@Edge to Compute.

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

v7.1.1 (2023-09-01)

Enhancements:

• feat(events): support extra created_at filters.

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

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

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

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

v6.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(acl_entry): support 'create' endpoint.
• feat(acl_entry): support 'delete' endpoint.
• feat(acl_entry): support 'list' endpoint.
• feat(acl_entry): support 'update' endpoint.
• feat(apex_redirect): support all endpoints.
• feat(contact): support 'create' endpoint.
• feat(content): support 'check status' 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(acl_entry): generate NEGATED enum.
• 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.

v5.3.1 (2023-07-05)

Bug fixes:

• fix(snippet): dynamic field switched from int to string.
• fix(vcl): implement correct response models.

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

v5.2.2 (2023-06-23)

Bug fixes:

• fix(historical_stats): generate missing models.

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

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

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

v5.1.0 (2023-05-17)

Enhancements:

• feat(config_store): add Config Store endpoints.

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

v4.4.0 (2023-04-26)

Bug fixes:

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

Enhancements:

• feat(object-store): new fields 'location', 'force'
• feat(object-store-item): new fields 'force', 'prefix'

v4.3.0 (2023-04-03)

Bug fixes:

• fix(purge): avoid CGI escape URL parameter

Enhancements:

• feat(domain-ownership): list API endpoint
• feat(object-store): items API endpoints
• feat(realtime): additional DDoS properties

v4.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
• docs(user): 'login' modification note removed

v4.0.0 (2022-12-15)

Full Changelog

Breaking:

• New interface from code-generated API client #183
  • Blog post: Better Fastly API clients with OpenAPI Generator
  • Documentation
  • Unsupported API endpoints

v3.0.2 (2021-06-30)

Full Changelog

Merged pull requests:

• Fix SumoLogic Logging #180 (integralist)

v3.0.1 (2021-02-03)

Full Changelog

Merged pull requests:

• Remove deprecation warning #174 (conniechu929)

v3.0.0 (2021-02-03)

Full Changelog

Merged pull requests:

• Removes session authentication #170 (conniechu929)

v2.5.0 (2020-01-16)

Full Changelog

Merged pull requests:

• Add tokens.rb #150 (malachy-mcconnell)

v2.4.0 (2019-07-29)

Full Changelog

Merged pull requests:

• [Backend] Add override_host attribute for Backend #146 (werkshy)

v2.3.1 (2019-07-25)

Full Changelog

Merged pull requests:

• Correct stats API path #147 (thommahoney)

v2.3.0 (2019-04-26)

Full Changelog

Closed issues:

• Ruby 2.5.0, fastly-1.15.0: Purge Errors #130

Merged pull requests:

• make concurrent-ruby optional #145 (thommahoney)
• Use concurrent-ruby to handle thread safety for http client. #144 (demersus)
• Fix bug auth #143 (ichiee)
• update ruby versions to latest supported #142 (thommahoney)

v2.2.0 (2018-12-11)

Full Changelog

Closed issues:

• purging https url doesn't work #100

Merged pull requests:

• ✨ Add BigQuery logging [APPENG-2076] #138 (jamesarosen)
• Update Fastly docs url #136 (crazyshot)
• 🔖 v2.1.0 #135 (jamesarosen)

v2.1.0 (2018-06-18)

Full Changelog

Merged pull requests:

• 👷➕🐛✅ fix tests in CI #134 (jamesarosen)
• ✨ add more user relationships to Customer #133 (jamesarosen)

v2.0.0 (2018-05-17)

Full Changelog

Merged pull requests:

• Update Changelog and version for 2.0.0 #129 (leklund)
• Update version and CHANGELOG for Release v1.15.0 #128 (leklund)
• Update fastly/invoice for v2 invoice endpoints #126 (leklund)

v1.15.0 (2018-04-04)

Full Changelog

Merged pull requests:

• Feature - add support for /stats/usage_by_month #124 (jrbeilke)
• add changelog for v1.14.0 #123 (thommahoney)

v1.14.0 (2018-03-23)

Full Changelog

Merged pull requests:

• bump to v1.14.0 #122 (thommahoney)
• Placement in Syslog #121 (RexBelli)

v1.13.2 (2017-12-18)

Full Changelog

Merged pull requests:

• Fix syslog response_condition attribute #117 (anotherJay)

v1.13.1 (2017-08-08)

Full Changelog

Merged pull requests:

• automatically load the sumologic_logging class #115 (thommahoney)

v1.13.0 (2017-08-07)

Full Changelog

Merged pull requests:

• add support for sumologic #114 (thommahoney)

v1.12.0 (2017-08-03)

Full Changelog

Merged pull requests:

• add support for dynamic snippets #113 (thommahoney)
• Added VCL snippets endpoint #112 (thomshutt)

v1.11.0 (2017-06-12)

Full Changelog

Merged pull requests:

• add GCS Logging object #111 (thommahoney)

v1.10.0 (2017-03-17)

Full Changelog

Merged pull requests:

• Support Papertrail logging endpoints #110 (werkshy)

v1.9.0 (2017-02-03)

Full Changelog

Closed issues:

• Missing tag for v1.8.0 #108

Merged pull requests:

• Add message\_type support to logging resources #109 (schisamo)

v1.8.0 (2017-01-17)

Full Changelog

Merged pull requests:

• Support for HTTP debug logs #107 (thommahoney)
• use public_suffix version 1.4.6 for ruby 1.9 #105 (thommahoney)
• Enable HTTP proxy support from environment #104 (vr)

v1.7.0 (2016-10-24)

Full Changelog

Merged pull requests:

• Add ACL and ACL Entry Support #103 (wrightp)
• add https support to purge function #99 (jgoulah)

v1.6.1 (2016-09-06)

Full Changelog

Merged pull requests:

• fix: use Appraisal to fix dependency conflicts #97 (lanej)
• Add format\_version to S3Logging and Syslog resources #96 (schisamo)

v1.6.0 (2016-07-14)

Full Changelog

Merged pull requests:

• Always add api key to requests if provided #93 (blithe)
• Fix header regex test #92 (blithe)
• Remove Origin model #91 (blithe)

v1.5.0 (2016-07-08)

Full Changelog

Closed issues:

• Support Edge Dictionaries #66
• version.locked? method returns incorrect value of true for unlocked version #47

Merged pull requests:

• build for all recent ruby patch-levels #90 (thommahoney)
• add Fastly::Dictionary#item #89 (lanej)
• fix initialize #88 (lanej)
• Raised ArgumentError if api_key or user/pass are not passed in. #87 (andriantoniades)
• Add support for dictionary items #86 (icco)
• Reintroduced :locked so the version.locked? check works #83 (eddieroger)

v1.4.2 (2016-05-23)

Full Changelog

Merged pull requests:

• Version#locked and #active are boolean values #81 (lanej)
• Update README #80 (tijmenb)
• Add Edge Dictionaries #69 (alexmuller)
• Validate was always returning true #55 (ljagiello)

v1.4.1 (2016-05-19)

Full Changelog

Merged pull requests:

• Fixes string interpolation #79 (gschorkopf)
• Add a user agent key/value pair to client headers #78 (gschorkopf)
• Soft purge #62 (simonwistow)

v1.3.0 (2016-04-04)

Full Changelog

Closed issues:

• Initializing Fastly.new with api_key option fails on version 1.2.2 #73
• Release 1.2.1 Is a breaking change #65

Merged pull requests:

• Added missing fields to S3Logging and syslog #76 (raybejjani)
• Update gem with missing fields #75 (raybejjani)
• URL escape names when used in URLs #74 (raybejjani)

v1.2.3 (2016-03-15)

Full Changelog

Merged pull requests:

• require 'openssl' #72 (cthomaspdx)

v1.2.2 (2016-03-09)

Full Changelog

Closed issues:

• regexp should be regex #64

Merged pull requests:

• rely on Net::HTTP default ca_path #71 (thommahoney)
• fix field name for regex #68 (thommahoney)
• Remove Fastly.commands #67 (alexmuller)

v1.2.1 (2016-01-08)

Full Changelog

Closed issues:

• TLS certificates not validated #59
• Purge by key returns status 200 but purge does not seem to fire #54
• Does purge_by_key require more then API_KEY to work? #52
• When chaining methods to purge by surrogate key, get_service API call is executed every time #50

Merged pull requests:

• validate TLS certificates #61 (lanej)
• Detect if client base_uri is HTTPS #53 (mmay)
• Improve examples of purging #51 (drbrain)
• having login_opts examples in the readme #49 (phoet)

v1.2.0 (2015-02-06)

Full Changelog

Closed issues:

• Can you bump the gem version? #43
• service name change fails on save! #20
• purge method doesn't take options hash #7
• Make sure types are correct #2

Merged pull requests:

• Better error reporting #48 (mastfish)
• Remove curb-fu once and for all #44 (mmay)

v1.1.5 (2014-12-16)

Full Changelog

Merged pull requests:

• bump curb to 0.8.6 #45 (mmay)
• Cleanup Style Issues #31 (ezkl)

v1.1.4 (2014-09-29)

Full Changelog

Merged pull requests:

• Require key #38 (thommahoney)

v1.1.3 (2014-07-25)

Full Changelog

Merged pull requests:

• Add create domain script #33 (mmay)
• Clarify the gem name in the README #32 (adarsh)

v1.1.2 (2014-06-12)

Full Changelog

Merged pull requests:

• Checks for existence of String#underscore prior to overriding #30 (spra85)

v1.1.1 (2014-06-05)

Full Changelog

Merged pull requests:

• Add VCL#set_main! #29 (ezkl)
• Minor project gardening #28 (ezkl)

v1.1.0 (2014-06-04)

Full Changelog

Closed issues:

• Using the API key instead of username + password #22
• Where to use full auth vs. token auth? #17
• License missing from gemspec #10

Merged pull requests:

• Allow creating an entirely new version of a service, inheriting nothing ... #27 (ctdk)
• Fix s3 #26 (ctdk)
• Fix listing objects, add some API features #24 (ctdk)
• Wrap test framework dependencies #23 (sgerrand)
• Readme updates for Testing #19 (phlipper)
• Streamline test suite #16 (aspires)

v1.02 (2013-11-26)

Full Changelog

Merged pull requests:

• Fixing misspelled field (quorom to quorum) #15 (renholm)

v1.01 (2013-10-03)

Full Changelog

Closed issues:

• No method for deleting vlc's #8

Merged pull requests:

• README should use 'new_version.activate!', not 'new_version.activate' #13 (samjsharpe)
• Move Fastly::VERSION to dedicated file #12 (f3nry)
• fix purge_all, purge_by_key and details at Fastly::Service #11 (kzk)

v1.0 (2013-07-16)

Full Changelog

Merged pull requests:

• Fix for issue #8 #9 (ajardan)

v0.99 (2012-05-01)

Full Changelog

Merged pull requests:

• Minor bug fix and README update #5 (ramezjm)

v0.98 (2012-02-16)

Full Changelog

v0.97 (2012-01-27)

Full Changelog

Closed issues:

• Every invocation of fastly_upload_vcl from v0.95 dies with an error #4

v0.96 (2012-01-17)

Full Changelog

v0.95 (2011-12-19)

Full Changelog

Closed issues:

• Gem does not default site or port #3
• Update to new form of versions #1

v0.9 (2011-12-15)

Full Changelog

v0.8 (2011-11-03)

Full Changelog

v0.6 (2011-11-03)

Full Changelog

v0.5 (2011-11-01)

[Full Changelog](https://github.com/fastly/fastly-ruby/compare/2015-02-05 v1.2.0...v0.5)

HEAD

2015-02-05 v1.2.0

• remove curb-fu. Net::HTTP is used instead - #44
• better client error handling - #48

2014-12-15 v1.1.5

• major refactor and reorganization of code (merged branch #31)
• bump curb dep to 0.8.6 for ruby 2.1 support (see #43)

2014-09-29 v1.1.4

• Require API Key for purge by key requests

2014-07-25 v1.1.3

• Add test:unit rake task
• Add Rubocop and some rubocop cleanup
• Clarify gem name in documentation
• Fix a bug in the Fastly.get_options method
• Add bin/fastly_create_domain script to easily create domain

2014-06-12 v1.1.2

• Replace String#underscore with Fastly::Util.class_to_path method.
• Add first true unit test
• Add test_helper.rb
• Add pry as dependency
• Add console Rake task

2013-11-26 v1.02

Fix rdoc dependency and quorum spelling (Kristoffer Renholm)

2013-10-03 v1.01

Add historical stats functionality Fix settings Add conditions Add in auto_loadbalancing for backends Fix some doc stuff (Sam Sharpe) Reorganize library (Eric Saxby & Paul Henry) Fix purge_all, purge_by_key and details (Kazuki Ohta)

2013-07-16 v1.00

Fix delete VCL (thanks Andrian Jardan)

2012-05-01 v0.99

Fix some SSL issues Allow some admin functionality

2012-02-02 v0.98

Make deactivate! work Add active? Add Service.purge_by_key

2012-01-27 v0.97

Fix invoice tests with new billing API

2012-01-16 v0.96

Fix version.locked? Make fastly_upload_vcl work

2011-12-19 v0.95

Fix the way invoices and stats are fetched

2011-12-15 v0.9

Add mapping from backends to directors and directors to origins

2011-11-03 v0.8

Add list_* to all objects

Add Healthchecks and Syslog endpoint streaming

2011-11-02 v0.5

Initial releasee