Skip to content

Some API calls that are defined as taking ints in the GitHub spec are strings in this library #3269

Description

@danhcole

See #3265 (comment) for context.

Happy to take the work to fix this, filing an issue for tracking.

Question about ergonomics, though... the current library (as well as the GitHub API spec[0]) return the thread ID as a string. Changing the library to match the spec makes it a bit more annoying to do something like 'get a thread -> call an API on that thread', since this will now require converting the returned string to an int.

Given that this 'problem' is present in the API spec, I'm inclined to match the spec, but want to double check that this is the desired behavior of this project.

[0] From https://docs.github.com/en/rest/activity/notifications?apiVersion=2022-11-28#get-a-thread

{
  "title": "Thread",
  "description": "Thread",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    ...

Activity

  1. gmlewis commented on Sep 16, 2024

    @gmlewis
    Collaborator

    OK, that's really odd. First, I would suggest contacting GitHub tech support to see if they have any recommendations.
    If they don't, then I'm wondering if we should leave #3265 like you originally wrote it, using a string for the thread ID?

  2. danhcole commented on Sep 17, 2024

    @danhcole
    ContributorAuthor

    I opened up a case with them to see what they say. Depending on what they say, I would still lean to following their API schema, even at the expense of ease-of-use, but that's a pretty weakly held opinion, if others feel strongly.

  3. gmlewis commented on Mar 17, 2025

    @gmlewis
    Collaborator

    @danhcole - can this issue be closed?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions