Skip to content

[Schema Inaccuracy] Incorrect link in field description for organization secrets #957

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

Open
gtback opened this issue Mar 14, 2022 · 0 comments

Comments

@gtback
Copy link

gtback commented Mar 14, 2022

Schema Inaccuracy

The description for the selected_repository_ids parameter to the "Set selected repositories for an organization secret" API (PUT /orgs/{org}/actions/secrets/{secret_name}/repositories) says:

Required. An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

The "Set selected repositories for an organization secret" link is to the same API function, rather than the intended function.

Expected

It should link to the "Add selected repository to an organization secret" (PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}) section directly below instead.

Reproduction Steps

There's no incorrect behavior I noticed as part of this issue, just a way to make the docs more helpful.

🎉 Thanks for the excellent API documentation! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants