Issue.state_reason can now be duplicate, breaking existing clients.

[sterliakov]

Select Topic Area

Bug

Body

Issue close_reason can be duplicate now.

The official docs do not seem to mention it, but... apparently it exists since today.

This is a breaking change that must be versioned. Please revert these changes to the current API version.

OpenAPI declaration in the docs:

      "state_reason": {
        "description": "The reason for the current state",
        "type": [
          "string",
          "null"
        ],
        "enum": [
          "completed",
          "reopened",
          "not_planned",
          null
        ],
        "examples": [
          "not_planned"
        ]
      },

Here's an issue with that state_reason (https://api.github.com/repos/python/mypy/issues/18584):

    {
        "active_lock_reason": null,
        "assignee": null,
        "assignees": [],
        "author_association": "CONTRIBUTOR",
        "body": "...",                                                                                                     
        "closed_at": "2025-02-02T16:24:49Z",
        "closed_by": {...},
        "comments": 1,
        "comments_url": "https://api.github.com/repos/python/mypy/issues/18584/comments",
        "created_at": "2025-02-01T23:28:55Z",
        "events_url": "https://api.github.com/repos/python/mypy/issues/18584/events",
        "html_url": "https://github.com/python/mypy/issues/18584",
        "id": 2825499430,
        "labels": [...],
        "labels_url": "https://api.github.com/repos/python/mypy/issues/18584/labels{/name}",
        "locked": false,
        "milestone": null,
        "node_id": "I_kwDOAGuhRc6oabMm",
        "number": 18584,
        "performed_via_github_app": null,
        "reactions": {...},
        "repository_url": "https://api.github.com/repos/python/mypy",
        "state": "closed",
        "state_reason": "duplicate",
        "sub_issues_summary": {
            "completed": 0,
            "percent_completed": 0,
            "total": 0
        },
        "timeline_url": "https://api.github.com/repos/python/mypy/issues/18584/timeline",
        "title": "Overloaded signature with `LiteralString` is seen as \"broader or same\" as `str`",
        "updated_at": "2025-02-02T16:24:50Z",
        "url": "https://api.github.com/repos/python/mypy/issues/18584",
        "user": {...}
    }

Issue model in https://github.com/yanyongyu/githubkit matches the API specification and declares this field as

state_reason: Missing[
    Union[None, Literal["completed", "reopened", "not_planned"]]
] = Field(default=UNSET, description="The reason for the current state")

causing some grief:

INFO:httpx:HTTP Request: GET https://api.github.com/repos/python/mypy/issues?state=closed&sort=created&direction=desc&since=2025-02-01+23%3A28%3A55%2B00%3A00&per_page=100&page=1 "HTTP/1.1 200 OK"
Traceback (most recent call last):
  File "/home/runner/work/mypy-issues/mypy-issues/.venv/bin/fetch", line 10, in <module>
    sys.exit(fetch_issues())
             ~~~~~~~~~~~~^^
  File "/home/runner/work/mypy-issues/mypy-issues/src/mypy_issues/__init__.py", line 28, in fetch_issues
    download_snippets(token, limit=args.limit)
    ~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/runner/work/mypy-issues/mypy-issues/src/mypy_issues/issues.py", line 47, in download_snippets
    removed = {iss.number for iss in _get_closed_issues(gh, org, repo, since)}
                                     ~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^
  File "/home/runner/work/mypy-issues/mypy-issues/src/mypy_issues/issues.py", line 147, in _get_closed_issues
    ).parsed_data
      ^^^^^^^^^^^
  File "/home/runner/work/mypy-issues/mypy-issues/.venv/lib/python3.13/site-packages/githubkit/response.py", line 94, in parsed_data
    return type_validate_json(self._data_model, self.content)
  File "/home/runner/work/mypy-issues/mypy-issues/.venv/lib/python3.13/site-packages/githubkit/compat.py", line 43, in type_validate_json
    return TypeAdapter(type_).validate_json(data)
           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^
  File "/home/runner/work/mypy-issues/mypy-issues/.venv/lib/python3.13/site-packages/pydantic/type_adapter.py", line 446, in validate_json
    return self.validator.validate_json(
           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~^
        data, strict=strict, context=context, allow_partial=experimental_allow_partial
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    )
    ^
pydantic_core._pydantic_core.ValidationError: 2 validation errors for list[Issue]
0.state_reason.literal[<UNSET>]
  Input should be <UNSET> [type=literal_error, input_value='duplicate', input_type=str]
    For further information visit https://errors.pydantic.dev/2.10/v/literal_error
0.state_reason.literal['completed','reopened','not_planned']
  Input should be 'completed', 'reopened' or 'not_planned' [type=literal_error, input_value='duplicate', input_type=str]
    For further information visit https://errors.pydantic.dev/2.10/v/literal_error

Here's a workflow that started failing today because of that: https://github.com/sterliakov/mypy-issues/actions/runs/13100571335/job/36549132079#step:6:50

[github-actions[bot]]

💬 Your Product Feedback Has Been Submitted 🎉

Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users.

Here's what you can expect moving forward ⏩

• Your input will be carefully reviewed and cataloged by members of our product teams. 
  • Due to the high volume of submissions, we may not always be able to provide individual responses.
  • Rest assured, your feedback will help chart our course for product improvements.
• Other users may engage with your post, sharing their own perspectives or experiences. 
• GitHub staff may reach out for further clarification or insight. 
  • We may 'Answer' your discussion if there is a current solution, workaround, or roadmap/changelog post related to the feedback.

Where to look to see what's shipping 👀

• Read the Changelog for real-time updates on the latest GitHub features, enhancements, and calls for feedback.
• Explore our Product Roadmap, which details upcoming major releases and initiatives.

What you can do in the meantime 💻

• Upvote and comment on other user feedback Discussions that resonate with you.
• Add more information at any point! Useful details include: use cases, relevant labels, desired outcomes, and any accompanying screenshots.

As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities.

Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐

[sterliakov]

Reposted at github/rest-api-description#4492 where it fits better.