envoyproxy/envoy

tools/api: add support for 1) deprecating message types and 2) moving nested message types up

Open

#10.740 aberto em 10 de abr. de 2020

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)C++ (5.373 forks)batch import
api/v3help wanted

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

Title: add support for 1) deprecating message types and 2) moving nested message types up

Description:

  • at the moment, there are already a few message types that have been deprecated, e.g.
    • bootstrap.v2.Runtime
      • tools/api already support removing it from the next API version by adding option deprecated = true;
    • trace.v3.Tracing
      • if option deprecated = true; is added, tools/api will remove the message along with its nested types, which is not desired (see next point)
  • additionally, there is a case where a nested message type needs to be moved up, e.g.
    • trace.v3.Tracing.Http => trace.v4.HttpTracer
    • and, probably, even trace.v3.Tracing.Http => trace.v3.HttpTracer

Context:

  • #10405

Guia do colaborador

Direção de pesquisa
Examine o código existente de tools/api para entender como a deprecação de mensagens e o versionamento são implementados. Veja exemplos como 'bootstrap.v2.Runtime' e 'trace.v3.Tracing'. Em seguida, implemente suporte para depreciar tipos de mensagem sem remover seus tipos aninhados, e suporte para mover tipos de mensagem aninhados para cima, para um pai ou um novo local.
Pilha de tecnologia
None
Domain
api
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.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75