Skip to content

Commit

Permalink
Generated v8.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Nov 30, 2023
1 parent bbfb4d5 commit 0e42d03
Show file tree
Hide file tree
Showing 45 changed files with 146 additions and 4,040 deletions.
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# Changelog

## [v8.0.0](https://github.com/fastly/fastly-ruby/releases/tag/release/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](https://github.com/fastly/fastly-ruby/releases/tag/release/v7.2.2) (2023-11-07)

**Enhancements:**
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', '~> 7.2.2'
gem 'fastly', '~> 8.0.0'
```

Then run `bundle install`.
Expand Down
24 changes: 12 additions & 12 deletions docs/HistoricalApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ api_instance = Fastly::HistoricalApi.new
## `get_hist_stats()`

```ruby
get_hist_stats(opts): <HistoricalResponse> # Get historical stats
get_hist_stats(opts): <HistoricalStatsByServiceResponse> # Get historical stats
```

Fetches historical stats for each of your Fastly services and groups the results by service ID.
Expand Down Expand Up @@ -60,14 +60,14 @@ end

### Return type

[**HistoricalResponse**](HistoricalResponse.md)
[**HistoricalStatsByServiceResponse**](HistoricalStatsByServiceResponse.md)

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

```ruby
get_hist_stats_aggregated(opts): <HistoricalAggregateResponse> # Get aggregated historical stats
get_hist_stats_aggregated(opts): <HistoricalStatsAggregatedResponse> # Get aggregated historical stats
```

Fetches historical stats information aggregated across all of your Fastly services.
Expand Down Expand Up @@ -103,14 +103,14 @@ end

### Return type

[**HistoricalAggregateResponse**](HistoricalAggregateResponse.md)
[**HistoricalStatsAggregatedResponse**](HistoricalStatsAggregatedResponse.md)

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

```ruby
get_hist_stats_field(opts): <HistoricalFieldResponse> # Get historical stats for a single field
get_hist_stats_field(opts): <HistoricalStatsByServiceResponse> # Get historical stats for a single field
```

Fetches the specified field from the historical stats for each of your services and groups the results by service ID.
Expand Down Expand Up @@ -148,14 +148,14 @@ end

### Return type

[**HistoricalFieldResponse**](HistoricalFieldResponse.md)
[**HistoricalStatsByServiceResponse**](HistoricalStatsByServiceResponse.md)

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

```ruby
get_hist_stats_service(opts): <HistoricalAggregateResponse> # Get historical stats for a single service
get_hist_stats_service(opts): <HistoricalStatsAggregatedResponse> # Get historical stats for a single service
```

Fetches historical stats for a given service.
Expand Down Expand Up @@ -193,14 +193,14 @@ end

### Return type

[**HistoricalAggregateResponse**](HistoricalAggregateResponse.md)
[**HistoricalStatsAggregatedResponse**](HistoricalStatsAggregatedResponse.md)

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

```ruby
get_hist_stats_service_field(opts): <HistoricalFieldAggregateResponse> # Get historical stats for a single service/field combination
get_hist_stats_service_field(opts): <HistoricalStatsAggregatedResponse> # Get historical stats for a single service/field combination
```

Fetches the specified field from the historical stats for a given service.
Expand Down Expand Up @@ -240,7 +240,7 @@ end

### Return type

[**HistoricalFieldAggregateResponse**](HistoricalFieldAggregateResponse.md)
[**HistoricalStatsAggregatedResponse**](HistoricalStatsAggregatedResponse.md)

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to README]](../../README.md)
Expand Down Expand Up @@ -279,7 +279,7 @@ This endpoint does not need any parameter.
## `get_usage()`

```ruby
get_usage(opts): <HistoricalUsageAggregateResponse> # Get usage statistics
get_usage(opts): <HistoricalUsageAggregatedResponse> # Get usage statistics
```

Returns usage information aggregated across all Fastly services and grouped by region. To aggregate across all Fastly services by time period, see [`/stats/aggregate`](#get-hist-stats-aggregated).
Expand Down Expand Up @@ -311,7 +311,7 @@ end

### Return type

[**HistoricalUsageAggregateResponse**](HistoricalUsageAggregateResponse.md)
[**HistoricalUsageAggregatedResponse**](HistoricalUsageAggregatedResponse.md)

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to README]](../../README.md)
Expand Down
13 changes: 0 additions & 13 deletions docs/HistoricalFieldAggregateResponse.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/HistoricalFieldAggregateResponseAllOf.md

This file was deleted.

Loading

0 comments on commit 0e42d03

Please sign in to comment.