Skip to content

Commit dc6286c

Browse files
authored
docs: add new signed URL fields to dataset & key-value store (#1767)
This PR updates updates storage responses: - GET dataset has `itemsPublicUrl` and `urlSigningSecretKey` - GET KV store has `keysPublicUrl` and `urlSigningSecretKey` - Get KV store keys, item has `recordPublicUrl`
1 parent 850a7d2 commit dc6286c

File tree

3 files changed

+22
-0
lines changed

3 files changed

+22
-0
lines changed

apify-api/openapi/components/schemas/datasets/Dataset.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,5 +69,13 @@ properties:
6969
consoleUrl:
7070
type: string
7171
example: 'https://console.apify.com/storage/datasets/27TmTznX9YPeAYhkC'
72+
itemsPublicUrl:
73+
type: string
74+
description: "A public link to access the dataset items directly."
75+
example: 'https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items?signature=abc123'
76+
urlSigningSecretKey:
77+
type: string
78+
description: "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the dataset."
79+
nullable: true
7280
stats:
7381
$ref: ./DatasetStats.yaml

apify-api/openapi/components/schemas/key-value-stores/KeyValueStore.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ required:
66
- modifiedAt
77
- accessedAt
88
- consoleUrl
9+
- keysPublicUrl
910
type: object
1011
properties:
1112
id:
@@ -42,5 +43,13 @@ properties:
4243
consoleUrl:
4344
type: string
4445
example: 'https://console.apify.com/storage/key-value-stores/27TmTznX9YPeAYhkC'
46+
keysPublicUrl:
47+
type: string
48+
description: "A public link to access keys of the key-value store directly."
49+
example: 'https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/keys?signature=abc123'
50+
urlSigningSecretKey:
51+
type: string
52+
description: "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the key-value store."
53+
nullable: true
4554
stats:
4655
$ref: ./KeyValueStoreStats.yaml

apify-api/openapi/components/schemas/key-value-stores/ListOfKeysResponse.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,18 @@ properties:
1414
required:
1515
- key
1616
- size
17+
- recordPublicUrl
1718
properties:
1819
key:
1920
type: string
2021
example: second-key
2122
size:
2223
type: number
2324
example: 36
25+
recordPublicUrl:
26+
type: string
27+
description: "A public link to access this record directly."
28+
example: 'https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key?signature=abc123'
2429
description: ''
2530
count:
2631
type: number

0 commit comments

Comments
 (0)