Schema documentation error for consumed-licenses

[google-admin]

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/enterprise-cloud@latest/rest/enterprise-admin/license?apiVersion=2022-11-28#list-enterprise-consumed-licenses

What part(s) of the article would you like to see updated?

The example response for /enterprises/{enterprise}/consumed-licenses has an inconsistency, namely that one user has enterprise_server_primary_emails but the second has enterprise_server_emails.

{
  // ...
  "users": [
    {
      "github_com_login": "monalisa",
      // ...
      "enterprise_server_primary_emails": [
        "[email protected]"
      ],
      // ...
    },
    {
      "github_com_login": "",
      // ...
      "enterprise_server_emails": [
        "[email protected]"
      ],
      // ...
    }
  ]
}

The Response schema indicates that it should be the latter:

"enterprise_server_emails": {
  "type": "array",
  "items": {
    "type": "string"
  }
},

However, that has no results searching on this repo whereas the former is mentioned elsewhere.

Making a live API call returns enterprise_server_primary_emails as well. Could the docs be updated to match the source of truth? Thanks!

Additional information

No response

[welcome]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[cmwilson21]

@google-admin Thanks so much for opening an issue! I'll triage this for the team to take a look 👀

[docs-bot]

Thank you for opening this issue! Changes to the REST API schema can be requested in github/rest-api-description. I will transfer your issue over to that open source repo.

[docs-bot]

Thank you for opening this issue! Changes to the REST API schema can be requested in github/rest-api-description. I will transfer your issue over to that open source repo.

[izuzak]

Thanks for reporting this -- this should be fixed now 🙇 🍰