Support pulls/{number}/commits

[SamWilsn]

No description provided.

[XAMPPRocky]

Thank you for your PR! Can you rebase it on top on main?

[SamWilsn]

Done!

[maflcko]

lgtm

[SamWilsn]

@XAMPPRocky So it seems like GitHub's schema isn't entirely correct for the Author type, or maybe I'm doing something wrong. For at least one pull request, I'm getting back JSON that's deserializing to Author that doesn't have login or id. Have you encountered this before?

[XAMPPRocky]

@SamWilsn Yes, GitHub's schema is descriptive at best. It doesn't match the reality of the API and what the API will actually return.

[SamWilsn]

Should I change the Author type to have optional fields, or make a new type specific to this endpoint?

[XAMPPRocky]

Make it have optional fields, there might other endpoints where this also happens.

[SamWilsn]

It's, uh... mostly Option now 😅

[maflcko]

not sure this is correct?

author inside a commit is optional, but the fields inside author inside commit are not.

If you disagree, please link to the GitHub API schema that shows that the fields in author are optional.

[SamWilsn]

I can't provide a schema, but here's an API response:

https://api.github.com/repos/ethereum/ERCs/commits/fb8277911c110491bf3610b5e0298c4f4cb70a3f

[maflcko]

This is a GitUser, not an Author, see:

/// Metaproperties for Git author/committer information.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GitUser {
    pub date: Option<String>,
    pub email: Option<String>,
    pub name: Option<String>,
}

[maflcko]

I can't provide a schema, but here's an API response:

You can get the schema from https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#list-commits-on-a-pull-request . See tab "Response schema".

[SamWilsn]

I don't think so. On this commit we have:

{
  // ...
  "comments_url": "https://api.github.com/repos/ethereum/ERCs/commits/fb8277911c110491bf3610b5e0298c4f4cb70a3f/comments",
  "author": {

  },
  "committer": {

  },
  "parents": [ /* ... */ ],
  // ...
}

Note the empty (but non-null) committer and author items.

---

On another commit we have:

{
  // ...
  "comments_url": "https://api.github.com/repos/ethereum/ERCs/commits/ce626a0f5d26545ececf4ca6ea4bf64c16b6b233/comments",
  "author": {
    "login": "tokernomics",
    "id": 88177870,
    "node_id": "MDQ6VXNlcjg4MTc3ODcw",
    "avatar_url": "https://avatars.githubusercontent.com/u/88177870?v=4",
    "gravatar_id": "",
    "url": "https://api.github.com/users/tokernomics",
    "html_url": "https://github.com/tokernomics",
    "followers_url": "https://api.github.com/users/tokernomics/followers",
    "following_url": "https://api.github.com/users/tokernomics/following{/other_user}",
    "gists_url": "https://api.github.com/users/tokernomics/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/tokernomics/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/tokernomics/subscriptions",
    "organizations_url": "https://api.github.com/users/tokernomics/orgs",
    "repos_url": "https://api.github.com/users/tokernomics/repos",
    "events_url": "https://api.github.com/users/tokernomics/events{/privacy}",
    "received_events_url": "https://api.github.com/users/tokernomics/received_events",
    "type": "User",
    "site_admin": false
  },
  "committer": {
    "login": "web-flow",
    "id": 19864447,
    "node_id": "MDQ6VXNlcjE5ODY0NDQ3",
    "avatar_url": "https://avatars.githubusercontent.com/u/19864447?v=4",
    "gravatar_id": "",
    "url": "https://api.github.com/users/web-flow",
    "html_url": "https://github.com/web-flow",
    "followers_url": "https://api.github.com/users/web-flow/followers",
    "following_url": "https://api.github.com/users/web-flow/following{/other_user}",
    "gists_url": "https://api.github.com/users/web-flow/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/web-flow/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/web-flow/subscriptions",
    "organizations_url": "https://api.github.com/users/web-flow/orgs",
    "repos_url": "https://api.github.com/users/web-flow/repos",
    "events_url": "https://api.github.com/users/web-flow/events{/privacy}",
    "received_events_url": "https://api.github.com/users/web-flow/received_events",
    "type": "User",
    "site_admin": false
  },
  "parents": [ /* ... */ ],
  // ...
}

The data here more closely matches the Author struct, and not the GitUser struct.

[maflcko]

I meant in the reply ["commit"]["author"] is a GitUser. In the reply ["author"] is indeed an Author.

The problem is that, apparently the API incorrectly returns an empty dict instead of null, when the author should be null?

See the schema:

    "author": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "title": "Simple User",
          "description": "A GitHub user.",
...

This seems like a GitHub bug, given that their docs claim otherwise than the reply and in the past the endpoint worked fine, no?

[SamWilsn]

I am not familiar enough with the GitHub API to judge. I'm just going off this comment.

[SamWilsn]

Seems like it's been broken for a while: https://github.com/orgs/community/discussions/57497

[maflcko]

I don't think they monitor the discussions. It can be reported here: https://github.com/github/docs/issues

[SamWilsn]

Seems like GitHub hasn't gotten around to fixing either the documentation or the API endpoint. How would you like to proceed?

[maflcko]

I think they did fix the docs. For me it now says:

        {
          "title": "Empty Object",
          "description": "An object without any properties.",
          "type": "object",
          "properties": {},
          "additionalProperties": false
        }

Would it be possible to write code to conditionally deserialize into either Author (with fields), or into an empty dictionary (without any fields)?

[SamWilsn]

I think they did fix the docs.

I don't know how I missed that! I'm sorry.

Would it be possible to write code to conditionally deserialize into either Author (with fields), or into an empty dictionary (without any fields)?

I could do something like:

#[derive(Deserialize)]
#[serde(deny_unknown_fields)]
struct Empty {
}

#[derive(Deserialize)]
#[serde(untagged)]
enum MaybeAuthor {
    Empty(Empty),
    Author(Author),
}

I think I'd prefer mapping {} to None though, unless there's a good reason not to?

[maflcko]

I think I'd prefer mapping {} to None though, unless there's a good reason not to?

Sure, I'd be ok with that as well.

[XAMPPRocky]

I think it would be better to have it be an option, if it's empty it should be considered equivalent to null.

[SamWilsn]

@XAMPPRocky @maflcko Sorry for the super long delay on this one. Noticed you've added support for pr commits! I've co-opted this pull request into adding support for deserializing {}.

Hopefully I've followed the specific pr style well enough!

[maflcko]

lgtm

[maflcko]

Needs rebase

[SamWilsn]

Done

[XAMPPRocky]

Thank you for your PR, and congrats on your first contribution! 🎉