Skip to content
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

Update flows-config-schema.json #369

Merged
merged 3 commits into from
Sep 7, 2023
Merged

Conversation

spokenbird
Copy link
Contributor

[#185752154]

@bseeger
Copy link
Contributor

bseeger commented Sep 5, 2023

Hi @spokenbird - can you explain how to test out this change? I applied the file, as described in our readme, and am not seeing it correct me. Not sure I'm doing it correctly.
Thanks!

@bseeger
Copy link
Contributor

bseeger commented Sep 5, 2023

It started working now. I am seeing the auto complete.

"type": "string",
"description": "For screen within a subflow, they need the name of the subflow defined."
"description": "A method name to run on a POST."
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should fill this description out a little more. Something along the lines of "This is is the name of an Action method that will be called when a POST occurs, before any general data processing happens."

I think you can say Action here, so folks can link this back to what an Action is in the docs.

},
"crossFieldValidationAction": {
"type": "string",
"description": "A method name to to validate one field based on another field."
Copy link
Contributor

@bseeger bseeger Sep 5, 2023

Choose a reason for hiding this comment

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

"This is the name of an Action method that will be called after general validation is done on the fields, but before the data is saved to the database. It is a chance to do any cross field validation necessary."

Copy link
Contributor

@bseeger bseeger Sep 5, 2023

Choose a reason for hiding this comment

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

I'd also fill the rest out some more as well (the ones below this). If this is the only documentation that a SNE sees, then it's good if we give a little more context.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done!

Copy link
Contributor

@bseeger bseeger left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks for the updates!

@spokenbird spokenbird merged commit c609177 into main Sep 7, 2023
1 check passed
@spokenbird spokenbird deleted the update-flows-config-schema branch September 7, 2023 20:09
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.

2 participants