envoyproxy/envoy

Use validate tags to auto generate markup

Aperta

#3092 aperta il 16 apr 2018

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)C++ (5373 fork)batch import
api/v3area/docshelp wantedpriority/high

Metriche repository

Star
 (27.997 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

It would be nice to leverage protoc-gen-validate tags to autogenerate markup about field constraints.

For instance for https://github.com/envoyproxy/data-plane-api/blob/2f7459baf7c95cf7e634f848948a022c4b16fa79/api/eds.proto#L94 it would be nice to add a note that mentioned the constraint.

Migrated from https://github.com/envoyproxy/data-plane-api/issues/311

Guida contributor

Direzione di ricerca
Investigare come utilizzare i tag protoc gen validate per generare automaticamente il markup per i vincoli dei campi nei file proto di Envoy. Guardare la generazione di documentazione esistente nel repository data plane api.
Tech stack
cpp
Dominio
documentationbackend
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40