Skip to content

fix: missing fields on dataset endpoint response #1547

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
stepskop merged 2 commits into from
Apr 24, 2025
Merged

fix: missing fields on dataset endpoint response #1547

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ea39ee
fix: missing fields on dataset endpoint response
stepskop Apr 23, 2025
beace11
chore: add example and link to the schema spec
stepskop Apr 23, 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
21 changes: 21 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 @@ -47,6 +47,27 @@ properties:
type: string
description: ''
nullable: true
schema:
type: object
nullable: true
Comment on lines +50 to +52
Copy link
Contributor

@janbuchar janbuchar Apr 23, 2025

Choose a reason for hiding this comment

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

Asking to describe the schema in OpenAPI would be too much, but a link to the output schema spec would be solid gold.

Also, could you add a minimal example here, too?

Copy link
Contributor Author

@stepskop stepskop Apr 23, 2025

Choose a reason for hiding this comment

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

Added mentioned.
image

description: Defines the schema of items in your dataset, the full specification can be found in [Apify docs](/platform/actors/development/actor-definition/dataset-schema)
example:
actorSpecification: 1
title: "My dataset"
views:
overview:
title: "Overview"
transformation:
fields:
- "linkUrl"
display:
component: "table"
properties:
linkUrl:
label: "Link URL"
format: "link"
consoleUrl:
type: string
example: 'https://console.apify.com/storage/datasets/27TmTznX9YPeAYhkC'
stats:
$ref: ./DatasetStats.yaml
16 changes: 16 additions & 0 deletions apify-api/openapi/components/schemas/datasets/DatasetStats.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
title: DatasetStats
required:
- readCount
- writeCount
- storageBytes
type: object
properties:
readCount:
type: number
example: 22
writeCount:
type: number
example: 3
storageBytes:
type: number
example: 783