docs/ObjectStoreApi.md in fastly-4.1.0 vs docs/ObjectStoreApi.md in fastly-4.2.0

- old
+ new

@@ -9,17 +9,13 @@ ## Methods | Method | HTTP request | Description | | ------ | ------------ | ----------- | | [**create_store**](ObjectStoreApi.md#create_store) | **POST** /resources/stores/object | Create an object store. | -| [**delete_key_from_store**](ObjectStoreApi.md#delete_key_from_store) | **DELETE** /resources/stores/object/{store_id}/keys/{key_name} | Delete object store key. | | [**delete_store**](ObjectStoreApi.md#delete_store) | **DELETE** /resources/stores/object/{store_id} | Delete an object store. | -| [**get_keys**](ObjectStoreApi.md#get_keys) | **GET** /resources/stores/object/{store_id}/keys | List object store keys. | | [**get_store**](ObjectStoreApi.md#get_store) | **GET** /resources/stores/object/{store_id} | Describe an object store. | | [**get_stores**](ObjectStoreApi.md#get_stores) | **GET** /resources/stores/object | List object stores. | -| [**get_value_for_key**](ObjectStoreApi.md#get_value_for_key) | **GET** /resources/stores/object/{store_id}/keys/{key_name} | Get object store key value. | -| [**set_value_for_key**](ObjectStoreApi.md#set_value_for_key) | **PUT** /resources/stores/object/{store_id}/keys/{key_name} | Insert object store key-value. | ## `create_store()` ```ruby @@ -55,55 +51,17 @@ [**StoreResponse**](StoreResponse.md) [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) -## `delete_key_from_store()` - -```ruby -delete_key_from_store(opts) # Delete object store key. -``` - -Delete a key from a customer store. - -### Examples - -```ruby -api_instance = Fastly::ObjectStoreApi.new -opts = { - store_id: 'store_id_example', # String | - key_name: 'key_name_example', # String | -} - -begin - # Delete object store key. - api_instance.delete_key_from_store(opts) -rescue Fastly::ApiError => e - puts "Error when calling ObjectStoreApi->delete_key_from_store: #{e}" -end -``` - -### Options - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **store_id** | **String** | | | -| **key_name** | **String** | | | - -### Return type - -nil (empty response body) - -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to README]](../../README.md) ## `delete_store()` ```ruby delete_store(opts) # Delete an object store. ``` -An object store must be empty before it can be deleted. Deleting an object store that still contains keys will result in a 409 Conflict. +An object store must be empty before it can be deleted. Deleting an object store that still contains keys will result in a `409` (Conflict). ### Examples ```ruby api_instance = Fastly::ObjectStoreApi.new @@ -129,51 +87,10 @@ nil (empty response body) [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) -## `get_keys()` - -```ruby -get_keys(opts): <KeyResponse> # List object store keys. -``` - -List all keys within an object store. - -### Examples - -```ruby -api_instance = Fastly::ObjectStoreApi.new -opts = { - store_id: 'store_id_example', # String | - cursor: 'cursor_example', # String | - limit: 56, # Integer | -} - -begin - # List object store keys. - result = api_instance.get_keys(opts) - p result -rescue Fastly::ApiError => e - puts "Error when calling ObjectStoreApi->get_keys: #{e}" -end -``` - -### Options - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **store_id** | **String** | | | -| **cursor** | **String** | | [optional] | -| **limit** | **Integer** | | [optional][default to 100] | - -### Return type - -[**KeyResponse**](KeyResponse.md) - -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to README]](../../README.md) ## `get_store()` ```ruby get_store(opts): <StoreResponse> # Describe an object store. ``` @@ -210,11 +127,11 @@ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) ## `get_stores()` ```ruby -get_stores(opts): <GetStoresResponse> # List object stores. +get_stores(opts): <InlineResponse2002> # List object stores. ``` Get all stores for a given customer. ### Examples @@ -242,89 +159,9 @@ | **cursor** | **String** | | [optional] | | **limit** | **Integer** | | [optional][default to 100] | ### Return type -[**GetStoresResponse**](GetStoresResponse.md) - -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to README]](../../README.md) -## `get_value_for_key()` - -```ruby -get_value_for_key(opts): File # Get object store key value. -``` - -Get the value associated with a key. - -### Examples - -```ruby -api_instance = Fastly::ObjectStoreApi.new -opts = { - store_id: 'store_id_example', # String | - key_name: 'key_name_example', # String | -} - -begin - # Get object store key value. - result = api_instance.get_value_for_key(opts) - p result -rescue Fastly::ApiError => e - puts "Error when calling ObjectStoreApi->get_value_for_key: #{e}" -end -``` - -### Options - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **store_id** | **String** | | | -| **key_name** | **String** | | | - -### Return type - -**File** - -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to README]](../../README.md) -## `set_value_for_key()` - -```ruby -set_value_for_key(opts): File # Insert object store key-value. -``` - -Insert a new key-value pair into an object store. - -### Examples - -```ruby -api_instance = Fastly::ObjectStoreApi.new -opts = { - store_id: 'store_id_example', # String | - key_name: 'key_name_example', # String | - body: File.new('/path/to/some/file'), # File | -} - -begin - # Insert object store key-value. - result = api_instance.set_value_for_key(opts) - p result -rescue Fastly::ApiError => e - puts "Error when calling ObjectStoreApi->set_value_for_key: #{e}" -end -``` - -### Options - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **store_id** | **String** | | | -| **key_name** | **String** | | | -| **body** | **File** | | [optional] | - -### Return type - -**File** +[**InlineResponse2002**](InlineResponse2002.md) [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)