grpc-ecosystem/grpc-gateway

Feature request: protoc-gen-swagger pluggable validation

Open

#1093 opened on Dec 5, 2019

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

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

Tech stack
gorest api
Domain
backendapidocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
GoProtocol BuffersgRPCSwagger/OpenAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Investigate the existing swagger generation code in the grpc gateway repository, particularly the protoc gen swagger plugin under `protoc gen swagger/genswagger/`. Understand how the protoc gen validate library outputs validation rules and explore how they can be injected into the generated swagger spec. Review issue comments for any suggested approaches or links to similar work. Consider the use of custom protobuf options to pass validation annotations to the generator.