Update 1. Flow Overview.md #312
Conversation
added the description of skip validation
WalkthroughA new section describing the "Skip Validation" feature was added to the Flow Listing Page Buttons documentation. This update explains an option that allows users to bypass validation when sending dynamically generated results that are not pre-defined in the flow, particularly when using the resume Flow API. No changes were made to code or public API declarations. Changes
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
🚀 Deployed on https://deploy-preview-312--glific-docs.netlify.app |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/3. Product Features/03. Flows/1. Flow Overview.md (1)
36-38: Correct indentation for list and description
The list item and its subsequent description should be indented consistently (4 spaces for nested list items) to satisfy Markdownlint MD005 and ensure proper rendering.- - **Skip Validation**: Check this box while sending results that are generated dynamically (not pre-defined in the flow). -This is helpful while using the [resume Flow API](https://api.glific.com/#89f5f6e6-9bdc-48c2-96c5-ad8c1f7a834b) and the flow doesn’t already have those results set up. It lets the flow continue without checking if those result fields were expected. + - **Skip Validation**: Check this box while sending results that are generated dynamically (not pre-defined in the flow). + This is helpful while using the [resume Flow API](https://api.glific.com/#89f5f6e6-9bdc-48c2-96c5-ad8c1f7a834b) and the flow doesn’t already have those results set up. It lets the flow continue without checking if those result fields were expected.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
36-36: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 3(MD005, list-indent)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/3. Product Features/03. Flows/1. Flow Overview.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/3. Product Features/03. Flows/1. Flow Overview.md
36-36: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 3
(MD005, list-indent)
corrected the typo error
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/3. Product Features/03. Flows/1. Flow Overview.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/3. Product Features/03. Flows/1. Flow Overview.md
36-36: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 3
(MD005, list-indent)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Test deployment
- GitHub Check: build
| - **Skip Validation** : Check this box while sending results that are generated dynamically (not pre-defined in the flow). | ||
| This is helpful while using the [resume Flow API](https://api.glific.com/#89f5f6e6-9bdc-48c2-96c5-ad8c1f7a834b) and the flow doesn’t already have those results set up. | ||
| It lets the flow continue without checking if those result fields were expected. |
There was a problem hiding this comment.
Normalize indentation for the new "Skip Validation" bullet
The new bullet is currently indented with only 3 spaces and its description line starts with an extra leading space, breaking the list structure under Edit. Please align it with the other items:
- - **Skip Validation** : Check this box while sending results that are generated dynamically (not pre-defined in the flow).
- This is helpful while using the [resume Flow API](https://api.glific.com/#89f5f6e6-9bdc-48c2-96c5-ad8c1f7a834b) and the flow doesn’t already have those results set up.
+ - **Skip Validation** : Check this box while sending results that are generated dynamically (not pre-defined in the flow).
+This is helpful while using the [resume Flow API](https://api.glific.com/#89f5f6e6-9bdc-48c2-96c5-ad8c1f7a834b) and the flow doesn’t already have those results set up. This will satisfy the MD005 rule for consistent list indentation and remove unintended whitespace.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **Skip Validation** : Check this box while sending results that are generated dynamically (not pre-defined in the flow). | |
| This is helpful while using the [resume Flow API](https://api.glific.com/#89f5f6e6-9bdc-48c2-96c5-ad8c1f7a834b) and the flow doesn’t already have those results set up. | |
| It lets the flow continue without checking if those result fields were expected. | |
| - **Skip Validation** : Check this box while sending results that are generated dynamically (not pre-defined in the flow). | |
| This is helpful while using the [resume Flow API](https://api.glific.com/#89f5f6e6-9bdc-48c2-96c5-ad8c1f7a834b) and the flow doesn’t already have those results set up. | |
| It lets the flow continue without checking if those result fields were expected. |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
36-36: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 3
(MD005, list-indent)
added the description of skip validation
Summary by CodeRabbit