Nexus #577
Nexus #577
Conversation
|
The fix for tqname is already in the versioning-2 branch but it may take a while (blocked on go SDK merge) until we merge it. It is just two lines, and I don't want to block your PR, do you want to go ahead and add them? |
| * `--description` (string) - Endpoint description in markdown format (encoded using the configured codec server). | ||
| * `--description-file` (string) - Endpoint description file in markdown format (encoded using the configured codec server). |
There was a problem hiding this comment.
This was removed in cloud API at temporalio/api-cloud#23 (comment), I think we should remove in this one too. Or we can have description, but I don't think we should get specific with the format expected at this time (I suspect there is a subset of markdown we will start using as part of temporalio/features#486).
There was a problem hiding this comment.
We may need to discuss this more. There's a strict requirement to have this description. We have it in all of the docs.
I've replied in that cloud API thread to request bringing the description back.
There was a problem hiding this comment.
Is there a strict requirement to have the description, or a strict requirement to say descriptions are markdown formatted? My issue is more with the latter and I think it should at least be subject to discussion.
Also, if this matched user metadata spec a bit better, there would be summary and details, not description. Workflows are going to get --summary and --details soon I believe.
There was a problem hiding this comment.
Yeah, we want markdown. Maybe it's worth consolidating on summary and details to match workflow metadata, I would be okay changing that now.
There was a problem hiding this comment.
I am not sure we can generally say we want all long-form "description" text accepted by Temporal APIs to be full markdown, and whatever we do want Temporal long-form format to be should be centrally/generally documented. Setting a long-form format specific to Nexus descriptions and not for Temporal as a whole I don't think is the best approach.
Can you just assume Nexus descriptions have to be like every other long-form Temporal description/details and then we can discuss/decide/document that long-form in a general way that helps everyone and is not just for Nexus?
What was changed