search

istio / old_issues_repo

Deprecated issue-tracking repo, please post new issues or feature requests to istio/istio instead.
37 stars 9 forks source link

Improper mixer configuration test data or incorrect reference documents #337

Open metacosm opened 6 years ago

metacosm commented 6 years ago

Is this a BUG or FEATURE REQUEST?:

BUG

Did you review https://istio.io/help/ and existing issues to identify if this is already solved or being worked on?: Yes

Bug: Y

What Version of Istio and Kubernetes are you using, where did you get Istio from, Installation details

0.7.1
kubectl version: irrelevant

Is Istio Auth enabled or not ? No / irrelevant

What happened:

Reference documents field names of Istio resources as using camelCase but the examples (and test data found at https://github.com/istio/istio/tree/master/mixer/testdata/config) use snake_case. The end result is that there is confusion as to which are the proper names for the fields.

What you expected to happen:

The reference should be authoritative and examples should conform to what is described.

How to reproduce it:

Just read the reference section on the istio.io website and try to reconcile the information in the reference with the actual examples.

Feature Request: N

kyessenov commented 6 years ago

Thanks for the report. Proto to JSON style is to use camel case, but the parser is lenient and accepts snake_case as well. We should update our test files to use camel case consistently.

On Mon, May 14, 2018 at 3:31 AM Chris Laprun notifications@github.com wrote:

Is this a BUG or FEATURE REQUEST?:

BUG

Did you review https://istio.io/help/ https://istio.io/help/ and existing issues to identify if this is already solved or being worked on?: Yes

Bug: Y

What Version of Istio and Kubernetes are you using, where did you get Istio from, Installation details

0.7.1 kubectl version: irrelevant

Is Istio Auth enabled or not ? No / irrelevant

What happened:

Reference documents field names of Istio resources as using camelCase but the examples (and test data found at https://github.com/istio/istio/tree/master/mixer/testdata/config) use snake_case. The end result is that there is confusion as to which are the proper names for the fields.

What you expected to happen:

The reference should be authoritative and examples should conform to what is described.

How to reproduce it:

Just read the reference section on the istio.io website and try to reconcile the information in the reference with the actual examples.

Feature Request: N

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/istio/issues/issues/337, or mute the thread https://github.com/notifications/unsubscribe-auth/AJGIxohyXv8ZK47fgDVm6KIZbasyRZeQks5tyVzxgaJpZM4T9iqL .

metacosm commented 6 years ago

I gathered from some other part of the documentation that the parser is lenient, however, this is making automated generation of tools in different languages more complex (speaking from the Java side of things), not to mention causing confusion.