Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[REST] Document /code-scanning/analysis/status #31331

Closed
1 task done
jsoref opened this issue Jan 29, 2024 · 4 comments
Closed
1 task done

[REST] Document /code-scanning/analysis/status #31331

jsoref opened this issue Jan 29, 2024 · 4 comments
Labels
content This issue or pull request belongs to the Docs Content team

Comments

@jsoref
Copy link
Contributor

jsoref commented Jan 29, 2024

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

@jsoref jsoref added the content This issue or pull request belongs to the Docs Content team label Jan 29, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jan 29, 2024
@aibaars
Copy link

aibaars commented Jan 29, 2024

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
Copy link
Contributor

Note: asking about this internally 💛

@angelapwen
Copy link
Contributor

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...

@nguyenalex836 nguyenalex836 removed the triage Do not begin working on this issue until triaged by the team label Jan 30, 2024
@angelapwen
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team
Projects
None yet
Development

No branches or pull requests

4 participants