I am trying to get the `README` of a flow through a graphql Prefect Community #ask-community

I am trying to get the `README` of a flow through...

Pierre Monico

11/10/2021, 2:08 PM

I am trying to get the

README

of a flow through a graphql call. I am able to do this by calling

flow_group.description

but: • What is a flow group? Is that all versions of a given flow? • If so, why does

flow_group.name

return a uuid? (aka. how can I simply relate a flow’s name to it’s description)

Anna Geller

11/10/2021, 2:25 PM

that’s correct, flow group is a higher level concept that overrides individual flow settings and it allows you to set the README or attach a schedule that will be valid for all flow versions

Anna Geller

11/10/2021, 2:32 PM

regarding the uuid, if you look at the details tab in any of your flows in the UI, I think it explains the relation a bit more - the flow group ID is a uuid for this flow that acts as a single source of truth for your flow configuration. Let’s say you defined a schedule in your flow code, but you would like to override it from the UI - thanks to this flow group UUID, you can do that and any settings performed on the flow group supersede metadata from the registration.

Pierre Monico

11/10/2021, 3:12 PM

Thanks @Anna Geller! But: • Why is the flow group’s

name

a uuid? • What is the actual flow’s (not group)

description

field for / how do I set it?

Pierre Monico

11/10/2021, 3:13 PM

Anna Geller

11/10/2021, 3:15 PM

in general, users are supposed to set it from the UI rather than from the API. If you set it from the UI, the description should appear in the query I believe

Anna Geller

11/10/2021, 3:21 PM

I can confirm that:

Copy code

query {
  flow_group(where: {id: {_eq: "a532da5f-5232-4fa0-83a0-7e7a218321ba"}}) {
    schedule
    description
    name
  }
}

Pierre Monico

11/17/2021, 2:50 PM

Thanks and sorry for the late reply @Anna Geller!

👍 1

3 Views

Open in Slack

Previous Next