Plugin request for Buf Schema Registry: protoc-gen-dedo-openapi

未关闭
#2,805 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
55/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
go, openapi
领域
api, tooling

调研方向

Read the plugin source at https://github.com/raveesh-me/dedo/tree/main/openapi/cmd/protoc-gen-dedo-openapi and the Buf Schema Registry plugin submission requirements. Check how the repository packages plugins and whether this Go plugin meets those requirements; done means the submission can be evaluated for inclusion in the BSR.

由索引模型根据 Issue 内容生成。

描述

Mandatory

Where is the source code for the plugin?

https://github.com/raveesh-me/dedo/tree/main/openapi/cmd/protoc-gen-dedo-openapi

protoc-gen-dedo-openapi writes one OpenAPI 3.1 document for a set of services from their google.api.http bindings only. It leaves out Connect and gRPC routes, so the document describes the public REST API. It reads google.api.field_behavior, google.api.resource, field comments, and the options in the buf.build/r-a/dedo module (scopes as security requirements, declared error reasons per HTTP status, deprecation and sunset dates, cache headers). Path parameters are named after resource patterns. Run with strategy: all.

Optional

Does the plugin have a valid semver version?

Yes, v0.5.0. It is the latest GitHub release (https://github.com/raveesh-me/dedo/releases/tag/v0.5.0). The Go module tag is openapi/v0.5.0, and go install github.com/raveesh-me/dedo/openapi/cmd/[email protected] works.

Does the plugin have a dependency on another plugin?

No. The output is a standalone JSON document.

Does the output of this plugin depend on any other external libraries?

No. The output is openapi.json, with no code.

License: Apache-2.0 (https://github.com/raveesh-me/dedo/blob/v0.5.0/LICENSE). The output depends only on the request: no network or file access.

主要语言
Dockerfile
星标
74
派生
26
平均合并
3 小时 17 分钟
30 天内合并 PR
74

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

bufbuild/plugins 的其他 Issue

查看 bufbuild/plugins 的全部 Issue

相似的 Issue

更多 Backend & API Design Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。