Skip to content

Commit

Permalink
Generated v8.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Jul 1, 2024
1 parent 4c5d619 commit f66532c
Show file tree
Hide file tree
Showing 38 changed files with 86 additions and 74 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Changelog

## [v8.5.0](https://github.com/fastly/fastly-ruby/releases/tag/release/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](https://github.com/fastly/fastly-ruby/releases/tag/release/v8.4.0) (2024-06-27)

**Bug fixes:**
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ A Ruby client library for interacting with most facets of the [Fastly API](https
To install via RubyGems, add the following to your project's `Gemfile`:

```ruby
gem 'fastly', '~> 8.4.0'
gem 'fastly', '~> 8.5.0'
```

Then run `bundle install`.
Expand Down
2 changes: 1 addition & 1 deletion docs/ContentApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Method | HTTP request | Description
content_check(opts): <Array<Content>> # Check status of content in each POP's cache
```

Retrieve headers and MD5 hash of the content for a particular URL from each Fastly edge server. This API is limited to 200 requests per hour.
Retrieve headers and MD5 hash of the content for a particular URL from each Fastly edge server. This API is limited to 200 requests per hour. If the content takes too long to download, the hash will be set to `error-timeout-$pop`. If the response is too large, it will be set to `warning-too-large-$pop`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/LoggingKafkaAdditional.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
| **auth_method** | **String** | SASL authentication method. | [optional] |
| **user** | **String** | SASL user. | [optional] |
| **password** | **String** | SASL password. | [optional] |
| **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) | | [optional][default to LoggingUseTls::no_tls] |
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to &#39;0&#39;] |

[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

4 changes: 2 additions & 2 deletions docs/LoggingKafkaApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ opts = {
auth_method: 'plain', # String | SASL authentication method.
user: 'user_example', # String | SASL user.
password: 'password_example', # String | SASL password.
use_tls: Fastly::LoggingUseTls::no_tls, # LoggingUseTls |
use_tls: Fastly::LoggingUseTlsString::no_tls, # LoggingUseTlsString |
}

begin
Expand Down Expand Up @@ -89,7 +89,7 @@ end
| **auth_method** | **String** | SASL authentication method. | [optional] |
| **user** | **String** | SASL user. | [optional] |
| **password** | **String** | SASL password. | [optional] |
| **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) | | [optional][default to 0] |
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to &#39;0&#39;] |

### Return type

Expand Down
2 changes: 1 addition & 1 deletion docs/LoggingKafkaResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
| **auth_method** | **String** | SASL authentication method. | [optional] |
| **user** | **String** | SASL user. | [optional] |
| **password** | **String** | SASL password. | [optional] |
| **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) | | [optional][default to LoggingUseTls::no_tls] |
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to &#39;0&#39;] |

[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

2 changes: 1 addition & 1 deletion docs/LoggingKafkaResponsePost.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
| **auth_method** | **String** | SASL authentication method. | [optional] |
| **user** | **String** | SASL user. | [optional] |
| **password** | **String** | SASL password. | [optional] |
| **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) | | [optional][default to LoggingUseTls::no_tls] |
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to &#39;0&#39;] |

[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

2 changes: 1 addition & 1 deletion docs/LoggingLogentriesAdditional.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
| ---- | ---- | ----------- | ----- |
| **port** | **Integer** | The port number. | [optional][default to 20000] |
| **token** | **String** | Use token based authentication. | [optional] |
| **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) | | [optional][default to LoggingUseTls::no_tls] |
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to &#39;0&#39;] |
| **region** | **String** | The region to which to stream logs. | [optional] |

[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
Expand Down
8 changes: 4 additions & 4 deletions docs/LoggingLogentriesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ opts = {
format_version: 1, # Integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.
port: 56, # Integer | The port number.
token: 'token_example', # String | Use token based authentication.
use_tls: Fastly::LoggingUseTls::no_tls, # LoggingUseTls |
use_tls: Fastly::LoggingUseTlsString::no_tls, # LoggingUseTlsString |
region: 'US', # String | The region to which to stream logs.
}

Expand All @@ -68,7 +68,7 @@ end
| **format_version** | **Integer** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to FORMAT_VERSION::v2] |
| **port** | **Integer** | The port number. | [optional][default to 20000] |
| **token** | **String** | Use token based authentication. | [optional] |
| **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) | | [optional][default to LoggingUseTls::no_tls] |
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to &#39;0&#39;] |
| **region** | **String** | The region to which to stream logs. | [optional] |

### Return type
Expand Down Expand Up @@ -221,7 +221,7 @@ opts = {
format_version: 1, # Integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.
port: 56, # Integer | The port number.
token: 'token_example', # String | Use token based authentication.
use_tls: Fastly::LoggingUseTls::no_tls, # LoggingUseTls |
use_tls: Fastly::LoggingUseTlsString::no_tls, # LoggingUseTlsString |
region: 'US', # String | The region to which to stream logs.
}

Expand All @@ -248,7 +248,7 @@ end
| **format_version** | **Integer** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to FORMAT_VERSION::v2] |
| **port** | **Integer** | The port number. | [optional][default to 20000] |
| **token** | **String** | Use token based authentication. | [optional] |
| **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) | | [optional][default to LoggingUseTls::no_tls] |
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to &#39;0&#39;] |
| **region** | **String** | The region to which to stream logs. | [optional] |

### Return type
Expand Down
2 changes: 1 addition & 1 deletion docs/LoggingLogentriesResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
| **format_version** | **String** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to &#39;2&#39;] |
| **port** | **Integer** | The port number. | [optional][default to 20000] |
| **token** | **String** | Use token based authentication. | [optional] |
| **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) | | [optional][default to LoggingUseTls::no_tls] |
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to &#39;0&#39;] |
| **region** | **String** | The region to which to stream logs. | [optional] |
| **created_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
| **deleted_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
Expand Down
2 changes: 1 addition & 1 deletion docs/LoggingSplunkAdditional.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
| ---- | ---- | ----------- | ----- |
| **url** | **String** | The URL to post logs to. | [optional] |
| **token** | **String** | A Splunk token for use in posting logs over HTTP to your collector. | [optional] |
| **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) | | [optional][default to LoggingUseTls::no_tls] |
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to &#39;0&#39;] |

[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

8 changes: 4 additions & 4 deletions docs/LoggingSplunkApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ opts = {
request_max_bytes: 56, # Integer | The maximum number of bytes sent in one request. Defaults `0` for unbounded.
url: 'url_example', # String | The URL to post logs to.
token: 'token_example', # String | A Splunk token for use in posting logs over HTTP to your collector.
use_tls: Fastly::LoggingUseTls::no_tls, # LoggingUseTls |
use_tls: Fastly::LoggingUseTlsString::no_tls, # LoggingUseTlsString |
}

begin
Expand Down Expand Up @@ -79,7 +79,7 @@ end
| **request_max_bytes** | **Integer** | The maximum number of bytes sent in one request. Defaults `0` for unbounded. | [optional][default to 0] |
| **url** | **String** | The URL to post logs to. | [optional] |
| **token** | **String** | A Splunk token for use in posting logs over HTTP to your collector. | [optional] |
| **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) | | [optional][default to LoggingUseTls::no_tls] |
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to &#39;0&#39;] |

### Return type

Expand Down Expand Up @@ -237,7 +237,7 @@ opts = {
request_max_bytes: 56, # Integer | The maximum number of bytes sent in one request. Defaults `0` for unbounded.
url: 'url_example', # String | The URL to post logs to.
token: 'token_example', # String | A Splunk token for use in posting logs over HTTP to your collector.
use_tls: Fastly::LoggingUseTls::no_tls, # LoggingUseTls |
use_tls: Fastly::LoggingUseTlsString::no_tls, # LoggingUseTlsString |
}

begin
Expand Down Expand Up @@ -269,7 +269,7 @@ end
| **request_max_bytes** | **Integer** | The maximum number of bytes sent in one request. Defaults `0` for unbounded. | [optional][default to 0] |
| **url** | **String** | The URL to post logs to. | [optional] |
| **token** | **String** | A Splunk token for use in posting logs over HTTP to your collector. | [optional] |
| **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) | | [optional][default to LoggingUseTls::no_tls] |
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to &#39;0&#39;] |

### Return type

Expand Down
2 changes: 1 addition & 1 deletion docs/LoggingSplunkResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
| **request_max_bytes** | **Integer** | The maximum number of bytes sent in one request. Defaults `0` for unbounded. | [optional][default to 0] |
| **url** | **String** | The URL to post logs to. | [optional] |
| **token** | **String** | A Splunk token for use in posting logs over HTTP to your collector. | [optional] |
| **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) | | [optional][default to LoggingUseTls::no_tls] |
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to &#39;0&#39;] |
| **created_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
| **deleted_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
| **updated_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
Expand Down
2 changes: 1 addition & 1 deletion docs/LoggingSyslogAdditional.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
| **hostname** | **String** | The hostname used for the syslog endpoint. | [optional] |
| **ipv4** | **String** | The IPv4 address used for the syslog endpoint. | [optional] |
| **token** | **String** | Whether to prepend each message with a specific token. | [optional][default to &#39;null&#39;] |
| **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) | | [optional][default to LoggingUseTls::no_tls] |
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to &#39;0&#39;] |

[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

8 changes: 4 additions & 4 deletions docs/LoggingSyslogApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ opts = {
hostname: 'hostname_example', # String | The hostname used for the syslog endpoint.
ipv4: 'ipv4_example', # String | The IPv4 address used for the syslog endpoint.
token: 'token_example', # String | Whether to prepend each message with a specific token.
use_tls: Fastly::LoggingUseTls::no_tls, # LoggingUseTls |
use_tls: Fastly::LoggingUseTlsString::no_tls, # LoggingUseTlsString |
}

begin
Expand Down Expand Up @@ -83,7 +83,7 @@ end
| **hostname** | **String** | The hostname used for the syslog endpoint. | [optional] |
| **ipv4** | **String** | The IPv4 address used for the syslog endpoint. | [optional] |
| **token** | **String** | Whether to prepend each message with a specific token. | [optional][default to &#39;null&#39;] |
| **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) | | [optional][default to LoggingUseTls::no_tls] |
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to &#39;0&#39;] |

### Return type

Expand Down Expand Up @@ -243,7 +243,7 @@ opts = {
hostname: 'hostname_example', # String | The hostname used for the syslog endpoint.
ipv4: 'ipv4_example', # String | The IPv4 address used for the syslog endpoint.
token: 'token_example', # String | Whether to prepend each message with a specific token.
use_tls: Fastly::LoggingUseTls::no_tls, # LoggingUseTls |
use_tls: Fastly::LoggingUseTlsString::no_tls, # LoggingUseTlsString |
}

begin
Expand Down Expand Up @@ -277,7 +277,7 @@ end
| **hostname** | **String** | The hostname used for the syslog endpoint. | [optional] |
| **ipv4** | **String** | The IPv4 address used for the syslog endpoint. | [optional] |
| **token** | **String** | Whether to prepend each message with a specific token. | [optional][default to &#39;null&#39;] |
| **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) | | [optional][default to LoggingUseTls::no_tls] |
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to &#39;0&#39;] |

### Return type

Expand Down
2 changes: 1 addition & 1 deletion docs/LoggingSyslogResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
| **hostname** | **String** | The hostname used for the syslog endpoint. | [optional] |
| **ipv4** | **String** | The IPv4 address used for the syslog endpoint. | [optional] |
| **token** | **String** | Whether to prepend each message with a specific token. | [optional][default to &#39;null&#39;] |
| **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) | | [optional][default to LoggingUseTls::no_tls] |
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to &#39;0&#39;] |
| **created_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
| **deleted_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
| **updated_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
Expand Down
2 changes: 1 addition & 1 deletion docs/LoggingUseTls.md → docs/LoggingUseTlsString.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Fastly::LoggingUseTls
# Fastly::LoggingUseTlsString

## Properties

Expand Down
2 changes: 1 addition & 1 deletion lib/fastly.rb
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@
require 'fastly/models/logging_syslog_additional'
require 'fastly/models/logging_syslog_response'
require 'fastly/models/logging_tls_common'
require 'fastly/models/logging_use_tls'
require 'fastly/models/logging_use_tls_string'
require 'fastly/models/metadata'
require 'fastly/models/mutual_authentication'
require 'fastly/models/mutual_authentication_data'
Expand Down
4 changes: 2 additions & 2 deletions lib/fastly/api/content_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ def initialize(api_client = ApiClient.default)
@api_client = api_client
end
# Check status of content in each POP's cache
# Retrieve headers and MD5 hash of the content for a particular URL from each Fastly edge server. This API is limited to 200 requests per hour.
# Retrieve headers and MD5 hash of the content for a particular URL from each Fastly edge server. This API is limited to 200 requests per hour. If the content takes too long to download, the hash will be set to `error-timeout-$pop`. If the response is too large, it will be set to `warning-too-large-$pop`.
# @option opts [String] :url Full URL (host and path) to check on all nodes. if protocol is omitted, http will be assumed.
# @return [Array<Content>]
def content_check(opts = {})
Expand All @@ -27,7 +27,7 @@ def content_check(opts = {})
end

# Check status of content in each POP&#39;s cache
# Retrieve headers and MD5 hash of the content for a particular URL from each Fastly edge server. This API is limited to 200 requests per hour.
# Retrieve headers and MD5 hash of the content for a particular URL from each Fastly edge server. This API is limited to 200 requests per hour. If the content takes too long to download, the hash will be set to &#x60;error-timeout-$pop&#x60;. If the response is too large, it will be set to &#x60;warning-too-large-$pop&#x60;.
# @option opts [String] :url Full URL (host and path) to check on all nodes. if protocol is omitted, http will be assumed.
# @return [Array<(Array<Content>, Integer, Hash)>] Array<Content> data, response status code and response headers
def content_check_with_http_info(opts = {})
Expand Down
4 changes: 2 additions & 2 deletions lib/fastly/api/logging_datadog_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ def create_log_datadog_with_http_info(opts = {})
if @api_client.config.client_side_validation && opts[:'format_version'] && !allowable_values.include?(opts[:'format_version'])
fail ArgumentError, "invalid value for \"format_version\", must be one of #{allowable_values}"
end
allowable_values = ["US", "EU"]
allowable_values = ["US", "US3", "US5", "EU (legacy, same as EU1)", "EU1", "AP1"]
if @api_client.config.client_side_validation && opts[:'region'] && !allowable_values.include?(opts[:'region'])
fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
end
Expand Down Expand Up @@ -408,7 +408,7 @@ def update_log_datadog_with_http_info(opts = {})
if @api_client.config.client_side_validation && opts[:'format_version'] && !allowable_values.include?(opts[:'format_version'])
fail ArgumentError, "invalid value for \"format_version\", must be one of #{allowable_values}"
end
allowable_values = ["US", "EU"]
allowable_values = ["US", "US3", "US5", "EU (legacy, same as EU1)", "EU1", "AP1"]
if @api_client.config.client_side_validation && opts[:'region'] && !allowable_values.include?(opts[:'region'])
fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
end
Expand Down
4 changes: 2 additions & 2 deletions lib/fastly/api/logging_kafka_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ def initialize(api_client = ApiClient.default)
# @option opts [String] :auth_method SASL authentication method.
# @option opts [String] :user SASL user.
# @option opts [String] :password SASL password.
# @option opts [LoggingUseTls] :use_tls (default to 0)
# @option opts [LoggingUseTlsString] :use_tls (default to '0')
# @return [LoggingKafkaResponsePost]
def create_log_kafka(opts = {})
data, _status_code, _headers = create_log_kafka_with_http_info(opts)
Expand Down Expand Up @@ -68,7 +68,7 @@ def create_log_kafka(opts = {})
# @option opts [String] :auth_method SASL authentication method.
# @option opts [String] :user SASL user.
# @option opts [String] :password SASL password.
# @option opts [LoggingUseTls] :use_tls (default to 0)
# @option opts [LoggingUseTlsString] :use_tls (default to '0')
# @return [Array<(LoggingKafkaResponsePost, Integer, Hash)>] LoggingKafkaResponsePost data, response status code and response headers
def create_log_kafka_with_http_info(opts = {})
if @api_client.config.debugging
Expand Down
Loading

0 comments on commit f66532c

Please sign in to comment.