Skip to content

Commit 435034f

Browse files
committed
Merge branch 'master' into integration-playbook
2 parents 073f2f2 + 2c5a176 commit 435034f

File tree

16 files changed

+649
-496
lines changed

16 files changed

+649
-496
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@
88
/sources/academy/ @honzajavorek
99

1010
# OpenAPI spec
11-
/apify-api/ @netmilk @janbuchar @fnesveda
11+
/apify-api/ @janbuchar @fnesveda

apify-api/openapi/openapi.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -581,6 +581,8 @@ paths:
581581
$ref: 'paths/request-queues/request-queues@{queueId}.yaml'
582582
'/v2/request-queues/{queueId}/requests/batch':
583583
$ref: 'paths/request-queues/request-queues@{queueId}@requests@batch.yaml'
584+
'/v2/request-queues/{queueId}/requests/unlock':
585+
$ref: 'paths/request-queues/request-queues@{queueId}@requests@unlock.yaml'
584586
'/v2/request-queues/{queueId}/requests':
585587
$ref: 'paths/request-queues/request-queues@{queueId}@requests.yaml'
586588
'/v2/request-queues/{queueId}/requests/{requestId}':

apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi.json.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,9 @@ get:
3737
application/json:
3838
schema:
3939
$ref: '../../components/schemas/actor-builds/GetOpenApiResponse.yaml'
40+
x-js-parent: BuildClient
41+
x-js-name: getOpenApiDefinition
42+
x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/BuildClient#getOpenApiDefinition
43+
x-py-parent: BuildClient
44+
x-py-name: get_open_api_definition
45+
x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/BuildClient#get_open_api_definition

apify-api/openapi/paths/actor-runs/actor-runs@{runId}@resurrect.yaml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,22 @@ post:
3838
schema:
3939
type: number
4040
example: 256
41+
- name: maxItems
42+
in: query
43+
required: false
44+
schema:
45+
type: number
46+
example: 1000
47+
description: |
48+
Optional number of items that the run should return. Used for pay-per-result Actors. The value can only be increased beyond the value specified when the Actor run was started.
49+
- name: maxTotalChargeUsd
50+
in: query
51+
required: false
52+
schema:
53+
type: number
54+
example: 10
55+
description: |
56+
Optional maximum cost of the run, in USD. Used for pay-per-event Actors. The value can only be increased beyond the value specified when the Actor run was started.
4157
responses:
4258
'200':
4359
description: ''

apify-api/openapi/paths/actors/acts@{actorId}@builds@default.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,3 +74,9 @@ get:
7474
inputSchema: '{\n \"title\": \"Schema for ... }'
7575
readme: '# Magic Actor\nThis Actor is magic.'
7676
buildNumber: 0.1.1
77+
x-js-parent: ActorClient
78+
x-js-name: defaultBuild
79+
x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/ActorClient#defaultBuild
80+
x-py-parent: ActorClient
81+
x-py-name: default_build
82+
x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorClient#default_build

apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}@keys.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,19 @@ get:
3838
type: number
3939
format: double
4040
example: 100
41+
- name: collection
42+
in: query
43+
description: Limit the results to keys that belong to a specific collection from the key-value store schema.
44+
The key-value store need to have a schema defined for this parameter to work.
45+
schema:
46+
type: string
47+
example: postImages
48+
- name: prefix
49+
in: query
50+
description: Limit the results to keys that start with a specific prefix.
51+
schema:
52+
type: string
53+
example: post-images-
4154
responses:
4255
'200':
4356
description: ''
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
post:
2+
tags:
3+
- Storage/Request queues/Requests locks
4+
summary: Unlock requests
5+
description: |
6+
Unlocks requests in the queue that are currently locked by the client.
7+
8+
* If the client is within an Actor run, it unlocks all requests locked by that specific run plus all requests locked by the same clientKey.
9+
* If the client is outside of an Actor run, it unlocks all requests locked using the same clientKey.
10+
operationId: requestQueue_requests_unlock_post
11+
parameters:
12+
- name: queueId
13+
in: path
14+
description: Queue ID or `username~queue-name`.
15+
required: true
16+
style: simple
17+
schema:
18+
type: string
19+
example: WkzbQMuFYuamGv3YF
20+
- name: clientKey
21+
in: query
22+
description: |
23+
A unique identifier of the client accessing the request queue. It must
24+
be a string between 1 and 32 characters long
25+
style: form
26+
explode: true
27+
schema:
28+
type: string
29+
example: client-abc
30+
responses:
31+
'200':
32+
description: 'Number of requests that were unlocked'
33+
content:
34+
application/json:
35+
schema:
36+
type: object
37+
required:
38+
- data
39+
properties:
40+
data:
41+
type: object
42+
required:
43+
- unlockedCount
44+
properties:
45+
unlockedCount:
46+
type: integer
47+
description: 'Number of requests that were successfully unlocked'
48+
example:
49+
data:
50+
unlockedCount: 10
51+
52+
deprecated: false
53+
x-js-parent: RequestQueueClient
54+
x-js-name: unlockRequests
55+
x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#unlockRequests
56+
x-py-parent: RequestQueueClientAsync
57+
x-py-name: unlock_requests
58+
x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#unlock_requests

nginx.conf

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -446,18 +446,45 @@ server {
446446

447447
server {
448448
listen 0.0.0.0:8080;
449-
449+
resolver 172.20.0.10;
450450
server_name ~^(?<subdomain>[^.]+)\.preview\.docs\.apify\.com$;
451451

452+
# add trailing slashes to the root of GH pages docs
453+
rewrite ^/api/client/js$ /api/client/js/ redirect;
454+
rewrite ^/api/client/python$ /api/client/python/ redirect;
455+
rewrite ^/sdk/js$ /sdk/js/ redirect;
456+
rewrite ^/sdk/python$ /sdk/python/ redirect;
457+
rewrite ^/cli$ /cli/ redirect;
458+
459+
location ~ ^/api/client/js/(.*)$ {
460+
proxy_pass https://apify.github.io/apify-client-js/$1;
461+
}
462+
location ~ ^/api/client/python/(.*)$ {
463+
proxy_pass https://apify.github.io/apify-client-python/$1;
464+
}
465+
location ~ ^/sdk/js/(.*)$ {
466+
proxy_pass https://apify.github.io/apify-sdk-js/$1;
467+
}
468+
location ~ ^/sdk/python/(.*)$ {
469+
proxy_pass https://apify.github.io/apify-sdk-python/$1;
470+
}
471+
location ~ ^/cli/(.*)$ {
472+
proxy_pass https://apify.github.io/apify-cli/$1;
473+
}
474+
475+
location = / {
476+
proxy_pass https://s3.amazonaws.com/apify-docs-preview/$subdomain/index.html;
477+
}
452478
location ~ ^/(.*)/$ {
453479
proxy_pass https://s3.amazonaws.com/apify-docs-preview/$subdomain/$1/index.html;
454480
}
455-
456-
location ~ ^/(.*[^./])$ {
481+
location ~ ^/([^.]+)$ {
457482
proxy_pass https://s3.amazonaws.com/apify-docs-preview/$subdomain/$1.html;
458483
}
459-
484+
location ~ ^/(.*)$ {
485+
proxy_pass https://s3.amazonaws.com/apify-docs-preview/$subdomain/$1;
486+
}
460487
location / {
461-
proxy_pass https://s3.amazonaws.com/apify-docs-preview/$subdomain/;
488+
proxy_pass https://s3.amazonaws.com/apify-docs-preview/$subdomain$uri;
462489
}
463-
}
490+
}

0 commit comments

Comments
 (0)