Update routing.rst; Extract main property block & Review the phrases

ThreeMammals · Oct 11, 2023 · c0bbcf8 · c0bbcf8
1 parent e55956c
commit c0bbcf8
Showing 1 changed file with 10 additions and 24 deletions.
diff --git a/docs/features/routing.rst b/docs/features/routing.rst
@@ -286,7 +286,7 @@ The current patterns managed are the following:
 
 This feature was requested in the `issue 1400 <https://github.com/ThreeMammals/Ocelot/issues/1400>`_.
 
-Upstream header-based routing
+Upstream Header-Based Routing
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 This feature was requested in `issue 360 <https://github.com/ThreeMammals/Ocelot/issues/360>`_ and `issue 624 <https://github.com/ThreeMammals/Ocelot/issues/624>`_.
@@ -300,16 +300,8 @@ A sample configuration might look like the following:
     {
         "Routes": [
             {
-                "DownstreamPathTemplate": "/api/posts",
-                "DownstreamScheme": "http",
-                "DownstreamHostAndPorts": [
-                        {
-                            "Host": "server1",
-                            "Port": 80,
-                        }
-                    ],
-                "UpstreamPathTemplate": "/posts",
-                "UpstreamHttpMethod": [ "Put", "Delete" ]
+                // Downstream* props
+                // Upstream* props
                 "UpstreamHeaderRoutingOptions": {
                     "Headers": {
                         "X-API-Version": [ "1" ],
@@ -319,29 +311,23 @@ A sample configuration might look like the following:
                 }
             },
             {
-                "DownstreamPathTemplate": "/api/posts",
-                "DownstreamScheme": "http",
-                "DownstreamHostAndPorts": [
-                        {
-                            "Host": "server2",
-                            "Port": 80,
-                        }
-                    ],
-                "UpstreamPathTemplate": "/posts",
-                "UpstreamHttpMethod": [ "Put", "Delete" ]
+                // Downstream* props
+                // Upstream* props
                 "UpstreamHeaderRoutingOptions": {
                     "Headers": {
-                        "X-API-Version": [ "2" ]
+                        "X-API-Version": [ "1", "2" ]
                     },
                     "TriggerOn": "any"
                 }
             }
         ]
     }
 
-The ``UpstreamHeaderRoutingOptions`` block defines two attributes -- the ``Headers`` block and the ``TriggerOn`` attribute. The ``Headers`` attribute defines required header names as keys and lists of acceptable header values as values. During route matching, both header names and values are matched in *case insensitive* manner. Please note that if a header has more than one acceptable value configured, presence of any of those values in a request is sufficient for a header to be a match.
+The ``UpstreamHeaderRoutingOptions`` block defines two attributes: the ``Headers`` block and the ``TriggerOn`` attribute.
+
+The ``Headers`` attribute defines required header names as keys and lists of acceptable header values as values. During route matching, both header names and values are matched in *case insensitive* manner. Please note that if a header has more than one acceptable value configured, presence of any of those values in a request is sufficient for a header to be a match.
 
 The second attribute, ``TriggerOn``, defines how the route finder will determine whether a particular header configuration in a request matches a Route's header configuration. The attribute accepts two values:
 
-* ``"Any"`` causes the route finder to match a Route if any value of any configured header is present in a request
+* ``"Any"`` causes the route finder to match a Route if any value of *any* configured header is present in a request
 * ``"All"`` causes the route finder to match a Route only if any value of *all* configured headers is present in a request