envoyproxy/envoy

Use validate tags to auto generate markup

Open

#3.092 aberto em 16 de abr. de 2018

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (5.373 forks)batch import
api/v3area/docshelp wantedpriority/high

Métricas do repositório

Stars
 (27.997 stars)
Métricas de merge de PR
 (Mesclagem média 8d) (378 fundiu PRs em 30d)

Description

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

Guia do colaborador

Direção de pesquisa
Investigue como usar as tags protoc gen validate para gerar automaticamente marcação para restrições de campo nos arquivos proto do Envoy. Veja a geração de documentação existente no repositório data plane api.
Pilha de tecnologia
cpp
Domain
documentationbackend
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40