Skip to content

Commit 0d13c65

Browse files
authored
feat: documented the changes made in PR 1633 (#1748)
* documented the changes made in PR 1633 * added user agent string example
1 parent f1705cf commit 0d13c65

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,13 @@ Validation reports have a unique URL link that can be shared and are available 3
4545

4646
The GTFS Web Validator contains two main components: the GTFS Web Validator Client and the GTFS Validator Web Service. More information about these components can be found in [GTFS Web Validator Client](./web/client/README.md) and [GTFS Validator Web Service](./web/service/README.md).
4747

48+
Several users have reported issues with the validator when processing their GTFS feeds. These issues arise due to the configuration of their websites, which may not be set up to handle:
49+
50+
1. Requests that come with custom user agents.
51+
2. Requests originating from non-browser sources.
52+
53+
To facilitate easier debugging and logging, we have made our user agent header explicit. The user agent string follows the format: "MobilityData GTFS-Validator/{validatorVersion} (Java {java version})". In cases where the `validatorVersion` is null, the `{validatorVersion}` segment in the user agent string will be left blank. The string "MobilityData GTFS-Validator/5.0.1 (Java 11.0.1)" serves as an example of the User Agent string.
54+
4855
# Using the Desktop app
4956
### Setup
5057
1. Navigate to the [Releases page](https://github.com/MobilityData/gtfs-validator/releases) and download the latest `Gtfs Validator` installer for your operating system:

0 commit comments

Comments
 (0)