diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 7b7c4eafe1..0a1ec9f153 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -38849,7 +38849,7 @@ "/repos/{owner}/{repo}/collaborators": { "get": { "summary": "List repository collaborators", - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have push access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nThe `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization.\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", "tags": [ "repos" ], @@ -39102,7 +39102,7 @@ "/repos/{owner}/{repo}/collaborators/{username}/permission": { "get": { "summary": "Get repository permissions for a user", - "description": "Checks the repository permission of a collaborator. The possible repository\npermissions are `admin`, `write`, `read`, and `none`.\n\n*Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the\ncollaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The\n`permissions` hash can also be used to determine which base level of access the collaborator has to the repository.", + "description": "Checks the repository permission and role of a collaborator.\n\nThe `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`.\nThe `role_name` attribute provides the name of the assigned role, including custom roles. The\n`permission` can also be used to determine which base level of access the collaborator has to the repository.\n\nThe calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.", "tags": [ "repos" ], diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index 5956f5e99e..00bb674b2c 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -28238,12 +28238,12 @@ paths: summary: List repository collaborators description: |- For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. Team members will include the members of child teams. - The authenticated user must have push access to the repository to use this endpoint. - + The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. tags: - repos @@ -28468,13 +28468,15 @@ paths: get: summary: Get repository permissions for a user description: |- - Checks the repository permission of a collaborator. The possible repository - permissions are `admin`, `write`, `read`, and `none`. + Checks the repository permission and role of a collaborator. + + The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + The `role_name` attribute provides the name of the assigned role, including custom roles. The + `permission` can also be used to determine which base level of access the collaborator has to the repository. - *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. tags: - repos operationId: repos/get-collaborator-permission-level diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 7b7c4eafe1..0a1ec9f153 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -38849,7 +38849,7 @@ "/repos/{owner}/{repo}/collaborators": { "get": { "summary": "List repository collaborators", - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have push access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nThe `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization.\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", "tags": [ "repos" ], @@ -39102,7 +39102,7 @@ "/repos/{owner}/{repo}/collaborators/{username}/permission": { "get": { "summary": "Get repository permissions for a user", - "description": "Checks the repository permission of a collaborator. The possible repository\npermissions are `admin`, `write`, `read`, and `none`.\n\n*Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the\ncollaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The\n`permissions` hash can also be used to determine which base level of access the collaborator has to the repository.", + "description": "Checks the repository permission and role of a collaborator.\n\nThe `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`.\nThe `role_name` attribute provides the name of the assigned role, including custom roles. The\n`permission` can also be used to determine which base level of access the collaborator has to the repository.\n\nThe calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.", "tags": [ "repos" ], diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 5956f5e99e..00bb674b2c 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -28238,12 +28238,12 @@ paths: summary: List repository collaborators description: |- For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. Team members will include the members of child teams. - The authenticated user must have push access to the repository to use this endpoint. - + The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. tags: - repos @@ -28468,13 +28468,15 @@ paths: get: summary: Get repository permissions for a user description: |- - Checks the repository permission of a collaborator. The possible repository - permissions are `admin`, `write`, `read`, and `none`. + Checks the repository permission and role of a collaborator. + + The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + The `role_name` attribute provides the name of the assigned role, including custom roles. The + `permission` can also be used to determine which base level of access the collaborator has to the repository. - *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. tags: - repos operationId: repos/get-collaborator-permission-level diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 248d3f6b47..6c0f7b6635 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -277280,7 +277280,7 @@ "/repos/{owner}/{repo}/collaborators": { "get": { "summary": "List repository collaborators", - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have push access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nThe `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization.\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", "tags": [ "repos" ], @@ -279425,7 +279425,7 @@ "/repos/{owner}/{repo}/collaborators/{username}/permission": { "get": { "summary": "Get repository permissions for a user", - "description": "Checks the repository permission of a collaborator. The possible repository\npermissions are `admin`, `write`, `read`, and `none`.\n\n*Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the\ncollaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The\n`permissions` hash can also be used to determine which base level of access the collaborator has to the repository.", + "description": "Checks the repository permission and role of a collaborator.\n\nThe `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`.\nThe `role_name` attribute provides the name of the assigned role, including custom roles. The\n`permission` can also be used to determine which base level of access the collaborator has to the repository.\n\nThe calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.", "tags": [ "repos" ], diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index c55afaad4f..d832b591cc 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -59684,12 +59684,12 @@ paths: summary: List repository collaborators description: |- For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. Team members will include the members of child teams. - The authenticated user must have push access to the repository to use this endpoint. - + The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. tags: - repos @@ -60240,13 +60240,15 @@ paths: get: summary: Get repository permissions for a user description: |- - Checks the repository permission of a collaborator. The possible repository - permissions are `admin`, `write`, `read`, and `none`. + Checks the repository permission and role of a collaborator. + + The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + The `role_name` attribute provides the name of the assigned role, including custom roles. The + `permission` can also be used to determine which base level of access the collaborator has to the repository. - *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. tags: - repos operationId: repos/get-collaborator-permission-level diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 248d3f6b47..6c0f7b6635 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -277280,7 +277280,7 @@ "/repos/{owner}/{repo}/collaborators": { "get": { "summary": "List repository collaborators", - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have push access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nThe `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization.\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", "tags": [ "repos" ], @@ -279425,7 +279425,7 @@ "/repos/{owner}/{repo}/collaborators/{username}/permission": { "get": { "summary": "Get repository permissions for a user", - "description": "Checks the repository permission of a collaborator. The possible repository\npermissions are `admin`, `write`, `read`, and `none`.\n\n*Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the\ncollaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The\n`permissions` hash can also be used to determine which base level of access the collaborator has to the repository.", + "description": "Checks the repository permission and role of a collaborator.\n\nThe `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`.\nThe `role_name` attribute provides the name of the assigned role, including custom roles. The\n`permission` can also be used to determine which base level of access the collaborator has to the repository.\n\nThe calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.", "tags": [ "repos" ], diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index c55afaad4f..d832b591cc 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -59684,12 +59684,12 @@ paths: summary: List repository collaborators description: |- For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. Team members will include the members of child teams. - The authenticated user must have push access to the repository to use this endpoint. - + The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. tags: - repos @@ -60240,13 +60240,15 @@ paths: get: summary: Get repository permissions for a user description: |- - Checks the repository permission of a collaborator. The possible repository - permissions are `admin`, `write`, `read`, and `none`. + Checks the repository permission and role of a collaborator. + + The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + The `role_name` attribute provides the name of the assigned role, including custom roles. The + `permission` can also be used to determine which base level of access the collaborator has to the repository. - *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. tags: - repos operationId: repos/get-collaborator-permission-level diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index 1c61f8a2cf..85b293a0cc 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -315233,7 +315233,7 @@ "/repos/{owner}/{repo}/collaborators": { "get": { "summary": "List repository collaborators", - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have push access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nThe `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization.\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", "tags": [ "repos" ], @@ -317390,7 +317390,7 @@ "/repos/{owner}/{repo}/collaborators/{username}/permission": { "get": { "summary": "Get repository permissions for a user", - "description": "Checks the repository permission of a collaborator. The possible repository\npermissions are `admin`, `write`, `read`, and `none`.\n\n*Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the\ncollaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The\n`permissions` hash can also be used to determine which base level of access the collaborator has to the repository.", + "description": "Checks the repository permission and role of a collaborator.\n\nThe `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`.\nThe `role_name` attribute provides the name of the assigned role, including custom roles. The\n`permission` can also be used to determine which base level of access the collaborator has to the repository.\n\nThe calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.", "tags": [ "repos" ], diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index b4b33f8352..aebd0c5a23 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -68067,12 +68067,12 @@ paths: summary: List repository collaborators description: |- For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. Team members will include the members of child teams. - The authenticated user must have push access to the repository to use this endpoint. - + The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. tags: - repos @@ -68623,13 +68623,15 @@ paths: get: summary: Get repository permissions for a user description: |- - Checks the repository permission of a collaborator. The possible repository - permissions are `admin`, `write`, `read`, and `none`. + Checks the repository permission and role of a collaborator. + + The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + The `role_name` attribute provides the name of the assigned role, including custom roles. The + `permission` can also be used to determine which base level of access the collaborator has to the repository. - *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. tags: - repos operationId: repos/get-collaborator-permission-level diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index 1c61f8a2cf..85b293a0cc 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -315233,7 +315233,7 @@ "/repos/{owner}/{repo}/collaborators": { "get": { "summary": "List repository collaborators", - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have push access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nThe `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization.\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", "tags": [ "repos" ], @@ -317390,7 +317390,7 @@ "/repos/{owner}/{repo}/collaborators/{username}/permission": { "get": { "summary": "Get repository permissions for a user", - "description": "Checks the repository permission of a collaborator. The possible repository\npermissions are `admin`, `write`, `read`, and `none`.\n\n*Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the\ncollaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The\n`permissions` hash can also be used to determine which base level of access the collaborator has to the repository.", + "description": "Checks the repository permission and role of a collaborator.\n\nThe `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`.\nThe `role_name` attribute provides the name of the assigned role, including custom roles. The\n`permission` can also be used to determine which base level of access the collaborator has to the repository.\n\nThe calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.", "tags": [ "repos" ], diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index b4b33f8352..aebd0c5a23 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -68067,12 +68067,12 @@ paths: summary: List repository collaborators description: |- For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. Team members will include the members of child teams. - The authenticated user must have push access to the repository to use this endpoint. - + The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. tags: - repos @@ -68623,13 +68623,15 @@ paths: get: summary: Get repository permissions for a user description: |- - Checks the repository permission of a collaborator. The possible repository - permissions are `admin`, `write`, `read`, and `none`. + Checks the repository permission and role of a collaborator. + + The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + The `role_name` attribute provides the name of the assigned role, including custom roles. The + `permission` can also be used to determine which base level of access the collaborator has to the repository. - *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. tags: - repos operationId: repos/get-collaborator-permission-level diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index 845c703932..8af779dc89 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -46926,7 +46926,7 @@ "/repos/{owner}/{repo}/collaborators": { "get": { "summary": "List repository collaborators", - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have push access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nThe `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization.\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", "tags": [ "repos" ], @@ -47179,7 +47179,7 @@ "/repos/{owner}/{repo}/collaborators/{username}/permission": { "get": { "summary": "Get repository permissions for a user", - "description": "Checks the repository permission of a collaborator. The possible repository\npermissions are `admin`, `write`, `read`, and `none`.\n\n*Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the\ncollaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The\n`permissions` hash can also be used to determine which base level of access the collaborator has to the repository.", + "description": "Checks the repository permission and role of a collaborator.\n\nThe `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`.\nThe `role_name` attribute provides the name of the assigned role, including custom roles. The\n`permission` can also be used to determine which base level of access the collaborator has to the repository.\n\nThe calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.", "tags": [ "repos" ], diff --git a/descriptions-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index 8638320727..dd3c4c941f 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -34011,12 +34011,12 @@ paths: summary: List repository collaborators description: |- For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. Team members will include the members of child teams. - The authenticated user must have push access to the repository to use this endpoint. - + The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. tags: - repos @@ -34241,13 +34241,15 @@ paths: get: summary: Get repository permissions for a user description: |- - Checks the repository permission of a collaborator. The possible repository - permissions are `admin`, `write`, `read`, and `none`. + Checks the repository permission and role of a collaborator. + + The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + The `role_name` attribute provides the name of the assigned role, including custom roles. The + `permission` can also be used to determine which base level of access the collaborator has to the repository. - *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. tags: - repos operationId: repos/get-collaborator-permission-level diff --git a/descriptions-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index 845c703932..8af779dc89 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -46926,7 +46926,7 @@ "/repos/{owner}/{repo}/collaborators": { "get": { "summary": "List repository collaborators", - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have push access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nThe `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization.\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", "tags": [ "repos" ], @@ -47179,7 +47179,7 @@ "/repos/{owner}/{repo}/collaborators/{username}/permission": { "get": { "summary": "Get repository permissions for a user", - "description": "Checks the repository permission of a collaborator. The possible repository\npermissions are `admin`, `write`, `read`, and `none`.\n\n*Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the\ncollaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The\n`permissions` hash can also be used to determine which base level of access the collaborator has to the repository.", + "description": "Checks the repository permission and role of a collaborator.\n\nThe `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`.\nThe `role_name` attribute provides the name of the assigned role, including custom roles. The\n`permission` can also be used to determine which base level of access the collaborator has to the repository.\n\nThe calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.", "tags": [ "repos" ], diff --git a/descriptions-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index 8638320727..dd3c4c941f 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -34011,12 +34011,12 @@ paths: summary: List repository collaborators description: |- For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. Team members will include the members of child teams. - The authenticated user must have push access to the repository to use this endpoint. - + The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. tags: - repos @@ -34241,13 +34241,15 @@ paths: get: summary: Get repository permissions for a user description: |- - Checks the repository permission of a collaborator. The possible repository - permissions are `admin`, `write`, `read`, and `none`. + Checks the repository permission and role of a collaborator. + + The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + The `role_name` attribute provides the name of the assigned role, including custom roles. The + `permission` can also be used to determine which base level of access the collaborator has to the repository. - *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. tags: - repos operationId: repos/get-collaborator-permission-level diff --git a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json index 52389597ad..1285bef260 100644 --- a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json @@ -245779,7 +245779,7 @@ "/repos/{owner}/{repo}/collaborators": { "get": { "summary": "List repository collaborators", - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have push access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nThe `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization.\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", "tags": [ "repos" ], @@ -246530,7 +246530,7 @@ "/repos/{owner}/{repo}/collaborators/{username}/permission": { "get": { "summary": "Get repository permissions for a user", - "description": "Checks the repository permission of a collaborator. The possible repository\npermissions are `admin`, `write`, `read`, and `none`.\n\n*Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the\ncollaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The\n`permissions` hash can also be used to determine which base level of access the collaborator has to the repository.", + "description": "Checks the repository permission and role of a collaborator.\n\nThe `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`.\nThe `role_name` attribute provides the name of the assigned role, including custom roles. The\n`permission` can also be used to determine which base level of access the collaborator has to the repository.\n\nThe calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.", "tags": [ "repos" ], diff --git a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml index aab8024695..16396bc777 100644 --- a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml +++ b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml @@ -52748,12 +52748,12 @@ paths: summary: List repository collaborators description: |- For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. Team members will include the members of child teams. - The authenticated user must have push access to the repository to use this endpoint. - + The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. tags: - repos @@ -53115,13 +53115,15 @@ paths: get: summary: Get repository permissions for a user description: |- - Checks the repository permission of a collaborator. The possible repository - permissions are `admin`, `write`, `read`, and `none`. + Checks the repository permission and role of a collaborator. + + The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + The `role_name` attribute provides the name of the assigned role, including custom roles. The + `permission` can also be used to determine which base level of access the collaborator has to the repository. - *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. tags: - repos operationId: repos/get-collaborator-permission-level diff --git a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.json b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.json index 52389597ad..1285bef260 100644 --- a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.json +++ b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.json @@ -245779,7 +245779,7 @@ "/repos/{owner}/{repo}/collaborators": { "get": { "summary": "List repository collaborators", - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have push access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nThe `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization.\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", "tags": [ "repos" ], @@ -246530,7 +246530,7 @@ "/repos/{owner}/{repo}/collaborators/{username}/permission": { "get": { "summary": "Get repository permissions for a user", - "description": "Checks the repository permission of a collaborator. The possible repository\npermissions are `admin`, `write`, `read`, and `none`.\n\n*Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the\ncollaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The\n`permissions` hash can also be used to determine which base level of access the collaborator has to the repository.", + "description": "Checks the repository permission and role of a collaborator.\n\nThe `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`.\nThe `role_name` attribute provides the name of the assigned role, including custom roles. The\n`permission` can also be used to determine which base level of access the collaborator has to the repository.\n\nThe calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.", "tags": [ "repos" ], diff --git a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.yaml b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.yaml index aab8024695..16396bc777 100644 --- a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.yaml +++ b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.yaml @@ -52748,12 +52748,12 @@ paths: summary: List repository collaborators description: |- For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. Team members will include the members of child teams. - The authenticated user must have push access to the repository to use this endpoint. - + The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. tags: - repos @@ -53115,13 +53115,15 @@ paths: get: summary: Get repository permissions for a user description: |- - Checks the repository permission of a collaborator. The possible repository - permissions are `admin`, `write`, `read`, and `none`. + Checks the repository permission and role of a collaborator. + + The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + The `role_name` attribute provides the name of the assigned role, including custom roles. The + `permission` can also be used to determine which base level of access the collaborator has to the repository. - *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. tags: - repos operationId: repos/get-collaborator-permission-level diff --git a/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.json b/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.json index 5b44b3e576..64be4e8f68 100644 --- a/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.json +++ b/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.json @@ -35562,7 +35562,7 @@ "/repos/{owner}/{repo}/collaborators": { "get": { "summary": "List repository collaborators", - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have push access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nThe `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization.\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", "tags": [ "repos" ], @@ -35800,7 +35800,7 @@ "/repos/{owner}/{repo}/collaborators/{username}/permission": { "get": { "summary": "Get repository permissions for a user", - "description": "Checks the repository permission of a collaborator. The possible repository\npermissions are `admin`, `write`, `read`, and `none`.\n\n*Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the\ncollaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The\n`permissions` hash can also be used to determine which base level of access the collaborator has to the repository.", + "description": "Checks the repository permission and role of a collaborator.\n\nThe `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`.\nThe `role_name` attribute provides the name of the assigned role, including custom roles. The\n`permission` can also be used to determine which base level of access the collaborator has to the repository.\n\nThe calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.", "tags": [ "repos" ], diff --git a/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.yaml b/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.yaml index 799bd997aa..ef691e6739 100644 --- a/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.yaml +++ b/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.yaml @@ -25596,12 +25596,12 @@ paths: summary: List repository collaborators description: |- For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. Team members will include the members of child teams. - The authenticated user must have push access to the repository to use this endpoint. - + The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. tags: - repos @@ -25808,13 +25808,15 @@ paths: get: summary: Get repository permissions for a user description: |- - Checks the repository permission of a collaborator. The possible repository - permissions are `admin`, `write`, `read`, and `none`. + Checks the repository permission and role of a collaborator. + + The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + The `role_name` attribute provides the name of the assigned role, including custom roles. The + `permission` can also be used to determine which base level of access the collaborator has to the repository. - *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. tags: - repos operationId: repos/get-collaborator-permission-level diff --git a/descriptions-next/ghes-3.12/ghes-3.12.json b/descriptions-next/ghes-3.12/ghes-3.12.json index 5b44b3e576..64be4e8f68 100644 --- a/descriptions-next/ghes-3.12/ghes-3.12.json +++ b/descriptions-next/ghes-3.12/ghes-3.12.json @@ -35562,7 +35562,7 @@ "/repos/{owner}/{repo}/collaborators": { "get": { "summary": "List repository collaborators", - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have push access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nThe `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization.\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", "tags": [ "repos" ], @@ -35800,7 +35800,7 @@ "/repos/{owner}/{repo}/collaborators/{username}/permission": { "get": { "summary": "Get repository permissions for a user", - "description": "Checks the repository permission of a collaborator. The possible repository\npermissions are `admin`, `write`, `read`, and `none`.\n\n*Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the\ncollaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The\n`permissions` hash can also be used to determine which base level of access the collaborator has to the repository.", + "description": "Checks the repository permission and role of a collaborator.\n\nThe `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`.\nThe `role_name` attribute provides the name of the assigned role, including custom roles. The\n`permission` can also be used to determine which base level of access the collaborator has to the repository.\n\nThe calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.", "tags": [ "repos" ], diff --git a/descriptions-next/ghes-3.12/ghes-3.12.yaml b/descriptions-next/ghes-3.12/ghes-3.12.yaml index 799bd997aa..ef691e6739 100644 --- a/descriptions-next/ghes-3.12/ghes-3.12.yaml +++ b/descriptions-next/ghes-3.12/ghes-3.12.yaml @@ -25596,12 +25596,12 @@ paths: summary: List repository collaborators description: |- For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. Team members will include the members of child teams. - The authenticated user must have push access to the repository to use this endpoint. - + The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. tags: - repos @@ -25808,13 +25808,15 @@ paths: get: summary: Get repository permissions for a user description: |- - Checks the repository permission of a collaborator. The possible repository - permissions are `admin`, `write`, `read`, and `none`. + Checks the repository permission and role of a collaborator. + + The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + The `role_name` attribute provides the name of the assigned role, including custom roles. The + `permission` can also be used to determine which base level of access the collaborator has to the repository. - *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. tags: - repos operationId: repos/get-collaborator-permission-level diff --git a/descriptions-next/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.json b/descriptions-next/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.json index 0d60e3ade9..81908dd7cf 100644 --- a/descriptions-next/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.json @@ -248346,7 +248346,7 @@ "/repos/{owner}/{repo}/collaborators": { "get": { "summary": "List repository coll{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}