{"id":28749366,"url":"https://github.com/octokit/app-permissions","last_synced_at":"2025-06-16T20:08:58.861Z","repository":{"id":37082259,"uuid":"288536830","full_name":"octokit/app-permissions","owner":"octokit","description":"machine-readable, always up-to-date GitHub App permissions","archived":false,"fork":false,"pushed_at":"2025-05-20T11:28:29.000Z","size":1696,"stargazers_count":12,"open_issues_count":7,"forks_count":8,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-06-02T05:15:50.753Z","etag":null,"topics":["hacktoberfest","octokit-js","tooling"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/octokit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-08-18T18:45:24.000Z","updated_at":"2025-05-20T11:28:32.000Z","dependencies_parsed_at":"2024-05-21T04:42:07.202Z","dependency_job_id":"b4d458cd-0056-4e63-a094-5d1b75c3b677","html_url":"https://github.com/octokit/app-permissions","commit_stats":{"total_commits":280,"total_committers":12,"mean_commits":"23.333333333333332","dds":0.4214285714285714,"last_synced_commit":"3c8a6d1dc77873956a474e98adc7ea1167fde947"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/octokit/app-permissions","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octokit%2Fapp-permissions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octokit%2Fapp-permissions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octokit%2Fapp-permissions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octokit%2Fapp-permissions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/octokit","download_url":"https://codeload.github.com/octokit/app-permissions/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octokit%2Fapp-permissions/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260216195,"owners_count":22976088,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","octokit-js","tooling"],"created_at":"2025-06-16T20:08:58.030Z","updated_at":"2025-06-16T20:08:58.856Z","avatar_url":"https://github.com/octokit.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# app-permissions\n\n\u003e machine-readable, always up-to-date GitHub App permissions\n\nThis repository is scraping the [Permissions required for GitHub Apps](https://docs.github.com/en/rest/reference/permissions-required-for-github-apps) app on an hourly basis and generates the [`generated/api.github.com.json`](generated/api.github.com.json) file.\n\n## Usage\n\nThe structure of the JSON export looks like this\n\n```\npermissions\n  api.github.com\n    permissions\n      [name of permission]\n        url # documentation URL\n        read # array of routes with read access\n        write # array of routes with write access\n    paths\n      [http path]\n        [http method]\n          permission # name of permission\n          access # \"read\" or \"write\"\n```\n\n### Node.js\n\n```js\nconst appPermissions = require(\"@octokit/app-permissions\");\n\nconst createIssuePermissions =\n  appPermissions[\"api.github.com\"].paths[\"/repos/{owner}/{repo}/issues\"].post;\nconsole.log(\n  `Required app permissions to create an issue: %o`,\n  createIssuePermissions,\n);\n\nconst issuesPermission = appPermissions[\"api.github.com\"].permissions.issues;\nconsole.log(`\"issues\" read access paths: %o`, issuesPermission.read);\nconsole.log(`\"issues\" write access paths: %o`, issuesPermission.write);\n```\n\n### Download\n\nAll generated JSON files are uploaded as assets to each [GitHub release](https://github.com/octokit/app-permissions/releases)\n\n## See also\n\n- [octokit/graphql-schema](https://github.com/octokit/graphql-schema) – GitHub’s GraphQL Schema with validation\n- [octokit/openapi](https://github.com/octokit/openapi) – GitHub REST API route specifications\n- [octokit/webhooks](https://github.com/octokit/webhooks) – GitHub Webhooks specifications\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctokit%2Fapp-permissions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foctokit%2Fapp-permissions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctokit%2Fapp-permissions/lists"}