Skip to content

docs: Sub-schemas in input-schema #1992

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 6 commits into from
Oct 23, 2025
Merged

docs: Sub-schemas in input-schema #1992

merged 6 commits into from
Oct 23, 2025

Conversation

@mfori
Copy link
Member

@mfori mfori commented Oct 8, 2025

Document sub-schema support in input-schema specification page in docs.

@mfori mfori self-assigned this Oct 8, 2025
@mfori mfori requested a review from TC-MO as a code owner October 8, 2025 10:01
@mfori mfori added the t-console Issues with this label are in the ownership of the console team. label Oct 8, 2025
@github-actions github-actions bot added this to the 125th sprint - Console team milestone Oct 8, 2025
@mfori mfori requested a review from GriffinTrent October 8, 2025 10:02
@apify-service-account
Copy link

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

@mfori mfori requested review from gippy and patrikbraborec October 8, 2025 10:05
@apify-service-account
Copy link

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

gippy
gippy approved these changes Oct 9, 2025
View reviewed changes
Copy link
Member

@gippy gippy left a comment

Choose a reason for hiding this comment

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

Haven't gone too deep reviewing it. Just checked if the location of the docs and the text themselves make sense to me.

One comment is that maybe we should restructure the whole input schema doc in later PR. It's too large now. We could maybe have a general page and then one page for each type of input?

@mfori
Copy link
Member Author

mfori commented Oct 9, 2025

Haven't gone too deep reviewing it. Just checked if the location of the docs and the text themselves make sense to me.

One comment is that maybe we should restructure the whole input schema doc in later PR. It's too large now. We could maybe have a general page and then one page for each type of input?

Good idea, also I would put the available fields for each type at the top of the type-specific section, and the example below. Currently you need to scroll down through all the examples to see the actual table with fields.

@TC-MO
Copy link
Contributor

TC-MO commented Oct 15, 2025

Yeah I concur this is getting a little bit unwieldy. Unfortunately with curren workload I have very little capacity to try and address it until December. But I'm not sure about that approach that would be adding a lot of additional pages, let me try to think how to best approach it from information architecture POV

mfori added 2 commits October 22, 2025 10:31
@mfori
Merge branch 'master' into feat/sub-schema-input-schema
c89b7e2 
# Conflicts:
#	sources/platform/actors/development/actor_definition/input_schema/specification.md
@mfori
default/prefill, validation
ce9ab03
@apify-service-account
Copy link

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

@mfori
Copy link
Member Author

mfori commented Oct 22, 2025

Added notes about how default and prefill are handled in sub-properties (introduced in apify/apify-shared-js#555)

@mfori
Copy link
Member Author

mfori commented Oct 22, 2025

@TC-MO could you find time to review this 🙏 ?

@apify-service-account
Copy link

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

TC-MO
TC-MO requested changes Oct 22, 2025
View reviewed changes
Copy link
Contributor

@TC-MO TC-MO left a comment

Choose a reason for hiding this comment

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

Apparently clicking Submit review is hard 🤦

@mfori
Copy link
Member Author

mfori commented Oct 22, 2025

Apparently clicking Submit review is hard 🤦

@TC-MO Thank you, I addressed all your comments

@mfori mfori requested a review from TC-MO October 22, 2025 13:18
@apify-service-account
Copy link

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

@mfori mfori merged commit 4961335 into master Oct 23, 2025
9 checks passed
@mfori mfori deleted the feat/sub-schema-input-schema branch October 23, 2025 10:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gippy gippy gippy approved these changes

@patrikbraborec patrikbraborec patrikbraborec approved these changes

@GriffinTrent GriffinTrent GriffinTrent approved these changes

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

Assignees

@mfori mfori

Labels

t-console Issues with this label are in the ownership of the console team.

Projects

None yet

Milestone

125th sprint - Console team

Development

Successfully merging this pull request may close these issues.

7 participants

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