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

Offen
#2,805 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
55/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
go, openapi
Bereich
api, tooling

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
Dockerfile
Sterne
74
Forks
26
Ø Merge
3 Std. 17 Min.
Gemergte PRs (30 T.)
74

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus bufbuild/plugins

Alle Issues in bufbuild/plugins

Ähnliche Issues

Weitere Issues zu Backend & API Design

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.