envoyproxy/envoy

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

Open

#10 740 ouverte le 10 avr. 2020

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)C++ (5 373 forks)batch import
api/v3help wanted

Métriques du dépôt

Stars
 (27 997 stars)
Métriques de merge PR
 (Merge moyen 8j) (378 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Examinez la base de code tools/api existante pour comprendre comment la dépréciation des messages et le versionnement sont implémentés. Regardez des exemples comme 'bootstrap.v2.Runtime' et 'trace.v3.Tracing'. Ensuite, implémentez le support pour déprécier les types de messages sans supprimer leurs types imbriqués, et le support pour déplacer les types de messages imbriqués vers le haut, vers un parent ou un nouvel emplacement.
Stack technique
Aucun
Domaine
api
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75