Skip to content

Commit 99b0145

Browse files
authored
docs: Add signature query parameter to docs of relevant endpoints (#1955)
### Description: Update docs with signature query parameter for the following endpoints: - /key-value-store-record-get - /key-value-store-keys-get - /dataset-items-get ### Issues: Closed: #1954
1 parent 74b5790 commit 99b0145

File tree

3 files changed

+24
-0
lines changed

3 files changed

+24
-0
lines changed

apify-api/openapi/paths/datasets/datasets@{datasetId}@items.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -367,6 +367,14 @@ get:
367367
schema:
368368
type: boolean
369369
example: false
370+
- name: signature
371+
in: query
372+
description: Signature used to access the items.
373+
required: false
374+
style: simple
375+
schema:
376+
type: string
377+
example: 2wTI46Bg8qWQrV7tavlPI
370378
responses:
371379
'200':
372380
description: ''

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,14 @@ get:
4848
schema:
4949
type: string
5050
example: post-images-
51+
- name: signature
52+
in: query
53+
description: Signature used to access the keys.
54+
required: false
55+
style: simple
56+
schema:
57+
type: string
58+
example: 2wTI46Bg8qWQrV7tavlPI
5159
responses:
5260
'200':
5361
description: ''

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,14 @@ get:
3232
schema:
3333
type: string
3434
example: someKey
35+
- name: signature
36+
in: query
37+
description: Signature used to access the record.
38+
required: false
39+
style: simple
40+
schema:
41+
type: string
42+
example: 2wTI46Bg8qWQrV7tavlPI
3543
responses:
3644
'200':
3745
description: ''

0 commit comments

Comments
 (0)