Skip to content

Response for List app installations accessible to the user access token is odd #1397

Open
@jsoref

Description

@jsoref

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token

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

The JSON response is suspicious:

{
    "total_count": 2,
    "installations": [
      {
        "id": 1,
        "account": {
          "login": "octocat",
          "id": 1,
          "node_id": "MDQ6VXNlcjE=",
          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
          "gravatar_id": "",
          "url": "https://api.github.com/users/octocat",
          "html_url": "https://github.com/octocat",
          "followers_url": "https://api.github.com/users/octocat/followers",
          "following_url": "https://api.github.com/users/octocat/following{/other_user}",
          "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
          "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
          "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
          "organizations_url": "https://api.github.com/users/octocat/orgs",
          "repos_url": "https://api.github.com/users/octocat/repos",
          "events_url": "https://api.github.com/users/octocat/events{/privacy}",
          "received_events_url": "https://api.github.com/users/octocat/received_events",
          "type": "User",
          "site_admin": false
        },
        "access_tokens_url": "https://api.github.com/installations/1/access_tokens",
        "repositories_url": "https://api.github.com/installation/repositories",
        "html_url": "https://github.com/organizations/github/settings/installations/1",
        "app_id": 1,
        "target_id": 1,
        "target_type": "Organization",
        "permissions": {
          "checks": "write",
          "metadata": "read",
          "contents": "read"
        },
        "events": [
          "push",
          "pull_request"
        ],
        "single_file_name": "config.yaml",
        "has_multiple_single_files": true,
        "single_file_paths": [
          "config.yml",
          ".github/issue_TEMPLATE.md"
        ],
        "repository_selection": "all",
        "created_at": "2017-07-08T16:18:44-04:00",
        "updated_at": "2017-07-08T16:18:44-04:00",
        "app_slug": "github-actions",
        "suspended_at": null,
        "suspended_by": null
      },
      {
        "id": 3,
        "account": {
          "login": "octocat",
          "id": 2,
          "node_id": "MDQ6VXNlcjE=",
          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
          "gravatar_id": "",
          "url": "https://api.github.com/users/octocat",
          "html_url": "https://github.com/octocat",
          "followers_url": "https://api.github.com/users/octocat/followers",
          "following_url": "https://api.github.com/users/octocat/following{/other_user}",
          "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
          "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
          "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
          "organizations_url": "https://api.github.com/users/octocat/orgs",
          "repos_url": "https://api.github.com/users/octocat/repos",
          "events_url": "https://api.github.com/users/octocat/events{/privacy}",
          "received_events_url": "https://api.github.com/users/octocat/received_events",
          "type": "User",
          "site_admin": false
        },
        "access_tokens_url": "https://api.github.com/installations/1/access_tokens",
        "repositories_url": "https://api.github.com/installation/repositories",
        "html_url": "https://github.com/organizations/github/settings/installations/1",
        "app_id": 1,
        "target_id": 1,
        "target_type": "Organization",
        "permissions": {
          "checks": "write",
          "metadata": "read",
          "contents": "read"
        },
        "events": [
          "push",
          "pull_request"
        ],
        "single_file_name": "config.yaml",
        "has_multiple_single_files": true,
        "single_file_paths": [
          "config.yml",
          ".github/issue_TEMPLATE.md"
        ],
        "repository_selection": "all",
        "created_at": "2017-07-08T16:18:44-04:00",
        "updated_at": "2017-07-08T16:18:44-04:00",
        "app_slug": "github-actions",
        "suspended_at": null,
        "suspended_by": null
      }
    ]
  }

I'd expect these fields to differ for each element in the array:

        "access_tokens_url": "https://api.github.com/installations/1/access_tokens",
        "html_url": "https://github.com/organizations/github/settings/installations/1",

It'd also be nice if the example provided something that matched the experience described in https://github.com/orgs/community/discussions/27520

Additional information

No response

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions