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

Jump to bottom
Merged
merged 2 commits into from
Aug 13, 2025
Merged

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

merged 2 commits into from
Aug 13, 2025

Conversation

@danpoletaev
Copy link
Contributor

@danpoletaev danpoletaev commented Aug 6, 2025

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

@danpoletaev danpoletaev requested a review from TC-MO August 6, 2025 12:41
@danpoletaev danpoletaev self-assigned this Aug 6, 2025
@danpoletaev danpoletaev added the adhoc Ad-hoc unplanned task added during the sprint. label Aug 6, 2025
@github-actions github-actions bot added the t-core-services Issues with this label are in the ownership of the core services team. label Aug 6, 2025
@danpoletaev danpoletaev requested review from tobice and removed request for tobice August 6, 2025 12:41
@danpoletaev
Copy link
Contributor Author

danpoletaev commented Aug 6, 2025

@fnesveda @janbuchar it seems you're code owners, I was not able to remove you from reviewers 😕

@apify-service-account
Copy link

apify-service-account commented Aug 6, 2025

Preview for this PR was built for commit 8f82370 and is ready at https://pr-1767.preview.docs.apify.com!

fnesveda
fnesveda requested changes Aug 6, 2025
View reviewed changes
Copy link
Member

@fnesveda fnesveda left a comment

Choose a reason for hiding this comment

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

I had a note about the naming. I'm not strongly opinionated about it, but I'd like to hear a few more opinions.

apify-api/openapi/components/schemas/datasets/Dataset.yaml
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 🙂

@fnesveda
Copy link
Member

fnesveda commented Aug 6, 2025

Looping in @tobice as our resident pedant.

@fnesveda fnesveda requested a review from tobice August 6, 2025 14:13
tobice
tobice approved these changes Aug 7, 2025
View reviewed changes
apify-api/openapi/components/schemas/datasets/Dataset.yaml
consoleUrl:
type: string
example: 'https://console.apify.com/storage/datasets/27TmTznX9YPeAYhkC'
itemsPublicUrl:
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?

@apify-service-account
Copy link

apify-service-account commented Aug 11, 2025

Preview for this PR was built for commit d3147252 and is ready at https://pr-1767.preview.docs.apify.com!

@danpoletaev danpoletaev merged commit dc6286c into master Aug 13, 2025
10 checks passed
@danpoletaev danpoletaev deleted the chore/signed-urls-update-response branch August 13, 2025 08:58
@tobice tobice added the validated Issues that are resolved and their solutions fulfill the acceptance criteria. label Aug 18, 2025
daveomri pushed a commit to daveomri/apify-docs that referenced this pull request Sep 3, 2025
@danpoletaev @daveomri
docs: add new signed URL fields to dataset & key-value store (apify#1767
042f950 
)

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`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fnesveda fnesveda fnesveda approved these changes

@janbuchar janbuchar janbuchar approved these changes

@tobice tobice tobice approved these changes

@TC-MO TC-MO Awaiting requested review from TC-MO

Assignees

@danpoletaev danpoletaev

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-core-services Issues with this label are in the ownership of the core services team. validated Issues that are resolved and their solutions fulfill the acceptance criteria.

Projects

None yet

Milestone

120th sprint - Core Services team

Development

Successfully merging this pull request may close these issues.

6 participants

@danpoletaev @apify-service-account @fnesveda @janbuchar @tobice