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

Đang mở
  • Có gì không ổn?
#2,805 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
55/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
go, openapi
Lĩnh vực
api, tooling

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Dockerfile
Star
74
Fork
26
Merge trung bình
3 giờ 17 phút
Pull request đã merge (30 ngày)
74

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của bufbuild/plugins

Tất cả issue của bufbuild/plugins

Issue tương tự

Thêm issue về Backend & API Design

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.