Skip to content

feat: added output schema docs - #1976

Merged
gippy merged 29 commits into
masterfrom
feat/add-output-schema
Oct 20, 2025
Merged

feat: added output schema docs#1976
gippy merged 29 commits into
masterfrom
feat/add-output-schema

Conversation

@gippy

@gippy gippy commented Oct 5, 2025

Copy link
Copy Markdown
Member

Resolves: https://github.com/apify/apify-core/issues/22480

This PR adds output schema docs. I have added a few examples, but there is probably even more things that can be done with it. Will try to think of more later.

@gippy
gippy requested a review from TC-MO as a code owner October 5, 2025 17:29
@gippy gippy self-assigned this Oct 5, 2025
@gippy
gippy requested a review from patrikbraborec October 5, 2025 17:29
@gippy gippy added documentation Improvements or additions to documentation. t-console Issues with this label are in the ownership of the console team. labels Oct 5, 2025
@github-actions github-actions Bot added this to the 124th sprint - Console team milestone Oct 5, 2025
@apify-service-account

apify-service-account commented Oct 5, 2025

Copy link
Copy Markdown
Contributor

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

@apify-service-account

apify-service-account commented Oct 5, 2025

Copy link
Copy Markdown
Contributor

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

patrikbraborec
patrikbraborec reviewed Oct 8, 2025
View reviewed changes
Comment thread sources/platform/actors/development/actor_definition/output_schema/index.md Outdated
patrikbraborec
patrikbraborec reviewed Oct 8, 2025
View reviewed changes
Comment thread sources/platform/actors/development/actor_definition/output_schema/index.md Outdated
patrikbraborec
patrikbraborec reviewed Oct 8, 2025
View reviewed changes
Comment thread sources/platform/actors/development/actor_definition/output_schema/index.md Outdated
patrikbraborec
patrikbraborec reviewed Oct 8, 2025
View reviewed changes
Comment thread sources/platform/actors/development/actor_definition/output_schema/index.md Outdated
patrikbraborec
patrikbraborec reviewed Oct 8, 2025
View reviewed changes
Comment thread sources/platform/actors/development/actor_definition/output_schema/index.md Outdated
patrikbraborec
patrikbraborec reviewed Oct 8, 2025
View reviewed changes
Comment thread sources/platform/actors/development/actor_definition/output_schema/index.md Outdated
patrikbraborec
patrikbraborec reviewed Oct 8, 2025
View reviewed changes
Comment thread sources/platform/actors/development/actor_definition/output_schema/index.md Outdated
@patrikbraborec

patrikbraborec commented Oct 8, 2025

Copy link
Copy Markdown
Contributor

Generally, it looks good. I added few comments, and here are some general comments:

  • I would link this page from platform/actors/running/input-and-output#output
  • I think that the page should be below Actor input schema in the left menu
  • I would consider moving the whole section with "Advanced examples" to a subpage (similarly as Actor input schema has its own subpages)

TC-MO
TC-MO requested changes Oct 9, 2025
View reviewed changes

@TC-MO TC-MO left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Made adjustments for clarity & style guide compliance. I also had an idea regarding structure, and perhaps it would be good to move Example section just before Advanced Examples? I know that this is different than other schema docs, but I think it makes sense to first introduce the concept, explain it, and then show example, instead of bombarding the user with example without any context

Comment thread sources/platform/actors/development/actor_definition/output_schema/index.md Outdated
Comment thread sources/platform/actors/development/actor_definition/output_schema/index.md Outdated
Comment thread sources/platform/actors/development/actor_definition/output_schema/index.md Outdated
Comment thread sources/platform/actors/development/actor_definition/output_schema/index.md Outdated
Comment thread sources/platform/actors/development/actor_definition/output_schema/index.md Outdated
Comment thread sources/platform/actors/development/actor_definition/output_schema/index.md Outdated
Comment thread sources/platform/actors/development/actor_definition/output_schema/index.md Outdated
Comment thread sources/platform/actors/development/actor_definition/output_schema/index.md Outdated
Comment thread sources/platform/actors/development/actor_definition/output_schema/index.md Outdated
Comment thread sources/platform/actors/development/actor_definition/output_schema/index.md Outdated
gippy and others added 10 commits October 15, 2025 12:58
@gippy @TC-MO
Apply suggestion from @TC-MO
6b77366 
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@gippy @TC-MO
Apply suggestion from @TC-MO
cca1677 
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@gippy @TC-MO
Apply suggestion from @TC-MO
1247620 
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@gippy @TC-MO
Apply suggestion from @TC-MO
176fb03 
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@gippy @TC-MO
Apply suggestion from @TC-MO
1f4ebc7 
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@gippy @TC-MO
Apply suggestion from @TC-MO
e0273a0 
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@gippy @TC-MO
Apply suggestion from @TC-MO
72f30a2 
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@gippy @TC-MO
Apply suggestion from @TC-MO
25dc0b1 
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@gippy @TC-MO
Apply suggestion from @TC-MO
1e917ef 
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@gippy @TC-MO
Apply suggestion from @TC-MO
4e6292d 
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
gippy and others added 9 commits October 15, 2025 13:03
@gippy @TC-MO
Apply suggestion from @TC-MO
441acb6 
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@gippy @TC-MO
Apply suggestion from @TC-MO
e0e5aa9 
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@gippy @TC-MO
Apply suggestion from @TC-MO
ba313d3 
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@gippy @TC-MO
Apply suggestion from @TC-MO
174ffb5 
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@gippy @TC-MO
Apply suggestion from @TC-MO
cf3a8a4 
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@gippy @TC-MO
Apply suggestion from @TC-MO
307f41b 
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@gippy @TC-MO
Apply suggestion from @TC-MO
30f795f 
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@gippy @TC-MO
Apply suggestion from @TC-MO
20bb100 
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@gippy
Merge branch 'master' into feat/add-output-schema
48fbea1
@apify-service-account

apify-service-account commented Oct 15, 2025

Copy link
Copy Markdown
Contributor

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

@apify-service-account

apify-service-account commented Oct 15, 2025

Copy link
Copy Markdown
Contributor

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

@apify-service-account

apify-service-account commented Oct 16, 2025

Copy link
Copy Markdown
Contributor

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

@patrikbraborec patrikbraborec mentioned this pull request Oct 16, 2025
Merged
@apify-service-account

apify-service-account commented Oct 19, 2025

Copy link
Copy Markdown
Contributor

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

1 similar comment
@apify-service-account

apify-service-account commented Oct 19, 2025

Copy link
Copy Markdown
Contributor

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

@gippy
gippy requested a review from TC-MO October 20, 2025 06:00
@TC-MO

TC-MO commented Oct 20, 2025

Copy link
Copy Markdown
Contributor

Yup, thank you, I think this works much better, I'll open separate issue to reorder other schema pages in similar way.

TC-MO
TC-MO approved these changes Oct 20, 2025
View reviewed changes

@TC-MO TC-MO left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@patrikbraborec

patrikbraborec commented Oct 20, 2025

Copy link
Copy Markdown
Contributor

LGTM

@apify-service-account

apify-service-account commented Oct 20, 2025

Copy link
Copy Markdown
Contributor

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

@gippy
gippy merged commit 00559a5 into master Oct 20, 2025
9 checks passed
@gippy
gippy deleted the feat/add-output-schema branch October 20, 2025 12:24
@TC-MO TC-MO mentioned this pull request Aug 12, 2026
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@patrikbraborec patrikbraborec patrikbraborec approved these changes
@TC-MO TC-MO TC-MO approved these changes

Assignees

@gippy gippy

Labels

documentation Improvements or additions to documentation. t-console Issues with this label are in the ownership of the console team.

Projects

None yet

Milestone

124th sprint - Console team

Development

Successfully merging this pull request may close these issues.

4 participants

@gippy @apify-service-account @patrikbraborec @TC-MO