temporalio / temporalio/temporal

Standardized Documentation Format a la Swagger

Open
#6,600 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Go
Stars
23.2k
Forks
1.9k
Avg merge
2d 8h
Merged PRs (30d)
228

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no repository files, tests, or entry points. First clarify the consistent structure and tooling scope, then define what generated human-friendly documentation must contain; the work is done when the shared format and documentation-generation behavior are specified and implemented.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, yaml
Domain
api, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.