[REST] Document `/code-scanning/analysis/status`

[jsoref]

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/rest/authentication/permissions-required-for-github-apps?apiVersion=2022-11-28

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

https://docs.github.com/en/rest/authentication/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-code-scanning-alerts

Additional information

This is the only thing nearby, but it isn't technically the same api:

GET /repos/{owner}/{repo}/code-scanning/analyses	read	UAT IAT	✖️

All I know is that it's possible to not have enough permission to access the endpoint: github/codeql#15462

[aibaars]

I believe /code-scanning/analysis/status is an internal API for telemetry purposes, it's not part of the public API. I wonder why it fails for you though. Perhaps GitHub Advanced Security / CodeScanning is not enabled for the repository for some reason.

[nguyenalex836]

Note: asking about this internally 💛

[angelapwen]

I'm on the owning team 👋 can confirm that this is not meant to be externally documented. We'll follow up on why it's returning a 403/404 sometimes though...

[angelapwen]

This issue can be closed as we're not planning to document this internal-only API. I'll write more detail in github/codeql#15462 but we're planning on making sure failures from this endpoint don't fail the entire code scanning workflow, given that they are telemetry errors and unrelated to the actual analysis.