Skip to content

Commit

Permalink
feat: GET /repos/{owner}/{repo}/events/issues requires meta read,…
Browse files Browse the repository at this point in the history
… `GET /user/interaction-limits` requires `interaction_limits` read, `{PUT,DELETED} /user/interaction-limits` requires `interaction_limits` write (#63)
  • Loading branch information
octokitbot authored May 19, 2021
1 parent 9d189fd commit 74391e5
Show file tree
Hide file tree
Showing 2 changed files with 98 additions and 36 deletions.
117 changes: 81 additions & 36 deletions cache/api.github.com.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@ <h3 id="about-github-app-permissions">
</h3>
<p>
GitHub Apps are created with a set of permissions. Permissions define what
resources the GitHub App can access via the API. For more information, see "<a
resources the GitHub App can access via the API. For more information, see
&quot;<a
href="/en/apps/building-github-apps/setting-permissions-for-github-apps"
>Setting permissions for GitHub Apps</a
>."
>.&quot;
</p>
<h3 id="metadata-permissions">
<a href="#metadata-permissions">Metadata permissions</a>
Expand Down Expand Up @@ -399,6 +400,11 @@ <h3 id="metadata-permissions">
><code>GET /repos/:owner/:repo/events</code></a
>
</li>
<li>
<a href="/en/rest/reference/issues#list-issue-events-for-a-repository"
><code>GET /repos/:owner/:repo/events/issues</code></a
>
</li>
<li>
<a href="/en/rest/reference/activity#list-events-for-the-authenticated-user"
><code>GET /users/:username/events</code></a
Expand Down Expand Up @@ -494,7 +500,7 @@ <h3 id="metadata-permissions">
</li>
</ul>
<h3 id="permission-on-actions">
<a href="#permission-on-actions">Permission on "actions"</a>
<a href="#permission-on-actions">Permission on &quot;actions&quot;</a>
</h3>
<ul>
<li>
Expand Down Expand Up @@ -650,7 +656,9 @@ <h3 id="permission-on-actions">
</li>
</ul>
<h3 id="permission-on-administration">
<a href="#permission-on-administration">Permission on "administration"</a>
<a href="#permission-on-administration"
>Permission on &quot;administration&quot;</a
>
</h3>
<ul>
<li>
Expand Down Expand Up @@ -1284,7 +1292,7 @@ <h3 id="permission-on-administration">
</li>
</ul>
<h3 id="permission-on-blocking">
<a href="#permission-on-blocking">Permission on "blocking"</a>
<a href="#permission-on-blocking">Permission on &quot;blocking&quot;</a>
</h3>
<ul>
<li>
Expand Down Expand Up @@ -1315,7 +1323,7 @@ <h3 id="permission-on-blocking">
</li>
</ul>
<h3 id="permission-on-checks">
<a href="#permission-on-checks">Permission on "checks"</a>
<a href="#permission-on-checks">Permission on &quot;checks&quot;</a>
</h3>
<ul>
<li>
Expand Down Expand Up @@ -1393,7 +1401,7 @@ <h3 id="permission-on-checks">
</li>
</ul>
<h3 id="permission-on-contents">
<a href="#permission-on-contents">Permission on "contents"</a>
<a href="#permission-on-contents">Permission on &quot;contents&quot;</a>
</h3>
<ul>
<li>
Expand Down Expand Up @@ -2088,7 +2096,7 @@ <h3 id="permission-on-contents">
</li>
</ul>
<h3 id="permission-on-deployments">
<a href="#permission-on-deployments">Permission on "deployments"</a>
<a href="#permission-on-deployments">Permission on &quot;deployments&quot;</a>
</h3>
<ul>
<li>
Expand Down Expand Up @@ -2142,7 +2150,7 @@ <h3 id="permission-on-deployments">
</li>
</ul>
<h3 id="permission-on-emails">
<a href="#permission-on-emails">Permission on "emails"</a>
<a href="#permission-on-emails">Permission on &quot;emails&quot;</a>
</h3>
<ul>
<li>
Expand Down Expand Up @@ -2192,7 +2200,7 @@ <h3 id="permission-on-emails">
</li>
</ul>
<h3 id="permission-on-followers">
<a href="#permission-on-followers">Permission on "followers"</a>
<a href="#permission-on-followers">Permission on &quot;followers&quot;</a>
</h3>
<ul>
<li>
Expand Down Expand Up @@ -2228,7 +2236,7 @@ <h3 id="permission-on-followers">
</li>
</ul>
<h3 id="permission-on-gpg-keys">
<a href="#permission-on-gpg-keys">Permission on "gpg keys"</a>
<a href="#permission-on-gpg-keys">Permission on &quot;gpg keys&quot;</a>
</h3>
<ul>
<li>
Expand Down Expand Up @@ -2258,17 +2266,46 @@ <h3 id="permission-on-gpg-keys">
(:write)
</li>
</ul>
<h3 id="permission-on-interaction-limits">
<a href="#permission-on-interaction-limits"
>Permission on &quot;interaction limits&quot;</a
>
</h3>
<ul>
<li>
<a
href="/en/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories"
><code>GET /user/interaction-limits</code></a
>
(:read)
</li>
<li>
<a
href="/en/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories"
><code>PUT /user/interaction-limits</code></a
>
(:write)
</li>
<li>
<a
href="/en/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories"
><code>DELETE /user/interaction-limits</code></a
>
(:write)
</li>
</ul>
<h3 id="permission-on-issues">
<a href="#permission-on-issues">Permission on "issues"</a>
<a href="#permission-on-issues">Permission on &quot;issues&quot;</a>
</h3>
<p>
Issues and pull requests are closely related. For more information, see "<a
Issues and pull requests are closely related. For more information, see
&quot;<a
href="/en/rest/reference/issues#list-issues-assigned-to-the-authenticated-user"
>List issues assigned to the authenticated user</a
>." If your GitHub App has permissions on issues but not on pull requests,
these endpoints will be limited to issues. Endpoints that return both issues
and pull requests will be filtered. Endpoints that allow operations on both
issues and pull requests will be restricted to issues.
>.&quot; If your GitHub App has permissions on issues but not on pull
requests, these endpoints will be limited to issues. Endpoints that return
both issues and pull requests will be filtered. Endpoints that allow
operations on both issues and pull requests will be restricted to issues.
</p>
<ul>
<li>
Expand Down Expand Up @@ -2643,7 +2680,7 @@ <h3 id="permission-on-issues">
</li>
</ul>
<h3 id="permission-on-keys">
<a href="#permission-on-keys">Permission on "keys"</a>
<a href="#permission-on-keys">Permission on &quot;keys&quot;</a>
</h3>
<p><em>Keys</em></p>
<ul>
Expand Down Expand Up @@ -2677,7 +2714,7 @@ <h3 id="permission-on-keys">
</li>
</ul>
<h3 id="permission-on-members">
<a href="#permission-on-members">Permission on "members"</a>
<a href="#permission-on-members">Permission on &quot;members&quot;</a>
</h3>
<ul>
<li>
Expand Down Expand Up @@ -3030,7 +3067,7 @@ <h3 id="permission-on-members">
</ul>
<h3 id="permission-on-organization-administration">
<a href="#permission-on-organization-administration"
>Permission on "organization administration"</a
>Permission on &quot;organization administration&quot;</a
>
</h3>
<ul>
Expand Down Expand Up @@ -3072,7 +3109,7 @@ <h3 id="permission-on-organization-administration">
</ul>
<h3 id="permission-on-organization-hooks">
<a href="#permission-on-organization-hooks"
>Permission on "organization hooks"</a
>Permission on &quot;organization hooks&quot;</a
>
</h3>
<ul>
Expand Down Expand Up @@ -3124,7 +3161,7 @@ <h3 id="permission-on-organization-hooks">
</ul>
<h3 id="permission-on-organization-projects">
<a href="#permission-on-organization-projects"
>Permission on "organization projects"</a
>Permission on &quot;organization projects&quot;</a
>
</h3>
<ul>
Expand Down Expand Up @@ -3233,7 +3270,7 @@ <h3 id="permission-on-organization-projects">
</ul>
<h3 id="permission-on-organization-user-blocking">
<a href="#permission-on-organization-user-blocking"
>Permission on "organization user blocking"</a
>Permission on &quot;organization user blocking&quot;</a
>
</h3>
<ul>
Expand Down Expand Up @@ -3264,7 +3301,7 @@ <h3 id="permission-on-organization-user-blocking">
</li>
</ul>
<h3 id="permission-on-pages">
<a href="#permission-on-pages">Permission on "pages"</a>
<a href="#permission-on-pages">Permission on &quot;pages&quot;</a>
</h3>
<ul>
<li>
Expand Down Expand Up @@ -3342,7 +3379,9 @@ <h3 id="permission-on-pages">
</li>
</ul>
<h3 id="permission-on-pull-requests">
<a href="#permission-on-pull-requests">Permission on "pull requests"</a>
<a href="#permission-on-pull-requests"
>Permission on &quot;pull requests&quot;</a
>
</h3>
<p>
Pull requests and issues are closely related.. If your GitHub App has
Expand Down Expand Up @@ -3869,7 +3908,7 @@ <h3 id="permission-on-pull-requests">
</li>
</ul>
<h3 id="permission-on-profile">
<a href="#permission-on-profile">Permission on "profile"</a>
<a href="#permission-on-profile">Permission on &quot;profile&quot;</a>
</h3>
<ul>
<li>
Expand All @@ -3880,7 +3919,9 @@ <h3 id="permission-on-profile">
</li>
</ul>
<h3 id="permission-on-repository-hooks">
<a href="#permission-on-repository-hooks">Permission on "repository hooks"</a>
<a href="#permission-on-repository-hooks"
>Permission on &quot;repository hooks&quot;</a
>
</h3>
<ul>
<li>
Expand Down Expand Up @@ -3928,7 +3969,7 @@ <h3 id="permission-on-repository-hooks">
</ul>
<h3 id="permission-on-repository-projects">
<a href="#permission-on-repository-projects"
>Permission on "repository projects"</a
>Permission on &quot;repository projects&quot;</a
>
</h3>
<ul>
Expand Down Expand Up @@ -4051,7 +4092,7 @@ <h3 id="permission-on-repository-projects">
</li>
</ul>
<h3 id="permission-on-secrets">
<a href="#permission-on-secrets">Permission on "secrets"</a>
<a href="#permission-on-secrets">Permission on &quot;secrets&quot;</a>
</h3>
<ul>
<li>
Expand Down Expand Up @@ -4151,7 +4192,7 @@ <h3 id="permission-on-secrets">
</ul>
<h3 id="permission-on-secret-scanning-alerts">
<a href="#permission-on-secret-scanning-alerts"
>Permission on "secret scanning alerts"</a
>Permission on &quot;secret scanning alerts&quot;</a
>
</h3>
<ul>
Expand Down Expand Up @@ -4187,7 +4228,9 @@ <h3 id="permission-on-secret-scanning-alerts">
</li>
</ul>
<h3 id="permission-on-security-events">
<a href="#permission-on-security-events">Permission on "security events"</a>
<a href="#permission-on-security-events"
>Permission on &quot;security events&quot;</a
>
</h3>
<ul>
<li>
Expand Down Expand Up @@ -4283,7 +4326,7 @@ <h3 id="permission-on-security-events">
</ul>
<h3 id="permission-on-self-hosted-runners">
<a href="#permission-on-self-hosted-runners"
>Permission on "self-hosted runners"</a
>Permission on &quot;self-hosted runners&quot;</a
>
</h3>
<ul>
Expand Down Expand Up @@ -4331,7 +4374,7 @@ <h3 id="permission-on-self-hosted-runners">
</li>
</ul>
<h3 id="permission-on-single-file">
<a href="#permission-on-single-file">Permission on "single file"</a>
<a href="#permission-on-single-file">Permission on &quot;single file&quot;</a>
</h3>
<ul>
<li>
Expand All @@ -4354,7 +4397,7 @@ <h3 id="permission-on-single-file">
</li>
</ul>
<h3 id="permission-on-starring">
<a href="#permission-on-starring">Permission on "starring"</a>
<a href="#permission-on-starring">Permission on &quot;starring&quot;</a>
</h3>
<ul>
<li>
Expand All @@ -4380,7 +4423,7 @@ <h3 id="permission-on-starring">
</li>
</ul>
<h3 id="permission-on-statuses">
<a href="#permission-on-statuses">Permission on "statuses"</a>
<a href="#permission-on-statuses">Permission on &quot;statuses&quot;</a>
</h3>
<ul>
<li>
Expand All @@ -4404,7 +4447,9 @@ <h3 id="permission-on-statuses">
</li>
</ul>
<h3 id="permission-on-team-discussions">
<a href="#permission-on-team-discussions">Permission on "team discussions"</a>
<a href="#permission-on-team-discussions"
>Permission on &quot;team discussions&quot;</a
>
</h3>
<ul>
<li>
Expand Down
17 changes: 17 additions & 0 deletions generated/api.github.com.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
"GET /repos/{owner}/{repo}/community/profile",
"GET /repos/{owner}/{repo}/contributors",
"GET /repos/{owner}/{repo}/events",
"GET /repos/{owner}/{repo}/events/issues",
"GET /repos/{owner}/{repo}/forks",
"GET /repos/{owner}/{repo}/languages",
"GET /repos/{owner}/{repo}/license",
Expand Down Expand Up @@ -337,6 +338,14 @@
"read": ["GET /user/gpg_keys", "GET /user/gpg_keys/{gpg_key_id}"],
"write": ["DELETE /user/gpg_keys/{gpg_key_id}", "POST /user/gpg_keys"]
},
"interaction_limits": {
"url": "https://docs.github.com/en/free-pro-team@latest/rest/reference/permissions-required-for-github-apps/#permission-on-interaction-limits",
"read": ["GET /user/interaction-limits"],
"write": [
"DELETE /user/interaction-limits",
"PUT /user/interaction-limits"
]
},
"issues": {
"url": "https://docs.github.com/en/free-pro-team@latest/rest/reference/permissions-required-for-github-apps/#permission-on-issues",
"read": [
Expand Down Expand Up @@ -893,6 +902,9 @@
"/repos/{owner}/{repo}/events": {
"GET": { "permission": "meta", "access": "read" }
},
"/repos/{owner}/{repo}/events/issues": {
"GET": { "permission": "meta", "access": "read" }
},
"/users/{username}/events": {
"GET": { "permission": "meta", "access": "read" }
},
Expand Down Expand Up @@ -1344,6 +1356,11 @@
"GET": { "permission": "gpg_keys", "access": "read" },
"DELETE": { "permission": "gpg_keys", "access": "write" }
},
"/user/interaction-limits": {
"GET": { "permission": "interaction_limits", "access": "read" },
"PUT": { "permission": "interaction_limits", "access": "write" },
"DELETE": { "permission": "interaction_limits", "access": "write" }
},
"/repos/{owner}/{repo}/issues": {
"GET": { "permission": "issues", "access": "read" },
"POST": { "permission": "issues", "access": "write" }
Expand Down

1 comment on commit 74391e5

@UserFix9000937

This comment was marked as off-topic.

Please sign in to comment.