Skip to content

Add documentation for configuring runtime argument schema for automation#175

Open
senurah wants to merge 9 commits intowso2:mainfrom
senurah:docs-runtime-args-schema
Open

Add documentation for configuring runtime argument schema for automation#175
senurah wants to merge 9 commits intowso2:mainfrom
senurah:docs-runtime-args-schema

Conversation

@senurah
Copy link
Copy Markdown

@senurah senurah commented Apr 8, 2026

Purpose

Adds a new quick-start guide for configuring runtime argument schemas and links it from the manual testing flow in Schedule Your First Automation.

  • Created/updated the Configure Runtime Argument Schemas guide to explain:
    • how to configure runtime arguments using WSO2 Integrator: BI and component.yaml (v1.2) (tabbed format)
    • supported argument types for each method
    • step-by-step configuration flow
    • runtimeArguments field definitions and usage patterns
    • validation rules, UI behavior, and current limitations
  • Updated Schedule Your First Automation to include a cross-link from Test with Arguments to Configure Runtime Argument Schema for structured runtime input configuration.

resolves: #131

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

  • Unit tests

    Code coverage information

  • Integration tests

    Details about the test cases and coverage

Security checks

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

Summary by CodeRabbit

  • Documentation
    • New guide: configuring runtime argument schemas for automation (schema v1.2), covering supported argument types, object fields, examples and validation rules.
    • Updated scheduling guide: added an optional manual test step, detailed "Test with Arguments" and preset-specific examples, plus updated production "Run" guidance.
    • Navigation updated to include the new guide.

@senurah senurah requested a review from pcnfernando as a code owner April 8, 2026 12:56
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 8, 2026

Walkthrough

Added a new guide for configuring runtime argument schemas (schema v1.2), updated the quick-start scheduling guide to include an optional manual test and "Run with Arguments" flow, and updated MkDocs navigation to include the new page.

Changes

Cohort / File(s) Summary
Runtime Argument Schema doc
en/docs/quick-start-guides/configure-runtime-argument-schema.md
New page describing runtimeArguments (schema v1.2): two setup paths (WSO2 Integrator: BI and .choreo/component.yaml), supported types and fields, variadic/repeat handling, validation rules, CLI/Devant examples, reusable snippets, and current limitations.
Scheduling guide update
en/docs/quick-start-guides/schedule-your-first-automation.md
Replaced Step 5 with an optional "Test the automation manually" section; adjusted build-status expectations to Completed; added "Test with Arguments" and preset-specific examples for WSO2 MI/BI; added post-promotion "Run with Arguments" flow and renumbered subsequent sections.
Navigation
en/mkdocs.yml
Added "Configure Runtime Argument Schema" entry under Quick Start Guides navigation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 I nibbled on docs beneath moonlight's beam,

typed out flags and values in a dream.
Repeats and enums now hop in a row,
testers can run — the forms all know.
Hooray for schemas! Off I go — a happy squeak.

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description provides Purpose and issue reference, but most required template sections are empty or contain only placeholder text. Complete Goals, Approach, User stories, Release note, Documentation, Training, Certification, Marketing, Automation tests, Security checks, Samples, Related PRs, Migrations, Test environment, and Learning sections with actual content or explicit N/A statements with explanations.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically summarizes the main change: adding documentation for configuring runtime argument schemas, which is the core objective of this PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
en/mkdocs.yml (1)

81-81: Clean up nav label formatting for consistency.

Line 81 has an extra space before : in the menu label (Schema :), which makes the left-nav text inconsistent with surrounding entries.

Suggested edit
-      - Configure Runtime Argument Schema : quick-start-guides/configure-runtime-argument-schema.md
+      - Configure Runtime Argument Schema: quick-start-guides/configure-runtime-argument-schema.md
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@en/mkdocs.yml` at line 81, The nav label "Configure Runtime Argument Schema :
quick-start-guides/configure-runtime-argument-schema.md" contains an extra space
before the colon; update the entry in mkdocs.yml so the label reads "Configure
Runtime Argument Schema:
quick-start-guides/configure-runtime-argument-schema.md" (remove the space
before the colon) to match the surrounding menu formatting.
en/docs/quick-start-guides/configure-runtime-argument-schema.md (1)

2-2: Consider aligning page title with nav/link wording (Schema vs Schemas).

Line 2 uses “Configure Runtime Argument Schemas” while navigation and inbound links use singular “Schema.” Keeping one form improves searchability and avoids naming drift.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@en/docs/quick-start-guides/configure-runtime-argument-schema.md` at line 2,
The page title "Configure Runtime Argument Schemas" is plural while nav and
inbound links use the singular "Schema"; update the title string to "Configure
Runtime Argument Schema" to match navigation/link wording and maintain
consistent naming across the site (searchable term: the title value "Configure
Runtime Argument Schemas" should be replaced).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@en/docs/quick-start-guides/configure-runtime-argument-schema.md`:
- Line 34: Replace the incorrect phrase "got to" with "go to" in the sentence
that reads 'In Devant, got to automation **Overview** page, click **Test with
Arguments**.' and the identical occurrence later in the doc so both lines read
"go to the automation **Overview** page" (update the two instances of the string
"got to" to "go to" and add "the" before "automation Overview page" where
missing).

---

Nitpick comments:
In `@en/docs/quick-start-guides/configure-runtime-argument-schema.md`:
- Line 2: The page title "Configure Runtime Argument Schemas" is plural while
nav and inbound links use the singular "Schema"; update the title string to
"Configure Runtime Argument Schema" to match navigation/link wording and
maintain consistent naming across the site (searchable term: the title value
"Configure Runtime Argument Schemas" should be replaced).

In `@en/mkdocs.yml`:
- Line 81: The nav label "Configure Runtime Argument Schema :
quick-start-guides/configure-runtime-argument-schema.md" contains an extra space
before the colon; update the entry in mkdocs.yml so the label reads "Configure
Runtime Argument Schema:
quick-start-guides/configure-runtime-argument-schema.md" (remove the space
before the colon) to match the surrounding menu formatting.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0d9dad29-17a5-4c53-b9bb-af54bb976044

📥 Commits

Reviewing files that changed from the base of the PR and between fb0b7be and 2190a88.

⛔ Files ignored due to path filters (2)
  • en/docs/assets/img/get-started/configure-runtime-argument-schema/runtime-args-bi-trigger.gif is excluded by !**/*.gif
  • en/docs/assets/img/get-started/configure-runtime-argument-schema/runtime-args-bi.gif is excluded by !**/*.gif
📒 Files selected for processing (3)
  • en/docs/quick-start-guides/configure-runtime-argument-schema.md
  • en/docs/quick-start-guides/schedule-your-first-automation.md
  • en/mkdocs.yml

Comment thread en/docs/quick-start-guides/configure-runtime-argument-schema.md Outdated
@senurah senurah force-pushed the docs-runtime-args-schema branch from 86aa94e to 88f8491 Compare April 9, 2026 01:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add documentation for executing manual task

2 participants