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

First class descriptions #177

Merged
merged 5 commits into from
Jan 20, 2021
Merged

First class descriptions #177

merged 5 commits into from
Jan 20, 2021

Conversation

cicdw
Copy link
Member

@cicdw cicdw commented Jan 20, 2021

Summary

This PR adds formal support for Flow Group descriptions that can be edited via API. In particular, we now have the following ways of creating and managing descriptions for flows and flow groups:

  • passing a description when calling mutation{create_flow} (this has been supported for a long time -- cc @jcrist in case you wanted to begin using this in Core)
  • calling the set_flow_group_description mutation (this is what this PR adds)

Note that this flow group field will be treated slightly differently from other flow group fields in that the description will not be an override. Instead, it will be editable and persistent, but individual versions may still have their own descriptions displayed (but note that they won't be editable).

All descriptions will support markdown formatting when displayed.

cc: @zhen0

Importance

This will enable a more fully featured UI experience for flows, especially for those that

Checklist

This PR:

  • adds new tests (if appropriate)
  • adds a change file in the changes/ directory (if appropriate)

@cicdw cicdw requested a review from zanieb January 20, 2021 22:50
@cicdw cicdw merged commit 2da2115 into master Jan 20, 2021
@cicdw cicdw deleted the first-class-descriptions branch January 20, 2021 23:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants