Skip to content

Commit d314725

Browse files
committed
chore: add description
1 parent 8f82370 commit d314725

File tree

3 files changed

+5
-0
lines changed

3 files changed

+5
-0
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,11 @@ properties:
7171
example: 'https://console.apify.com/storage/datasets/27TmTznX9YPeAYhkC'
7272
itemsPublicUrl:
7373
type: string
74+
description: "A public link to access the dataset items directly."
7475
example: 'https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items?signature=abc123'
7576
urlSigningSecretKey:
7677
type: string
78+
description: "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the dataset."
7779
nullable: true
7880
stats:
7981
$ref: ./DatasetStats.yaml

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,11 @@ properties:
4545
example: 'https://console.apify.com/storage/key-value-stores/27TmTznX9YPeAYhkC'
4646
keysPublicUrl:
4747
type: string
48+
description: "A public link to access keys of the key-value store directly."
4849
example: 'https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/keys?signature=abc123'
4950
urlSigningSecretKey:
5051
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."
5153
nullable: true
5254
stats:
5355
$ref: ./KeyValueStoreStats.yaml

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ properties:
2424
example: 36
2525
recordPublicUrl:
2626
type: string
27+
description: "A public link to access this record directly."
2728
example: 'https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key?signature=abc123'
2829
description: ''
2930
count:

0 commit comments

Comments
 (0)