Merge pull request #1 from nu11ptr/base_path_docs

Add base_path docs to explain behavior
nu11ptr · Apr 5, 2019 · c1b7a87 · c1b7a87
2 parents 79ff520 + 1c34df8
commit c1b7a87
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/protoc-gen-swagger/options/openapiv2.proto b/protoc-gen-swagger/options/openapiv2.proto
@@ -15,6 +15,10 @@ message Swagger {
   string swagger = 1;
   Info info = 2;
   string host = 3;
+  // Note that using `base_path` does not change the endpoint paths that are generated in the resulting 
+  // Swagger file. If you wish to use `base_path` with relatively generated Swagger paths, the 
+  // `base_path` must be manually removed from your `google.api.http` paths and your code changed to 
+  // serve the API from the `base_path`.
   string base_path = 4;
   enum SwaggerScheme {
     UNKNOWN = 0;