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

response schema provided as a sapmle and actual api output is differnt #32884

Closed
1 task done
githubofkrishnadhas opened this issue May 9, 2024 · 3 comments
Closed
1 task done
Labels
content This issue or pull request belongs to the Docs Content team fix-internally Triggers a workflow to copy the issue internally and close the current issue rest Content related to rest - overview.

Comments

@githubofkrishnadhas
Copy link

Code of Conduct

What article on docs.github.com is affected?

i was going through https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#list-organization-repositories

i was doing an automation on enabling codeql analysis on repos https://docs.github.com/en/rest/code-scanning/code-scanning?apiVersion=2022-11-28, which are not enabled. for that i was running repositories api first to check for the repo dependabot, secret scanning are enabled or not.

i see the sample api response back like
image

`
"security_and_analysis": {
"advanced_security": {
"status": "enabled"
},
"secret_scanning": {
"status": "enabled"
},
"secret_scanning_push_protection": {
"status": "disabled"
}
}

`
but the actual response getting back is differnt

"security_and_analysis": { "secret_scanning": { "status": "disabled" }, "secret_scanning_push_protection": { "status": "disabled" }, "dependabot_security_updates": { "status": "disabled" }, "secret_scanning_validity_checks": { "status": "disabled" } }

i donot see this "advanced_security": { "status": "enabled" }, instead , "secret_scanning_validity_checks": { "status": "disabled" }, "secret_scanning": { "status": "disabled" }, are available. I urge you to adjust these as these can mislead developers.

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

Please make necessary changes on the response section

  • example response
  • response schema

image

Additional information

Hope the above details are good enough.

@githubofkrishnadhas githubofkrishnadhas added the content This issue or pull request belongs to the Docs Content team label May 9, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label May 9, 2024
@nguyenalex836 nguyenalex836 added rest Content related to rest - overview. fix-internally Triggers a workflow to copy the issue internally and close the current issue and removed triage Do not begin working on this issue until triaged by the team labels May 9, 2024
@docs-bot
Copy link
Collaborator

docs-bot commented May 9, 2024

Thank you for opening this issue! Updates to this documentation must be made internally. I have copied your issue to an internal issue, so I will close this issue.

@nguyenalex836
Copy link
Contributor

@githubofkrishnadhas Thank you for submitting this issue, and raising a flag on this! ✨ This portion of the documentation will need to be fixed internally. I've created an internal issue for our team to review, and will close out this issue 💛

@docs-bot docs-bot closed this as completed May 9, 2024
@githubofkrishnadhas
Copy link
Author

Thanks.i would be happy if you can add the issue id on pr 😉

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 fix-internally Triggers a workflow to copy the issue internally and close the current issue rest Content related to rest - overview.
Projects
None yet
Development

No branches or pull requests

4 participants
@docs-bot @githubofkrishnadhas @nguyenalex836 and others