Skip to content

Override headers#227

Merged
sebpretzer merged 9 commits into
mainfrom
override_headers
Dec 18, 2025
Merged

Override headers#227
sebpretzer merged 9 commits into
mainfrom
override_headers

Conversation

@sebpretzer

@sebpretzer sebpretzer commented Dec 17, 2025

Copy link
Copy Markdown
Owner

Fixes: #212 and #226

  1. Updates the settings to allow users to pass in custom headers
  2. Adds documentation to show users how to do so
  3. Adds a warning message when it occurs in code to point to the documentation

@github-actions

github-actions Bot commented Dec 17, 2025

Copy link
Copy Markdown
Contributor

Coverage report

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)
Lines missing
  src/pyticktick
  settings.py 393-402
Project Total  

This report was generated by python-coverage-comment-action

@sebpretzer sebpretzer left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

self-review complete

@sebpretzer sebpretzer marked this pull request as ready for review December 18, 2025 03:13
Copilot AI review requested due to automatic review settings December 18, 2025 03:13

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR adds support for overriding V2 API request headers to address issues where TickTick returns 429 errors due to outdated headers. The changes enable users to customize the User-Agent and X-Device headers when the default values become invalid.

  • Introduces configurable v2_user_agent and v2_x_device settings with sensible defaults
  • Adds warning message when 429 errors occur to guide users to header override documentation
  • Provides comprehensive documentation explaining how to find and set valid header values

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.

File Description
src/pyticktick/settings.py Adds V2XDevice model and configurable header fields; removes hardcoded header values; adds warning for 429 errors
tests/unit/test_settings.py Adds comprehensive test coverage for new header configuration functionality
docs/guides/settings/overriding_outdated_headers.md New documentation explaining header override feature with examples
mkdocs.yaml Adds navigation entry for new documentation page

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/pyticktick/settings.py Outdated
Comment thread src/pyticktick/settings.py
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@sebpretzer sebpretzer merged commit cfab661 into main Dec 18, 2025
11 checks passed
@sebpretzer sebpretzer deleted the override_headers branch December 18, 2025 03:19
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.

Allow headers to be overwritten

2 participants