From ffbac012e6c37535b6824371665807877b688fec Mon Sep 17 00:00:00 2001 From: Jakub Dyszkiewicz Date: Thu, 30 Nov 2023 14:19:53 +0100 Subject: [PATCH 1/2] docs(policies): reminder for using snakeCase Signed-off-by: Jakub Dyszkiewicz --- app/_src/policies/meshproxypatch.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/app/_src/policies/meshproxypatch.md b/app/_src/policies/meshproxypatch.md index 9149bc510..690af099f 100644 --- a/app/_src/policies/meshproxypatch.md +++ b/app/_src/policies/meshproxypatch.md @@ -160,7 +160,7 @@ spec: origin: inbound # optional: if absent, all clusters regardless of its origin will be patched jsonPatches: # optional and mutually exclusive with "value": list of modifications in JSON Patch notation - op: add - path: /transportSocket/typedConfig/commonTlsContext/tlsParams + path: /transportSocket/typedConfig/commonTlsContext/tlsParams # remember to always use camelCase value: tlsMinimumProtocolVersion: TLSv1_2 - op: add @@ -1473,6 +1473,10 @@ All modifications from `appendModification` list are always merged. For example, if there is a policy with `targetRef.kind: Mesh` and second policy with `targetRef.kind: MeshService` that matches a data plane proxy, all modifications from both policies will be applied. +## JSON Patch + +If you use JSON Patch, remember to always use _snakeCase_ instead of _camel_case_ in `path` parameter even though you see _camel_case_ in Envoy Config Dump. + ## Examples From 81537c9283c01c8610624915a13d7345b42d7431 Mon Sep 17 00:00:00 2001 From: Jakub Dyszkiewicz Date: Thu, 30 Nov 2023 14:47:13 +0100 Subject: [PATCH 2/2] make vale happy Signed-off-by: Jakub Dyszkiewicz --- app/_src/policies/meshproxypatch.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/app/_src/policies/meshproxypatch.md b/app/_src/policies/meshproxypatch.md index 690af099f..b9028289f 100644 --- a/app/_src/policies/meshproxypatch.md +++ b/app/_src/policies/meshproxypatch.md @@ -1473,9 +1473,9 @@ All modifications from `appendModification` list are always merged. For example, if there is a policy with `targetRef.kind: Mesh` and second policy with `targetRef.kind: MeshService` that matches a data plane proxy, all modifications from both policies will be applied. -## JSON Patch +## Json patch -If you use JSON Patch, remember to always use _snakeCase_ instead of _camel_case_ in `path` parameter even though you see _camel_case_ in Envoy Config Dump. +If you use json patch, remember to always use _snakeCase_ instead of _camel_case_ in `path` parameter even though you see _camel_case_ in Envoy Config Dump. ## Examples