envoyproxy/envoy

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

Open

#10.740 geöffnet am 10. Apr. 2020

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (5.373 Forks)batch import
api/v3help wanted

Repository-Metriken

Stars
 (27.997 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 8T) (378 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Untersuche die vorhandene tools/api Codebasis, um zu verstehen, wie die Veralterung von Nachrichten und die Versionierung implementiert werden. Sieh dir Beispiele wie 'bootstrap.v2.Runtime' und 'trace.v3.Tracing' an. Implementiere dann Unterstützung für die Veralterung von Nachrichtentypen ohne Entfernung ihrer verschachtelten Typen und Unterstützung für das Verschieben verschachtelter Nachrichtentypen nach oben zu einem übergeordneten oder neuen Ort.
Tech Stack
Keine
Domain
api
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75