Skip to content

docs: add new signed URL fields to dataset & key-value store #1767

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 13, 2025
Merged

docs: add new signed URL fields to dataset & key-value store #1767

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f82370
docs: add new signed URL fields to dataset & key-value store
danpoletaev Aug 6, 2025
d314725
chore: add description
danpoletaev Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions apify-api/openapi/components/schemas/datasets/Dataset.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,11 @@ properties:
consoleUrl:
type: string
example: 'https://console.apify.com/storage/datasets/27TmTznX9YPeAYhkC'
itemsPublicUrl:
Copy link
Member

@fnesveda fnesveda Aug 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry to complain about the naming only this late, but the itemsPublicUrl sounds wrong, the adjectives are in a wrong order. It sounds like "red big ball" instead of "big red ball". How about calling this publicItemsUrl? Same with keysPublicUrl -> publicKeysUrl.

Copy link
Member

@fnesveda fnesveda Aug 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, I'm not sure now. I wouldn't know if publicItemsUrl is "public URL of items", or "URL of public items". But I still think it's slightly better.

Copy link
Contributor Author

@danpoletaev danpoletaev Aug 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like we need to train a model, which will help us with naming 😅

attaching convesation that we already had in previous PR - apify/apify-client-js#720 (comment)

Copy link
Contributor

@tobice tobice Aug 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, that conversation captures it pretty well, nothing to add 😄

I understand the awkwardness, but this is the best we can do and there is logical coherence to it. Once you get used to it, you'll love it 😄

Copy link
Member

@fnesveda fnesveda Aug 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright, I guess this is the best option after all 🙂

Copy link
Contributor

@tobice tobice Aug 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the place where we actually explain to the users what it is? 😄

The overall documentation for he general access feature is on me, so we will definitely have a proper page for it in the docs. But I think it'd still be good practice to explain what these fields do directly on the API?

I guess we can do it later and just add links...

Copy link
Contributor Author

@danpoletaev danpoletaev Aug 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, I added descriptions. Can you, please, check if it makes sense to you?

type: string
example: 'https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items?signature=abc123'
urlSigningSecretKey:
type: string
nullable: true
stats:
$ref: ./DatasetStats.yaml
7 changes: 7 additions & 0 deletions apify-api/openapi/components/schemas/key-value-stores/KeyValueStore.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ required:
- modifiedAt
- accessedAt
- consoleUrl
- keysPublicUrl
type: object
properties:
id:
Expand Down Expand Up @@ -42,5 +43,11 @@ properties:
consoleUrl:
type: string
example: 'https://console.apify.com/storage/key-value-stores/27TmTznX9YPeAYhkC'
keysPublicUrl:
type: string
example: 'https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/keys?signature=abc123'
urlSigningSecretKey:
type: string
nullable: true
stats:
$ref: ./KeyValueStoreStats.yaml
4 changes: 4 additions & 0 deletions apify-api/openapi/components/schemas/key-value-stores/ListOfKeysResponse.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,17 @@ properties:
required:
- key
- size
- recordPublicUrl
properties:
key:
type: string
example: second-key
size:
type: number
example: 36
recordPublicUrl:
type: string
example: 'https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key?signature=abc123'
description: ''
count:
type: number
Expand Down