docs/PurgeApi.md in fastly-4.0.0.alpha4 vs docs/PurgeApi.md in fastly-4.0.0
- old
+ new
@@ -10,11 +10,11 @@
| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
| [**bulk_purge_tag**](PurgeApi.md#bulk_purge_tag) | **POST** /service/{service_id}/purge | Purge multiple surrogate key tags |
| [**purge_all**](PurgeApi.md#purge_all) | **POST** /service/{service_id}/purge_all | Purge everything from a service |
-| [**purge_single_url**](PurgeApi.md#purge_single_url) | **GET** /* | Purge a URL |
+| [**purge_single_url**](PurgeApi.md#purge_single_url) | **POST** /purge/{cached_url} | Purge a URL |
| [**purge_tag**](PurgeApi.md#purge_tag) | **POST** /service/{service_id}/purge/{surrogate_key} | Purge by surrogate key tag |
## `bulk_purge_tag()`
@@ -28,11 +28,11 @@
```ruby
api_instance = Fastly::PurgeApi.new
opts = {
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
- fastly_soft_purge: 1, # Integer | Optional header indicating that the operation should be a 'soft' purge, which marks the affected object as stale rather than making it inaccessible.
+ fastly_soft_purge: 1, # Integer | If present, this header triggers the purge to be 'soft', which marks the affected object as stale rather than making it inaccessible. Typically set to \"1\" when used, but the value is not important.
surrogate_key: 'key_1 key_2 key_3', # String | Purge multiple surrogate key tags using a request header. Not required if a JSON POST body is specified.
purge_response: Fastly::PurgeResponse.new, # PurgeResponse |
}
begin
@@ -46,11 +46,11 @@
### Options
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
-| **fastly_soft_purge** | **Integer** | Optional header indicating that the operation should be a 'soft' purge, which marks the affected object as stale rather than making it inaccessible. | [optional][default to 1] |
+| **fastly_soft_purge** | **Integer** | If present, this header triggers the purge to be 'soft', which marks the affected object as stale rather than making it inaccessible. Typically set to \"1\" when used, but the value is not important. | [optional] |
| **service_id** | **String** | Alphanumeric string identifying the service. | |
| **surrogate_key** | **String** | Purge multiple surrogate key tags using a request header. Not required if a JSON POST body is specified. | [optional] |
| **purge_response** | [**PurgeResponse**](PurgeResponse.md) | | [optional] |
### Return type
@@ -107,12 +107,12 @@
### Examples
```ruby
api_instance = Fastly::PurgeApi.new
opts = {
- host: 'www.example.com', # String | The hostname for the content you'll be purging.
- fastly_soft_purge: 1, # Integer | Optional header indicating that the operation should be a 'soft' purge, which marks the affected object as stale rather than making it inaccessible.
+ cached_url: 'www.example.com/path/to/object-to-purge', # String | URL of object in cache to be purged.
+ fastly_soft_purge: 1, # Integer | If present, this header triggers the purge to be 'soft', which marks the affected object as stale rather than making it inaccessible. Typically set to \"1\" when used, but the value is not important.
}
begin
# Purge a URL
result = api_instance.purge_single_url(opts)
@@ -124,12 +124,12 @@
### Options
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
-| **fastly_soft_purge** | **Integer** | Optional header indicating that the operation should be a 'soft' purge, which marks the affected object as stale rather than making it inaccessible. | [optional][default to 1] |
-| **host** | **String** | The hostname for the content you'll be purging. | |
+| **fastly_soft_purge** | **Integer** | If present, this header triggers the purge to be 'soft', which marks the affected object as stale rather than making it inaccessible. Typically set to \"1\" when used, but the value is not important. | [optional] |
+| **cached_url** | **String** | URL of object in cache to be purged. | |
### Return type
[**PurgeResponse**](PurgeResponse.md)
@@ -148,11 +148,11 @@
```ruby
api_instance = Fastly::PurgeApi.new
opts = {
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
surrogate_key: 'key_1', # String | Surrogate keys are used to efficiently purge content from cache. Instead of purging your entire site or individual URLs, you can tag related assets (like all images and descriptions associated with a single product) with surrogate keys, and these grouped URLs can be purged in a single request.
- fastly_soft_purge: 1, # Integer | Optional header indicating that the operation should be a 'soft' purge, which marks the affected object as stale rather than making it inaccessible.
+ fastly_soft_purge: 1, # Integer | If present, this header triggers the purge to be 'soft', which marks the affected object as stale rather than making it inaccessible. Typically set to \"1\" when used, but the value is not important.
}
begin
# Purge by surrogate key tag
result = api_instance.purge_tag(opts)
@@ -166,10 +166,10 @@
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **service_id** | **String** | Alphanumeric string identifying the service. | |
| **surrogate_key** | **String** | Surrogate keys are used to efficiently purge content from cache. Instead of purging your entire site or individual URLs, you can tag related assets (like all images and descriptions associated with a single product) with surrogate keys, and these grouped URLs can be purged in a single request. | |
-| **fastly_soft_purge** | **Integer** | Optional header indicating that the operation should be a 'soft' purge, which marks the affected object as stale rather than making it inaccessible. | [optional][default to 1] |
+| **fastly_soft_purge** | **Integer** | If present, this header triggers the purge to be 'soft', which marks the affected object as stale rather than making it inaccessible. Typically set to \"1\" when used, but the value is not important. | [optional] |
### Return type
[**PurgeResponse**](PurgeResponse.md)