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

Aperta
#2,805 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
55/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
go, openapi
Ambito
api, tooling

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Dockerfile
Stelle
74
Fork
26
Merge medio
3h 17m
PR unite (30g)
74

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di bufbuild/plugins

Tutte le issue di bufbuild/plugins

Issue simili

Altre issue su Backend & API Design

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.