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

API slug isn't defined in GHEC Secret scanning patterns page #16825

Open
1 task done
jsoref opened this issue Apr 4, 2022 · 3 comments · May be fixed by #17452
Open
1 task done

API slug isn't defined in GHEC Secret scanning patterns page #16825

jsoref opened this issue Apr 4, 2022 · 3 comments · May be fixed by #17452
Labels
content enterprise good first issue help wanted

Comments

@jsoref
Copy link

@jsoref jsoref commented Apr 4, 2022

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/enterprise-cloud@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security

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

https://docs.github.com/en/enterprise-cloud@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security

Provider Supported secret API slug
Adafruit IO Adafruit IO Key adafruit_io_key

Something in this page should explain what an API slug is.

Additional information

An API slug is apparently meant to be used as a secret_type when fed to:
https://docs.github.com/en/rest/reference/secret-scanning


Update from a maintainer:

Content design plan

  1. Update the column header on Secret scanning patterns to read "Secret types" instead of "API slug". The change will need to be made in: https://github.com/github/docs/blob/main/data/reusables/secret-scanning/partner-secret-list-private-repo.md.
  2. Edit the main Secret scanning patterns page to add a brief introduction in the section before the table to explain that if you use the REST API for secret scanning, you can use the "Secret type" to report on specific types of secret. With a link to the Secret Scanning article.

Once this is fixed, we'll need to open an internal pull request to remove the reference to "API slug" from the REST API reference notes.

@jsoref jsoref added the content label Apr 4, 2022
@github-actions github-actions bot added the triage label Apr 4, 2022
@ramyaparimi ramyaparimi added enterprise waiting for review and removed triage labels Apr 5, 2022
@ramyaparimi
Copy link

@ramyaparimi ramyaparimi commented Apr 5, 2022

@jsoref
Thanks so much for opening an issue! I'll triage this for the team to review 👀

@felicitymay
Copy link

@felicitymay felicitymay commented Apr 6, 2022

Thanks for flagging this discrepancy and lack of explanation 👍🏻

I'll check whether there's a reason for using the two different descriptions for this value. If not, then it would make sense to talk about "Secret types" in both locations.

@felicitymay
Copy link

@felicitymay felicitymay commented Apr 22, 2022

I've managed to catch up with the team on this and they agree that we should talk about "Secret types" in both locations. In addition, we think that it would be helpful to add a brief sentence to the paragraph above the table explaining that if you use the REST API for secret scanning, you can use "Secret type" to report on specific types of secret.

I'll update the issue summary with this plan and mark this issue as help wanted.

Thank you for bringing this to our attention 🙂

@felicitymay felicitymay added help wanted good first issue and removed waiting for review labels Apr 22, 2022
@ramyaparimi ramyaparimi added this to Help wanted in Docs open source board Apr 26, 2022
@jsoref jsoref linked a pull request Apr 29, 2022 that will close this issue
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content enterprise good first issue help wanted
Projects
Development

Successfully merging a pull request may close this issue.

4 participants
@felicitymay @jsoref @ramyaparimi and others