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

Addons: move the HTTP header to a GET parameter #10753

Merged
merged 1 commit into from
Sep 20, 2023
Merged

Conversation

humitos
Copy link
Member

@humitos humitos commented Sep 19, 2023

Move X-RTD-Hosting-Integration-Version header to api-version querystring parameter. This has some benefits:

  • make links to this URL clickable (there is no need to use a browser extension to send a specific header in the request)
  • easier to cache using the default strategy supported by CF

Related #10536

Move `X-RTD-Hosting-Integration-Version` header to `api-version` querystring
parameter. This has some benefits:

- make links to this URL clickable (there is no need to use a browser extension
  to send a specific header in the request)
- easier to cache using the default strategy supported by CF

Related #10536
@humitos humitos requested a review from a team as a code owner September 19, 2023 13:39
humitos added a commit to readthedocs/addons that referenced this pull request Sep 19, 2023
Send `api-version=` querystring parameter instead of a HTTP header
`X-RTD-Hosting-Integrations-Version` as discussed.

* Requires: readthedocs/readthedocs.org#10753
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea, this makes sense for something that is often sent via browser instead of an API client.

@humitos humitos merged commit a5af4e5 into main Sep 20, 2023
6 of 7 checks passed
@humitos humitos deleted the humitos/header-to-query branch September 20, 2023 10:30
humitos added a commit to readthedocs/addons that referenced this pull request Sep 20, 2023
Send `api-version=` querystring parameter instead of a HTTP header
`X-RTD-Hosting-Integrations-Version` as discussed.

* Requires: readthedocs/readthedocs.org#10753
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants