envoyproxy/envoy

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

Open

#10,740 opened on Apr 10, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
api/v3help wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 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

Contributor guide

Research direction
Examine the existing tools/api codebase to understand how message deprecation and versioning are implemented. Look at examples such as 'bootstrap.v2.Runtime' and 'trace.v3.Tracing'. Then implement support for deprecating message types without removing their nested types, and support for moving nested message types up to a parent or a new location.
Tech stack
None
Domain
api
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75