grpc-ecosystem/grpc-gateway

Feature request: protoc-gen-swagger pluggable validation

Open

#1,093 opened on Dec 5, 2019

View on GitHub
 (14 comments) (2 reactions) (0 assignees)Go (2,250 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (16,971 stars)
PR merge metrics
 (Avg merge 8d 23h) (147 merged PRs in 30d)

Description

Our team makes heave use of https://github.com/envoyproxy/protoc-gen-validate and would like a way for those validations to end up in the swagger spec so we don't need to define them twice.

Contributor guide

Research direction
Examine the protoc gen validate plugin and its annotations, then explore how to inject those validations into the Swagger output in the grpc gateway's protoc gen swagger plugin. Look at how existing protobuf options are handled in the swagger generation code.
Tech stack
go
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GoprotobufgRPC
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50