README.md in fastly-4.0.1.pre.alpha.0 vs README.md in fastly-4.1.0

- old
+ new

@@ -1,16 +1,26 @@ # fastly-ruby A Ruby client library for interacting with most facets of the [Fastly API](https://developer.fastly.com/reference/api). +> NOTE: This 4.x release is a new [generated API client](https://dev.to/fastly/better-fastly-api-clients-with-openapi-generator-3lno) for the Fastly API. +> The previous 3.x version is no longer supported, but can be found at https://github.com/fastly/fastly-ruby/tree/v3.x. + +> ⚠️ This client library (`v4.1.0`) is an early-access release. Features may change without notice. Use at your own risk. + +**We strongly recommend that you do not install alpha and beta releases on live production services.** No official support is provided for such releases. Please try out the library in a test environment, see what breaks without worrying about consequences, and give us [feedback](#issues). + +Read about the [Fastly Product Lifecycle](https://docs.fastly.com/products/fastly-product-lifecycle). + + ## Installation To install via RubyGems, add the following to your project's `Gemfile`: ```ruby -gem 'fastly', '~> 4.0.0' +gem 'fastly', '~> v4.1.0' ``` Then run `bundle install`. ## Usage @@ -53,11 +63,11 @@ end ``` Alternatively, set the `FASTLY_API_TOKEN` environment variable instead of setting `api_token`. -## Endpoints +## Documentation for API Endpoints The main documentation for the Fastly API can be found on our [Developer Hub](https://developer.fastly.com/reference/api). Class | Method | Description ------------ | ------------- | ------------- @@ -314,10 +324,18 @@ [*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**create_mutual_tls_authentication**](docs/MutualAuthenticationApi.md#create_mutual_tls_authentication) | Create a Mutual Authentication [*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**delete_mutual_tls**](docs/MutualAuthenticationApi.md#delete_mutual_tls) | Delete a Mutual TLS [*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**get_mutual_authentication**](docs/MutualAuthenticationApi.md#get_mutual_authentication) | Get a Mutual Authentication [*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**list_mutual_authentications**](docs/MutualAuthenticationApi.md#list_mutual_authentications) | List Mutual Authentications [*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**patch_mutual_authentication**](docs/MutualAuthenticationApi.md#patch_mutual_authentication) | Update a Mutual Authentication +[*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**create_store**](docs/ObjectStoreApi.md#create_store) | Create an object store. +[*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**delete_key_from_store**](docs/ObjectStoreApi.md#delete_key_from_store) | Delete object store key. +[*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**delete_store**](docs/ObjectStoreApi.md#delete_store) | Delete an object store. +[*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**get_keys**](docs/ObjectStoreApi.md#get_keys) | List object store keys. +[*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**get_store**](docs/ObjectStoreApi.md#get_store) | Describe an object store. +[*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**get_stores**](docs/ObjectStoreApi.md#get_stores) | List object stores. +[*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**get_value_for_key**](docs/ObjectStoreApi.md#get_value_for_key) | Get object store key value. +[*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**set_value_for_key**](docs/ObjectStoreApi.md#set_value_for_key) | Insert object store key-value. [*Fastly::PackageApi*](docs/PackageApi.md) | [**get_package**](docs/PackageApi.md#get_package) | Get details of the service's Compute@Edge package. [*Fastly::PackageApi*](docs/PackageApi.md) | [**put_package**](docs/PackageApi.md#put_package) | Upload a Compute@Edge package. [*Fastly::PoolApi*](docs/PoolApi.md) | [**create_server_pool**](docs/PoolApi.md#create_server_pool) | Create a server pool [*Fastly::PoolApi*](docs/PoolApi.md) | [**delete_server_pool**](docs/PoolApi.md#delete_server_pool) | Delete a server pool [*Fastly::PoolApi*](docs/PoolApi.md) | [**get_server_pool**](docs/PoolApi.md#get_server_pool) | Get a server pool @@ -365,10 +383,11 @@ [*Fastly::ServiceAuthorizationsApi*](docs/ServiceAuthorizationsApi.md) | [**delete_service_authorization**](docs/ServiceAuthorizationsApi.md#delete_service_authorization) | Delete service authorization [*Fastly::ServiceAuthorizationsApi*](docs/ServiceAuthorizationsApi.md) | [**list_service_authorization**](docs/ServiceAuthorizationsApi.md#list_service_authorization) | List service authorizations [*Fastly::ServiceAuthorizationsApi*](docs/ServiceAuthorizationsApi.md) | [**show_service_authorization**](docs/ServiceAuthorizationsApi.md#show_service_authorization) | Show service authorization [*Fastly::ServiceAuthorizationsApi*](docs/ServiceAuthorizationsApi.md) | [**update_service_authorization**](docs/ServiceAuthorizationsApi.md#update_service_authorization) | Update service authorization [*Fastly::SettingsApi*](docs/SettingsApi.md) | [**get_service_settings**](docs/SettingsApi.md#get_service_settings) | Get service settings +[*Fastly::SettingsApi*](docs/SettingsApi.md) | [**update_service_settings**](docs/SettingsApi.md#update_service_settings) | Update service settings [*Fastly::SnippetApi*](docs/SnippetApi.md) | [**create_snippet**](docs/SnippetApi.md#create_snippet) | Create a snippet [*Fastly::SnippetApi*](docs/SnippetApi.md) | [**delete_snippet**](docs/SnippetApi.md#delete_snippet) | Delete a snippet [*Fastly::SnippetApi*](docs/SnippetApi.md) | [**get_snippet**](docs/SnippetApi.md#get_snippet) | Get a versioned snippet [*Fastly::SnippetApi*](docs/SnippetApi.md) | [**get_snippet_dynamic**](docs/SnippetApi.md#get_snippet_dynamic) | Get a dynamic snippet [*Fastly::SnippetApi*](docs/SnippetApi.md) | [**list_snippets**](docs/SnippetApi.md#list_snippets) | List snippets @@ -473,86 +492,9 @@ [*Fastly::WafRulesApi*](docs/WafRulesApi.md) | [**list_waf_rules**](docs/WafRulesApi.md#list_waf_rules) | List available WAF rules [*Fastly::WafTagsApi*](docs/WafTagsApi.md) | [**list_waf_tags**](docs/WafTagsApi.md#list_waf_tags) | List tags ## Issues - -The fastly-ruby API client currently does not support the following endpoints: - -- [`/content/edge_check`](https://developer.fastly.com/reference/api/utils/content) (GET) -- [`/customer/{customer_id}/contacts`](https://developer.fastly.com/reference/api/account/contact) (POST) -- [`/metrics/domains/services/{service_id}`](https://developer.fastly.com/reference/api/metrics-stats/domain-inspector/historical) (GET) -- [`/metrics/origins/services/{service_id}`](https://developer.fastly.com/reference/api/metrics-stats/origin-inspector/historical) (GET) -- [`/rate-limiters/{rate_limiter_id}`](https://developer.fastly.com/reference/api/vcl-services/rate-limiter) (PUT) -- [`/resources/stores/object/{store_id}/keys/{key_name}`](https://developer.fastly.com/reference/api/) (DELETE, GET, PUT) -- [`/resources/stores/object/{store_id}/keys`](https://developer.fastly.com/reference/api/) (GET) -- [`/resources/stores/object/{store_id}`](https://developer.fastly.com/reference/api/) (DELETE, GET) -- [`/resources/stores/object`](https://developer.fastly.com/reference/api/) (GET, POST) -- [`/resources/stores/secret/{store_id}/secrets/{secret_name}`](https://developer.fastly.com/reference/api/) (DELETE, GET) -- [`/resources/stores/secret/{store_id}/secrets`](https://developer.fastly.com/reference/api/) (GET, POST) -- [`/resources/stores/secret/{store_id}`](https://developer.fastly.com/reference/api/) (DELETE, GET) -- [`/resources/stores/secret`](https://developer.fastly.com/reference/api/) (GET, POST) -- [`/roles/{role_id}/permissions`](https://developer.fastly.com/reference/api/account/roles) (DELETE, POST) -- [`/roles/{role_id}`](https://developer.fastly.com/reference/api/account/roles) (PATCH) -- [`/roles`](https://developer.fastly.com/reference/api/account/roles) (POST) -- [`/service-authorizations`](https://developer.fastly.com/reference/api/account/service-authorization) (DELETE, PATCH) -- [`/service-groups/{service_group_id}/services`](https://developer.fastly.com/reference/api/account/service-groups) (DELETE, POST) -- [`/service-groups/{service_group_id}`](https://developer.fastly.com/reference/api/account/service-groups) (PATCH) -- [`/service-groups`](https://developer.fastly.com/reference/api/account/service-groups) (POST) -- [`/service/{service_id}/acl/{acl_id}/entries`](https://developer.fastly.com/reference/api/acls/acl-entry) (GET) -- [`/service/{service_id}/acl/{acl_id}/entry/{acl_entry_id}`](https://developer.fastly.com/reference/api/acls/acl-entry) (GET, PATCH) -- [`/service/{service_id}/acl/{acl_id}/entry`](https://developer.fastly.com/reference/api/acls/acl-entry) (POST) -- [`/service/{service_id}/dictionary/{dictionary_id}/items`](https://developer.fastly.com/reference/api/dictionaries/dictionary-item) (PATCH) -- [`/service/{service_id}/version/{version_id}/apex-redirects`](https://developer.fastly.com/reference/api/vcl-services/apex-redirect) (POST) -- [`/service/{service_id}/version/{version_id}/director/{director_name}`](https://developer.fastly.com/reference/api/load-balancing/directors/director) (PUT) -- [`/service/{service_id}/version/{version_id}/logging/kafka/{logging_kafka_name}`](https://developer.fastly.com/reference/api/logging/kafka) (PUT) -- [`/service/{service_id}/version/{version_id}/logging/kinesis/{logging_kinesis_name}`](https://developer.fastly.com/reference/api/logging/kinesis) (PUT) -- [`/service/{service_id}/version/{version_id}/rate-limiters`](https://developer.fastly.com/reference/api/vcl-services/rate-limiter) (POST) -- [`/service/{service_id}/version/{version_id}/request_settings`](https://developer.fastly.com/reference/api/vcl-services/request-settings) (POST) -- [`/service/{service_id}/version/{version_id}/response_object/{response_object_name}`](https://developer.fastly.com/reference/api/vcl-services/response-object) (PUT) -- [`/service/{service_id}/version/{version_id}/response_object`](https://developer.fastly.com/reference/api/vcl-services/response-object) (POST) -- [`/service/{service_id}/version/{version_id}/settings`](https://developer.fastly.com/reference/api/vcl-services/settings) (PUT) -- [`/service/{service_id}/version/{version_id}/snippet/{snippet_name}`](https://developer.fastly.com/reference/api/vcl-services/snippet) (PUT) -- [`/service/{service_id}/version/{version_id}/wafs/{firewall_id}`](https://developer.fastly.com/reference/api/legacy-waf/firewall) (GET, PATCH) -- [`/service/{service_id}/version/{version_id}/wafs`](https://developer.fastly.com/reference/api/legacy-waf/firewall) (GET, POST) -- [`/service/{service_id}/wafs/{firewall_id}/owasp`](https://developer.fastly.com/reference/api/legacy-waf/owasp) (GET, PATCH, POST) -- [`/service/{service_id}/wafs/{firewall_id}/rule_statuses`](https://developer.fastly.com/reference/api/legacy-waf/rule-status) (GET, POST) -- [`/service/{service_id}/wafs/{firewall_id}/rules/{waf_rule_id}/rule_status`](https://developer.fastly.com/reference/api/legacy-waf/rule-status) (GET, PATCH) -- [`/service/{service_id}/wafs/{firewall_id}/ruleset/preview`](https://developer.fastly.com/reference/api/legacy-waf/ruleset) (GET) -- [`/service/{service_id}/wafs/{firewall_id}/ruleset`](https://developer.fastly.com/reference/api/legacy-waf/ruleset) (GET, PATCH) -- [`/service/{service_id}/wafs/{firewall_id}/update_statuses/{update_status_id}`](https://developer.fastly.com/reference/api/legacy-waf/update-status) (GET) -- [`/service/{service_id}/wafs/{firewall_id}/update_statuses`](https://developer.fastly.com/reference/api/legacy-waf/update-status) (GET) -- [`/sudo`](https://developer.fastly.com/reference/api/utils/sudo) (POST) -- [`/tls/activations/{tls_activation_id}`](https://developer.fastly.com/reference/api/tls/mutual-tls/activations) (GET, PATCH) -- [`/tls/activations`](https://developer.fastly.com/reference/api/tls/mutual-tls/activations) (GET) -- [`/tokens`](https://developer.fastly.com/reference/api/auth-tokens/user) (DELETE, POST) -- [`/user-groups/{user_group_id}/members`](https://developer.fastly.com/reference/api/account/user-groups) (DELETE, POST) -- [`/user-groups/{user_group_id}/roles`](https://developer.fastly.com/reference/api/account/user-groups) (DELETE, POST) -- [`/user-groups/{user_group_id}/service-groups`](https://developer.fastly.com/reference/api/account/user-groups) (DELETE, POST) -- [`/user-groups/{user_group_id}`](https://developer.fastly.com/reference/api/account/user-groups) (PATCH) -- [`/user-groups`](https://developer.fastly.com/reference/api/account/user-groups) (POST) -- [`/v1/channel/{service_id}/ts/h/limit/{max_entries}`](https://developer.fastly.com/reference/api/metrics-stats/origin-insights) (GET) -- [`/v1/channel/{service_id}/ts/h`](https://developer.fastly.com/reference/api/metrics-stats/origin-insights) (GET) -- [`/v1/channel/{service_id}/ts/{start_timestamp}`](https://developer.fastly.com/reference/api/metrics-stats/origin-insights) (GET) -- [`/v1/domains/{service_id}/ts/h/limit/{max_entries}`](https://developer.fastly.com/reference/api/metrics-stats/domain-inspector/real-time) (GET) -- [`/v1/domains/{service_id}/ts/h`](https://developer.fastly.com/reference/api/metrics-stats/domain-inspector/real-time) (GET) -- [`/v1/domains/{service_id}/ts/{start_timestamp}`](https://developer.fastly.com/reference/api/metrics-stats/domain-inspector/real-time) (GET) -- [`/v1/origins/{service_id}/ts/h/limit/{max_entries}`](https://developer.fastly.com/reference/api/metrics-stats/origin-inspector/real-time) (GET) -- [`/v1/origins/{service_id}/ts/h`](https://developer.fastly.com/reference/api/metrics-stats/origin-inspector/real-time) (GET) -- [`/v1/origins/{service_id}/ts/{start_timestamp}`](https://developer.fastly.com/reference/api/metrics-stats/origin-inspector/real-time) (GET) -- [`/waf/firewalls/{firewall_id}/versions/{version_id}/active-rules`](https://developer.fastly.com/reference/api/waf/rules/active) (DELETE) -- [`/wafs/configuration_sets/{configuration_set_id}/relationships/wafs`](https://developer.fastly.com/reference/api/legacy-waf/configuration-set) (GET, PATCH) -- [`/wafs/configuration_sets`](https://developer.fastly.com/reference/api/legacy-waf/configuration-set) (GET) -- [`/wafs/rules/{waf_rule_id}/vcl`](https://developer.fastly.com/reference/api/legacy-waf/rule) (GET) -- [`/wafs/rules/{waf_rule_id}`](https://developer.fastly.com/reference/api/legacy-waf/rule) (GET) -- [`/wafs/rules`](https://developer.fastly.com/reference/api/legacy-waf/rule) (GET) -- [`/wafs/tags`](https://developer.fastly.com/reference/api/legacy-waf/tag) (GET) -- [`/wafs/{firewall_id}/disable`](https://developer.fastly.com/reference/api/legacy-waf/firewall) (PATCH) -- [`/wafs/{firewall_id}/enable`](https://developer.fastly.com/reference/api/legacy-waf/firewall) (PATCH) -- [`/wafs/{firewall_id}/rules/{waf_rule_id}/vcl`](https://developer.fastly.com/reference/api/legacy-waf/rule) (GET) -- [`/wafs/{firewall_id}`](https://developer.fastly.com/reference/api/legacy-waf/firewall) (GET) -- [`/wafs`](https://developer.fastly.com/reference/api/legacy-waf/firewall) (GET) - If you encounter any non-security-related bug or unexpected behavior, please [file an issue][bug] using the bug report template. [bug]: https://github.com/fastly/fastly-ruby/issues/new?labels=bug