fastly 4.1.0 → 4.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +37 -0
  3. data/Gemfile.lock +1 -1
  4. data/README.md +93 -11
  5. data/docs/Backend.md +1 -1
  6. data/docs/BackendApi.md +4 -4
  7. data/docs/BackendResponse.md +1 -1
  8. data/docs/DomainOwnershipsApi.md +47 -0
  9. data/docs/EnabledProductResponse.md +12 -0
  10. data/docs/EnabledProductResponseLinks.md +11 -0
  11. data/docs/{EnabledProductProduct.md → EnabledProductResponseProduct.md} +3 -3
  12. data/docs/EnabledProductResponseService.md +11 -0
  13. data/docs/EnabledProductsApi.md +7 -7
  14. data/docs/EventsApi.md +2 -0
  15. data/docs/HistoricalApi.md +10 -10
  16. data/docs/{EnabledProductLinks.md → InlineResponse2002.md} +2 -3
  17. data/docs/{GetStoresResponse.md → InlineResponse2003.md} +2 -2
  18. data/docs/{GetStoresResponseMeta.md → InlineResponse2003Meta.md} +1 -1
  19. data/docs/{KeyResponse.md → InlineResponse2004.md} +2 -2
  20. data/docs/{ResourceCreateAllOf.md → InlineResponse2004Meta.md} +3 -2
  21. data/docs/ObjectStoreApi.md +3 -166
  22. data/docs/ObjectStoreItemApi.md +177 -0
  23. data/docs/Pop.md +7 -4
  24. data/docs/PopCoordinates.md +2 -4
  25. data/docs/RealtimeMeasurements.md +10 -2
  26. data/docs/Resource.md +2 -1
  27. data/docs/ResourceApi.md +34 -32
  28. data/docs/ResourceResponse.md +3 -3
  29. data/docs/ResourceResponseAllOf.md +1 -1
  30. data/docs/Results.md +11 -3
  31. data/docs/TlsSubscriptionResponseAttributes.md +1 -1
  32. data/docs/TlsSubscriptionResponseAttributesAllOf.md +1 -1
  33. data/docs/TlsSubscriptionsApi.md +3 -3
  34. data/lib/fastly/api/backend_api.rb +4 -4
  35. data/lib/fastly/api/domain_ownerships_api.rb +76 -0
  36. data/lib/fastly/api/enabled_products_api.rb +12 -12
  37. data/lib/fastly/api/events_api.rb +3 -0
  38. data/lib/fastly/api/historical_api.rb +10 -10
  39. data/lib/fastly/api/object_store_api.rb +5 -289
  40. data/lib/fastly/api/object_store_item_api.rb +304 -0
  41. data/lib/fastly/api/purge_api.rb +2 -2
  42. data/lib/fastly/api/resource_api.rb +51 -48
  43. data/lib/fastly/api/tls_subscriptions_api.rb +4 -4
  44. data/lib/fastly/models/backend.rb +1 -1
  45. data/lib/fastly/models/backend_response.rb +1 -1
  46. data/lib/fastly/models/{enabled_product.rb → enabled_product_response.rb} +6 -6
  47. data/lib/fastly/models/{enabled_product_links.rb → enabled_product_response_links.rb} +5 -3
  48. data/lib/fastly/models/{enabled_product_product.rb → enabled_product_response_product.rb} +5 -3
  49. data/lib/fastly/models/enabled_product_response_service.rb +227 -0
  50. data/lib/fastly/models/{resource_create_all_of.rb → inline_response2002.rb} +11 -11
  51. data/lib/fastly/models/{get_stores_response.rb → inline_response2003.rb} +4 -4
  52. data/lib/fastly/models/{get_stores_response_meta.rb → inline_response2003_meta.rb} +3 -3
  53. data/lib/fastly/models/{key_response.rb → inline_response2004.rb} +4 -4
  54. data/lib/fastly/models/inline_response2004_meta.rb +225 -0
  55. data/lib/fastly/models/pop.rb +121 -1
  56. data/lib/fastly/models/pop_coordinates.rb +12 -19
  57. data/lib/fastly/models/realtime_measurements.rb +86 -6
  58. data/lib/fastly/models/resource.rb +12 -2
  59. data/lib/fastly/models/resource_response.rb +23 -23
  60. data/lib/fastly/models/resource_response_all_of.rb +1 -1
  61. data/lib/fastly/models/results.rb +87 -7
  62. data/lib/fastly/models/tls_subscription_response_attributes.rb +2 -2
  63. data/lib/fastly/models/tls_subscription_response_attributes_all_of.rb +2 -2
  64. data/lib/fastly/models/type_resource.rb +2 -0
  65. data/lib/fastly/version.rb +1 -1
  66. data/lib/fastly.rb +11 -8
  67. data/sig.json +1 -1
  68. metadata +24 -18
  69. data/docs/EnabledProduct.md +0 -12
  70. data/docs/ResourceCreate.md +0 -11
  71. data/lib/fastly/models/resource_create.rb +0 -235
@@ -1,10 +1,11 @@
1
- # Fastly::ResourceCreateAllOf
1
+ # Fastly::InlineResponse2004Meta
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **resource_id** | **String** | The ID of the linked resource. | [optional] |
7
+ | **next_cursor** | **String** | | [optional] |
8
+ | **limit** | **Integer** | | [optional] |
8
9
 
9
10
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10
11
 
@@ -11,13 +11,9 @@ api_instance = Fastly::ObjectStoreApi.new
11
11
  | Method | HTTP request | Description |
12
12
  | ------ | ------------ | ----------- |
13
13
  | [**create_store**](ObjectStoreApi.md#create_store) | **POST** /resources/stores/object | Create an object store. |
14
- | [**delete_key_from_store**](ObjectStoreApi.md#delete_key_from_store) | **DELETE** /resources/stores/object/{store_id}/keys/{key_name} | Delete object store key. |
15
14
  | [**delete_store**](ObjectStoreApi.md#delete_store) | **DELETE** /resources/stores/object/{store_id} | Delete an object store. |
16
- | [**get_keys**](ObjectStoreApi.md#get_keys) | **GET** /resources/stores/object/{store_id}/keys | List object store keys. |
17
15
  | [**get_store**](ObjectStoreApi.md#get_store) | **GET** /resources/stores/object/{store_id} | Describe an object store. |
18
16
  | [**get_stores**](ObjectStoreApi.md#get_stores) | **GET** /resources/stores/object | List object stores. |
19
- | [**get_value_for_key**](ObjectStoreApi.md#get_value_for_key) | **GET** /resources/stores/object/{store_id}/keys/{key_name} | Get object store key value. |
20
- | [**set_value_for_key**](ObjectStoreApi.md#set_value_for_key) | **PUT** /resources/stores/object/{store_id}/keys/{key_name} | Insert object store key-value. |
21
17
 
22
18
 
23
19
  ## `create_store()`
@@ -55,44 +51,6 @@ end
55
51
 
56
52
  [**StoreResponse**](StoreResponse.md)
57
53
 
58
- [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
59
- [[Back to README]](../../README.md)
60
- ## `delete_key_from_store()`
61
-
62
- ```ruby
63
- delete_key_from_store(opts) # Delete object store key.
64
- ```
65
-
66
- Delete a key from a customer store.
67
-
68
- ### Examples
69
-
70
- ```ruby
71
- api_instance = Fastly::ObjectStoreApi.new
72
- opts = {
73
- store_id: 'store_id_example', # String |
74
- key_name: 'key_name_example', # String |
75
- }
76
-
77
- begin
78
- # Delete object store key.
79
- api_instance.delete_key_from_store(opts)
80
- rescue Fastly::ApiError => e
81
- puts "Error when calling ObjectStoreApi->delete_key_from_store: #{e}"
82
- end
83
- ```
84
-
85
- ### Options
86
-
87
- | Name | Type | Description | Notes |
88
- | ---- | ---- | ----------- | ----- |
89
- | **store_id** | **String** | | |
90
- | **key_name** | **String** | | |
91
-
92
- ### Return type
93
-
94
- nil (empty response body)
95
-
96
54
  [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
97
55
  [[Back to README]](../../README.md)
98
56
  ## `delete_store()`
@@ -101,7 +59,7 @@ nil (empty response body)
101
59
  delete_store(opts) # Delete an object store.
102
60
  ```
103
61
 
104
- 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.
62
+ 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).
105
63
 
106
64
  ### Examples
107
65
 
@@ -129,47 +87,6 @@ end
129
87
 
130
88
  nil (empty response body)
131
89
 
132
- [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
133
- [[Back to README]](../../README.md)
134
- ## `get_keys()`
135
-
136
- ```ruby
137
- get_keys(opts): <KeyResponse> # List object store keys.
138
- ```
139
-
140
- List all keys within an object store.
141
-
142
- ### Examples
143
-
144
- ```ruby
145
- api_instance = Fastly::ObjectStoreApi.new
146
- opts = {
147
- store_id: 'store_id_example', # String |
148
- cursor: 'cursor_example', # String |
149
- limit: 56, # Integer |
150
- }
151
-
152
- begin
153
- # List object store keys.
154
- result = api_instance.get_keys(opts)
155
- p result
156
- rescue Fastly::ApiError => e
157
- puts "Error when calling ObjectStoreApi->get_keys: #{e}"
158
- end
159
- ```
160
-
161
- ### Options
162
-
163
- | Name | Type | Description | Notes |
164
- | ---- | ---- | ----------- | ----- |
165
- | **store_id** | **String** | | |
166
- | **cursor** | **String** | | [optional] |
167
- | **limit** | **Integer** | | [optional][default to 100] |
168
-
169
- ### Return type
170
-
171
- [**KeyResponse**](KeyResponse.md)
172
-
173
90
  [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
174
91
  [[Back to README]](../../README.md)
175
92
  ## `get_store()`
@@ -212,7 +129,7 @@ end
212
129
  ## `get_stores()`
213
130
 
214
131
  ```ruby
215
- get_stores(opts): <GetStoresResponse> # List object stores.
132
+ get_stores(opts): <InlineResponse2003> # List object stores.
216
133
  ```
217
134
 
218
135
  Get all stores for a given customer.
@@ -244,87 +161,7 @@ end
244
161
 
245
162
  ### Return type
246
163
 
247
- [**GetStoresResponse**](GetStoresResponse.md)
248
-
249
- [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
250
- [[Back to README]](../../README.md)
251
- ## `get_value_for_key()`
252
-
253
- ```ruby
254
- get_value_for_key(opts): File # Get object store key value.
255
- ```
256
-
257
- Get the value associated with a key.
258
-
259
- ### Examples
260
-
261
- ```ruby
262
- api_instance = Fastly::ObjectStoreApi.new
263
- opts = {
264
- store_id: 'store_id_example', # String |
265
- key_name: 'key_name_example', # String |
266
- }
267
-
268
- begin
269
- # Get object store key value.
270
- result = api_instance.get_value_for_key(opts)
271
- p result
272
- rescue Fastly::ApiError => e
273
- puts "Error when calling ObjectStoreApi->get_value_for_key: #{e}"
274
- end
275
- ```
276
-
277
- ### Options
278
-
279
- | Name | Type | Description | Notes |
280
- | ---- | ---- | ----------- | ----- |
281
- | **store_id** | **String** | | |
282
- | **key_name** | **String** | | |
283
-
284
- ### Return type
285
-
286
- **File**
287
-
288
- [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
289
- [[Back to README]](../../README.md)
290
- ## `set_value_for_key()`
291
-
292
- ```ruby
293
- set_value_for_key(opts): File # Insert object store key-value.
294
- ```
295
-
296
- Insert a new key-value pair into an object store.
297
-
298
- ### Examples
299
-
300
- ```ruby
301
- api_instance = Fastly::ObjectStoreApi.new
302
- opts = {
303
- store_id: 'store_id_example', # String |
304
- key_name: 'key_name_example', # String |
305
- body: File.new('/path/to/some/file'), # File |
306
- }
307
-
308
- begin
309
- # Insert object store key-value.
310
- result = api_instance.set_value_for_key(opts)
311
- p result
312
- rescue Fastly::ApiError => e
313
- puts "Error when calling ObjectStoreApi->set_value_for_key: #{e}"
314
- end
315
- ```
316
-
317
- ### Options
318
-
319
- | Name | Type | Description | Notes |
320
- | ---- | ---- | ----------- | ----- |
321
- | **store_id** | **String** | | |
322
- | **key_name** | **String** | | |
323
- | **body** | **File** | | [optional] |
324
-
325
- ### Return type
326
-
327
- **File**
164
+ [**InlineResponse2003**](InlineResponse2003.md)
328
165
 
329
166
  [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
330
167
  [[Back to README]](../../README.md)
@@ -0,0 +1,177 @@
1
+ # Fastly::ObjectStoreItemApi
2
+
3
+
4
+ ```ruby
5
+ require 'fastly'
6
+ api_instance = Fastly::ObjectStoreItemApi.new
7
+ ```
8
+
9
+ ## Methods
10
+
11
+ | Method | HTTP request | Description |
12
+ | ------ | ------------ | ----------- |
13
+ | [**delete_key_from_store**](ObjectStoreItemApi.md#delete_key_from_store) | **DELETE** /resources/stores/object/{store_id}/keys/{key_name} | Delete object store item. |
14
+ | [**get_keys**](ObjectStoreItemApi.md#get_keys) | **GET** /resources/stores/object/{store_id}/keys | List object store keys. |
15
+ | [**get_value_for_key**](ObjectStoreItemApi.md#get_value_for_key) | **GET** /resources/stores/object/{store_id}/keys/{key_name} | Get the value of an object store item |
16
+ | [**set_value_for_key**](ObjectStoreItemApi.md#set_value_for_key) | **PUT** /resources/stores/object/{store_id}/keys/{key_name} | Insert an item into an object store |
17
+
18
+
19
+ ## `delete_key_from_store()`
20
+
21
+ ```ruby
22
+ delete_key_from_store(opts) # Delete object store item.
23
+ ```
24
+
25
+ Delete an item from an object store
26
+
27
+ ### Examples
28
+
29
+ ```ruby
30
+ api_instance = Fastly::ObjectStoreItemApi.new
31
+ opts = {
32
+ store_id: 'store_id_example', # String |
33
+ key_name: 'key_name_example', # String |
34
+ }
35
+
36
+ begin
37
+ # Delete object store item.
38
+ api_instance.delete_key_from_store(opts)
39
+ rescue Fastly::ApiError => e
40
+ puts "Error when calling ObjectStoreItemApi->delete_key_from_store: #{e}"
41
+ end
42
+ ```
43
+
44
+ ### Options
45
+
46
+ | Name | Type | Description | Notes |
47
+ | ---- | ---- | ----------- | ----- |
48
+ | **store_id** | **String** | | |
49
+ | **key_name** | **String** | | |
50
+
51
+ ### Return type
52
+
53
+ nil (empty response body)
54
+
55
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
56
+ [[Back to README]](../../README.md)
57
+ ## `get_keys()`
58
+
59
+ ```ruby
60
+ get_keys(opts): <InlineResponse2004> # List object store keys.
61
+ ```
62
+
63
+ List the keys of all items within an object store.
64
+
65
+ ### Examples
66
+
67
+ ```ruby
68
+ api_instance = Fastly::ObjectStoreItemApi.new
69
+ opts = {
70
+ store_id: 'store_id_example', # String |
71
+ cursor: 'cursor_example', # String |
72
+ limit: 56, # Integer |
73
+ }
74
+
75
+ begin
76
+ # List object store keys.
77
+ result = api_instance.get_keys(opts)
78
+ p result
79
+ rescue Fastly::ApiError => e
80
+ puts "Error when calling ObjectStoreItemApi->get_keys: #{e}"
81
+ end
82
+ ```
83
+
84
+ ### Options
85
+
86
+ | Name | Type | Description | Notes |
87
+ | ---- | ---- | ----------- | ----- |
88
+ | **store_id** | **String** | | |
89
+ | **cursor** | **String** | | [optional] |
90
+ | **limit** | **Integer** | | [optional][default to 100] |
91
+
92
+ ### Return type
93
+
94
+ [**InlineResponse2004**](InlineResponse2004.md)
95
+
96
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
97
+ [[Back to README]](../../README.md)
98
+ ## `get_value_for_key()`
99
+
100
+ ```ruby
101
+ get_value_for_key(opts): File # Get the value of an object store item
102
+ ```
103
+
104
+ Get the value associated with a key.
105
+
106
+ ### Examples
107
+
108
+ ```ruby
109
+ api_instance = Fastly::ObjectStoreItemApi.new
110
+ opts = {
111
+ store_id: 'store_id_example', # String |
112
+ key_name: 'key_name_example', # String |
113
+ }
114
+
115
+ begin
116
+ # Get the value of an object store item
117
+ result = api_instance.get_value_for_key(opts)
118
+ p result
119
+ rescue Fastly::ApiError => e
120
+ puts "Error when calling ObjectStoreItemApi->get_value_for_key: #{e}"
121
+ end
122
+ ```
123
+
124
+ ### Options
125
+
126
+ | Name | Type | Description | Notes |
127
+ | ---- | ---- | ----------- | ----- |
128
+ | **store_id** | **String** | | |
129
+ | **key_name** | **String** | | |
130
+
131
+ ### Return type
132
+
133
+ **File**
134
+
135
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
136
+ [[Back to README]](../../README.md)
137
+ ## `set_value_for_key()`
138
+
139
+ ```ruby
140
+ set_value_for_key(opts): File # Insert an item into an object store
141
+ ```
142
+
143
+ Set a new value for a new or existing key in an object store.
144
+
145
+ ### Examples
146
+
147
+ ```ruby
148
+ api_instance = Fastly::ObjectStoreItemApi.new
149
+ opts = {
150
+ store_id: 'store_id_example', # String |
151
+ key_name: 'key_name_example', # String |
152
+ body: File.new('/path/to/some/file'), # File |
153
+ }
154
+
155
+ begin
156
+ # Insert an item into an object store
157
+ result = api_instance.set_value_for_key(opts)
158
+ p result
159
+ rescue Fastly::ApiError => e
160
+ puts "Error when calling ObjectStoreItemApi->set_value_for_key: #{e}"
161
+ end
162
+ ```
163
+
164
+ ### Options
165
+
166
+ | Name | Type | Description | Notes |
167
+ | ---- | ---- | ----------- | ----- |
168
+ | **store_id** | **String** | | |
169
+ | **key_name** | **String** | | |
170
+ | **body** | **File** | | [optional] |
171
+
172
+ ### Return type
173
+
174
+ **File**
175
+
176
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
177
+ [[Back to README]](../../README.md)
data/docs/Pop.md CHANGED
@@ -4,11 +4,14 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **code** | **String** | | [optional] |
8
- | **name** | **String** | | [optional] |
9
- | **group** | **String** | | [optional] |
7
+ | **code** | **String** | the three-letter code for the [POP](https://developer.fastly.com/learning/concepts/pop/) | |
8
+ | **name** | **String** | the name of the POP | |
9
+ | **group** | **String** | | |
10
+ | **region** | **String** | | |
11
+ | **stats_region** | **String** | the region used for stats reporting | |
12
+ | **billing_region** | **String** | the region used for billing | |
10
13
  | **coordinates** | [**PopCoordinates**](PopCoordinates.md) | | [optional] |
11
- | **shield** | **String** | | [optional] |
14
+ | **shield** | **String** | the name of the [shield code](https://developer.fastly.com/learning/concepts/shielding/#choosing-a-shield-location) if this POP is suitable for shielding | [optional] |
12
15
 
13
16
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
14
17
 
@@ -4,10 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **x** | **Float** | | [optional] |
8
- | **y** | **Float** | | [optional] |
9
- | **latitude** | **Float** | | [optional] |
10
- | **longitude** | **Float** | | [optional] |
7
+ | **latitude** | **Float** | | |
8
+ | **longitude** | **Float** | | |
11
9
 
12
10
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
13
11
 
@@ -202,8 +202,10 @@
202
202
  | **websocket_resp_body_bytes** | **Integer** | Total message content bytes sent to end users over passthrough WebSocket connections. | [optional] |
203
203
  | **fanout_recv_publishes** | **Integer** | Total published messages received from the publish API endpoint. | [optional] |
204
204
  | **fanout_send_publishes** | **Integer** | Total published messages sent to end users. | [optional] |
205
- | **object_store_read_requests** | **Integer** | The total number of reads received for the object store. | [optional] |
206
- | **object_store_write_requests** | **Integer** | The total number of writes received for the object store. | [optional] |
205
+ | **object_store_class_a_operations** | **Integer** | The total number of class a operations for the object store. | [optional] |
206
+ | **object_store_class_b_operations** | **Integer** | The total number of class b operations for the object store. | [optional] |
207
+ | **object_store_read_requests** | **Integer** | Use object_store_class_b_operations. | [optional] |
208
+ | **object_store_write_requests** | **Integer** | Use object_store_class_a_operations. | [optional] |
207
209
  | **fanout_req_header_bytes** | **Integer** | Total header bytes received from end users over Fanout connections. | [optional] |
208
210
  | **fanout_req_body_bytes** | **Integer** | Total body or message content bytes received from end users over Fanout connections. | [optional] |
209
211
  | **fanout_resp_header_bytes** | **Integer** | Total header bytes sent to end users over Fanout connections. | [optional] |
@@ -213,6 +215,12 @@
213
215
  | **fanout_beresp_header_bytes** | **Integer** | Total header bytes received from backends over Fanout connections. | [optional] |
214
216
  | **fanout_beresp_body_bytes** | **Integer** | Total body or message content bytes received from backends over Fanout connections. | [optional] |
215
217
  | **fanout_conn_time_ms** | **Integer** | Total duration of Fanout connections with end users. | [optional] |
218
+ | **ddos_action_limit_streams_connections** | **Integer** | For HTTP/2, the number of connections the limit-streams action was applied to. The limit-streams action caps the allowed number of concurrent streams in a connection. | [optional] |
219
+ | **ddos_action_limit_streams_requests** | **Integer** | For HTTP/2, the number of requests made on a connection for which the limit-streams action was taken. The limit-streams action caps the allowed number of concurrent streams in a connection. | [optional] |
220
+ | **ddos_action_tarpit_accept** | **Integer** | The number of times the tarpit-accept action was taken. The tarpit-accept action adds a delay when accepting future connections. | [optional] |
221
+ | **ddos_action_tarpit** | **Integer** | The number of times the tarpit action was taken. The tarpit action delays writing the response to the client. | [optional] |
222
+ | **ddos_action_close** | **Integer** | The number of times the close action was taken. The close action aborts the connection as soon as possible. The close action takes effect either right after accept, right after the client hello, or right after the response was sent. | [optional] |
223
+ | **ddos_action_blackhole** | **Integer** | The number of times the blackhole action was taken. The blackhole action quietly closes a TCP connection without sending a reset. The blackhole action quietly closes a TCP connection without notifying its peer (all TCP state is dropped). | [optional] |
216
224
 
217
225
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
218
226
 
data/docs/Resource.md CHANGED
@@ -4,7 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | The name of the resource. | [optional] |
7
+ | **resource_id** | **String** | The ID of the underlying linked resource. | [optional] |
8
+ | **name** | **String** | The name of the resource link. | [optional] |
8
9
 
9
10
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10
11
 
data/docs/ResourceApi.md CHANGED
@@ -10,20 +10,20 @@ api_instance = Fastly::ResourceApi.new
10
10
 
11
11
  | Method | HTTP request | Description |
12
12
  | ------ | ------------ | ----------- |
13
- | [**create_resource**](ResourceApi.md#create_resource) | **POST** /service/{service_id}/version/{version_id}/resource | Create a resource |
14
- | [**delete_resource**](ResourceApi.md#delete_resource) | **DELETE** /service/{service_id}/version/{version_id}/resource/{resource_id} | Delete a resource |
15
- | [**get_resource**](ResourceApi.md#get_resource) | **GET** /service/{service_id}/version/{version_id}/resource/{resource_id} | Display a resource |
16
- | [**list_resources**](ResourceApi.md#list_resources) | **GET** /service/{service_id}/version/{version_id}/resource | List resources |
17
- | [**update_resource**](ResourceApi.md#update_resource) | **PUT** /service/{service_id}/version/{version_id}/resource/{resource_id} | Update a resource |
13
+ | [**create_resource**](ResourceApi.md#create_resource) | **POST** /service/{service_id}/version/{version_id}/resource | Create a resource link |
14
+ | [**delete_resource**](ResourceApi.md#delete_resource) | **DELETE** /service/{service_id}/version/{version_id}/resource/{id} | Delete a resource link |
15
+ | [**get_resource**](ResourceApi.md#get_resource) | **GET** /service/{service_id}/version/{version_id}/resource/{id} | Display a resource link |
16
+ | [**list_resources**](ResourceApi.md#list_resources) | **GET** /service/{service_id}/version/{version_id}/resource | List resource links |
17
+ | [**update_resource**](ResourceApi.md#update_resource) | **PUT** /service/{service_id}/version/{version_id}/resource/{id} | Update a resource link |
18
18
 
19
19
 
20
20
  ## `create_resource()`
21
21
 
22
22
  ```ruby
23
- create_resource(opts): <ResourceResponse> # Create a resource
23
+ create_resource(opts): <ResourceResponse> # Create a resource link
24
24
  ```
25
25
 
26
- Create a resource.
26
+ Create a link between a resource and a service version.
27
27
 
28
28
  ### Examples
29
29
 
@@ -32,12 +32,12 @@ api_instance = Fastly::ResourceApi.new
32
32
  opts = {
33
33
  service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
34
34
  version_id: 56, # Integer | Integer identifying a service version.
35
- name: 'name_example', # String | The name of the resource.
36
- resource_id: 'resource_id_example', # String | The ID of the linked resource.
35
+ resource_id: 'resource_id_example', # String | The ID of the underlying linked resource.
36
+ name: 'name_example', # String | The name of the resource link.
37
37
  }
38
38
 
39
39
  begin
40
- # Create a resource
40
+ # Create a resource link
41
41
  result = api_instance.create_resource(opts)
42
42
  p result
43
43
  rescue Fastly::ApiError => e
@@ -51,8 +51,8 @@ end
51
51
  | ---- | ---- | ----------- | ----- |
52
52
  | **service_id** | **String** | Alphanumeric string identifying the service. | |
53
53
  | **version_id** | **Integer** | Integer identifying a service version. | |
54
- | **name** | **String** | The name of the resource. | [optional] |
55
- | **resource_id** | **String** | The ID of the linked resource. | [optional] |
54
+ | **resource_id** | **String** | The ID of the underlying linked resource. | [optional] |
55
+ | **name** | **String** | The name of the resource link. | [optional] |
56
56
 
57
57
  ### Return type
58
58
 
@@ -63,10 +63,10 @@ end
63
63
  ## `delete_resource()`
64
64
 
65
65
  ```ruby
66
- delete_resource(opts): <InlineResponse200> # Delete a resource
66
+ delete_resource(opts): <InlineResponse200> # Delete a resource link
67
67
  ```
68
68
 
69
- Delete a resource.
69
+ Delete a link between a resource and a service version.
70
70
 
71
71
  ### Examples
72
72
 
@@ -75,11 +75,11 @@ api_instance = Fastly::ResourceApi.new
75
75
  opts = {
76
76
  service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
77
77
  version_id: 56, # Integer | Integer identifying a service version.
78
- resource_id: 'resource_id_example', # String | An alphanumeric string identifying the resource.
78
+ id: 'id_example', # String | An alphanumeric string identifying the resource link.
79
79
  }
80
80
 
81
81
  begin
82
- # Delete a resource
82
+ # Delete a resource link
83
83
  result = api_instance.delete_resource(opts)
84
84
  p result
85
85
  rescue Fastly::ApiError => e
@@ -93,7 +93,7 @@ end
93
93
  | ---- | ---- | ----------- | ----- |
94
94
  | **service_id** | **String** | Alphanumeric string identifying the service. | |
95
95
  | **version_id** | **Integer** | Integer identifying a service version. | |
96
- | **resource_id** | **String** | An alphanumeric string identifying the resource. | |
96
+ | **id** | **String** | An alphanumeric string identifying the resource link. | |
97
97
 
98
98
  ### Return type
99
99
 
@@ -104,10 +104,10 @@ end
104
104
  ## `get_resource()`
105
105
 
106
106
  ```ruby
107
- get_resource(opts): <ResourceResponse> # Display a resource
107
+ get_resource(opts): <ResourceResponse> # Display a resource link
108
108
  ```
109
109
 
110
- Display a resource by its identifier.
110
+ Display a resource link by its identifier.
111
111
 
112
112
  ### Examples
113
113
 
@@ -116,11 +116,11 @@ api_instance = Fastly::ResourceApi.new
116
116
  opts = {
117
117
  service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
118
118
  version_id: 56, # Integer | Integer identifying a service version.
119
- resource_id: 'resource_id_example', # String | An alphanumeric string identifying the resource.
119
+ id: 'id_example', # String | An alphanumeric string identifying the resource link.
120
120
  }
121
121
 
122
122
  begin
123
- # Display a resource
123
+ # Display a resource link
124
124
  result = api_instance.get_resource(opts)
125
125
  p result
126
126
  rescue Fastly::ApiError => e
@@ -134,7 +134,7 @@ end
134
134
  | ---- | ---- | ----------- | ----- |
135
135
  | **service_id** | **String** | Alphanumeric string identifying the service. | |
136
136
  | **version_id** | **Integer** | Integer identifying a service version. | |
137
- | **resource_id** | **String** | An alphanumeric string identifying the resource. | |
137
+ | **id** | **String** | An alphanumeric string identifying the resource link. | |
138
138
 
139
139
  ### Return type
140
140
 
@@ -145,10 +145,10 @@ end
145
145
  ## `list_resources()`
146
146
 
147
147
  ```ruby
148
- list_resources(opts): <Array<ResourceResponse>> # List resources
148
+ list_resources(opts): <Array<ResourceResponse>> # List resource links
149
149
  ```
150
150
 
151
- List resources.
151
+ List links between resources and services
152
152
 
153
153
  ### Examples
154
154
 
@@ -160,7 +160,7 @@ opts = {
160
160
  }
161
161
 
162
162
  begin
163
- # List resources
163
+ # List resource links
164
164
  result = api_instance.list_resources(opts)
165
165
  p result
166
166
  rescue Fastly::ApiError => e
@@ -184,10 +184,10 @@ end
184
184
  ## `update_resource()`
185
185
 
186
186
  ```ruby
187
- update_resource(opts): <ResourceResponse> # Update a resource
187
+ update_resource(opts): <ResourceResponse> # Update a resource link
188
188
  ```
189
189
 
190
- Update a resource.
190
+ Update a link between a resource and a service version.
191
191
 
192
192
  ### Examples
193
193
 
@@ -196,12 +196,13 @@ api_instance = Fastly::ResourceApi.new
196
196
  opts = {
197
197
  service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
198
198
  version_id: 56, # Integer | Integer identifying a service version.
199
- resource_id: 'resource_id_example', # String | An alphanumeric string identifying the resource.
200
- name: 'name_example', # String | The name of the resource.
199
+ id: 'id_example', # String | An alphanumeric string identifying the resource link.
200
+ resource_id: 'resource_id_example', # String | The ID of the underlying linked resource.
201
+ name: 'name_example', # String | The name of the resource link.
201
202
  }
202
203
 
203
204
  begin
204
- # Update a resource
205
+ # Update a resource link
205
206
  result = api_instance.update_resource(opts)
206
207
  p result
207
208
  rescue Fastly::ApiError => e
@@ -215,8 +216,9 @@ end
215
216
  | ---- | ---- | ----------- | ----- |
216
217
  | **service_id** | **String** | Alphanumeric string identifying the service. | |
217
218
  | **version_id** | **Integer** | Integer identifying a service version. | |
218
- | **resource_id** | **String** | An alphanumeric string identifying the resource. | |
219
- | **name** | **String** | The name of the resource. | [optional] |
219
+ | **id** | **String** | An alphanumeric string identifying the resource link. | |
220
+ | **resource_id** | **String** | The ID of the underlying linked resource. | [optional] |
221
+ | **name** | **String** | The name of the resource link. | [optional] |
220
222
 
221
223
  ### Return type
222
224
 
@@ -4,12 +4,12 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **resource_id** | **String** | The ID of the underlying linked resource. | [optional] |
8
+ | **name** | **String** | The name of the resource link. | [optional] |
7
9
  | **created_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
8
10
  | **deleted_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
9
11
  | **updated_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
10
- | **name** | **String** | The name of the resource. | [optional] |
11
- | **resource_id** | **String** | The ID of the linked resource. | [optional] |
12
- | **id** | **String** | An alphanumeric string identifying the resource. | [optional] |
12
+ | **id** | **String** | An alphanumeric string identifying the resource link. | [optional] |
13
13
  | **href** | **String** | The path to the resource. | [optional] |
14
14
  | **service_id** | **String** | Alphanumeric string identifying the service. | [optional] |
15
15
  | **version** | **Integer** | Integer identifying a service version. | [optional] |