You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: examples/digital-ocean-api/DigitalOcean-public.v2.yaml
+50-7
Original file line number
Diff line number
Diff line change
@@ -318,11 +318,11 @@ tags:
318
318
configurations requiring movable addresses.
319
319
320
320
Floating IPs are bound to a specific region.
321
-
321
+
322
322
- name: Functions
323
323
description: |-
324
324
[Serverless functions](https://docs.digitalocean.com/products/functions) are blocks of code that run on demand without the need to manage any infrastructure.
325
-
You can develop functions on your local machine and then deploy them to a namespace using `doctl`, the [official DigitalOcean CLI tool](https://docs.digitalocean.com/reference/doctl).
325
+
You can develop functions on your local machine and then deploy them to a namespace using `doctl`, the [official DigitalOcean CLI tool](https://docs.digitalocean.com/reference/doctl).
326
326
327
327
The Serverless Functions API currently only supports creating and managing namespaces.
328
328
@@ -515,8 +515,8 @@ tags:
515
515
516
516
- name: Uptime
517
517
description: >-
518
-
[DigitalOcean Uptime Checks](https://docs.digitalocean.com/products/uptime/) provide the ability to monitor your endpoints from around the world, and alert you when they're slow, unavailable, or SSL certificates are expiring.
519
-
518
+
[DigitalOcean Uptime Checks](https://docs.digitalocean.com/products/uptime/) provide the ability to monitor your endpoints from around the world, and alert you when they're slow, unavailable, or SSL certificates are expiring.
519
+
520
520
To interact with Uptime, you will generally send requests to the Uptime endpoint at `/v2/uptime/`.
Copy file name to clipboardExpand all lines: examples/digital-ocean-api/description.yml
+16-12
Original file line number
Diff line number
Diff line change
@@ -202,30 +202,30 @@ introduction: |
202
202
The rate limiting information is contained within the response headers of
203
203
each request. The relevant headers are:
204
204
205
-
* **RateLimit-Limit**: The number of requests that can be made per hour.
206
-
* **RateLimit-Remaining**: The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
207
-
* **RateLimit-Reset**: This represents the time when the oldest request will expire. The value is given in [Unix epoch time](http://en.wikipedia.org/wiki/Unix_time). See below for more information about how request limits expire.
205
+
* **ratelimit-limit**: The number of requests that can be made per hour.
206
+
* **ratelimit-remaining**: The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
207
+
* **ratelimit-reset**: This represents the time when the oldest request will expire. The value is given in [Unix epoch time](http://en.wikipedia.org/wiki/Unix_time). See below for more information about how request limits expire.
208
208
209
-
As long as the `RateLimit-Remaining` count is above zero, you will be able
209
+
As long as the `ratelimit-remaining` count is above zero, you will be able
210
210
to make additional requests.
211
211
212
212
The way that a request expires and is removed from the current limit count
213
213
is important to understand. Rather than counting all of the requests for an
214
-
hour and resetting the `RateLimit-Remaining` value at the end of the hour,
214
+
hour and resetting the `ratelimit-remaining` value at the end of the hour,
215
215
each request instead has its own timer.
216
216
217
-
This means that each request contributes toward the `RateLimit-Remaining`
217
+
This means that each request contributes toward the `ratelimit-remaining`
218
218
count for one complete hour after the request is made. When that request's
219
219
timer runs out, it is no longer counted towards the request limit.
220
220
221
-
This has implications on the meaning of the `RateLimit-Reset` header as
221
+
This has implications on the meaning of the `ratelimit-reset` header as
222
222
well. Because the entire rate limit is not reset at one time, the value of
223
223
this header is set to the time when the _oldest_ request will expire.
224
224
225
-
Keep this in mind if you see your `RateLimit-Reset` value change, but not
225
+
Keep this in mind if you see your `ratelimit-reset` value change, but not
226
226
move an entire hour into the future.
227
227
228
-
If the `RateLimit-Remaining` reaches zero, subsequent requests will receive
228
+
If the `ratelimit-remaining` reaches zero, subsequent requests will receive
229
229
a 429 error code until the request reset has been reached. You can see the
230
230
format of the response in the examples.
231
231
@@ -234,14 +234,18 @@ introduction: |
234
234
235
235
* Only 12 `POST` requests to the `/v2/floating_ips` endpoint to create Floating IPs can be made per 60 seconds.
236
236
* Only 10 `GET` requests to the `/v2/account/keys` endpoint to list SSH keys can be made per 60 seconds.
237
+
* Only 5 requests to any and all `v2/cdn/endpoints` can be made per 10 seconds. This includes `v2/cdn/endpoints`,
238
+
`v2/cdn/endpoints/$ENDPOINT_ID`, and `v2/cdn/endpoints/$ENDPOINT_ID/cache`.
239
+
* Only 50 strings within the `files` json struct in the `v2/cdn/endpoints/$ENDPOINT_ID/cache` [payload](https://docs.digitalocean.com/reference/api/api-reference/#operation/cdn_purge_cache)
description: The name of the component to route to.
5
+
type: string
6
+
example: web
7
+
8
+
preserve_path_prefix:
9
+
description: "An optional flag to preserve the path that is forwarded to the backend service. By default, the HTTP request path will be trimmed from the left when forwarded to the component. For example, a component with `path=/api` will have requests to `/api/list` trimmed to `/list`. If this value is `true`, the path will remain `/api/list`. Note: this is not applicable for Functions Components and is mutually exclusive with `rewrite`."
10
+
type: string
11
+
example: "true"
12
+
13
+
rewrite:
14
+
description: "An optional field that will rewrite the path of the component to be what is specified here. By default, the HTTP request path will be trimmed from the left when forwarded to the component. For example, a component with `path=/api` will have requests to `/api/list` trimmed to `/list`. If you specified the rewrite to be `/v1/`, requests to `/api/list` would be rewritten to `/v1/list`. Note: this is mutually exclusive with `preserve_path_prefix`."
15
+
type: string
16
+
example: /api/v1/
17
+
description: The component to route to. Only one of `component` or `redirect` may be set.
description: "An optional URI path to redirect to. Note: if this is specified the whole URI of the original request will be overwritten to this value, irrespective of the original request URI being matched."
5
+
type: string
6
+
example: /about
7
+
8
+
authority:
9
+
description: "The authority/host to redirect to. This can be a hostname or IP address. Note: use `port` to set the port."
10
+
type: string
11
+
example: example.com
12
+
13
+
port:
14
+
description: The port to redirect to.
15
+
type: integer
16
+
format: int64
17
+
example: 443
18
+
19
+
scheme:
20
+
description: "The scheme to redirect to. Supported values are `http` or `https`. Default: `https`."
21
+
type: string
22
+
example: "https"
23
+
24
+
redirect_code:
25
+
description: The redirect code to use. Defaults to `302`. Supported values are 300, 301, 302, 303, 304, 307, 308.
26
+
type: integer
27
+
format: int64
28
+
example: 302
29
+
description: The redirect configuration for the rule. Only one of `component` or `redirect` may be set.
0 commit comments