Skip to content

Commit fa1e4b2

Browse files
author
github-actions
committed
Generated v2.02
1 parent 6840ee8 commit fa1e4b2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+4032
-273
lines changed

‎Changes

+15
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
Revision history for https://metacpan.org/dist/WebService-Fastly
22

3+
2.02 2023-03-23
4+
* fix(purge): switch authentication type to 'token'
5+
* feat(domain-ownerships): List domain-ownerships
6+
* feat(events): implement 'filter[created_at]' property
7+
* feat(mutual-authentication): implement 'include' property
8+
* feat(object-store): implement api
9+
* docs(backend): keepalive_time
10+
* docs(pop): region, shield, latitude, longitude
11+
* docs(product-enablement): brotli_compression
12+
* docs(resource): terminology
13+
* docs(results): fanout properties
14+
* docs(tls/subscriptions): new 'failed' state
15+
* docs(user): 'login' modification note removed
16+
317
2.01 2022-12-15
418
* New code-generated API client using Fastly's OpenAPI specification: https://dev.to/fastly/better-fastly-api-clients-with-openapi-generator-3lno
519
* New client interface: https://github.com/fastly/fastly-perl#documentation-for-api-endpoints
@@ -104,3 +118,4 @@ Revision history for https://metacpan.org/dist/Net-Fastly
104118
0.5 2011-10-28
105119

106120
* Initial release
121+

‎README.md

+32-14
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@ WebService::Fastly - an interface to most facets of the [Fastly API](https://dev
44

55
# VERSION
66

7-
2.01
7+
2.02
8+
9+
> NOTE: This 2.x release is a new [generated API client](https://dev.to/fastly/better-fastly-api-clients-with-openapi-generator-3lno) for the Fastly API.
10+
> The previous 1.x version is no longer supported, but can be found at https://github.com/fastly/fastly-perl/tree/v1.x.
11+
812

913

1014
# SYNOPSIS
@@ -128,6 +132,7 @@ Class | Method | HTTP request | Description
128132
*DomainApi* | [**get_domain**](docs/DomainApi.md#get_domain) | **GET** /service/{service_id}/version/{version_id}/domain/{domain_name} | Describe a domain
129133
*DomainApi* | [**list_domains**](docs/DomainApi.md#list_domains) | **GET** /service/{service_id}/version/{version_id}/domain | List domains
130134
*DomainApi* | [**update_domain**](docs/DomainApi.md#update_domain) | **PUT** /service/{service_id}/version/{version_id}/domain/{domain_name} | Update a domain
135+
*DomainOwnershipsApi* | [**list_domain_ownerships**](docs/DomainOwnershipsApi.md#list_domain_ownerships) | **GET** /domain-ownerships | List domain-ownerships
131136
*EnabledProductsApi* | [**disable_product**](docs/EnabledProductsApi.md#disable_product) | **DELETE** /enabled-products/{product_id}/services/{service_id} | Disable a product
132137
*EnabledProductsApi* | [**enable_product**](docs/EnabledProductsApi.md#enable_product) | **PUT** /enabled-products/{product_id}/services/{service_id} | Enable a product
133138
*EnabledProductsApi* | [**get_enabled_product**](docs/EnabledProductsApi.md#get_enabled_product) | **GET** /enabled-products/{product_id}/services/{service_id} | Get enabled product
@@ -311,6 +316,14 @@ Class | Method | HTTP request | Description
311316
*MutualAuthenticationApi* | [**get_mutual_authentication**](docs/MutualAuthenticationApi.md#get_mutual_authentication) | **GET** /tls/mutual_authentications/{mutual_authentication_id} | Get a Mutual Authentication
312317
*MutualAuthenticationApi* | [**list_mutual_authentications**](docs/MutualAuthenticationApi.md#list_mutual_authentications) | **GET** /tls/mutual_authentications | List Mutual Authentications
313318
*MutualAuthenticationApi* | [**patch_mutual_authentication**](docs/MutualAuthenticationApi.md#patch_mutual_authentication) | **PATCH** /tls/mutual_authentications/{mutual_authentication_id} | Update a Mutual Authentication
319+
*ObjectStoreApi* | [**create_store**](docs/ObjectStoreApi.md#create_store) | **POST** /resources/stores/object | Create an object store.
320+
*ObjectStoreApi* | [**delete_store**](docs/ObjectStoreApi.md#delete_store) | **DELETE** /resources/stores/object/{store_id} | Delete an object store.
321+
*ObjectStoreApi* | [**get_store**](docs/ObjectStoreApi.md#get_store) | **GET** /resources/stores/object/{store_id} | Describe an object store.
322+
*ObjectStoreApi* | [**get_stores**](docs/ObjectStoreApi.md#get_stores) | **GET** /resources/stores/object | List object stores.
323+
*ObjectStoreItemApi* | [**delete_key_from_store**](docs/ObjectStoreItemApi.md#delete_key_from_store) | **DELETE** /resources/stores/object/{store_id}/keys/{key_name} | Delete object store item.
324+
*ObjectStoreItemApi* | [**get_keys**](docs/ObjectStoreItemApi.md#get_keys) | **GET** /resources/stores/object/{store_id}/keys | List object store keys.
325+
*ObjectStoreItemApi* | [**get_value_for_key**](docs/ObjectStoreItemApi.md#get_value_for_key) | **GET** /resources/stores/object/{store_id}/keys/{key_name} | Get the value of an object store item
326+
*ObjectStoreItemApi* | [**set_value_for_key**](docs/ObjectStoreItemApi.md#set_value_for_key) | **PUT** /resources/stores/object/{store_id}/keys/{key_name} | Insert an item into an object store
314327
*PackageApi* | [**get_package**](docs/PackageApi.md#get_package) | **GET** /service/{service_id}/version/{version_id}/package | Get details of the service's Compute@Edge package.
315328
*PackageApi* | [**put_package**](docs/PackageApi.md#put_package) | **PUT** /service/{service_id}/version/{version_id}/package | Upload a Compute@Edge package.
316329
*PoolApi* | [**create_server_pool**](docs/PoolApi.md#create_server_pool) | **POST** /service/{service_id}/version/{version_id}/pool | Create a server pool
@@ -335,11 +348,11 @@ Class | Method | HTTP request | Description
335348
*RequestSettingsApi* | [**get_request_settings**](docs/RequestSettingsApi.md#get_request_settings) | **GET** /service/{service_id}/version/{version_id}/request_settings/{request_settings_name} | Get a Request Settings object
336349
*RequestSettingsApi* | [**list_request_settings**](docs/RequestSettingsApi.md#list_request_settings) | **GET** /service/{service_id}/version/{version_id}/request_settings | List Request Settings objects
337350
*RequestSettingsApi* | [**update_request_settings**](docs/RequestSettingsApi.md#update_request_settings) | **PUT** /service/{service_id}/version/{version_id}/request_settings/{request_settings_name} | Update a Request Settings object
338-
*ResourceApi* | [**create_resource**](docs/ResourceApi.md#create_resource) | **POST** /service/{service_id}/version/{version_id}/resource | Create a resource
339-
*ResourceApi* | [**delete_resource**](docs/ResourceApi.md#delete_resource) | **DELETE** /service/{service_id}/version/{version_id}/resource/{resource_id} | Delete a resource
340-
*ResourceApi* | [**get_resource**](docs/ResourceApi.md#get_resource) | **GET** /service/{service_id}/version/{version_id}/resource/{resource_id} | Display a resource
341-
*ResourceApi* | [**list_resources**](docs/ResourceApi.md#list_resources) | **GET** /service/{service_id}/version/{version_id}/resource | List resources
342-
*ResourceApi* | [**update_resource**](docs/ResourceApi.md#update_resource) | **PUT** /service/{service_id}/version/{version_id}/resource/{resource_id} | Update a resource
351+
*ResourceApi* | [**create_resource**](docs/ResourceApi.md#create_resource) | **POST** /service/{service_id}/version/{version_id}/resource | Create a resource link
352+
*ResourceApi* | [**delete_resource**](docs/ResourceApi.md#delete_resource) | **DELETE** /service/{service_id}/version/{version_id}/resource/{id} | Delete a resource link
353+
*ResourceApi* | [**get_resource**](docs/ResourceApi.md#get_resource) | **GET** /service/{service_id}/version/{version_id}/resource/{id} | Display a resource link
354+
*ResourceApi* | [**list_resources**](docs/ResourceApi.md#list_resources) | **GET** /service/{service_id}/version/{version_id}/resource | List resource links
355+
*ResourceApi* | [**update_resource**](docs/ResourceApi.md#update_resource) | **PUT** /service/{service_id}/version/{version_id}/resource/{id} | Update a resource link
343356
*ResponseObjectApi* | [**delete_response_object**](docs/ResponseObjectApi.md#delete_response_object) | **DELETE** /service/{service_id}/version/{version_id}/response_object/{response_object_name} | Delete a Response Object
344357
*ResponseObjectApi* | [**get_response_object**](docs/ResponseObjectApi.md#get_response_object) | **GET** /service/{service_id}/version/{version_id}/response_object/{response_object_name} | Get a Response object
345358
*ResponseObjectApi* | [**list_response_objects**](docs/ResponseObjectApi.md#list_response_objects) | **GET** /service/{service_id}/version/{version_id}/response_object | List Response objects
@@ -477,14 +490,19 @@ The fastly-perl API client currently does not support the following endpoints:
477490
- [`/metrics/domains/services/{service_id}`](https://developer.fastly.com/reference/api/metrics-stats/domain-inspector/historical) (GET)
478491
- [`/metrics/origins/services/{service_id}`](https://developer.fastly.com/reference/api/metrics-stats/origin-inspector/historical) (GET)
479492
- [`/rate-limiters/{rate_limiter_id}`](https://developer.fastly.com/reference/api/vcl-services/rate-limiter) (PUT)
480-
- [`/resources/stores/object/{store_id}/keys/{key_name}`](https://developer.fastly.com/reference/api/) (DELETE, GET, PUT)
481-
- [`/resources/stores/object/{store_id}/keys`](https://developer.fastly.com/reference/api/) (GET)
482-
- [`/resources/stores/object/{store_id}`](https://developer.fastly.com/reference/api/) (DELETE, GET)
483-
- [`/resources/stores/object`](https://developer.fastly.com/reference/api/) (GET, POST)
484-
- [`/resources/stores/secret/{store_id}/secrets/{secret_name}`](https://developer.fastly.com/reference/api/) (DELETE, GET)
485-
- [`/resources/stores/secret/{store_id}/secrets`](https://developer.fastly.com/reference/api/) (GET, POST)
486-
- [`/resources/stores/secret/{store_id}`](https://developer.fastly.com/reference/api/) (DELETE, GET)
487-
- [`/resources/stores/secret`](https://developer.fastly.com/reference/api/) (GET, POST)
493+
- [`/resources/stores/config/{config_store_id}/info`](https://developer.fastly.com/reference/api/services/resources/config-store) (GET)
494+
- [`/resources/stores/config/{config_store_id}/item/{config_store_item_key}`](https://developer.fastly.com/reference/api/services/resources/config-store-item) (DELETE, GET, PATCH, PUT)
495+
- [`/resources/stores/config/{config_store_id}/item`](https://developer.fastly.com/reference/api/services/resources/config-store-item) (POST)
496+
- [`/resources/stores/config/{config_store_id}/items`](https://developer.fastly.com/reference/api/services/resources/config-store-item) (GET, PATCH)
497+
- [`/resources/stores/config/{config_store_id}/services`](https://developer.fastly.com/reference/api/services/resources/config-store) (GET)
498+
- [`/resources/stores/config/{config_store_id}`](https://developer.fastly.com/reference/api/services/resources/config-store) (DELETE, GET, PUT)
499+
- [`/resources/stores/config`](https://developer.fastly.com/reference/api/services/resources/config-store) (GET, POST)
500+
- [`/resources/stores/secret/client-key`](https://developer.fastly.com/reference/api/services/resources/secret-store) (POST)
501+
- [`/resources/stores/secret/signing-key`](https://developer.fastly.com/reference/api/services/resources/secret-store) (GET)
502+
- [`/resources/stores/secret/{store_id}/secrets/{secret_name}`](https://developer.fastly.com/reference/api/services/resources/secret) (DELETE, GET)
503+
- [`/resources/stores/secret/{store_id}/secrets`](https://developer.fastly.com/reference/api/services/resources/secret) (GET, POST)
504+
- [`/resources/stores/secret/{store_id}`](https://developer.fastly.com/reference/api/services/resources/secret-store) (DELETE, GET)
505+
- [`/resources/stores/secret`](https://developer.fastly.com/reference/api/services/resources/secret-store) (GET, POST)
488506
- [`/roles/{role_id}/permissions`](https://developer.fastly.com/reference/api/account/roles) (DELETE, POST)
489507
- [`/roles/{role_id}`](https://developer.fastly.com/reference/api/account/roles) (PATCH)
490508
- [`/roles`](https://developer.fastly.com/reference/api/account/roles) (POST)

‎bin/autodoc

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
#!/usr/bin/perl
2+
use FindBin;
3+
use File::Spec;
4+
use lib File::Spec->catdir($FindBin::Bin, '..', 'lib');
5+
6+
use Moose::Util qw(apply_all_roles);
7+
use Getopt::Std;
8+
9+
my %options=();
10+
getopts("wnphmHc:", \%options);
11+
help if $options{h};
12+
13+
my $my_app = $options{c} || 'My::App';
14+
15+
if ($options{c}) {
16+
eval <<LOAD;
17+
use $my_app;
18+
apply_all_roles($my_app, "WebService::Fastly::Role::AutoDoc");
19+
LOAD
20+
die $@ if $@;
21+
}
22+
else {
23+
package My::App;
24+
use Moose;
25+
with ('WebService::Fastly::Role', 'WebService::Fastly::Role::AutoDoc');
26+
}
27+
28+
package main;
29+
30+
my $opt;
31+
$opt = 'wide' if $options{w};
32+
$opt = 'narrow' if $options{n};
33+
34+
$opt = 'pod' if $options{p};
35+
$opt = 'pod' if $options{H};
36+
$opt = 'pod' if $options{m};
37+
38+
$opt ||= 'wide';
39+
40+
my $api = $my_app->new;
41+
42+
if ($options{H}) {
43+
my $pod2html = "pod2html --backlink --css http://st.pimg.net/tucs/style.css?3";
44+
open STDOUT, "| $pod2html" or die "Can't fork: $!";
45+
$api->autodoc($opt);
46+
close STDOUT or die "Can't close: $!";
47+
}
48+
elsif ($options{m}) {
49+
my $pod2markdown = "pod2markdown --html-encode-chars 1";
50+
open STDOUT, "| $pod2markdown" or die "Can't fork: $!";
51+
$api->autodoc($opt);
52+
close STDOUT or die "Can't close: $!";
53+
}
54+
else {
55+
$api->autodoc($opt);
56+
}
57+
58+
exit(0);
59+
60+
# --------------------
61+
sub help {
62+
print <<HELP;
63+
Usage: autodoc [OPTION] [-c My::App::Class]
64+
65+
-w wide format (default)
66+
-n narrow format
67+
-p POD format
68+
-H HTML format
69+
-m Markdown format
70+
-h print this help message
71+
-c your application class
72+
73+
HELP
74+
75+
exit(0);
76+
}

‎docs/Backend.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Name | Type | Description | Notes
1919
**hostname** | **string** | The hostname of the backend. May be used as an alternative to `address` to set the backend location. | [optional]
2020
**ipv4** | **string** | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional]
2121
**ipv6** | **string** | IPv6 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional]
22-
**keepalive_time** | **int** | How long to keep a persistent connection to the backend between requests. | [optional]
22+
**keepalive_time** | **int** | How long in seconds to keep a persistent connection to the backend between requests. | [optional]
2323
**max_conn** | **int** | Maximum number of concurrent connections this backend will accept. | [optional]
2424
**max_tls_version** | **string** | Maximum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional]
2525
**min_tls_version** | **string** | Minimum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional]

‎docs/BackendApi.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ my $healthcheck = "healthcheck_example"; # string | The name of the healthcheck
4848
my $hostname = "hostname_example"; # string | The hostname of the backend. May be used as an alternative to `address` to set the backend location.
4949
my $ipv4 = "ipv4_example"; # string | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.
5050
my $ipv6 = "ipv6_example"; # string | IPv6 address of the backend. May be used as an alternative to `address` to set the backend location.
51-
my $keepalive_time = 56; # int | How long to keep a persistent connection to the backend between requests.
51+
my $keepalive_time = 56; # int | How long in seconds to keep a persistent connection to the backend between requests.
5252
my $max_conn = 56; # int | Maximum number of concurrent connections this backend will accept.
5353
my $max_tls_version = "max_tls_version_example"; # string | Maximum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated.
5454
my $min_tls_version = "min_tls_version_example"; # string | Minimum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated.
@@ -94,7 +94,7 @@ Name | Type | Description | Notes
9494
**hostname** | **string**| The hostname of the backend. May be used as an alternative to `address` to set the backend location. | [optional]
9595
**ipv4** | **string**| IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional]
9696
**ipv6** | **string**| IPv6 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional]
97-
**keepalive_time** | **int**| How long to keep a persistent connection to the backend between requests. | [optional]
97+
**keepalive_time** | **int**| How long in seconds to keep a persistent connection to the backend between requests. | [optional]
9898
**max_conn** | **int**| Maximum number of concurrent connections this backend will accept. | [optional]
9999
**max_tls_version** | **string**| Maximum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional]
100100
**min_tls_version** | **string**| Minimum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional]
@@ -325,7 +325,7 @@ my $healthcheck = "healthcheck_example"; # string | The name of the healthcheck
325325
my $hostname = "hostname_example"; # string | The hostname of the backend. May be used as an alternative to `address` to set the backend location.
326326
my $ipv4 = "ipv4_example"; # string | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.
327327
my $ipv6 = "ipv6_example"; # string | IPv6 address of the backend. May be used as an alternative to `address` to set the backend location.
328-
my $keepalive_time = 56; # int | How long to keep a persistent connection to the backend between requests.
328+
my $keepalive_time = 56; # int | How long in seconds to keep a persistent connection to the backend between requests.
329329
my $max_conn = 56; # int | Maximum number of concurrent connections this backend will accept.
330330
my $max_tls_version = "max_tls_version_example"; # string | Maximum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated.
331331
my $min_tls_version = "min_tls_version_example"; # string | Minimum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated.
@@ -372,7 +372,7 @@ Name | Type | Description | Notes
372372
**hostname** | **string**| The hostname of the backend. May be used as an alternative to `address` to set the backend location. | [optional]
373373
**ipv4** | **string**| IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional]
374374
**ipv6** | **string**| IPv6 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional]
375-
**keepalive_time** | **int**| How long to keep a persistent connection to the backend between requests. | [optional]
375+
**keepalive_time** | **int**| How long in seconds to keep a persistent connection to the backend between requests. | [optional]
376376
**max_conn** | **int**| Maximum number of concurrent connections this backend will accept. | [optional]
377377
**max_tls_version** | **string**| Maximum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional]
378378
**min_tls_version** | **string**| Minimum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional]

0 commit comments

Comments
 (0)