envoyproxy/envoy

Add jsonschema dump of API protocols

Open

#13,254 opened on Sep 24, 2020

View on GitHub
 (23 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/docshelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 30d)

Description

description

In order to create a vscode plugin (#13078) we need to dump the protobuf protocols to jsonschema

I have created a container for testing https://github.com/chrusty/protoc-gen-jsonschema - and have it installed and working there with the provided examples etc

Im not totally clear how/where to install this within bazel so it is available to protoc - and also how to trigger the actual protoc commands for the envoy API - any help/pointers with these tasks would be much appreciated

refs

Contributor guide

Research direction
Research how to integrate protoc gen jsonschema into the Bazel build system using rules proto or a custom genrule. Look at existing examples of protoc plugins in Bazel (e.g., protoc gen validate). Trigger protoc generation for all Envoy API proto files by defining a Bazel macro or rule that runs protoc with the plugin. Start by examining the envoy's build structure and how protos are currently compiled. Consider using a containerized approach as suggested in the issue for testing.
Tech stack
go
Domain
apitooling
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.
1-2 days
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
GitBazelProtobuf
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30