docs/SettingsApi.md in fastly-4.0.1.pre.alpha.0 vs docs/SettingsApi.md in fastly-4.1.0

- old
+ new

@@ -9,10 +9,11 @@ ## Methods | Method | HTTP request | Description | | ------ | ------------ | ----------- | | [**get_service_settings**](SettingsApi.md#get_service_settings) | **GET** /service/{service_id}/version/{version_id}/settings | Get service settings | +| [**update_service_settings**](SettingsApi.md#update_service_settings) | **PUT** /service/{service_id}/version/{version_id}/settings | Update service settings | ## `get_service_settings()` ```ruby @@ -43,9 +44,56 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **service_id** | **String** | Alphanumeric string identifying the service. | | | **version_id** | **Integer** | Integer identifying a service version. | | + +### Return type + +[**SettingsResponse**](SettingsResponse.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to README]](../../README.md) +## `update_service_settings()` + +```ruby +update_service_settings(opts): <SettingsResponse> # Update service settings +``` + +Update the settings for a particular service and version. NOTE: If you override TTLs with custom VCL, any general.default_ttl value will not be honored and the expected behavior may change. + +### Examples + +```ruby +api_instance = Fastly::SettingsApi.new +opts = { + service_id: 'service_id_example', # String | Alphanumeric string identifying the service. + version_id: 56, # Integer | Integer identifying a service version. + general_default_host: 'general_default_host_example', # String | The default host name for the version. + general_default_ttl: 56, # Integer | The default time-to-live (TTL) for the version. + general_stale_if_error: true, # Boolean | Enables serving a stale object if there is an error. + general_stale_if_error_ttl: 56, # Integer | The default time-to-live (TTL) for serving the stale object for the version. +} + +begin + # Update service settings + result = api_instance.update_service_settings(opts) + p result +rescue Fastly::ApiError => e + puts "Error when calling SettingsApi->update_service_settings: #{e}" +end +``` + +### Options + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **service_id** | **String** | Alphanumeric string identifying the service. | | +| **version_id** | **Integer** | Integer identifying a service version. | | +| **general_default_host** | **String** | The default host name for the version. | [optional] | +| **general_default_ttl** | **Integer** | The default time-to-live (TTL) for the version. | [optional] | +| **general_stale_if_error** | **Boolean** | Enables serving a stale object if there is an error. | [optional][default to false] | +| **general_stale_if_error_ttl** | **Integer** | The default time-to-live (TTL) for serving the stale object for the version. | [optional][default to 43200] | ### Return type [**SettingsResponse**](SettingsResponse.md)