Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GTFS download from URL: send a User-Agent #1562

Closed
derhuerst opened this issue Aug 25, 2023 · 2 comments · Fixed by #1633
Closed

GTFS download from URL: send a User-Agent #1562

derhuerst opened this issue Aug 25, 2023 · 2 comments · Fixed by #1633
Assignees
Labels
enhancement New feature request or improvement on an existing feature status: Ready An issue that is ready to be worked on.

Comments

@derhuerst
Copy link

Describe the problem

As someone hosting (a) GTFS(s), I would like to see in my access logs which and how many requests come from the GTFS Validator, e.g. to gain insights into if/how the feed(s) are being validated, or to provide a more generous bandwidth quota.

Proposed solution

I propose to let the GTFS Validator send a User-Agent header with its requests.

Alternatives you've considered

No response

Additional context

According to the User-Agent section in RFC 9110 (HTTP Semantics), User-Agent should

contain[s] information about the user agent originating the request, which is often used by servers to help identify the scope of reported interoperability problems, to work around or tailor responses to avoid particular user agent limitations, and for analytics regarding browser or operating system use. A user agent SHOULD send a User-Agent header field in each request unless specifically configured not to do so.
[…]
The User-Agent field value consists of one or more product identifiers, […], which together identify the user agent software and its significant subproducts. […] Each product identifier consists of a name and optional version.

It is also quite common to include a URL to the software's website or code repository, to let people contact the software's authors more conveniently.

@derhuerst derhuerst added enhancement New feature request or improvement on an existing feature status: Needs triage Applied to all new issues labels Aug 25, 2023
@github-project-automation github-project-automation bot moved this to Requires investigation in Bug triage Aug 31, 2023
@emmambd emmambd moved this to MobilityData Backlog (bugs & maintenance) in Schedule Validator Q2 backlog Dec 7, 2023
@emmambd emmambd added status: Ready An issue that is ready to be worked on. and removed status: Needs triage Applied to all new issues labels Jan 3, 2024
@emmambd emmambd added this to the Now milestone Jan 9, 2024
@davidgamez
Copy link
Member

Hi @derhuerst, as part of #1633, we're including the user-agent header in outgoing requests. To illustrate the expected formatting, this is an example, User-Agent: MobilityData GTFS-Validator/4.2.1 (Java 17.0.6). We welcome any feedback you may have.

@derhuerst
Copy link
Author

Sounds good!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature request or improvement on an existing feature status: Ready An issue that is ready to be worked on.
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants