Support OpenAPI schema annotations on enum types
- Dominant language
- Go
- Stars
- 2.3k
- Forks
- 279
- PR merge metrics
- No merged PRs in 30d
Description
OpenAPI v3 annotations currently support files, methods, messages, and message fields, but not protobuf enum types.
Because `protoc-gen-openapi` generates enum schemas inline, there is no simple way to attach enum-level schema metadata (e.g. `title`, `description`, `example`, or `default`). In our case, this prevents downstream documentation renderers from using those values when generating examples for enum-typed fields.
Contributor guide
Research direction
Start at the protoc-gen-openapi annotation handling and enum schema generation paths. Trace how annotations are supported for files, methods, messages, and message fields, then determine where enum-level metadata should enter the generated schema. Done means enum annotations can provide values such as title, description, example, and default for downstream documentation rendering.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, openapi
- Domain
- api, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100