-
Notifications
You must be signed in to change notification settings - Fork 78
docs: document input schema processing #58
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates the documentation for how the Actor input schema is processed, ensuring that it complies with JSON Schema standards and outlines the new processing rules.
- Updated the description of schema processing steps, including description truncation, enum length limits, required field marking, nested property building, and array item type inference.
- Provides detailed bullet points for each processing step.
Comments suppressed due to low confidence (2)
README.md:370
- [nitpick] It’s unclear how this new 'combined length' limit relates to the previous limit of 50 options. A brief note or cross-reference could help clarify the change.
+- **Enum fields** are truncated to a maximum combined length of 200 characters for all elements (as defined in `ACTOR_ENUM_MAX_LENGTH`).
README.md:373
- [nitpick] The priority order for inferring array item types could benefit from additional clarification or punctuation to improve readability.
+- **Array item types** are inferred when not explicitly defined in the schema, using a priority order: explicit type in items > prefill type > default value type > editor type.
jirispilka
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks
* docs: document input schema processing (#58) document Actor input schema processing in README * add VS Code instructions to README (#62) * Add vs code instructions --------- Co-authored-by: mbaiza27 <mbaiza27@outllook.com> Co-authored-by: Jiří Spilka <jiri.spilka@apify.com> * ci: run prerelase manually (#70) run prerelase manually * get apify api url base from env var --------- Co-authored-by: Marc Baiza <43151891+mbaiza27@users.noreply.github.com> Co-authored-by: mbaiza27 <mbaiza27@outllook.com> Co-authored-by: Jiří Spilka <jiri.spilka@apify.com>
* docs: document input schema processing (#58) document Actor input schema processing in README * add VS Code instructions to README (#62) * Add vs code instructions --------- Co-authored-by: mbaiza27 <mbaiza27@outllook.com> Co-authored-by: Jiří Spilka <jiri.spilka@apify.com> * initial working draft of proxy actorized mcp servers * fix tests * fix proxy tool name handling * ci: run prerelase manually (#70) run prerelase manually * organize, fix passing of apify token * fix env var name * fix imports * get standby url from actor id, check if is mcp server based on actor name for now * Actor MCP server load default Actors * get standbyUrlBase from env var * fix standby url base, use dns friendly owner name * get mcp path from definition * Remove unused import from actor.ts * console.log to logger * Remove extra slash from MCP server URL construction * Simplify actor tools loading logic * Refactor actorOwnerDNSFriendly to handle special characters * Add TODO comment for reworking actor definition fetch logic * refactor mcp actor and utils, use real Actor ID as standby URL * fix: get-actor-definition-default-build (#73) * fix get default build in get actor definition * fix tests * fix double import, lint --------- Co-authored-by: Marc Baiza <43151891+mbaiza27@users.noreply.github.com> Co-authored-by: mbaiza27 <mbaiza27@outllook.com> Co-authored-by: Jiří Spilka <jiri.spilka@apify.com> Co-authored-by: Jiri Spilka <jirka.spilka@gmail.com>
closes #43