Skip to content

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

Open
@gtback

Description

@gtback

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! 🎉

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions