Skip to content

Commit

Permalink
update configuration examples
Browse files Browse the repository at this point in the history
  • Loading branch information
doramatadora committed Jun 28, 2021
1 parent 7ca5375 commit 570a7cf
Show file tree
Hide file tree
Showing 29 changed files with 378 additions and 2,563 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ require_once('/path/to/project/vendor/autoload.php');
require_once(__DIR__ . '/vendor/autoload.php');

// Authorize the client with a Fastly API token
$config = Fastly\Configuration::getDefaultConfiguration()->setApiToken('Fastly-Key', 'YOUR_API_TOKEN');
$config = Fastly\Configuration::getDefaultConfiguration()->setApiToken('YOUR_API_TOKEN');

$apiInstance = new Fastly\Api\(
// Optionally, pass a custom client that implements `GuzzleHttp\ClientInterface`.
Expand All @@ -62,7 +62,7 @@ try {
The Fastly API requires an [API token](https://developer.fastly.com/reference/api/#authentication) for most operations. Set it in the PHP client by using the `setApiToken` method of a configuration as shown:

```php
Fastly\Configuration::getDefaultConfiguration()->setApiToken('Fastly-Key', 'YOUR_API_TOKEN');
Fastly\Configuration::getDefaultConfiguration()->setApiToken('YOUR_API_TOKEN');
```


Expand Down
2 changes: 1 addition & 1 deletion docs/Api/DirectorApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**service_id** | **string** | |
**version_id** | **int** | |
**backends** | [**\Fastly\Model\SchemasBackend[]**](../Model/\Fastly\Model\SchemasBackend.md) | List of backends associated to a director. | [optional]
**backends** | [**\Fastly\Model\Backend[]**](../Model/\Fastly\Model\Backend.md) | List of backends associated to a director. | [optional]
**capacity** | **int** | Unused. | [optional]
**comment** | **string** | A freeform descriptive note. | [optional]
**name** | **string** | Name for the Director. | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/Model/Director.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**backends** | [**\Fastly\Model\SchemasBackend[]**](SchemasBackend.md) | List of backends associated to a director. | [optional]
**backends** | [**\Fastly\Model\Backend[]**](Backend.md) | List of backends associated to a director. | [optional]
**capacity** | **int** | Unused. | [optional]
**comment** | **string** | A freeform descriptive note. | [optional]
**name** | **string** | Name for the Director. | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/Model/DirectorResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**backends** | [**\Fastly\Model\SchemasBackend[]**](SchemasBackend.md) | List of backends associated to a director. | [optional]
**backends** | [**\Fastly\Model\Backend[]**](Backend.md) | List of backends associated to a director. | [optional]
**capacity** | **int** | Unused. | [optional]
**comment** | **string** | A freeform descriptive note. | [optional]
**name** | **string** | Name for the Director. | [optional]
Expand Down
4 changes: 2 additions & 2 deletions docs/Model/NestedVersion.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ Name | Type | Description | Notes
**backends** | [**\Fastly\Model\BackendResponse[]**](BackendResponse.md) | List of backends associated to this service. | [optional]
**cache_settings** | [**\Fastly\Model\CacheSettingResponse[]**](CacheSettingResponse.md) | List of cache settings associated to this service. | [optional]
**conditions** | [**\Fastly\Model\ConditionResponse[]**](ConditionResponse.md) | List of conditions associated to this service. | [optional]
**directors** | [**\Fastly\Model\SchemasDirector[]**](SchemasDirector.md) | List of directors associated to this service. | [optional]
**directors** | [**\Fastly\Model\Director[]**](Director.md) | List of directors associated to this service. | [optional]
**domains** | [**\Fastly\Model\DomainResponse[]**](DomainResponse.md) | List of domains associated to this service. | [optional]
**gzips** | [**\Fastly\Model\SchemasGzipResponse[]**](SchemasGzipResponse.md) | List of gzip rules associated to this service. | [optional]
**headers** | [**\Fastly\Model\SchemasHeaderResponse[]**](SchemasHeaderResponse.md) | List of headers associated to this service. | [optional]
**healthchecks** | [**\Fastly\Model\HealthcheckResponse[]**](HealthcheckResponse.md) | List of healthchecks associated to this service. | [optional]
**request_settings** | [**\Fastly\Model\RequestSettingsResponse[]**](RequestSettingsResponse.md) | List of request settings for this service. | [optional]
**response_objects** | [**\Fastly\Model\ResponseObjectResponse[]**](ResponseObjectResponse.md) | List of response objects for this service. | [optional]
**settings** | [**Settings**](Settings.md) | | [optional]
**snippets** | [**\Fastly\Model\SchemasSnippetResponse[]**](SchemasSnippetResponse.md) | List of VCL snippets for this service. | [optional]
**snippets** | [**\Fastly\Model\SnippetResponse[]**](SnippetResponse.md) | List of VCL snippets for this service. | [optional]
**vcls** | [**\Fastly\Model\SchemasVclResponse[]**](SchemasVclResponse.md) | List of VCL files for this service. | [optional]
**wordpress** | **object[]** | A list of Wordpress rules with this service. | [optional]

Expand Down
37 changes: 0 additions & 37 deletions docs/Model/SchemasBackend.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/Model/SchemasDirector.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/Model/SchemasSnippetResponse.md

This file was deleted.

9 changes: 9 additions & 0 deletions docs/Model/SchemasWafActiveRule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# # SchemasWafActiveRule

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**\Fastly\Model\WafActiveRuleData**](WafActiveRuleData.md) | | [optional]

[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
4 changes: 2 additions & 2 deletions docs/Model/VersionDetail.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ Name | Type | Description | Notes
**backends** | [**\Fastly\Model\BackendResponse[]**](BackendResponse.md) | List of backends associated to this service. | [optional]
**cache_settings** | [**\Fastly\Model\CacheSettingResponse[]**](CacheSettingResponse.md) | List of cache settings associated to this service. | [optional]
**conditions** | [**\Fastly\Model\ConditionResponse[]**](ConditionResponse.md) | List of conditions associated to this service. | [optional]
**directors** | [**\Fastly\Model\SchemasDirector[]**](SchemasDirector.md) | List of directors associated to this service. | [optional]
**directors** | [**\Fastly\Model\Director[]**](Director.md) | List of directors associated to this service. | [optional]
**domains** | [**\Fastly\Model\DomainResponse[]**](DomainResponse.md) | List of domains associated to this service. | [optional]
**gzips** | [**\Fastly\Model\SchemasGzipResponse[]**](SchemasGzipResponse.md) | List of gzip rules associated to this service. | [optional]
**headers** | [**\Fastly\Model\SchemasHeaderResponse[]**](SchemasHeaderResponse.md) | List of headers associated to this service. | [optional]
**healthchecks** | [**\Fastly\Model\HealthcheckResponse[]**](HealthcheckResponse.md) | List of healthchecks associated to this service. | [optional]
**request_settings** | [**\Fastly\Model\RequestSettingsResponse[]**](RequestSettingsResponse.md) | List of request settings for this service. | [optional]
**response_objects** | [**\Fastly\Model\ResponseObjectResponse[]**](ResponseObjectResponse.md) | List of response objects for this service. | [optional]
**settings** | [**Settings**](Settings.md) | | [optional]
**snippets** | [**\Fastly\Model\SchemasSnippetResponse[]**](SchemasSnippetResponse.md) | List of VCL snippets for this service. | [optional]
**snippets** | [**\Fastly\Model\SnippetResponse[]**](SnippetResponse.md) | List of VCL snippets for this service. | [optional]
**vcls** | [**\Fastly\Model\SchemasVclResponse[]**](SchemasVclResponse.md) | List of VCL files for this service. | [optional]
**wordpress** | **object[]** | A list of Wordpress rules with this service. | [optional]

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/WafActiveRulesResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ Name | Type | Description | Notes
**links** | [**\Fastly\Model\PaginationLinks**](PaginationLinks.md) | | [optional]
**meta** | [**\Fastly\Model\PaginationMeta**](PaginationMeta.md) | | [optional]
**data** | [**\Fastly\Model\Data[]**](Data.md) | | [optional]
**included** | [**AnyOfSchemasWafFirewallVersionWafRuleRevision[]**](AnyOfSchemasWafFirewallVersionWafRuleRevision.md) | | [optional]
**included** | [**AnyOfWafFirewallVersionWafRuleRevision[]**](AnyOfWafFirewallVersionWafRuleRevision.md) | | [optional]

[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
2 changes: 1 addition & 1 deletion docs/Model/WafActiveRulesResponseAllOf.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**\Fastly\Model\Data[]**](Data.md) | | [optional]
**included** | [**AnyOfSchemasWafFirewallVersionWafRuleRevision[]**](AnyOfSchemasWafFirewallVersionWafRuleRevision.md) | | [optional]
**included** | [**AnyOfWafFirewallVersionWafRuleRevision[]**](AnyOfWafFirewallVersionWafRuleRevision.md) | | [optional]

[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
2 changes: 1 addition & 1 deletion docs/Model/WafFirewallVersionResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**Data**](Data.md) | | [optional]
**included** | [**AnyOfWafFirewallVersionWafActiveRule[]**](AnyOfWafFirewallVersionWafActiveRule.md) | | [optional]
**included** | [**AnyOfWafFirewallVersionSchemasWafActiveRule[]**](AnyOfWafFirewallVersionSchemasWafActiveRule.md) | | [optional]

[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
2 changes: 1 addition & 1 deletion docs/Model/WafFirewallVersionsResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ Name | Type | Description | Notes
**links** | [**\Fastly\Model\PaginationLinks**](PaginationLinks.md) | | [optional]
**meta** | [**\Fastly\Model\PaginationMeta**](PaginationMeta.md) | | [optional]
**data** | [**\Fastly\Model\Data[]**](Data.md) | | [optional]
**included** | [**AnyOfWafFirewallVersionWafActiveRule[]**](AnyOfWafFirewallVersionWafActiveRule.md) | | [optional]
**included** | [**AnyOfWafFirewallVersionSchemasWafActiveRule[]**](AnyOfWafFirewallVersionSchemasWafActiveRule.md) | | [optional]

[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
2 changes: 1 addition & 1 deletion docs/Model/WafFirewallVersionsResponseAllOf.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**\Fastly\Model\Data[]**](Data.md) | | [optional]
**included** | [**AnyOfWafFirewallVersionWafActiveRule[]**](AnyOfWafFirewallVersionWafActiveRule.md) | | [optional]
**included** | [**AnyOfWafFirewallVersionSchemasWafActiveRule[]**](AnyOfWafFirewallVersionSchemasWafActiveRule.md) | | [optional]

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

0 comments on commit 570a7cf

Please sign in to comment.