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

Standardized Documentation Format a la Swagger #6600

Open
alexdavis24 opened this issue Oct 4, 2024 · 0 comments
Open

Standardized Documentation Format a la Swagger #6600

alexdavis24 opened this issue Oct 4, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@alexdavis24
Copy link

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

  1. defining a consistent structure to use across projects and
  2. 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.

@alexdavis24 alexdavis24 added the enhancement New feature or request label Oct 4, 2024
@alexdavis24 alexdavis24 changed the title Documentation Format Standardized Documentation Format a la Swagger Oct 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant