You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
Coming from a a world of Swagger/OpenAPI, there is a clearly defined documentation template around exposing an API. We would like to expose Temporal Workflows as part of a larger service, where a Temporal Workflow plays the role of a "black box" service call, and accordingly the front-end dev should know only what input parameters/return values are expected for a particular workflow, with the rest of the workflow abstracted away.
Describe the solution you'd like
Is there a possibility of Temporal
defining a consistent structure to use across projects and
Creating tooling that can read in the consistent structure to generate a human-friendly documentation page, etc.?
Describe alternatives you've considered
Custom yaml files that are shared across teams - this requires teams to agree on their own internal standards and makes reuse of documentation across projects difficult
Additional context
Add any other context or screenshots about the feature request here.
The text was updated successfully, but these errors were encountered:
Is your feature request related to a problem? Please describe.
Coming from a a world of Swagger/OpenAPI, there is a clearly defined documentation template around exposing an API. We would like to expose Temporal Workflows as part of a larger service, where a Temporal Workflow plays the role of a "black box" service call, and accordingly the front-end dev should know only what input parameters/return values are expected for a particular workflow, with the rest of the workflow abstracted away.
Swagger/OpenAPI has a clearly defined structure to share between end users:
https://swagger.io/docs/specification/v3_0/basic-structure/
Describe the solution you'd like
Is there a possibility of Temporal
Describe alternatives you've considered
Custom yaml files that are shared across teams - this requires teams to agree on their own internal standards and makes reuse of documentation across projects difficult
Additional context
Add any other context or screenshots about the feature request here.
The text was updated successfully, but these errors were encountered: