Skip to content

Schema documentation error for consumed-licenses #2842

Closed
@google-admin

Description

@google-admin

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": [
        "monalisa@github.com"
      ],
      // ...
    },
    {
      "github_com_login": "",
      // ...
      "enterprise_server_emails": [
        "hubot@example.com"
      ],
      // ...
    }
  ]
}

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

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions