-
Notifications
You must be signed in to change notification settings - Fork 139
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
Add documentation for input validation #315
Conversation
Docs Build status updates of commit 1ec19ca: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
||
# Input Validation | ||
|
||
Versions 1.3 and later of the Adaptive Cards schema support client side input validation of Input types. |
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.
Nit nit: ',' after schema
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.
I'm not sure a comma goes there? I could do: "Adaptive cards, in versions 1.3 and later of the schema, supports client side input validation of Input types" Does that seem clearer?
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.
Should we include a note about guidance and expectations for custom input types (backcompat and newer ones)?
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.
I'm not sure a comma goes there? I could do: "Adaptive cards, in versions 1.3 and later of the schema, supports client side input validation of Input types" Does that seem clearer?
Yeah or maybe even "In versions 1.3 and later of the schema, AdaptiveCards supports ... "
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.
Should we include a note about guidance and expectations for custom input types (backcompat and newer ones)?
Is there something specific you had in mind here?
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.
In terms of the Extensibility options here do things just work as far as any custom inputs they might have had, post-upgrade to 1.3/renderer lib 2.0?
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.
Ok, digging in a bit I have some questions myself. I think that's going to have to be beyond the scope of this change. The extensibility documentation in general, and for inputs in particular, even prior to this work is pretty lacking. I'm going to log a new issue for input extensibility documentation to follow up.
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.
@RebeccaAnne this would then need to be CP'd into live as well IIRC (post-release) |
Docs Build status updates of commit 94310b5: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Cherry-pick to 'live': Add documentation for input validation #315
@@ -18,6 +18,8 @@ | |||
href: authoring-cards/speech.md |
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.
Arlyss engebretson
@@ -18,6 +18,8 @@ | |||
href: authoring-cards/speech.md | |||
- name: Text Features | |||
href: authoring-cards/text-features.md | |||
- name: Input Validation | |||
href: authoring-cards/input-validation.md | |||
- name: Rendering Cards | |||
items: | |||
- name: Getting Started |
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.
Arlyss Engebretson
Added a documentation page for Input Validation. Covers the issues in microsoft/AdaptiveCards#4391.