Clarify documentation

opentripplanner · Jan 24, 2024 · 6a087d1 · 6a087d1
1 parent b2e14f2
commit 6a087d1
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/docs/RouterConfiguration.md b/docs/RouterConfiguration.md
@@ -67,7 +67,7 @@ A full list of them can be found in the [RouteRequest](RouteRequest.md).
 |    [hideFeedId](#transmodelApi_hideFeedId)                                                |       `boolean`       | Hide the FeedId in all API output, and add it to input.                                               | *Optional* | `false`       |   na  |
 |    [tracingHeaderTags](#transmodelApi_tracingHeaderTags)                                  |       `string[]`      | Used to group requests when monitoring OTP.                                                           | *Optional* |               |   na  |
 | [updaters](UpdaterConfig.md)                                                              |       `object[]`      | Configuration for the updaters that import various types of data into OTP.                            | *Optional* |               |  1.5  |
-| [vectorTiles](sandbox/MapboxVectorTilesApi.md)                                            |        `object`       | TODO: Add short summary.                                                                              | *Optional* |               |   na  |
+| [vectorTiles](sandbox/MapboxVectorTilesApi.md)                                            |        `object`       | Vector tile configuration                                                                             | *Optional* |               |   na  |
 | [vehicleRentalServiceDirectory](sandbox/VehicleRentalServiceDirectory.md)                 |        `object`       | Configuration for the vehicle rental service directory.                                               | *Optional* |               |  2.0  |
 
 <!-- PARAMETERS-TABLE END -->

diff --git a/docs/sandbox/MapboxVectorTilesApi.md b/docs/sandbox/MapboxVectorTilesApi.md
@@ -179,6 +179,10 @@ The protocol and host are always read from the incoming HTTP request. If you run
 a proxy then make sure to set the headers `X-Forwarded-Proto` and `X-Forwarded-Host` to make OTP
 return the protocol and host for the original request and not the proxied one.
 
+**Note:** This does _not_ change the path that OTP itself serves the tiles or `tilejson.json`
+responses but simply changes the URLs listed in `tilejson.json`. The rewriting of the path
+is expected to be handled by a proxy.
+
 
 <h4 id="vectorTiles_layers">layers</h4>
 

diff --git a/src/main/java/org/opentripplanner/standalone/config/routerconfig/VectorTileConfig.java b/src/main/java/org/opentripplanner/standalone/config/routerconfig/VectorTileConfig.java
@@ -42,7 +42,7 @@ public Optional<String> basePath() {
   }
 
   public static VectorTileConfig mapVectorTilesParameters(NodeAdapter node, String paramName) {
-    var root = node.of(paramName).asObject();
+    var root = node.of(paramName).summary("Vector tile configuration").asObject();
     return new VectorTileConfig(
       root
         .of("layers")
@@ -65,6 +65,10 @@ public static VectorTileConfig mapVectorTilesParameters(NodeAdapter node, String
           The protocol and host are always read from the incoming HTTP request. If you run OTP behind 
           a proxy then make sure to set the headers `X-Forwarded-Proto` and `X-Forwarded-Host` to make OTP
           return the protocol and host for the original request and not the proxied one.
+          
+          **Note:** This does _not_ change the path that OTP itself serves the tiles or `tilejson.json`
+          responses but simply changes the URLs listed in `tilejson.json`. The rewriting of the path
+          is expected to be handled by a proxy.
           """
         )
         .asString(DEFAULT.basePath)