[BUG]: octokit.rest.apps.getInstallation(installation_id) calls `GET /app/installations` when it should call `GET /app/installations/{installation_id}`

[kevinwright]

What happened?

I first identified the problem when I called octokit.rest.apps.getInstallation, and expected it to return a single Installation instance as per the declared return type.

What I discovered was that the return value breached the return-type contract and instead contained an array of all installations for the app, as per octokit.rest.apps.listInstallations. This then caused a runtime failure due to the conflic between the declared return type and the actual return type.

Further investigation by way of the https://github.com/octokit/plugin-request-log.js plugin confirms that the wrong endpoint is being called.

Versions

octokit.js 4.0.2
@octokit/plugin-rest-endpoint-methods 13.2.6

Relevant log output

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[github-actions]

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

[wolfy1339]

Can you please share a code snipped demonstrating the issue

[wolfy1339]

According to the documentation, there should only be one value returned ever and not an array

[kevinwright]

According to the documentation, there should only be one value returned ever and not an array

Correct.

And yet when I log the reply I see that its value is actually an array.

To make it work I'm having to do this:

const installations =
    octokit.rest.apps.getInstallation(installation_id)

type T = typeof installations.data
const installationsArr: T[] = installations.data as T[]
const matching: T = installationsArr.find(x => x.id == installation_id)

It would appear that /app/installations is being called instead of /app/installations/{installation_id}

[kevinwright]

Better workaround:

const installations = octokit.rest.apps.listInstallations()
const matching = installations.data.find(x => x.id == installation_id)

If I'm going to be getting the full list anyway, then this costs me no more network bandwidth or latency - and I might as well get it with the right type to avoid jumping through hoops.

[wolfy1339]

So you are getting the full list from the endpoint called from Octokit?

[kevinwright]

So you are getting the full list from the endpoint called from Octokit?

Correct

[kevinwright]

I've now tested the behaviour when also using https://github.com/octokit/plugin-request-log.js and can confirm that - as suspected - the wrong endpoint is being called.

Ticket title and description has been updated to reflect this confirmation.

[wolfy1339]

As far as I can see, the correct endpoint is generated in the code,

plugin-rest-endpoint-methods.js/src/generated/endpoints.ts

Line 381 in 577d7d7

getInstallation: ["GET /app/installations/{installation_id}"],

I have no idea where it's coming from