protoc-gen-platform-openapi

command
v0.12.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 9, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Command protoc-gen-platform-openapi is the OpenAPI generator of the platform, a buf plugin. It writes OpenAPI 3.1 of the REST API the api module serves, merged into the project's api/openapi/base.yaml:

plugins:
  - local: [go, tool, protoc-gen-platform-openapi]
    out: api/openapi
    strategy: all
    opt: [base=api/openapi/base.yaml, path=openapi.yaml]

With documents=platformgo.yaml it also writes openapi.<name>.bundle.yaml for every document of api.openapi.documents in that file, a description for one audience each.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL