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

Aberta
#2,805 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
55/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
go, openapi
Domínio
api, tooling

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
Dockerfile
Estrelas
74
Forks
26
Merge médio
3h 17min
PRs com merge (30d)
74

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de bufbuild/plugins

Todas as issues de bufbuild/plugins

Issues semelhantes

Mais issues de Backend & API Design

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.