smi-spec icon indicating copy to clipboard operation
smi-spec copied to clipboard

Published 20 hours ago • verified publisher icon servicemeshinterface

rename TrafficTarget to TrafficAccess

Open michelleN opened this issue 5 years ago • 6 comments

Describe the proposal rename TrafficTarget to TrafficAccess

Scope

  • [ ] New specification
  • [x] Traffic Access Control
  • [ ] Traffic Specs
  • [ ] Traffic Metrics
  • [ ] Traffic Split

Possible use cases This might be easier to understand and more intuitive. Would love to know the origin of the name TrafficTarget if someone has context.

michelleN avatar Jul 14 '20 02:07 michelleN

I think TrafficAccess better defines what the API does 👍

stefanprodan avatar Aug 05 '20 17:08 stefanprodan

Indeed, when I started to look at SMI, I have been confused by this suffix "Target". The API is called "Traffic Access Control" in the documentation, the API Group is access.smi-spec.io, and the kind is TrafficTarget, and not (yet?) TrafficAccess.

patricekrakow avatar Sep 02 '20 15:09 patricekrakow

@michelleN I can make the PR for this one if it's OK with you.

patricekrakow avatar Sep 29 '20 20:09 patricekrakow

That would be great. Thank you @patricekrakow

michelleN avatar Sep 30 '20 15:09 michelleN

Before I start with the PR, I would like to summarize the possible options I see.

AS-IS

APIs group Kind(s)
Traffic Specs specs HTTPRouteGroup, TCPRoute
Traffic Access Control access TrafficTarget
Traffic Split split TrafficSplit
Traffic Metrics metrics TrafficMetrics, TrafficMetricsList

TO-BE Options

The changes will be shown in italic

Option 1

APIs group Kind(s)
Traffic Specs specs HTTPRouteGroup, TCPRoute
Traffic Access Control access TrafficAccess
Traffic Split split TrafficSplit
Traffic Metrics metrics TrafficMetrics, TrafficMetricsList

Option 2

APIs group Kind(s)
Traffic Specs specs HTTPRouteGroup, TCPRoute
Traffic Access access TrafficAccess
Traffic Split split TrafficSplit
Traffic Metrics metrics TrafficMetrics, TrafficMetricsList

Option 3

APIs group Kind(s)
Traffic Specs specs HTTPRouteGroup, TCPRoute
Traffic Access Control access-control TrafficAccessControl
Traffic Split split TrafficSplit
Traffic Metrics metrics TrafficMetrics, TrafficMetricsList

Option 4

APIs group Kind(s)
Traffic Specs specs HTTPRouteGroup, TCPRoute
Traffic Access Control access TrafficAccessControl
Traffic Split split TrafficSplit
Traffic Metrics metrics TrafficMetrics, TrafficMetricsList

Let me know if you have a preference for any of these options, or even another permutation I would have missed...

patricekrakow avatar Oct 14 '20 17:10 patricekrakow

Hey @patricekrakow - option 2 looks the most clear to me. Would you still be able to work on this issue?

cc/ @johnsonshi

michelleN avatar Jun 21 '21 19:06 michelleN