@withgateway/sdk 0.2.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1188) hide show
  1. package/README.md +30 -6
  2. package/dist/cli.js +7815 -2406
  3. package/dist/cli.js.map +1 -1
  4. package/dist/cli.mjs +7807 -2398
  5. package/dist/cli.mjs.map +1 -1
  6. package/dist/files/index.d.mts +2 -0
  7. package/dist/files/index.d.ts +2 -0
  8. package/dist/files/index.js +446 -0
  9. package/dist/files/index.js.map +1 -0
  10. package/dist/files/index.mjs +395 -0
  11. package/dist/files/index.mjs.map +1 -0
  12. package/dist/index-BgvvQ3BC.d.ts +170 -0
  13. package/dist/index-CLkMr6VG.d.ts +171 -0
  14. package/dist/index-CdbmO4aX.d.mts +171 -0
  15. package/dist/index-CiKWoroJ.d.mts +170 -0
  16. package/dist/index.d.mts +3 -1
  17. package/dist/index.d.ts +3 -1
  18. package/dist/index.js +2283 -116
  19. package/dist/index.js.map +1 -1
  20. package/dist/index.mjs +2255 -116
  21. package/dist/index.mjs.map +1 -1
  22. package/dist/traces/index.d.mts +2 -0
  23. package/dist/traces/index.d.ts +2 -0
  24. package/dist/traces/index.js +320 -0
  25. package/dist/traces/index.js.map +1 -0
  26. package/dist/traces/index.mjs +278 -0
  27. package/dist/traces/index.mjs.map +1 -0
  28. package/dist/tracing/index.js +16 -1
  29. package/dist/tracing/index.js.map +1 -1
  30. package/dist/tracing/index.mjs +16 -1
  31. package/dist/tracing/index.mjs.map +1 -1
  32. package/dist/worlds/index.d.mts +685 -1
  33. package/dist/worlds/index.d.ts +685 -1
  34. package/dist/worlds/index.js +1876 -32
  35. package/dist/worlds/index.js.map +1 -1
  36. package/dist/worlds/index.mjs +1875 -32
  37. package/dist/worlds/index.mjs.map +1 -1
  38. package/package.json +16 -1
  39. package/runtime/gatewaysdk/environment/_world.py +14 -1
  40. package/runtime/gatewaysdk/environment/schema/__init__.py +8 -0
  41. package/runtime/gatewaysdk/environment/schema/__main__.py +154 -19
  42. package/runtime/gatewaysdk/environment/schema/api.py +233 -37
  43. package/runtime/gatewaysdk/environment/schema/batch.py +38 -8
  44. package/runtime/gatewaysdk/environment/schema/compiler.py +89 -11
  45. package/runtime/gatewaysdk/environment/schema/conform.py +105 -13
  46. package/runtime/gatewaysdk/environment/schema/connector.py +442 -103
  47. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/api/handlers.py +778 -0
  48. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/connector.toml +671 -0
  49. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/handlers.py +3 -2
  50. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/parity.json +11 -5
  51. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/provenance.json +1635 -100
  52. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/instruction.md +7 -0
  53. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/scenario.toml +2 -0
  54. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_activities.json +24 -0
  55. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_activity_devices.json +12 -0
  56. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_applecare_coverages.json +52 -0
  57. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_apps.json +35 -0
  58. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_audit_events.json +139 -0
  59. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_blueprint_apps.json +12 -0
  60. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_blueprint_configurations.json +20 -0
  61. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_blueprint_devices.json +16 -0
  62. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_blueprint_packages.json +8 -0
  63. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_blueprint_user_groups.json +12 -0
  64. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_blueprint_users.json +12 -0
  65. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_blueprints.json +39 -0
  66. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_configurations.json +64 -0
  67. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_device_assignments.json +20 -0
  68. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_mdm_device_details.json +55 -0
  69. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_mdm_devices.json +33 -0
  70. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_mdm_servers.json +56 -0
  71. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_org_devices.json +178 -0
  72. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_organizational_unit_memberships.json +16 -0
  73. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_organizational_units.json +24 -0
  74. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_packages.json +20 -0
  75. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_user_group_memberships.json +16 -0
  76. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_user_groups.json +30 -0
  77. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_users.json +115 -0
  78. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scope.toml +49 -22
  79. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/tests/tools.json +48 -0
  80. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/world.json +1180 -194
  81. package/runtime/gatewaysdk/environment/schema/connectors/asana/api/handlers.py +1026 -0
  82. package/runtime/gatewaysdk/environment/schema/connectors/asana/connector.toml +511 -0
  83. package/runtime/gatewaysdk/environment/schema/connectors/asana/fidelity.json +89 -0
  84. package/runtime/gatewaysdk/environment/schema/connectors/asana/handlers.py +40 -0
  85. package/runtime/gatewaysdk/environment/schema/connectors/asana/provenance.json +101 -0
  86. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/scenario.toml +2 -0
  87. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/account_settings.json +12 -0
  88. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/custom_field_settings.json +60 -0
  89. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/custom_fields.json +43 -0
  90. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/enum_options.json +52 -0
  91. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/notifications.json +103 -0
  92. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/project_favorites.json +12 -0
  93. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/project_memberships.json +144 -0
  94. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/projects.json +120 -0
  95. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/recent_projects.json +19 -0
  96. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/sections.json +102 -0
  97. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/stories.json +852 -0
  98. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/task_custom_fields.json +508 -0
  99. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/task_followers.json +368 -0
  100. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/task_memberships.json +184 -0
  101. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/tasks.json +1921 -0
  102. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/teams.json +22 -0
  103. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/user_task_list_sections.json +32 -0
  104. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/user_task_lists.json +11 -0
  105. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/users.json +60 -0
  106. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/workspace_memberships.json +76 -0
  107. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/workspaces.json +13 -0
  108. package/runtime/gatewaysdk/environment/schema/connectors/asana/scope.toml +156 -0
  109. package/runtime/gatewaysdk/environment/schema/connectors/asana/tests/routes.json +298 -0
  110. package/runtime/gatewaysdk/environment/schema/connectors/asana/tests/tools.json +152 -0
  111. package/runtime/gatewaysdk/environment/schema/connectors/asana/ui/static/assets/index-DTTTJ6a4.css +1 -0
  112. package/runtime/gatewaysdk/environment/schema/connectors/asana/ui/static/assets/index-WS8dLEjv.js +67 -0
  113. package/runtime/gatewaysdk/environment/schema/connectors/asana/ui/static/index.html +40 -0
  114. package/runtime/gatewaysdk/environment/schema/connectors/asana/world.json +1911 -0
  115. package/runtime/gatewaysdk/environment/schema/connectors/confluence/api/handlers.py +847 -0
  116. package/runtime/gatewaysdk/environment/schema/connectors/confluence/connector.toml +457 -0
  117. package/runtime/gatewaysdk/environment/schema/connectors/confluence/handlers.py +176 -0
  118. package/runtime/gatewaysdk/environment/schema/connectors/confluence/provenance.json +187 -0
  119. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/instruction.md +39 -0
  120. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/scenario.toml +3 -0
  121. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_favourites.json +29 -0
  122. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_footer_comments.json +984 -0
  123. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_inline_comments.json +355 -0
  124. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_labels.json +99 -0
  125. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_notifications.json +40 -0
  126. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_page_labels.json +209 -0
  127. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_page_versions.json +828 -0
  128. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_pages.json +949 -0
  129. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_recently_viewed_pages.json +59 -0
  130. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_sites.json +12 -0
  131. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_spaces.json +128 -0
  132. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_users.json +100 -0
  133. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_watches.json +96 -0
  134. package/runtime/gatewaysdk/environment/schema/connectors/confluence/tests/routes.json +212 -0
  135. package/runtime/gatewaysdk/environment/schema/connectors/confluence/tests/tools.json +140 -0
  136. package/runtime/gatewaysdk/environment/schema/connectors/confluence/tests/writes.json +201 -0
  137. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/assets/index-BWaOVdpn.js +70 -0
  138. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/assets/index-CKyfi3i5.css +1 -0
  139. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/acct-01.svg +1 -0
  140. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/acct-02.svg +1 -0
  141. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/acct-03.svg +1 -0
  142. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/acct-04.svg +1 -0
  143. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/acct-05.svg +1 -0
  144. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/acct-06.svg +1 -0
  145. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/space-DES.svg +1 -0
  146. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/space-ENG.svg +1 -0
  147. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/space-OPS.svg +1 -0
  148. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/space-ORB.svg +1 -0
  149. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/space-PN.svg +1 -0
  150. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/fonts/AtlassianMono-latin.woff2 +0 -0
  151. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/fonts/AtlassianSans-latin.woff2 +0 -0
  152. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/fonts/AtlassianSansItalic-latin.woff2 +0 -0
  153. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/index.html +47 -0
  154. package/runtime/gatewaysdk/environment/schema/connectors/confluence/world.json +1346 -0
  155. package/runtime/gatewaysdk/environment/schema/connectors/custom/provenance.json +35 -0
  156. package/runtime/gatewaysdk/environment/schema/connectors/custom/tests/tools.json +123 -0
  157. package/runtime/gatewaysdk/environment/schema/connectors/custom/world.json +112 -24
  158. package/runtime/gatewaysdk/environment/schema/connectors/github/api/handlers.py +2923 -0
  159. package/runtime/gatewaysdk/environment/schema/connectors/github/connector.toml +2091 -0
  160. package/runtime/gatewaysdk/environment/schema/connectors/github/provenance.json +109 -81
  161. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/instruction.md +18 -0
  162. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/scenario.toml +2 -0
  163. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_apps.json +49 -0
  164. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_artifacts.json +26 -0
  165. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_branches.json +443 -0
  166. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_check_runs.json +220 -0
  167. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_check_suites.json +404 -0
  168. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_code_scanning_alerts.json +126 -0
  169. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_collaborators.json +100 -0
  170. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_commit_comments.json +43 -0
  171. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_commit_statuses.json +80 -0
  172. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_commits.json +461 -0
  173. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_dependabot_alerts.json +168 -0
  174. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_deployment_statuses.json +86 -0
  175. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_deployments.json +94 -0
  176. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_environments.json +31 -0
  177. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_gist_comments.json +38 -0
  178. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_gists.json +118 -0
  179. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_git_refs.json +59 -0
  180. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_installations.json +54 -0
  181. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_issue_comments.json +151 -0
  182. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_issue_events.json +606 -0
  183. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_issue_types.json +26 -0
  184. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_issues.json +758 -0
  185. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_labels.json +64 -0
  186. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_licenses.json +54 -0
  187. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_milestones.json +130 -0
  188. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_organization_memberships.json +139 -0
  189. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_organizations.json +38 -0
  190. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_pull_requests.json +874 -0
  191. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_release_assets.json +45 -0
  192. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_releases.json +92 -0
  193. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_repositories.json +797 -0
  194. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_repository_invitations.json +184 -0
  195. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_review_comments.json +66 -0
  196. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_reviews.json +138 -0
  197. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_secret_scanning_alerts.json +50 -0
  198. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_stargazers.json +88 -0
  199. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_tags.json +28 -0
  200. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_team_memberships.json +25 -0
  201. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_team_repositories.json +258 -0
  202. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_teams.json +130 -0
  203. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_users.json +174 -0
  204. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_webhooks.json +31 -0
  205. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_workflow_jobs.json +115 -0
  206. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_workflow_runs.json +1021 -0
  207. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_workflows.json +30 -0
  208. package/runtime/gatewaysdk/environment/schema/connectors/github/scope.toml +501 -62
  209. package/runtime/gatewaysdk/environment/schema/connectors/github/tests/tools.json +79 -0
  210. package/runtime/gatewaysdk/environment/schema/connectors/github/vendor-openapi.json +1 -0
  211. package/runtime/gatewaysdk/environment/schema/connectors/github/world.json +14340 -4447
  212. package/runtime/gatewaysdk/environment/schema/connectors/gmail/api/handlers.py +1413 -0
  213. package/runtime/gatewaysdk/environment/schema/connectors/gmail/connector.toml +630 -0
  214. package/runtime/gatewaysdk/environment/schema/connectors/gmail/handlers.py +136 -0
  215. package/runtime/gatewaysdk/environment/schema/connectors/gmail/scenarios/default/scenario.toml +1 -0
  216. package/runtime/gatewaysdk/environment/schema/connectors/gmail/scenarios/default/seed/10-gmail_profiles.json +10 -0
  217. package/runtime/gatewaysdk/environment/schema/connectors/gmail/scenarios/default/seed/20-gmail_labels.json +205 -0
  218. package/runtime/gatewaysdk/environment/schema/connectors/gmail/scenarios/default/seed/30-gmail_contacts.json +234 -0
  219. package/runtime/gatewaysdk/environment/schema/connectors/gmail/scenarios/default/seed/40-gmail_threads.json +374 -0
  220. package/runtime/gatewaysdk/environment/schema/connectors/gmail/scenarios/default/seed/50-gmail_messages.json +1015 -0
  221. package/runtime/gatewaysdk/environment/schema/connectors/gmail/scenarios/default/seed/60-gmail_message_parts.json +3039 -0
  222. package/runtime/gatewaysdk/environment/schema/connectors/gmail/scenarios/default/seed/70-gmail_attachments.json +28 -0
  223. package/runtime/gatewaysdk/environment/schema/connectors/gmail/scenarios/default/seed/80-gmail_drafts.json +39 -0
  224. package/runtime/gatewaysdk/environment/schema/connectors/gmail/scenarios/default/seed/90-gmail_client_settings.json +103 -0
  225. package/runtime/gatewaysdk/environment/schema/connectors/gmail/world.json +784 -0
  226. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/api/handlers.py +454 -0
  227. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/connector.toml +519 -0
  228. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/provenance.json +229 -0
  229. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/scenarios/default/instruction.md +25 -0
  230. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/scenarios/default/scenario.toml +1 -0
  231. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/scenarios/default/seed/10-calendar_calendars.json +75 -0
  232. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/scenarios/default/seed/20-calendar_calendar_list_entries.json +115 -0
  233. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/scenarios/default/seed/30-calendar_acl_rules.json +124 -0
  234. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/scenarios/default/seed/40-calendar_events.json +810 -0
  235. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/scenarios/default/seed/50-calendar_settings.json +76 -0
  236. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/scenarios/default/seed/60-calendar_channels.json +26 -0
  237. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/scenarios/default/seed/70-calendar_colors.json +48 -0
  238. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/scope.toml +105 -0
  239. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/tests/tools.json +53 -0
  240. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/vendor-openapi.json +4185 -0
  241. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/world.json +1255 -80
  242. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/api/handlers.py +782 -0
  243. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/connector.toml +373 -0
  244. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/google-docs-types.json +4939 -0
  245. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/handlers.py +197 -0
  246. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/provenance.json +191 -0
  247. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/scenarios/default/instruction.md +29 -0
  248. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/scenarios/default/scenario.toml +2 -0
  249. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/scenarios/default/seed/gdocs_comments.json +50 -0
  250. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/scenarios/default/seed/gdocs_documents.json +8096 -0
  251. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/scenarios/default/seed/gdocs_files.json +1187 -0
  252. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/scenarios/default/seed/gdocs_permissions.json +543 -0
  253. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/scenarios/default/seed/gdocs_replies.json +22 -0
  254. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/scenarios/default/seed/gdocs_revisions.json +643 -0
  255. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/scenarios/default/seed/gdocs_users.json +32 -0
  256. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/scope.toml +148 -0
  257. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/tests/api.json +319 -0
  258. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/tests/tools.json +262 -0
  259. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/ui/static/assets/index-BH9fmZSS.css +1 -0
  260. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/ui/static/assets/index-CU4Fk9dX.js +67 -0
  261. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/ui/static/fonts/README.md +20 -0
  262. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/ui/static/fonts/google-sans-variable.woff2 +0 -0
  263. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/ui/static/fonts/roboto-italic-variable-latin.woff2 +0 -0
  264. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/ui/static/fonts/roboto-variable-latin-ext.woff2 +0 -0
  265. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/ui/static/fonts/roboto-variable-latin.woff2 +0 -0
  266. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/ui/static/icons/material_common_sprite1038_gm3_grey_medium.svg +1 -0
  267. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/ui/static/index.html +13 -0
  268. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/world.json +4489 -0
  269. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/api/handlers.py +466 -0
  270. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/connector.toml +626 -0
  271. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/handlers.py +42 -5
  272. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/provenance.json +342 -0
  273. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/instruction.md +11 -0
  274. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/scenario.toml +2 -0
  275. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/seed/drive_access_proposals.json +31 -0
  276. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/seed/drive_approvals.json +145 -0
  277. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/seed/drive_apps.json +81 -0
  278. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/seed/drive_comments.json +70 -0
  279. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/seed/drive_drives.json +71 -0
  280. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/seed/drive_files.json +700 -0
  281. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/seed/drive_labels.json +75 -0
  282. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/seed/drive_permissions.json +93 -0
  283. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/seed/drive_replies.json +66 -0
  284. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/seed/drive_revisions.json +82 -0
  285. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scope.toml +126 -0
  286. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/tests/tools.json +101 -0
  287. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/vendor-openapi.json +6193 -0
  288. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/world.json +1972 -108
  289. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/api/handlers.py +1645 -0
  290. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/connector.toml +414 -0
  291. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/handlers.py +200 -0
  292. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/scenarios/default/scenario.toml +2 -0
  293. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/scenarios/default/seed/gsheets_cells.json +10252 -0
  294. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/scenarios/default/seed/gsheets_charts.json +103 -0
  295. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/scenarios/default/seed/gsheets_conditional_formats.json +138 -0
  296. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/scenarios/default/seed/gsheets_dimensions.json +256 -0
  297. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/scenarios/default/seed/gsheets_named_ranges.json +16 -0
  298. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/scenarios/default/seed/gsheets_permissions.json +31 -0
  299. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/scenarios/default/seed/gsheets_sheets.json +95 -0
  300. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/scenarios/default/seed/gsheets_spreadsheets.json +14 -0
  301. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/scenarios/default/seed/gsheets_view_states.json +26 -0
  302. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/tests/page.json +311 -0
  303. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/tests/vendor.json +843 -0
  304. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/assets/index-CUpfKgm_.js +40 -0
  305. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/assets/index-D3VhwBIC.css +1 -0
  306. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/fonts/GoogleSans-400.woff2 +0 -0
  307. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/fonts/GoogleSans-500.woff2 +0 -0
  308. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/fonts/GoogleSans-700.woff2 +0 -0
  309. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/fonts/GoogleSansText-400.woff2 +0 -0
  310. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/fonts/GoogleSansText-500.woff2 +0 -0
  311. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/fonts/GoogleSansText-700.woff2 +0 -0
  312. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/fonts/Roboto-400.woff2 +0 -0
  313. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/fonts/Roboto-500.woff2 +0 -0
  314. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/fonts/Roboto-700.woff2 +0 -0
  315. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/index.html +26 -0
  316. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/world.json +4029 -0
  317. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/api/handlers.py +800 -0
  318. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/connector.toml +776 -0
  319. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/handlers.py +226 -0
  320. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/instruction.md +11 -0
  321. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/scenario.toml +2 -0
  322. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_accounts.json +17 -0
  323. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_associations.json +1478 -0
  324. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_calls.json +147 -0
  325. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_companies.json +144 -0
  326. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_contacts.json +284 -0
  327. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_deals.json +204 -0
  328. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_emails.json +160 -0
  329. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_meetings.json +147 -0
  330. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_nav_items.json +204 -0
  331. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_notes.json +160 -0
  332. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_notifications.json +25 -0
  333. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_object_views.json +334 -0
  334. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_owners.json +76 -0
  335. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_pipeline_stages.json +109 -0
  336. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_pipelines.json +13 -0
  337. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_properties.json +1220 -0
  338. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_tasks.json +394 -0
  339. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_tickets.json +34 -0
  340. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/assets/index-hdb5vB78.css +1 -0
  341. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/assets/index-xhg5ASqE.js +68 -0
  342. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/fonts/lexend-deca-300.ttf +0 -0
  343. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/fonts/lexend-deca-400.ttf +0 -0
  344. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/fonts/lexend-deca-500.ttf +0 -0
  345. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/fonts/lexend-deca-600.ttf +0 -0
  346. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/fonts/lexend-deca-700.ttf +0 -0
  347. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/fonts/lexend-deca-latin.woff2 +0 -0
  348. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/add.svg +1 -0
  349. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/avatar.svg +1 -0
  350. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/bell.svg +3 -0
  351. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/breeze.svg +4 -0
  352. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/call.svg +1 -0
  353. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/chevron-up.svg +3 -0
  354. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/companies.svg +1 -0
  355. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/contact.svg +1 -0
  356. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/contacts.svg +1 -0
  357. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/date.svg +1 -0
  358. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/deals.svg +1 -0
  359. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/duplicate.svg +1 -0
  360. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/export.svg +3 -0
  361. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/external-link.svg +1 -0
  362. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/filter-lines.svg +3 -0
  363. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/frame-expand.svg +3 -0
  364. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/funnel.svg +3 -0
  365. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/help.svg +1 -0
  366. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/hierarchy.svg +4 -0
  367. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/home.svg +1 -0
  368. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/hubspot-logo.svg +1 -0
  369. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/info.svg +1 -0
  370. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/kanban.svg +1 -0
  371. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/marketing-email.svg +1 -0
  372. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/marketplace.svg +1 -0
  373. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/meetings.svg +1 -0
  374. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/more.svg +1 -0
  375. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/pencil.svg +3 -0
  376. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/pin.svg +3 -0
  377. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/prospecting.svg +1 -0
  378. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/refresh.svg +1 -0
  379. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/search.svg +1 -0
  380. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/settings.svg +1 -0
  381. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/sidebar-collapse.svg +3 -0
  382. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/sort.svg +3 -0
  383. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/table.svg +1 -0
  384. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/tasks.svg +1 -0
  385. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/thumbs-down.svg +1 -0
  386. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/thumbs-up.svg +1 -0
  387. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/undo.svg +3 -0
  388. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/upgrade-arrow.svg +1 -0
  389. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/vertical-dots.svg +5 -0
  390. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/workflows.svg +1 -0
  391. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/index.html +37 -0
  392. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/world.json +1347 -0
  393. package/runtime/gatewaysdk/environment/schema/connectors/jamf/api/handlers.py +987 -0
  394. package/runtime/gatewaysdk/environment/schema/connectors/jamf/connector.toml +3057 -0
  395. package/runtime/gatewaysdk/environment/schema/connectors/jamf/provenance.json +9443 -129
  396. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/scenario.toml +4 -0
  397. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_account_groups.json +64 -0
  398. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_accounts.json +58 -0
  399. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_advanced_computer_searches.json +139 -0
  400. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_advanced_mobile_device_searches.json +61 -0
  401. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_advanced_user_content_searches.json +61 -0
  402. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_advanced_user_searches.json +124 -0
  403. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_api_integrations.json +37 -0
  404. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_api_roles.json +25 -0
  405. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_app_request_form_input_fields.json +22 -0
  406. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_buildings.json +34 -0
  407. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_byo_profiles.json +46 -0
  408. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_categories.json +19 -0
  409. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_classes.json +217 -0
  410. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_cloud_idps.json +19 -0
  411. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_computer_group_members.json +16 -0
  412. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_computer_groups.json +38 -0
  413. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_computer_invitations.json +82 -0
  414. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_computer_prestages.json +274 -0
  415. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_computers.json +1537 -0
  416. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_configuration_profiles.json +649 -0
  417. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_departments.json +16 -0
  418. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_device_enrollment_devices.json +70 -0
  419. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_device_enrollments.json +46 -0
  420. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_directory_bindings.json +34 -0
  421. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_disk_encryption_configurations.json +22 -0
  422. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_distribution_points.json +91 -0
  423. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_dock_items.json +25 -0
  424. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_ebooks.json +43 -0
  425. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_enrollment_customizations.json +43 -0
  426. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_extension_attributes.json +52 -0
  427. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_ibeacons.json +25 -0
  428. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_inventory_preload_records.json +100 -0
  429. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_ios_branding_configurations.json +31 -0
  430. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_ldap_servers.json +16 -0
  431. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_licensed_software_records.json +244 -0
  432. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mac_applications.json +610 -0
  433. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_macos_branding_configurations.json +34 -0
  434. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_managed_software_update_plans.json +67 -0
  435. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mdm_commands.json +58 -0
  436. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mobile_device_applications.json +700 -0
  437. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mobile_device_configuration_profiles.json +652 -0
  438. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mobile_device_enrollment_profiles.json +160 -0
  439. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mobile_device_extension_attributes.json +43 -0
  440. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mobile_device_group_members.json +16 -0
  441. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mobile_device_groups.json +38 -0
  442. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mobile_device_prestages.json +280 -0
  443. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mobile_device_provisioning_profiles.json +31 -0
  444. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mobile_devices.json +1558 -0
  445. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_network_segments.json +46 -0
  446. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_packages.json +118 -0
  447. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_patch_software_title_configurations.json +88 -0
  448. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_policies.json +1054 -0
  449. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_printers.json +52 -0
  450. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_removable_mac_addresses.json +16 -0
  451. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_restricted_software_titles.json +289 -0
  452. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_return_to_service_configurations.json +19 -0
  453. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_scripts.json +61 -0
  454. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_sites.json +19 -0
  455. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_software_update_servers.json +25 -0
  456. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_supervision_identities.json +22 -0
  457. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_user_extension_attributes.json +31 -0
  458. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_user_groups.json +112 -0
  459. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_users.json +37 -0
  460. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_volume_purchasing_locations.json +106 -0
  461. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_volume_purchasing_subscriptions.json +76 -0
  462. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_webhooks.json +70 -0
  463. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scope.toml +839 -67
  464. package/runtime/gatewaysdk/environment/schema/connectors/jamf/tests/tools.json +95 -0
  465. package/runtime/gatewaysdk/environment/schema/connectors/jamf/vendor-openapi.json +1 -0
  466. package/runtime/gatewaysdk/environment/schema/connectors/jamf/world.json +10835 -1494
  467. package/runtime/gatewaysdk/environment/schema/connectors/jira/api/handlers.py +1056 -0
  468. package/runtime/gatewaysdk/environment/schema/connectors/jira/connector.toml +955 -0
  469. package/runtime/gatewaysdk/environment/schema/connectors/jira/handlers.py +73 -14
  470. package/runtime/gatewaysdk/environment/schema/connectors/jira/parity.json +27 -0
  471. package/runtime/gatewaysdk/environment/schema/connectors/jira/provenance.json +166 -0
  472. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/instruction.md +22 -0
  473. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/scenario.toml +3 -0
  474. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_boards.json +61 -0
  475. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_changelogs.json +136 -0
  476. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_comments.json +205 -0
  477. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_components.json +78 -0
  478. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_fields.json +498 -0
  479. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_issue_link_types.json +25 -0
  480. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_issue_links.json +190 -0
  481. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_issue_types.json +44 -0
  482. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_issues.json +1448 -0
  483. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_priorities.json +40 -0
  484. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_project_categories.json +16 -0
  485. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_projects.json +111 -0
  486. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_resolutions.json +22 -0
  487. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_sprint_issues.json +20 -0
  488. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_sprints.json +39 -0
  489. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_status_categories.json +25 -0
  490. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_statuses.json +60 -0
  491. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_transitions.json +179 -0
  492. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_users.json +83 -0
  493. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_versions.json +30 -0
  494. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_worklogs.json +96 -0
  495. package/runtime/gatewaysdk/environment/schema/connectors/jira/scope.toml +255 -0
  496. package/runtime/gatewaysdk/environment/schema/connectors/jira/tests/tools.json +151 -0
  497. package/runtime/gatewaysdk/environment/schema/connectors/jira/vendor-openapi.json +13562 -0
  498. package/runtime/gatewaysdk/environment/schema/connectors/jira/world.json +3381 -183
  499. package/runtime/gatewaysdk/environment/schema/connectors/kandji/api/handlers.py +406 -0
  500. package/runtime/gatewaysdk/environment/schema/connectors/kandji/connector.toml +531 -0
  501. package/runtime/gatewaysdk/environment/schema/connectors/kandji/provenance.json +229 -46
  502. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/scenario.toml +2 -0
  503. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_blueprint_items.json +22 -0
  504. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_blueprint_template_categories.json +14 -0
  505. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_blueprint_templates.json +38 -0
  506. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_blueprints.json +52 -0
  507. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_custom_apps.json +45 -0
  508. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_custom_profiles.json +32 -0
  509. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_custom_scripts.json +27 -0
  510. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_device_activities.json +43 -0
  511. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_device_apps.json +52 -0
  512. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_device_commands.json +41 -0
  513. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_device_notes.json +20 -0
  514. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_device_parameters.json +28 -0
  515. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_device_tags.json +16 -0
  516. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_devices.json +122 -0
  517. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_in_house_apps.json +33 -0
  518. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_library_item_activities.json +33 -0
  519. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_library_item_statuses.json +98 -0
  520. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_library_items.json +24 -0
  521. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_self_service_categories.json +12 -0
  522. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_tags.json +16 -0
  523. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_users.json +61 -0
  524. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scope.toml +118 -39
  525. package/runtime/gatewaysdk/environment/schema/connectors/kandji/tests/tools.json +64 -0
  526. package/runtime/gatewaysdk/environment/schema/connectors/kandji/vendor-openapi.json +5463 -0
  527. package/runtime/gatewaysdk/environment/schema/connectors/kandji/world.json +1257 -205
  528. package/runtime/gatewaysdk/environment/schema/connectors/linear/api/handlers.py +139 -0
  529. package/runtime/gatewaysdk/environment/schema/connectors/linear/connector.toml +1574 -0
  530. package/runtime/gatewaysdk/environment/schema/connectors/linear/handlers.py +8 -5
  531. package/runtime/gatewaysdk/environment/schema/connectors/linear/provenance.json +142 -0
  532. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/scenario.toml +2 -0
  533. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/attachments.json +21 -0
  534. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/comments.json +79 -0
  535. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/customer_needs.json +21 -0
  536. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/customer_statuses.json +26 -0
  537. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/customer_tiers.json +26 -0
  538. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/customers.json +48 -0
  539. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/cycles.json +86 -0
  540. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/documents.json +27 -0
  541. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/initiative_projects.json +13 -0
  542. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/initiative_updates.json +23 -0
  543. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/initiatives.json +41 -0
  544. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/issue_labels.json +16 -0
  545. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/issue_relations.json +13 -0
  546. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/issues.json +264 -0
  547. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/labels.json +52 -0
  548. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/organizations.json +53 -0
  549. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/project_labels.json +34 -0
  550. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/project_members.json +16 -0
  551. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/project_milestones.json +30 -0
  552. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/project_relations.json +18 -0
  553. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/project_statuses.json +76 -0
  554. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/project_updates.json +42 -0
  555. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/projects.json +110 -0
  556. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/reactions.json +28 -0
  557. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/roadmap_projects.json +13 -0
  558. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/roadmaps.json +19 -0
  559. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/team_memberships.json +34 -0
  560. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/teams.json +114 -0
  561. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/templates.json +27 -0
  562. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/users.json +106 -0
  563. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/webhooks.json +21 -0
  564. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/workflow_states.json +108 -0
  565. package/runtime/gatewaysdk/environment/schema/connectors/linear/scope.toml +87 -0
  566. package/runtime/gatewaysdk/environment/schema/connectors/linear/tests/tools.json +52 -0
  567. package/runtime/gatewaysdk/environment/schema/connectors/linear/world.json +5957 -172
  568. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/api/handlers.py +1218 -0
  569. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/connector.toml +1246 -0
  570. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/fidelity.json +49 -19
  571. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/provenance.json +785 -4
  572. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/instruction.md +12 -0
  573. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/scenario.toml +2 -0
  574. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_async_operations.json +47 -0
  575. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_channel_hosted_contents.json +12 -0
  576. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_channel_members.json +88 -0
  577. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_channel_messages.json +313 -0
  578. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_channel_replies.json +128 -0
  579. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_channels.json +319 -0
  580. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_chat_hosted_contents.json +18 -0
  581. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_chat_members.json +155 -0
  582. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_chat_messages.json +265 -0
  583. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_chat_views.json +37 -0
  584. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_chats.json +167 -0
  585. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_incoming_channels.json +25 -0
  586. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_pinned_messages.json +9 -0
  587. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_reply_hosted_contents.json +13 -0
  588. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_shared_channel_teams.json +32 -0
  589. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_tag_members.json +31 -0
  590. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_tags.json +32 -0
  591. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_team_members.json +117 -0
  592. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_teams.json +193 -0
  593. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scope.md +76 -4
  594. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/teams-types.json +29 -0
  595. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/tests/routes.json +101 -0
  596. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/vendor-openapi.json +11280 -0
  597. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/world.json +74 -6
  598. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/api/handlers.py +571 -0
  599. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/connector.toml +1484 -0
  600. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/parity.json +28 -1
  601. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/provenance.json +215 -49
  602. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/instruction.md +11 -0
  603. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/scenario.toml +2 -0
  604. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_accounting_periods.json +107 -0
  605. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_accounts.json +514 -0
  606. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_classifications.json +64 -0
  607. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_contacts.json +90 -0
  608. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_credit_memos.json +112 -0
  609. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_currencies.json +37 -0
  610. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_customer_payments.json +108 -0
  611. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_customers.json +232 -0
  612. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_departments.json +80 -0
  613. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_employees.json +124 -0
  614. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_invoices.json +229 -0
  615. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_item_fulfillments.json +85 -0
  616. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_items.json +237 -0
  617. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_journal_entries.json +217 -0
  618. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_locations.json +62 -0
  619. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_price_levels.json +28 -0
  620. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_purchase_orders.json +152 -0
  621. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_sales_order_lines.json +235 -0
  622. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_sales_orders.json +219 -0
  623. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_subsidiaries.json +85 -0
  624. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_terms.json +48 -0
  625. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_vendor_bills.json +170 -0
  626. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_vendors.json +140 -0
  627. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scope.toml +251 -33
  628. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/tests/tools.json +82 -0
  629. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/world.json +31065 -8232
  630. package/runtime/gatewaysdk/environment/schema/connectors/notion/api/handlers.py +1330 -0
  631. package/runtime/gatewaysdk/environment/schema/connectors/notion/connector.toml +386 -0
  632. package/runtime/gatewaysdk/environment/schema/connectors/notion/handlers.py +54 -0
  633. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/scenario.toml +2 -0
  634. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/blocks.json +4197 -0
  635. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/calendar_events.json +18 -0
  636. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/collection_views.json +175 -0
  637. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/comments.json +109 -0
  638. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/databases.json +417 -0
  639. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/favorites.json +3 -0
  640. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/notifications.json +49 -0
  641. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/pages.json +3758 -0
  642. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/spaces.json +28 -0
  643. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/teamspaces.json +3 -0
  644. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/users.json +92 -0
  645. package/runtime/gatewaysdk/environment/schema/connectors/notion/tests/01-reads.json +165 -0
  646. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/assets/index-DQ36W7RG.css +1 -0
  647. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/assets/index-DythuuUy.js +67 -0
  648. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/avatars/eeee0000000000000000000000000002.svg +1 -0
  649. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/avatars/eeee0000000000000000000000000003.svg +1 -0
  650. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/avatars/eeee0000000000000000000000000004.svg +1 -0
  651. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/avatars/eeee0000000000000000000000000005.svg +1 -0
  652. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/avatars/eeee0000000000000000000000000006.svg +1 -0
  653. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/avatars/eeee0000000000000000000000000007.svg +1 -0
  654. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/avatars/eeee0000000000000000000000000008.svg +1 -0
  655. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/covers/dusk-harbor.png +0 -0
  656. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/covers/ember-coast.png +0 -0
  657. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/covers/green-ridge.png +0 -0
  658. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f30a.svg +1 -0
  659. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f331.svg +1 -0
  660. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f373.svg +1 -0
  661. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f3a7.svg +1 -0
  662. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f3a8.svg +1 -0
  663. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f3ac.svg +1 -0
  664. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f3af.svg +1 -0
  665. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f3c4.svg +1 -0
  666. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f3d6.svg +1 -0
  667. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f3e0.svg +1 -0
  668. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f44b.svg +1 -0
  669. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4a1.svg +1 -0
  670. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4b0.svg +1 -0
  671. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4bc.svg +1 -0
  672. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4c5.svg +1 -0
  673. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4c8.svg +1 -0
  674. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4cb.svg +1 -0
  675. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4ce.svg +1 -0
  676. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4d1.svg +1 -0
  677. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4d3.svg +1 -0
  678. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4d6.svg +1 -0
  679. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4da.svg +1 -0
  680. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4dd.svg +1 -0
  681. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4ec.svg +1 -0
  682. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4f7.svg +1 -0
  683. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f527.svg +1 -0
  684. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f55b.svg +1 -0
  685. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f5c2.svg +1 -0
  686. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f5d3.svg +1 -0
  687. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f680.svg +1 -0
  688. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f6a2.svg +1 -0
  689. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f9ca.svg +1 -0
  690. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f9e0.svg +1 -0
  691. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f9ea.svg +1 -0
  692. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f9ed.svg +1 -0
  693. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f9f0.svg +1 -0
  694. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1fab6.svg +1 -0
  695. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/2600.svg +1 -0
  696. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/2693.svg +1 -0
  697. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/2705.svg +1 -0
  698. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/2708.svg +1 -0
  699. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/270f.svg +1 -0
  700. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/2b50.svg +1 -0
  701. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/favicon.svg +1 -0
  702. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/fonts/SourceSerif4-latin.woff2 +0 -0
  703. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/index.html +31 -0
  704. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/learn/content-blocks.png +0 -0
  705. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/learn/databases.png +0 -0
  706. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/learn/sharing.png +0 -0
  707. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/learn/style-content.png +0 -0
  708. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/photos/home-icon.png +0 -0
  709. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/photos/viewer.png +0 -0
  710. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/photos/workspace.png +0 -0
  711. package/runtime/gatewaysdk/environment/schema/connectors/notion/world.json +2796 -0
  712. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_admin_role_assignments.json +44 -0
  713. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_app_assignments.json +40 -0
  714. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_app_group_assignments.json +59 -0
  715. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_applications.json +265 -0
  716. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_console_dashboards.json +91 -0
  717. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_device_users.json +32 -0
  718. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_devices.json +89 -0
  719. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_group_memberships.json +156 -0
  720. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_groups.json +100 -0
  721. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_orgs.json +20 -0
  722. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_policies.json +84 -0
  723. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_system_log_events.json +9656 -0
  724. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_users.json +744 -0
  725. package/runtime/gatewaysdk/environment/schema/connectors/outlook/api/handlers.py +624 -0
  726. package/runtime/gatewaysdk/environment/schema/connectors/outlook/connector.toml +381 -0
  727. package/runtime/gatewaysdk/environment/schema/connectors/outlook/handlers.py +54 -0
  728. package/runtime/gatewaysdk/environment/schema/connectors/outlook/provenance.json +408 -0
  729. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/instruction.md +22 -0
  730. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/scenario.toml +2 -0
  731. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/seed/outlook_attachments.json +44 -0
  732. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/seed/outlook_calendars.json +52 -0
  733. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/seed/outlook_contacts.json +326 -0
  734. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/seed/outlook_events.json +3050 -0
  735. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/seed/outlook_mail_folders.json +84 -0
  736. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/seed/outlook_mailbox_settings.json +35 -0
  737. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/seed/outlook_mailboxes.json +14 -0
  738. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/seed/outlook_messages.json +1400 -0
  739. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/seed/outlook_system_senders.json +44 -0
  740. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/seed/outlook_users.json +256 -0
  741. package/runtime/gatewaysdk/environment/schema/connectors/outlook/tests/routes.json +333 -0
  742. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/assets/index-DRVA5ahH.js +67 -0
  743. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/assets/index-kOnvVBhA.css +1 -0
  744. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/fonts/FluentSystemIcons-Filled.woff2 +0 -0
  745. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/fonts/FluentSystemIcons-Regular.woff2 +0 -0
  746. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/fonts/FluentSystemIcons-Resizable.woff2 +0 -0
  747. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/fonts/controlIcons.woff +0 -0
  748. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/fonts/segoeui-bold.woff2 +0 -0
  749. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/fonts/segoeui-light.woff2 +0 -0
  750. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/fonts/segoeui-regular.woff2 +0 -0
  751. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/fonts/segoeui-semibold.woff2 +0 -0
  752. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/fonts/segoeui-semilight.woff2 +0 -0
  753. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/bookings.svg +1 -0
  754. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/calendar.svg +35 -0
  755. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/copilot.png +0 -0
  756. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/excel.svg +1 -0
  757. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/mail.svg +32 -0
  758. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/my-day.svg +1 -0
  759. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/newsletters.svg +37 -0
  760. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/no-mail-selected-dark.svg +1 -0
  761. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/no-mail-selected.svg +1 -0
  762. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/onedrive.svg +1 -0
  763. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/onenote.svg +1 -0
  764. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/org-explorer.png +0 -0
  765. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/outlook.svg +1 -0
  766. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/people.svg +34 -0
  767. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/powerpoint.svg +1 -0
  768. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/ribbon-layout.svg +1 -0
  769. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/sharepoint.svg +1 -0
  770. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/teams-chat.svg +1 -0
  771. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/teams.svg +1 -0
  772. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/to-do.png +0 -0
  773. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/viva.svg +1 -0
  774. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/word.svg +1 -0
  775. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/index.html +34 -0
  776. package/runtime/gatewaysdk/environment/schema/connectors/outlook/world.json +686 -0
  777. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/api/handlers.py +447 -0
  778. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/connector.toml +3478 -0
  779. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/handlers.py +695 -616
  780. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/provenance.json +4254 -111
  781. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/instruction.md +8 -0
  782. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/scenario.toml +2 -0
  783. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_account_contact_relations.json +20 -0
  784. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_account_contact_roles.json +16 -0
  785. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_account_partners.json +18 -0
  786. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_account_team_members.json +16 -0
  787. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_accounts.json +38 -0
  788. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_assets.json +35 -0
  789. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_attachments.json +16 -0
  790. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_business_hours.json +16 -0
  791. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_campaign_member_statuses.json +16 -0
  792. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_campaign_members.json +38 -0
  793. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_campaigns.json +35 -0
  794. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_case_comments.json +14 -0
  795. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_case_histories.json +18 -0
  796. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_case_milestones.json +18 -0
  797. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_case_statuses.json +16 -0
  798. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_case_team_members.json +14 -0
  799. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_case_team_roles.json +12 -0
  800. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_cases.json +42 -0
  801. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_collaboration_group_members.json +16 -0
  802. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_collaboration_groups.json +16 -0
  803. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_contact_point_addresses.json +14 -0
  804. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_contact_point_emails.json +14 -0
  805. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_contact_point_phones.json +14 -0
  806. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_contacts.json +34 -0
  807. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_content_document_links.json +14 -0
  808. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_content_documents.json +18 -0
  809. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_content_folders.json +13 -0
  810. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_content_notes.json +12 -0
  811. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_content_versions.json +24 -0
  812. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_content_workspaces.json +16 -0
  813. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_contract_contact_roles.json +16 -0
  814. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_contract_line_items.json +32 -0
  815. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_contracts.json +40 -0
  816. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_dashboards.json +20 -0
  817. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_documents.json +22 -0
  818. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_email_message_relations.json +14 -0
  819. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_email_messages.json +21 -0
  820. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_email_templates.json +24 -0
  821. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_entitlements.json +32 -0
  822. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_events.json +26 -0
  823. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_feed_comments.json +19 -0
  824. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_feed_items.json +24 -0
  825. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_fiscal_year_settings.json +20 -0
  826. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_folders.json +18 -0
  827. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_group_members.json +12 -0
  828. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_groups.json +20 -0
  829. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_holidays.json +16 -0
  830. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_individuals.json +21 -0
  831. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_lead_statuses.json +14 -0
  832. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_leads.json +45 -0
  833. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_list_views.json +16 -0
  834. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_login_histories.json +18 -0
  835. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_milestone_types.json +14 -0
  836. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_notes.json +16 -0
  837. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_object_territory_associations.json +14 -0
  838. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_opportunities.json +48 -0
  839. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_opportunity_competitors.json +12 -0
  840. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_opportunity_contact_roles.json +16 -0
  841. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_opportunity_field_histories.json +18 -0
  842. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_opportunity_histories.json +20 -0
  843. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_opportunity_line_items.json +32 -0
  844. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_opportunity_partners.json +16 -0
  845. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_opportunity_stages.json +22 -0
  846. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_opportunity_team_members.json +18 -0
  847. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_order_items.json +33 -0
  848. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_orders.json +44 -0
  849. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_organizations.json +18 -0
  850. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_partners.json +18 -0
  851. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_periods.json +18 -0
  852. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_permission_set_assignments.json +16 -0
  853. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_permission_sets.json +18 -0
  854. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_pricebook_entries.json +22 -0
  855. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_pricebooks.json +16 -0
  856. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_products.json +20 -0
  857. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_profiles.json +14 -0
  858. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_queue_sobjects.json +12 -0
  859. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_quote_line_items.json +43 -0
  860. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_quotes.json +40 -0
  861. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_record_actions.json +16 -0
  862. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_record_types.json +18 -0
  863. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_reports.json +18 -0
  864. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_service_contracts.json +32 -0
  865. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_sla_processes.json +18 -0
  866. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_solutions.json +18 -0
  867. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_task_priorities.json +14 -0
  868. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_task_relations.json +14 -0
  869. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_task_statuses.json +16 -0
  870. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_tasks.json +26 -0
  871. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_territories.json +20 -0
  872. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_territory_models.json +16 -0
  873. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_territory_types.json +18 -0
  874. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_topic_assignments.json +12 -0
  875. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_topics.json +14 -0
  876. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_user_roles.json +16 -0
  877. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_user_territory_associations.json +16 -0
  878. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_users.json +57 -0
  879. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_web_links.json +26 -0
  880. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_work_order_line_items.json +42 -0
  881. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_work_orders.json +46 -0
  882. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scope.toml +624 -104
  883. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/tests/tools.json +69 -0
  884. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/world.json +19222 -2654
  885. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/api/handlers.py +630 -0
  886. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/connector.toml +266 -0
  887. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/handlers.py +3 -0
  888. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/provenance.json +245 -0
  889. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/instruction.md +15 -0
  890. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/scenario.toml +1 -0
  891. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/10-snow_users.json +268 -0
  892. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/11-snow_user_groups.json +40 -0
  893. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/20-snow_configuration_items.json +684 -0
  894. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/30-snow_catalog_categories.json +52 -0
  895. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/31-snow_catalog_items.json +334 -0
  896. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/40-snow_incidents.json +3086 -0
  897. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/41-snow_incident_tasks.json +54 -0
  898. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/42-snow_task_slas.json +64 -0
  899. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/43-snow_problems.json +148 -0
  900. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/44-snow_change_requests.json +364 -0
  901. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/45-snow_knowledge_articles.json +214 -0
  902. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/46-snow_journal_entries.json +1612 -0
  903. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/60-snow_ui_current_users.json +19 -0
  904. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/61-snow_ui_navigation_applications.json +187 -0
  905. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/62-snow_ui_home_widgets.json +91 -0
  906. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/63-snow_ui_notifications.json +3 -0
  907. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/64-snow_ui_employee_center_pages.json +74 -0
  908. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/65-snow_ui_list_layouts.json +54 -0
  909. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/66-snow_ui_search_facets.json +29 -0
  910. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/67-snow_ui_activity_entries.json +1076 -0
  911. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/68-snow_ui_instances.json +9 -0
  912. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scope.toml +166 -0
  913. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/tests/routes.json +272 -0
  914. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/assets/index-5QHcQLCI.css +1 -0
  915. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/assets/index-BzeVnzFt.js +67 -0
  916. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/cabin-400-700-italic.woff2 +0 -0
  917. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/cabin-400-700.woff2 +0 -0
  918. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-0-lato-v17-latin-ext_latin-100.woff2 +0 -0
  919. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-1-lato-v17-latin-ext_latin-100.woff +0 -0
  920. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-10-lato-v17-latin-ext_latin-italic.woff2 +0 -0
  921. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-11-lato-v17-latin-ext_latin-italic.woff +0 -0
  922. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-12-lato-v17-latin-ext_latin-700.woff2 +0 -0
  923. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-13-lato-v17-latin-ext_latin-700.woff +0 -0
  924. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-14-lato-v17-latin-ext_latin-700italic.woff2 +0 -0
  925. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-15-lato-v17-latin-ext_latin-700italic.woff +0 -0
  926. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-16-source-sans-pro-v11-latin-300.woff2 +0 -0
  927. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-17-source-sans-pro-v11-latin-300.woff +0 -0
  928. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-18-source-sans-pro-v11-latin-regular.woff2 +0 -0
  929. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-19-source-sans-pro-v11-latin-regular.woff +0 -0
  930. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-2-lato-v17-latin-ext_latin-100italic.woff2 +0 -0
  931. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-20-source-sans-pro-v11-latin-600.woff2 +0 -0
  932. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-21-source-sans-pro-v11-latin-600.woff +0 -0
  933. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-22-source-sans-pro-v11-latin-700.woff2 +0 -0
  934. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-23-source-sans-pro-v11-latin-700.woff +0 -0
  935. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-3-lato-v17-latin-ext_latin-100italic.woff +0 -0
  936. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-4-lato-v17-latin-ext_latin-300.woff2 +0 -0
  937. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-5-lato-v17-latin-ext_latin-300.woff +0 -0
  938. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-6-lato-v17-latin-ext_latin-300italic.woff2 +0 -0
  939. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-7-lato-v17-latin-ext_latin-300italic.woff +0 -0
  940. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-8-lato-v17-latin-ext_latin-regular.woff2 +0 -0
  941. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-9-lato-v17-latin-ext_latin-regular.woff +0 -0
  942. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/index.json +122 -0
  943. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/lato-300.woff2 +0 -0
  944. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/lato-600-italic.woff2 +0 -0
  945. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/lato-600.woff2 +0 -0
  946. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/lato-bold-italic.woff2 +0 -0
  947. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/lato-bold.woff2 +0 -0
  948. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/lato-normal-italic.woff2 +0 -0
  949. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/lato-normal.woff2 +0 -0
  950. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/appsee-outline.svg +1 -0
  951. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/arrow-up-outline.svg +1 -0
  952. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/available.svg +1 -0
  953. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/bell-outline.svg +1 -0
  954. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/caret-down-fill.svg +1 -0
  955. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/check-fill.svg +1 -0
  956. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/chevron-right-outline.svg +1 -0
  957. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/circle-close-outline.svg +1 -0
  958. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/circle-info-outline.svg +1 -0
  959. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/circle-question-outline.svg +1 -0
  960. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/circleinfooutline.svg +1 -0
  961. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/ellipsis-v-outline.svg +1 -0
  962. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/eye-outline.svg +1 -0
  963. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-bell-fill.svg +1 -0
  964. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-caret-down-fill.svg +1 -0
  965. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-check-square.svg +1 -0
  966. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-chevron-right.svg +1 -0
  967. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-clock-outline.svg +1 -0
  968. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-comment-chat.svg +1 -0
  969. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-external-link.svg +1 -0
  970. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-facebook.svg +1 -0
  971. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-heart-fill.svg +1 -0
  972. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-heart-outline.svg +1 -0
  973. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-home-fill-teal.svg +1 -0
  974. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-home-fill.svg +1 -0
  975. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-linkedin.svg +1 -0
  976. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-list-alt-fill.svg +1 -0
  977. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-pencil-square.svg +1 -0
  978. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-question-circle-fill.svg +1 -0
  979. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-times.svg +1 -0
  980. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-twitter.svg +1 -0
  981. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/filter-outline.svg +1 -0
  982. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/gear-outline.svg +1 -0
  983. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/globe-outline.svg +1 -0
  984. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/home-outline.svg +1 -0
  985. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/icon-2.svg +17 -0
  986. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/icon-3.svg +1 -0
  987. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/icon-4.svg +1 -0
  988. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/icon.svg +45 -0
  989. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/keyboard-outline.svg +1 -0
  990. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/link-icon-associated-to-view-all-adoption-blueprints.svg +1 -0
  991. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/link-icon-associated-to-view-all-applications.svg +1 -0
  992. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/list-fill.svg +1 -0
  993. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/loading-2.svg +1 -0
  994. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/loading.svg +1 -0
  995. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/magnifying-glass-outline.svg +1 -0
  996. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/ongoing-outline.svg +1 -0
  997. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/open-link-right-fill.svg +1 -0
  998. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/open-link-right-outline.svg +1 -0
  999. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/pencil-page-outline.svg +1 -0
  1000. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/plus-fill.svg +1 -0
  1001. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/serverbox-outline.svg +1 -0
  1002. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/servicenow-wordmark.svg +20 -0
  1003. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/signal-live-outline.svg +1 -0
  1004. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/square-arrow-left-outline.svg +1 -0
  1005. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/star-outline.svg +1 -0
  1006. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/sync-outline.svg +1 -0
  1007. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/task-slas-related-list.svg +24 -0
  1008. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/thumbtack-outline.svg +1 -0
  1009. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/trending-downward.svg +1 -0
  1010. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/trending-neutral.svg +1 -0
  1011. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/unpinned-all-menu.svg +1 -0
  1012. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/unpinned-favorites-menu.svg +1 -0
  1013. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/unpinned-history-menu.svg +1 -0
  1014. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/user-outline.svg +1 -0
  1015. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/adoption-blueprints.svg +40 -0
  1016. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/avatar-admin.jpg +0 -0
  1017. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/now-assist-admin.svg +17 -0
  1018. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/quick-link-desk.jpg +0 -0
  1019. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/quick-link-password.jpg +0 -0
  1020. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/quick-link-status.jpg +0 -0
  1021. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/topic-accessories.svg +1 -0
  1022. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/topic-computers.svg +1 -0
  1023. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/topic-developer.svg +1 -0
  1024. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/topic-email.svg +1 -0
  1025. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/topic-phone.svg +1 -0
  1026. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/topic-software-catalog.svg +1 -0
  1027. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/topic-software.svg +1 -0
  1028. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/topic-technology.svg +1 -0
  1029. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/index.html +36 -0
  1030. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/world.json +2004 -0
  1031. package/runtime/gatewaysdk/environment/schema/connectors/slack/MODEL.md +28 -0
  1032. package/runtime/gatewaysdk/environment/schema/connectors/slack/api/handlers.py +1880 -0
  1033. package/runtime/gatewaysdk/environment/schema/connectors/slack/capabilities.json +19 -2
  1034. package/runtime/gatewaysdk/environment/schema/connectors/slack/connector.toml +892 -0
  1035. package/runtime/gatewaysdk/environment/schema/connectors/slack/provenance.json +65 -10
  1036. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/scenario.toml +1 -0
  1037. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_apps.json +22 -0
  1038. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_bookmarks.json +22 -0
  1039. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_bots.json +19 -0
  1040. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_channels.json +206 -0
  1041. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_conversation_states.json +50 -0
  1042. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_emojis.json +19 -0
  1043. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_ephemeral_message_files.json +12 -0
  1044. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_ephemeral_message_threads.json +11 -0
  1045. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_ephemeral_messages.json +16 -0
  1046. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_file_channel_observations.json +16 -0
  1047. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_file_reaction_summaries.json +10 -0
  1048. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_file_reaction_users.json +10 -0
  1049. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_file_shares.json +29 -0
  1050. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_file_user_states.json +10 -0
  1051. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_files.json +64 -0
  1052. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_memberships.json +79 -0
  1053. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_message_files.json +18 -0
  1054. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_message_threads.json +10 -0
  1055. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_message_user_states.json +14 -0
  1056. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_messages.json +127 -0
  1057. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_pins.json +11 -0
  1058. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_presence.json +35 -0
  1059. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_reaction_summaries.json +25 -0
  1060. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_reaction_users.json +32 -0
  1061. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_scheduled_message_threads.json +10 -0
  1062. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_scheduled_messages.json +15 -0
  1063. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_unavailable_message_files.json +14 -0
  1064. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_user_profile_fields.json +28 -0
  1065. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_usergroup_channels.json +10 -0
  1066. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_usergroup_memberships.json +14 -0
  1067. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_usergroups.json +33 -0
  1068. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_users.json +228 -0
  1069. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_view_state_entries.json +22 -0
  1070. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_views.json +53 -0
  1071. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_workspaces.json +37 -0
  1072. package/runtime/gatewaysdk/environment/schema/connectors/slack/scope.toml +6 -2
  1073. package/runtime/gatewaysdk/environment/schema/connectors/slack/tests/api.json +177 -0
  1074. package/runtime/gatewaysdk/environment/schema/connectors/slack/tests/test_threads.py +49 -0
  1075. package/runtime/gatewaysdk/environment/schema/connectors/slack/tests/tools.json +92 -0
  1076. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/assets/index-BSqGskph.css +1 -0
  1077. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/assets/index-CKQh1igo.js +81 -0
  1078. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/fonts/README.md +15 -0
  1079. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/fonts/lato-black.woff2 +0 -0
  1080. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/fonts/lato-bold.woff2 +0 -0
  1081. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/fonts/lato-italic-black.woff2 +0 -0
  1082. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/fonts/lato-italic-bold.woff2 +0 -0
  1083. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/fonts/lato-italic-light.woff2 +0 -0
  1084. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/fonts/lato-italic.woff2 +0 -0
  1085. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/fonts/lato-light.woff2 +0 -0
  1086. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/fonts/lato-regular.woff2 +0 -0
  1087. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/fonts/slack-icons-v2.woff2 +0 -0
  1088. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/index.html +35 -0
  1089. package/runtime/gatewaysdk/environment/schema/connectors/slack/vendor-openapi.json +12515 -0
  1090. package/runtime/gatewaysdk/environment/schema/connectors/slack/world.json +396 -8
  1091. package/runtime/gatewaysdk/environment/schema/connectors/workday/api/handlers.py +175 -0
  1092. package/runtime/gatewaysdk/environment/schema/connectors/workday/connector.toml +610 -0
  1093. package/runtime/gatewaysdk/environment/schema/connectors/workday/parity.json +39 -6
  1094. package/runtime/gatewaysdk/environment/schema/connectors/workday/provenance.json +253 -25
  1095. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/instruction.md +10 -0
  1096. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/scenario.toml +2 -0
  1097. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_compensations.json +219 -0
  1098. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_job_profiles.json +76 -0
  1099. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_locations.json +142 -0
  1100. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_organizations.json +124 -0
  1101. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_positions.json +280 -0
  1102. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_absence_leaves.json +66 -0
  1103. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_business_title_changes.json +44 -0
  1104. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_check_in_topics.json +48 -0
  1105. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_check_ins.json +46 -0
  1106. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_countries.json +28 -0
  1107. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_currencies.json +25 -0
  1108. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_job_change_reasons.json +28 -0
  1109. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_job_families.json +40 -0
  1110. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_job_profiles.json +202 -0
  1111. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_jobs.json +120 -0
  1112. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_organization_types.json +19 -0
  1113. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_organizations.json +24 -0
  1114. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_persons.json +100 -0
  1115. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_scorecard_results.json +57 -0
  1116. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_scorecards.json +68 -0
  1117. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_supervisory_organizations.json +64 -0
  1118. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_time_off_details.json +112 -0
  1119. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_time_off_entries.json +91 -0
  1120. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_worker_history_events.json +58 -0
  1121. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_workers.json +90 -0
  1122. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_time_off_requests.json +181 -0
  1123. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_workers.json +492 -0
  1124. package/runtime/gatewaysdk/environment/schema/connectors/workday/scope.toml +178 -14
  1125. package/runtime/gatewaysdk/environment/schema/connectors/workday/tests/tools.json +81 -0
  1126. package/runtime/gatewaysdk/environment/schema/connectors/workday/vendor-openapi.json +10646 -0
  1127. package/runtime/gatewaysdk/environment/schema/connectors/workday/world.json +3787 -407
  1128. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/api/handlers.py +1183 -0
  1129. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/connector.toml +645 -0
  1130. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/handlers.py +377 -0
  1131. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/instruction.md +22 -0
  1132. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/scenario.toml +3 -0
  1133. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_brands.json +25 -0
  1134. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_group_memberships.json +49 -0
  1135. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_groups.json +37 -0
  1136. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_macros.json +154 -0
  1137. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_organizations.json +65 -0
  1138. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_ticket_audits.json +3328 -0
  1139. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_ticket_comments.json +2642 -0
  1140. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_tickets.json +1439 -0
  1141. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_users.json +624 -0
  1142. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_views.json +510 -0
  1143. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_workspace_tabs.json +10 -0
  1144. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/ui/static/assets/index-JWq7XNO5.css +1 -0
  1145. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/ui/static/assets/index-bn8ezNTi.js +67 -0
  1146. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/ui/static/index.html +22 -0
  1147. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/world.json +1707 -0
  1148. package/runtime/gatewaysdk/environment/schema/data.py +349 -35
  1149. package/runtime/gatewaysdk/environment/schema/dependencies.py +235 -0
  1150. package/runtime/gatewaysdk/environment/schema/extract.py +6 -6
  1151. package/runtime/gatewaysdk/environment/schema/host.py +226 -62
  1152. package/runtime/gatewaysdk/environment/schema/host_surfaces.py +62 -17
  1153. package/runtime/gatewaysdk/environment/schema/ingest.py +528 -0
  1154. package/runtime/gatewaysdk/environment/schema/local.py +536 -0
  1155. package/runtime/gatewaysdk/environment/schema/mapping.py +944 -0
  1156. package/runtime/gatewaysdk/environment/schema/platform.py +678 -202
  1157. package/runtime/gatewaysdk/environment/schema/reconcile.py +202 -0
  1158. package/runtime/gatewaysdk/environment/schema/redaction.py +378 -0
  1159. package/runtime/gatewaysdk/environment/schema/scaffold.py +68 -7
  1160. package/runtime/gatewaysdk/environment/schema/skill.py +1 -0
  1161. package/runtime/gatewaysdk/environment/schema/skills/benchmarks-getting-started/SKILL.md +391 -0
  1162. package/runtime/gatewaysdk/environment/schema/skills/connector-schema-authoring/CONNECTORS.md +64 -31
  1163. package/runtime/gatewaysdk/environment/schema/skills/connector-schema-authoring/SKILL.md +86 -36
  1164. package/runtime/gatewaysdk/environment/schema/skills/world-data-ingestion/ROWS.md +20 -0
  1165. package/runtime/gatewaysdk/environment/schema/skills/world-data-ingestion/SKILL.md +178 -11
  1166. package/runtime/gatewaysdk/environment/schema/skills/worlds-getting-started/SKILL.md +184 -74
  1167. package/runtime/gatewaysdk/environment/schema/skills/worlds-getting-started/references/cli-mcp-map.md +49 -0
  1168. package/runtime/gatewaysdk/environment/schema/skills/worlds-getting-started/references/ui-map.md +18 -0
  1169. package/runtime/gatewaysdk/environment/schema/store.py +103 -3
  1170. package/runtime/gatewaysdk/environment/schema/tasks.py +8 -3
  1171. package/runtime/gatewaysdk/environment/schema/tools_world.py +424 -57
  1172. package/runtime/gatewaysdk/environment/schema/transform.py +200 -0
  1173. package/runtime/gatewaysdk/environment/schema/transforms.py +103 -0
  1174. package/runtime/gatewaysdk/environment/schema/ui.py +455 -0
  1175. package/runtime/gatewaysdk/environment/schema/ui_static/app.js +581 -0
  1176. package/runtime/gatewaysdk/environment/schema/ui_static/index.html +72 -0
  1177. package/runtime/gatewaysdk/environment/schema/validation.py +59 -12
  1178. package/runtime/gatewaysdk/environment/schema/world_tests.py +245 -51
  1179. package/skills/benchmarks-getting-started/SKILL.md +391 -0
  1180. package/skills/connector-schema-authoring/CONNECTORS.md +64 -31
  1181. package/skills/connector-schema-authoring/SKILL.md +86 -36
  1182. package/skills/connector-schema-authoring/connector-worlds.md +355 -0
  1183. package/skills/connector-schema-authoring/world-schema.md +620 -0
  1184. package/skills/world-data-ingestion/ROWS.md +20 -0
  1185. package/skills/world-data-ingestion/SKILL.md +178 -11
  1186. package/skills/worlds-getting-started/SKILL.md +184 -74
  1187. package/skills/worlds-getting-started/references/cli-mcp-map.md +49 -0
  1188. package/skills/worlds-getting-started/references/ui-map.md +18 -0
@@ -0,0 +1 @@
1
+ {"openapi":"3.0.3","info":{"version":"1.1.4","title":"GitHub v3 REST API","description":"GitHub's v3 REST API.","license":{"name":"MIT","url":"https://spdx.org/licenses/MIT"},"termsOfService":"https://docs.github.com/articles/github-terms-of-service","contact":{"name":"Support","url":"https://support.github.com/contact?tags=dotcom-rest-api"},"x-github-plan":"api.github.com"},"servers":[{"url":"https://api.github.com"}],"paths":{"/app/installations":{"get":{"summary":"List installations for the authenticated app","description":"The permissions the installation has are included under the `permissions` key.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","tags":["apps"],"operationId":"apps/list-installations","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app"},"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/since"},{"name":"outdated","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The permissions the installation has are included under the `permissions` key.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/installation"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"apps","subcategory":"apps"}}},"/app/installations/{installation_id}":{"delete":{"summary":"Delete an installation for the authenticated app","description":"Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","tags":["apps"],"operationId":"apps/delete-installation","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/apps/apps#delete-an-installation-for-the-authenticated-app"},"parameters":[{"$ref":"#/components/parameters/installation-id"}],"responses":{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":false,"category":"apps","subcategory":"apps"},"x-github-breaking-changes":[{"changeset":"change_delete_installation_success_status","patch":{"responses":{"202":{"description":"Response"},"204":null}},"version":"2026-03-10"}]},"get":{"summary":"Get an installation for the authenticated app","description":"Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","tags":["apps"],"operationId":"apps/get-installation","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/apps/apps#get-an-installation-for-the-authenticated-app"},"parameters":[{"$ref":"#/components/parameters/installation-id"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/installation"}}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"apps","subcategory":"apps"}}},"/apps/{app_slug}":{"get":{"summary":"Get an app","description":"> [!NOTE]\n> The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).","tags":["apps"],"operationId":"apps/get-by-slug","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/apps/apps#get-an-app"},"parameters":[{"$ref":"#/components/parameters/app-slug"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/integration"}}}},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"apps","subcategory":"apps"}}},"/gists":{"get":{"summary":"List gists for the authenticated user","description":"Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:","tags":["gists"],"operationId":"gists/list","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user"},"parameters":[{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/base-gist"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":false,"category":"gists","subcategory":"gists"}},"post":{"summary":"Create a gist","description":"Allows you to add a new gist with one or more files.\n\n> [!NOTE]\n> Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.","operationId":"gists/create","tags":["gists"],"externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/gists/gists#create-a-gist"},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"description":{"description":"Description of the gist","type":"string"},"files":{"description":"Names and content for the files that make up the gist","type":"object","additionalProperties":{"type":"object","properties":{"content":{"description":"Content of the file","readOnly":false,"type":"string"}},"required":["content"]}},"public":{"oneOf":[{"description":"Flag indicating whether the gist is public","type":"boolean","default":false},{"type":"string","default":"false","enum":["true","false"]}]}},"required":["files"],"type":"object"}}}},"responses":{"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gist-simple"}}},"headers":{"Location":{"schema":{"type":"string"}}}},"422":{"$ref":"#/components/responses/validation_failed"},"304":{"$ref":"#/components/responses/not_modified"},"404":{"$ref":"#/components/responses/not_found"},"403":{"$ref":"#/components/responses/forbidden"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":false,"category":"gists","subcategory":"gists"}}},"/gists/public":{"get":{"summary":"List public gists","description":"List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.","tags":["gists"],"operationId":"gists/list-public","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/gists/gists#list-public-gists"},"parameters":[{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/base-gist"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"422":{"$ref":"#/components/responses/validation_failed"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":false,"category":"gists","subcategory":"gists"}}},"/gists/{gist_id}":{"delete":{"summary":"Delete a gist","description":"","tags":["gists"],"operationId":"gists/delete","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/gists/gists#delete-a-gist"},"parameters":[{"$ref":"#/components/parameters/gist-id"}],"responses":{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":false,"category":"gists","subcategory":"gists"}},"get":{"summary":"Get a gist","description":"Gets a specified gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.","tags":["gists"],"operationId":"gists/get","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/gists/gists#get-a-gist"},"parameters":[{"$ref":"#/components/parameters/gist-id"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gist-simple"}}}},"403":{"$ref":"#/components/responses/forbidden_gist"},"404":{"$ref":"#/components/responses/not_found"},"304":{"$ref":"#/components/responses/not_modified"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":false,"category":"gists","subcategory":"gists"}},"patch":{"summary":"Update a gist","description":"Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.\n\nAt least one of `description` or `files` is required.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.","tags":["gists"],"operationId":"gists/update","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/gists/gists#update-a-gist"},"parameters":[{"$ref":"#/components/parameters/gist-id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"description":{"description":"The description of the gist.","type":"string"},"files":{"description":"The gist files to be updated, renamed, or deleted. Each `key` must match the current filename\n(including extension) of the targeted gist file. For example: `hello.py`.\n\nTo delete a file, set the whole file to null. For example: `hello.py : null`. The file will also be\ndeleted if the specified object does not contain at least one of `content` or `filename`.","type":"object","additionalProperties":{"type":"object","nullable":true,"properties":{"content":{"description":"The new content of the file.","type":"string"},"filename":{"description":"The new filename for the file.","type":"string","nullable":true}}}}},"type":"object","nullable":true}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gist-simple"}}}},"422":{"$ref":"#/components/responses/validation_failed"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":false,"category":"gists","subcategory":"gists"}}},"/gists/{gist_id}/comments":{"get":{"summary":"List gist comments","description":"Lists the comments on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.","tags":["gists"],"operationId":"gists/list-comments","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/gists/comments#list-gist-comments"},"parameters":[{"$ref":"#/components/parameters/gist-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/gist-comment"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"404":{"$ref":"#/components/responses/not_found"},"403":{"$ref":"#/components/responses/forbidden"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":false,"category":"gists","subcategory":"comments"}},"post":{"summary":"Create a gist comment","description":"Creates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.","tags":["gists"],"operationId":"gists/create-comment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/gists/comments#create-a-gist-comment"},"parameters":[{"$ref":"#/components/parameters/gist-id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"body":{"description":"The comment text.","type":"string","maxLength":65535}},"type":"object","required":["body"]}}}},"responses":{"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gist-comment"}}},"headers":{"Location":{"schema":{"type":"string"}}}},"304":{"$ref":"#/components/responses/not_modified"},"404":{"$ref":"#/components/responses/not_found"},"403":{"$ref":"#/components/responses/forbidden"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":false,"category":"gists","subcategory":"comments"}}},"/gists/{gist_id}/comments/{comment_id}":{"delete":{"summary":"Delete a gist comment","description":"","tags":["gists"],"operationId":"gists/delete-comment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/gists/comments#delete-a-gist-comment"},"parameters":[{"$ref":"#/components/parameters/gist-id"},{"$ref":"#/components/parameters/comment-id"}],"responses":{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"404":{"$ref":"#/components/responses/not_found"},"403":{"$ref":"#/components/responses/forbidden"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":false,"category":"gists","subcategory":"comments"}},"get":{"summary":"Get a gist comment","description":"Gets a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.","tags":["gists"],"operationId":"gists/get-comment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/gists/comments#get-a-gist-comment"},"parameters":[{"$ref":"#/components/parameters/gist-id"},{"$ref":"#/components/parameters/comment-id"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gist-comment"}}}},"304":{"$ref":"#/components/responses/not_modified"},"404":{"$ref":"#/components/responses/not_found"},"403":{"$ref":"#/components/responses/forbidden_gist"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":false,"category":"gists","subcategory":"comments"}},"patch":{"summary":"Update a gist comment","description":"Updates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.","tags":["gists"],"operationId":"gists/update-comment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/gists/comments#update-a-gist-comment"},"parameters":[{"$ref":"#/components/parameters/gist-id"},{"$ref":"#/components/parameters/comment-id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"body":{"description":"The comment text.","type":"string","maxLength":65535}},"type":"object","required":["body"]}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gist-comment"}}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":false,"category":"gists","subcategory":"comments"}}},"/issues":{"get":{"summary":"List issues assigned to the authenticated user","description":"List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["issues"],"operationId":"issues/list","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/issues#list-issues-assigned-to-the-authenticated-user"},"parameters":[{"name":"filter","description":"Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.","in":"query","required":false,"schema":{"type":"string","enum":["assigned","created","mentioned","subscribed","repos","all"],"default":"assigned"}},{"name":"state","description":"Indicates the state of the issues to return.","in":"query","required":false,"schema":{"type":"string","enum":["open","closed","all"],"default":"open"}},{"$ref":"#/components/parameters/labels"},{"name":"sort","description":"What to sort results by.","in":"query","required":false,"schema":{"type":"string","enum":["created","updated","comments"],"default":"created"}},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/since"},{"name":"collab","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"orgs","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"owned","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"pulls","in":"query","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/issue"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"422":{"$ref":"#/components/responses/validation_failed"},"304":{"$ref":"#/components/responses/not_modified"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":false,"category":"issues","subcategory":"issues"}}},"/licenses":{"get":{"summary":"Get all commonly used licenses","description":"Lists the most commonly used licenses on GitHub. For more information, see \"[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"","tags":["licenses"],"operationId":"licenses/get-all-commonly-used","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/licenses/licenses#get-all-commonly-used-licenses"},"parameters":[{"name":"featured","in":"query","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/license-simple"}}}}},"304":{"$ref":"#/components/responses/not_modified"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"licenses","subcategory":"licenses"}}},"/licenses/{license}":{"get":{"summary":"Get a license","description":"Gets information about a specific license. For more information, see \"[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"","tags":["licenses"],"operationId":"licenses/get","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/licenses/licenses#get-a-license"},"parameters":[{"name":"license","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/license"}}}},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"304":{"$ref":"#/components/responses/not_modified"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"licenses","subcategory":"licenses"}}},"/organizations":{"get":{"summary":"List organizations","description":"Lists all organizations, in the order that they were created.\n\n> [!NOTE]\n> Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.","tags":["orgs"],"operationId":"orgs/list","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/orgs/orgs#list-organizations"},"parameters":[{"$ref":"#/components/parameters/since-org"},{"$ref":"#/components/parameters/per-page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/organization-simple"}}}},"headers":{"Link":{"schema":{"type":"string"}}}},"304":{"$ref":"#/components/responses/not_modified"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"orgs","subcategory":"orgs"}}},"/orgs/{org}":{"get":{"summary":"Get an organization","description":"Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission.","tags":["orgs"],"operationId":"orgs/get","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/orgs/orgs#get-an-organization"},"parameters":[{"$ref":"#/components/parameters/org"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organization-full"}}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"orgs","subcategory":"orgs"}},"patch":{"summary":"Update an organization","description":"> [!WARNING]\n> **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\n> [!WARNING]\n> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.","tags":["orgs"],"operationId":"orgs/update","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/orgs/orgs#update-an-organization"},"parameters":[{"$ref":"#/components/parameters/org"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"billing_email":{"type":"string","description":"Billing email address. This address is not publicized."},"company":{"type":"string","description":"The company name."},"email":{"type":"string","description":"The publicly visible email address."},"twitter_username":{"type":"string","description":"The Twitter username of the company."},"location":{"type":"string","description":"The location."},"name":{"type":"string","description":"The shorthand name of the company."},"description":{"type":"string","description":"The description of the company. The maximum size is 160 characters."},"has_organization_projects":{"type":"boolean","description":"Whether an organization can use organization projects."},"has_repository_projects":{"type":"boolean","description":"Whether repositories that belong to the organization can use repository projects."},"default_repository_permission":{"type":"string","description":"Default permission level members have for organization repositories.","enum":["read","write","admin","none"],"default":"read"},"members_can_create_repositories":{"type":"boolean","description":"Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.","default":true},"members_can_create_internal_repositories":{"type":"boolean","description":"Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation."},"members_can_create_private_repositories":{"type":"boolean","description":"Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation."},"members_can_create_public_repositories":{"type":"boolean","description":"Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation."},"members_allowed_repository_creation_type":{"type":"string","description":"Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.","enum":["all","private","none"]},"members_can_create_pages":{"type":"boolean","description":"Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.","default":true},"members_can_create_public_pages":{"type":"boolean","description":"Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.","default":true},"members_can_create_private_pages":{"type":"boolean","description":"Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.","default":true},"members_can_fork_private_repositories":{"type":"boolean","description":"Whether organization members can fork private organization repositories.","default":false},"web_commit_signoff_required":{"type":"boolean","description":"Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.","default":false},"blog":{"type":"string"},"advanced_security_enabled_for_new_repositories":{"type":"boolean","description":"**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.","deprecated":true},"dependabot_alerts_enabled_for_new_repositories":{"type":"boolean","description":"**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.","deprecated":true},"dependabot_security_updates_enabled_for_new_repositories":{"type":"boolean","description":"**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.","deprecated":true},"dependency_graph_enabled_for_new_repositories":{"type":"boolean","description":"**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.","deprecated":true},"secret_scanning_enabled_for_new_repositories":{"type":"boolean","description":"**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.","deprecated":true},"secret_scanning_push_protection_enabled_for_new_repositories":{"type":"boolean","description":"**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.","deprecated":true},"secret_scanning_push_protection_custom_link_enabled":{"type":"boolean","description":"Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection."},"secret_scanning_push_protection_custom_link":{"type":"string","description":"If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret."},"deploy_keys_enabled_for_repositories":{"type":"boolean","description":"Controls whether or not deploy keys may be added and used for repositories in the organization."}}}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organization-full"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/validation-error"},{"$ref":"#/components/schemas/validation-error-simple"}]}}}},"409":{"$ref":"#/components/responses/conflict"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"orgs","subcategory":"orgs"},"x-github-breaking-changes":[{"changeset":"remove_secret_scanning_custom_link_enablement_field","patch":{"requestBody":{"content":{"application/json":{"schema":{"properties":{"secret_scanning_push_protection_custom_link_enabled":null}}}}}},"version":"2026-03-10"}]}},"/orgs/{org}/code-scanning/alerts":{"get":{"summary":"List code scanning alerts for an organization","description":"Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.","tags":["code-scanning"],"operationId":"code-scanning/list-alerts-for-org","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization"},"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/tool-name"},{"$ref":"#/components/parameters/tool-guid"},{"$ref":"#/components/parameters/pagination-before"},{"$ref":"#/components/parameters/pagination-after"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/direction"},{"name":"state","description":"If specified, only code scanning alerts with this state will be returned.","in":"query","required":false,"schema":{"$ref":"#/components/schemas/code-scanning-alert-state-query"}},{"name":"sort","description":"The property by which to sort the results.","in":"query","required":false,"schema":{"type":"string","enum":["created","updated"],"default":"created"}},{"name":"severity","description":"If specified, only code scanning alerts with this severity will be returned.","in":"query","required":false,"schema":{"$ref":"#/components/schemas/code-scanning-alert-severity"}},{"name":"assignees","description":"Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`).\nUse `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.\n","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/code-scanning-organization-alert-items"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"},"503":{"$ref":"#/components/responses/service_unavailable"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"code-scanning","subcategory":"code-scanning"}}},"/orgs/{org}/dependabot/alerts":{"get":{"summary":"List Dependabot alerts for an organization","description":"Lists Dependabot alerts for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.","tags":["dependabot"],"operationId":"dependabot/list-alerts-for-org","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization"},"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-classifications"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-states"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-severities"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-ecosystems"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-packages"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-epss"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-artifact-registry-urls"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-artifact-registry"},{"$ref":"#/components/parameters/dependabot-alert-org-scope-comma-separated-has"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-assignees"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-runtime-risk"},{"$ref":"#/components/parameters/dependabot-alert-scope"},{"$ref":"#/components/parameters/dependabot-alert-relationship"},{"$ref":"#/components/parameters/dependabot-alert-sort"},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/pagination-before"},{"$ref":"#/components/parameters/pagination-after"},{"$ref":"#/components/parameters/per-page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/dependabot-alert-with-repository"}}}}},"304":{"$ref":"#/components/responses/not_modified"},"400":{"$ref":"#/components/responses/bad_request"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed_simple"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"dependabot","subcategory":"alerts"}}},"/orgs/{org}/installation":{"get":{"summary":"Get an organization installation for the authenticated app","description":"Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","tags":["apps"],"operationId":"apps/get-org-installation","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app"},"parameters":[{"$ref":"#/components/parameters/org"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/installation"}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":false,"category":"apps","subcategory":"apps"}}},"/orgs/{org}/issue-types":{"get":{"summary":"List issue types for an organization","description":"Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.","tags":["orgs"],"operationId":"orgs/list-issue-types","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization"},"parameters":[{"$ref":"#/components/parameters/org"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/issue-type"}}}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"orgs","subcategory":"issue-types"}},"post":{"summary":"Create issue type for an organization","description":"Create a new issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.","tags":["orgs"],"operationId":"orgs/create-issue-type","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization"},"parameters":[{"$ref":"#/components/parameters/org"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organization-create-issue-type"}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue-type"}}}},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed_simple"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"orgs","subcategory":"issue-types"}}},"/orgs/{org}/issue-types/{issue_type_id}":{"delete":{"summary":"Delete issue type for an organization","description":"Deletes an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.","tags":["orgs"],"operationId":"orgs/delete-issue-type","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization"},"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/issue-type-id"}],"responses":{"204":{"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed_simple"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"orgs","subcategory":"issue-types"}},"put":{"summary":"Update issue type for an organization","description":"Updates an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.","tags":["orgs"],"operationId":"orgs/update-issue-type","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization"},"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/issue-type-id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organization-update-issue-type"}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue-type"}}}},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed_simple"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"orgs","subcategory":"issue-types"}}},"/orgs/{org}/issues":{"get":{"summary":"List organization issues assigned to the authenticated user","description":"List issues in an organization assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["issues"],"operationId":"issues/list-for-org","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user"},"parameters":[{"$ref":"#/components/parameters/org"},{"name":"filter","description":"Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.","in":"query","required":false,"schema":{"type":"string","enum":["assigned","created","mentioned","subscribed","repos","all"],"default":"assigned"}},{"name":"state","description":"Indicates the state of the issues to return.","in":"query","required":false,"schema":{"type":"string","enum":["open","closed","all"],"default":"open"}},{"$ref":"#/components/parameters/labels"},{"name":"type","description":"Can be the name of an issue type.","in":"query","required":false,"schema":{"type":"string"}},{"name":"sort","description":"What to sort results by.","in":"query","required":false,"schema":{"type":"string","enum":["created","updated","comments"],"default":"created"}},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/issue"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":false,"category":"issues","subcategory":"issues"}}},"/orgs/{org}/members":{"get":{"summary":"List organization members","description":"List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.","tags":["orgs"],"operationId":"orgs/list-members","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/orgs/members#list-organization-members"},"parameters":[{"$ref":"#/components/parameters/org"},{"name":"filter","description":"Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners.","in":"query","required":false,"schema":{"type":"string","enum":["2fa_disabled","2fa_insecure","all"],"default":"all"}},{"name":"role","description":"Filter members returned by their role.","in":"query","required":false,"schema":{"type":"string","enum":["all","admin","member"],"default":"all"}},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/simple-user"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"422":{"$ref":"#/components/responses/validation_failed"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"orgs","subcategory":"members"}}},"/orgs/{org}/memberships/{username}":{"delete":{"summary":"Remove organization membership for a user","description":"In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.\n\n> [!NOTE]\n> If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.","tags":["orgs"],"operationId":"orgs/remove-membership-for-user","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user"},"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/username"}],"responses":{"204":{"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"orgs","subcategory":"members"}},"get":{"summary":"Get organization membership for a user","description":"In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.","tags":["orgs"],"operationId":"orgs/get-membership-for-user","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user"},"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/username"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/org-membership"}}}},"404":{"$ref":"#/components/responses/not_found"},"403":{"$ref":"#/components/responses/forbidden"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"orgs","subcategory":"members"}},"put":{"summary":"Set organization membership for a user","description":"Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.","tags":["orgs"],"operationId":"orgs/set-membership-for-user","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user"},"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/username"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","description":"The role to give the user in the organization. Can be one of: \n * `admin` - The user will become an owner of the organization. \n * `member` - The user will become a non-owner member of the organization.","enum":["admin","member"],"default":"member"}}}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/org-membership"}}}},"422":{"$ref":"#/components/responses/validation_failed"},"403":{"$ref":"#/components/responses/forbidden"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"orgs","subcategory":"members"},"x-github-breaking-changes":[{"changeset":"change_update_user_membership_trade_compliance_response_status","patch":{"responses":{"451":{"$ref":"#/components/responses/validation_failed"}}},"version":"2026-03-10"}]}},"/orgs/{org}/repos":{"get":{"summary":"List organization repositories","description":"Lists repositories for the specified organization.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"","tags":["repos"],"operationId":"repos/list-for-org","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/repos/repos#list-organization-repositories"},"parameters":[{"$ref":"#/components/parameters/org"},{"name":"type","description":"Specifies the types of repositories you want returned.","in":"query","required":false,"schema":{"type":"string","enum":["all","public","private","forks","sources","member"],"default":"all"}},{"name":"sort","description":"The property to sort the results by.","in":"query","required":false,"schema":{"type":"string","enum":["created","updated","pushed","full_name"],"default":"created"}},{"name":"direction","description":"The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"]}},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/minimal-repository"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"repos","subcategory":"repos"}},"post":{"summary":"Create an organization repository","description":"Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.","tags":["repos"],"operationId":"repos/create-in-org","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/repos/repos#create-an-organization-repository"},"parameters":[{"$ref":"#/components/parameters/org"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the repository."},"description":{"type":"string","description":"A short description of the repository."},"homepage":{"type":"string","description":"A URL with more information about the repository."},"private":{"type":"boolean","description":"Whether the repository is private.","default":false},"visibility":{"type":"string","description":"The visibility of the repository.","enum":["public","private"]},"has_issues":{"type":"boolean","description":"Either `true` to enable issues for this repository or `false` to disable them.","default":true},"has_projects":{"type":"boolean","description":"Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.","default":true},"has_wiki":{"type":"boolean","description":"Either `true` to enable the wiki for this repository or `false` to disable it.","default":true},"has_downloads":{"description":"Whether downloads are enabled.","default":true,"type":"boolean"},"is_template":{"type":"boolean","description":"Either `true` to make this repo available as a template repository or `false` to prevent it.","default":false},"team_id":{"type":"integer","description":"The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization."},"auto_init":{"type":"boolean","description":"Pass `true` to create an initial commit with empty README.","default":false},"gitignore_template":{"type":"string","description":"Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\"."},"license_template":{"type":"string","description":"Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"."},"allow_squash_merge":{"type":"boolean","description":"Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.","default":true},"allow_merge_commit":{"type":"boolean","description":"Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.","default":true},"allow_rebase_merge":{"type":"boolean","description":"Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.","default":true},"allow_auto_merge":{"type":"boolean","description":"Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.","default":false},"delete_branch_on_merge":{"type":"boolean","description":"Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.**","default":false},"use_squash_pr_title_as_default":{"type":"boolean","description":"Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead.","default":false,"deprecated":true},"squash_merge_commit_title":{"type":"string","enum":["PR_TITLE","COMMIT_OR_PR_TITLE"],"description":"Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."},"squash_merge_commit_message":{"type":"string","enum":["PR_BODY","COMMIT_MESSAGES","BLANK"],"description":"The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."},"merge_commit_title":{"type":"string","enum":["PR_TITLE","MERGE_MESSAGE"],"description":"Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."},"merge_commit_message":{"type":"string","enum":["PR_BODY","PR_TITLE","BLANK"],"description":"The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."},"custom_properties":{"type":"object","description":"The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values.","additionalProperties":true}},"required":["name"]}}}},"responses":{"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/full-repository"}}},"headers":{"Location":{"schema":{"type":"string"}}}},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"repos","subcategory":"repos"},"x-github-breaking-changes":[{"changeset":"change_create_repo_trade_compliance_response_status","patch":{"responses":{"451":{"$ref":"#/components/responses/validation_failed"}}},"version":"2026-03-10"}]}},"/orgs/{org}/secret-scanning/alerts":{"get":{"summary":"List secret scanning alerts for an organization","description":"Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.","tags":["secret-scanning"],"operationId":"secret-scanning/list-alerts-for-org","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization"},"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/secret-scanning-alert-state"},{"$ref":"#/components/parameters/secret-scanning-alert-secret-type"},{"$ref":"#/components/parameters/secret-scanning-alert-exclude-secret-types"},{"$ref":"#/components/parameters/secret-scanning-alert-exclude-providers"},{"$ref":"#/components/parameters/secret-scanning-alert-providers"},{"$ref":"#/components/parameters/secret-scanning-alert-resolution"},{"$ref":"#/components/parameters/secret-scanning-alert-assignee"},{"$ref":"#/components/parameters/secret-scanning-alert-sort"},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/secret-scanning-pagination-before-org-repo"},{"$ref":"#/components/parameters/secret-scanning-pagination-after-org-repo"},{"$ref":"#/components/parameters/secret-scanning-alert-validity"},{"$ref":"#/components/parameters/secret-scanning-alert-publicly-leaked"},{"$ref":"#/components/parameters/secret-scanning-alert-multi-repo"},{"$ref":"#/components/parameters/secret-scanning-alert-hide-secret"},{"$ref":"#/components/parameters/secret-scanning-alert-bypassed"},{"$ref":"#/components/parameters/secret-scanning-alert-included-metadata"},{"$ref":"#/components/parameters/secret-scanning-alert-owner-email-hash"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/organization-secret-scanning-alert"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"},"503":{"$ref":"#/components/responses/service_unavailable"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"secret-scanning","subcategory":"secret-scanning"}}},"/orgs/{org}/teams":{"get":{"summary":"List teams","description":"Lists all teams in an organization that are visible to the authenticated user.","tags":["teams"],"operationId":"teams/list","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/teams/teams#list-teams"},"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/team-type"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/team"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"403":{"$ref":"#/components/responses/forbidden"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"teams","subcategory":"teams"}},"post":{"summary":"Create a team","description":"To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)\".","tags":["teams"],"operationId":"teams/create","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/teams/teams#create-a-team"},"parameters":[{"$ref":"#/components/parameters/org"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the team."},"description":{"type":"string","description":"The description of the team."},"maintainers":{"type":"array","description":"List GitHub usernames for organization members who will become team maintainers.","items":{"type":"string"}},"repo_names":{"type":"array","description":"The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.","items":{"type":"string"}},"privacy":{"type":"string","description":"The level of privacy this team should have. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n * `closed` - visible to all members of this organization. \nDefault for child team: `closed`","enum":["secret","closed"]},"notification_setting":{"type":"string","description":"The notification setting the team has chosen. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications. \nDefault: `notifications_enabled`","enum":["notifications_enabled","notifications_disabled"]},"permission":{"type":"string","description":"**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.","enum":["pull","push"],"default":"pull"},"parent_team_id":{"type":"integer","description":"The ID of a team to set as the parent team."},"parent_team_slug":{"type":"string","description":"The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided."}},"required":["name"]}}}},"responses":{"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/team-full"}}}},"422":{"$ref":"#/components/responses/validation_failed"},"403":{"$ref":"#/components/responses/forbidden"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"teams","subcategory":"teams"},"x-github-breaking-changes":[{"changeset":"remove_team_permission","patch":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"permission":null}}}}}},"version":"2026-03-10"}]}},"/orgs/{org}/teams/{team_slug}":{"delete":{"summary":"Delete a team","description":"To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.","tags":["teams"],"operationId":"teams/delete-in-org","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/teams/teams#delete-a-team"},"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"}],"responses":{"204":{"description":"Response"},"422":{"$ref":"#/components/responses/enterprise_team_unsupported"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"teams","subcategory":"teams"}},"get":{"summary":"Get a team by name","description":"Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.","tags":["teams"],"operationId":"teams/get-by-name","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/teams/teams#get-a-team-by-name"},"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/team-full"}}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"teams","subcategory":"teams"}},"patch":{"summary":"Update a team","description":"To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.","tags":["teams"],"operationId":"teams/update-in-org","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/teams/teams#update-a-team"},"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the team."},"description":{"type":"string","description":"The description of the team."},"privacy":{"type":"string","description":"The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.","enum":["secret","closed"]},"notification_setting":{"type":"string","description":"The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.","enum":["notifications_enabled","notifications_disabled"]},"permission":{"type":"string","description":"**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.","enum":["pull","push","admin"],"default":"pull"},"parent_team_id":{"type":"integer","description":"The ID of a team to set as the parent team.","nullable":true},"parent_team_slug":{"type":"string","description":"The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided.","nullable":true}}}}}},"responses":{"200":{"description":"Response when the updated information already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/team-full"}}}},"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/team-full"}}}},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"},"403":{"$ref":"#/components/responses/forbidden"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"teams","subcategory":"teams"}}},"/orgs/{org}/teams/{team_slug}/members":{"get":{"summary":"List team members","description":"Team members will include the members of child teams.\n\nEach member includes their `role` on the team (`member` or `maintainer`) and an `inherited` flag indicating whether the membership is inherited from a child team (`true`) or is a direct membership (`false`). These fields let you read a member's role and direct/inherited status without additional requests.\n\nTo list members in a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/members`.","tags":["teams"],"operationId":"teams/list-members-in-org","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/teams/members#list-team-members"},"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"name":"role","description":"Filters members returned by their role in the team.","in":"query","required":false,"schema":{"type":"string","enum":["member","maintainer","all"],"default":"all"}},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/team-member"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"teams","subcategory":"members"}}},"/orgs/{org}/teams/{team_slug}/memberships/{username}":{"delete":{"summary":"Remove team membership for a user","description":"To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.","tags":["teams"],"operationId":"teams/remove-membership-for-user-in-org","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user"},"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/username"}],"responses":{"204":{"description":"Response"},"403":{"description":"Forbidden if team synchronization is set up"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"teams","subcategory":"members"}},"get":{"summary":"Get team membership for a user","description":"Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).","tags":["teams"],"operationId":"teams/get-membership-for-user-in-org","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/teams/members#get-team-membership-for-a-user"},"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/username"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/team-membership"}}}},"404":{"description":"if user has no team membership"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"teams","subcategory":"members"}},"put":{"summary":"Add or update team membership for a user","description":"Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.","tags":["teams"],"operationId":"teams/add-or-update-membership-for-user-in-org","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user"},"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/username"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","description":"The role that this user should have in the team.","enum":["member","maintainer"],"default":"member"}}}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/team-membership"}}}},"403":{"description":"Forbidden if team synchronization is set up"},"422":{"description":"Unprocessable Entity if you attempt to add an organization to a team"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"teams","subcategory":"members"}}},"/orgs/{org}/teams/{team_slug}/repos":{"get":{"summary":"List team repositories","description":"Lists a team's repositories visible to the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` or `repo` scope to use this endpoint.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.","tags":["teams"],"operationId":"teams/list-repos-in-org","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/teams/teams#list-team-repositories"},"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/minimal-repository"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"teams","subcategory":"teams"}}},"/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}":{"delete":{"summary":"Remove a repository from a team","description":"If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.","tags":["teams"],"operationId":"teams/remove-repo-in-org","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team"},"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"responses":{"204":{"description":"Response"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"teams","subcategory":"teams"}},"get":{"summary":"Check team permissions for a repository","description":"Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.","tags":["teams"],"operationId":"teams/check-permissions-for-repo-in-org","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository"},"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"responses":{"200":{"description":"Alternative response with repository permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/team-repository"}}}},"204":{"description":"Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header."},"404":{"description":"Not Found if team does not have permission for the repository"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"teams","subcategory":"teams"}},"put":{"summary":"Add or update team repository permissions","description":"To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".","tags":["teams"],"operationId":"teams/add-or-update-repo-permissions-in-org","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions"},"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"permission":{"type":"string","description":"The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository."}}}}}},"responses":{"204":{"description":"Response"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"teams","subcategory":"teams"}}},"/repos/{owner}/{repo}":{"delete":{"summary":"Delete a repository","description":"Deleting a repository requires admin access.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a `403 Forbidden` response.\n\nOAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint.","tags":["repos"],"operationId":"repos/delete","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/repos/repos#delete-a-repository"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"responses":{"204":{"description":"Response"},"403":{"description":"If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"documentation_url":{"type":"string"}}}}}},"307":{"$ref":"#/components/responses/temporary_redirect"},"404":{"$ref":"#/components/responses/not_found"},"409":{"$ref":"#/components/responses/conflict"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"repos","subcategory":"repos"}},"get":{"summary":"Get a repository","description":"The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.","tags":["repos"],"operationId":"repos/get","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/repos/repos#get-a-repository"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/full-repository"}}}},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"301":{"$ref":"#/components/responses/moved_permanently"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"repos","subcategory":"repos"}},"patch":{"summary":"Update a repository","description":"**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint.","tags":["repos"],"operationId":"repos/update","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/repos/repos#update-a-repository"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the repository."},"description":{"type":"string","description":"A short description of the repository."},"homepage":{"type":"string","description":"A URL with more information about the repository."},"private":{"type":"boolean","description":"Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.","default":false},"visibility":{"type":"string","description":"The visibility of the repository.","enum":["public","private"]},"security_and_analysis":{"type":"object","description":"Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.","nullable":true,"properties":{"advanced_security":{"type":"object","description":"Use the `status` property to enable or disable GitHub Advanced Security for this repository.\nFor more information, see \"[About GitHub Advanced\nSecurity](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.","properties":{"status":{"type":"string","description":"Can be `enabled` or `disabled`."}}},"code_security":{"type":"object","description":"Use the `status` property to enable or disable GitHub Code Security for this repository.","properties":{"status":{"type":"string","description":"Can be `enabled` or `disabled`."}}},"secret_scanning":{"type":"object","description":"Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"","properties":{"status":{"type":"string","description":"Can be `enabled` or `disabled`."}}},"secret_scanning_push_protection":{"type":"object","description":"Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"","properties":{"status":{"type":"string","description":"Can be `enabled` or `disabled`."}}},"secret_scanning_ai_detection":{"type":"object","description":"Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see \"[Responsible detection of generic secrets with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets).\"","properties":{"status":{"type":"string","description":"Can be `enabled` or `disabled`."}}},"secret_scanning_non_provider_patterns":{"type":"object","description":"Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see \"[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"","properties":{"status":{"type":"string","description":"Can be `enabled` or `disabled`."}}},"secret_scanning_delegated_alert_dismissal":{"type":"object","description":"Use the `status` property to enable or disable secret scanning delegated alert dismissal for this repository.","properties":{"status":{"type":"string","description":"Can be `enabled` or `disabled`."}}},"secret_scanning_delegated_bypass":{"type":"object","description":"Use the `status` property to enable or disable secret scanning delegated bypass for this repository.","properties":{"status":{"type":"string","description":"Can be `enabled` or `disabled`."}}},"secret_scanning_delegated_bypass_options":{"type":"object","description":"Feature options for secret scanning delegated bypass.\nThis object is only honored when `security_and_analysis.secret_scanning_delegated_bypass.status` is set to `enabled`.\nYou can send this object in the same request as `secret_scanning_delegated_bypass`, or update just the options in a separate request.","properties":{"reviewers":{"type":"array","description":"The bypass reviewers for secret scanning delegated bypass.\nIf you omit this field, the existing set of reviewers is unchanged.","items":{"type":"object","required":["reviewer_id","reviewer_type"],"properties":{"reviewer_id":{"type":"integer","description":"The ID of the team or role selected as a bypass reviewer"},"reviewer_type":{"type":"string","description":"The type of the bypass reviewer","enum":["TEAM","ROLE"]},"mode":{"type":"string","description":"The bypass mode for the reviewer","enum":["ALWAYS","EXEMPT"],"default":"ALWAYS"}}}}}}}},"has_issues":{"type":"boolean","description":"Either `true` to enable issues for this repository or `false` to disable them.","default":true},"has_projects":{"type":"boolean","description":"Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.","default":true},"has_wiki":{"type":"boolean","description":"Either `true` to enable the wiki for this repository or `false` to disable it.","default":true},"has_pull_requests":{"type":"boolean","description":"Either `true` to allow pull requests for this repository or `false` to prevent pull requests.","default":true},"pull_request_creation_policy":{"type":"string","description":"The policy that controls who can create pull requests for this repository: `all` or `collaborators_only`.","enum":["all","collaborators_only"]},"is_template":{"type":"boolean","description":"Either `true` to make this repo available as a template repository or `false` to prevent it.","default":false},"default_branch":{"type":"string","description":"Updates the default branch for this repository."},"allow_squash_merge":{"type":"boolean","description":"Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.","default":true},"allow_merge_commit":{"type":"boolean","description":"Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.","default":true},"allow_rebase_merge":{"type":"boolean","description":"Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.","default":true},"allow_auto_merge":{"type":"boolean","description":"Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.","default":false},"delete_branch_on_merge":{"type":"boolean","description":"Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.","default":false},"allow_update_branch":{"type":"boolean","description":"Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.","default":false},"use_squash_pr_title_as_default":{"type":"boolean","description":"Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead.","default":false,"deprecated":true},"squash_merge_commit_title":{"type":"string","enum":["PR_TITLE","COMMIT_OR_PR_TITLE"],"description":"Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."},"squash_merge_commit_message":{"type":"string","enum":["PR_BODY","COMMIT_MESSAGES","BLANK"],"description":"The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."},"merge_commit_title":{"type":"string","enum":["PR_TITLE","MERGE_MESSAGE"],"description":"Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."},"merge_commit_message":{"type":"string","enum":["PR_BODY","PR_TITLE","BLANK"],"description":"The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."},"archived":{"type":"boolean","description":"Whether to archive this repository. `false` will unarchive a previously archived repository.","default":false},"allow_forking":{"type":"boolean","description":"Either `true` to allow private forks, or `false` to prevent private forks.","default":false},"web_commit_signoff_required":{"type":"boolean","description":"Either `true` to require contributors to sign off on web-based commits, or `false` to not require contributors to sign off on web-based commits.","default":false}}}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/full-repository"}}}},"307":{"$ref":"#/components/responses/temporary_redirect"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"repos","subcategory":"repos"}}},"/repos/{owner}/{repo}/actions/artifacts":{"get":{"summary":"List artifacts for a repository","description":"Lists all artifacts for a repository.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.","tags":["actions"],"operationId":"actions/list-artifacts-for-repo","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/artifact-name"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"object","required":["total_count","artifacts"],"properties":{"total_count":{"type":"integer"},"artifacts":{"type":"array","items":{"$ref":"#/components/schemas/artifact"}}}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"actions","subcategory":"artifacts"}}},"/repos/{owner}/{repo}/actions/artifacts/{artifact_id}":{"delete":{"summary":"Delete an artifact","description":"Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","tags":["actions"],"operationId":"actions/delete-artifact","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/actions/artifacts#delete-an-artifact"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/artifact-id"}],"responses":{"204":{"description":"Response"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"actions","subcategory":"artifacts"}},"get":{"summary":"Get an artifact","description":"Gets a specific artifact for a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","tags":["actions"],"operationId":"actions/get-artifact","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/actions/artifacts#get-an-artifact"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/artifact-id"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/artifact"}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"actions","subcategory":"artifacts"}}},"/repos/{owner}/{repo}/actions/jobs/{job_id}":{"get":{"summary":"Get a job for a workflow run","description":"Gets a specific job in a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","tags":["actions"],"operationId":"actions/get-job-for-workflow-run","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/job-id"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/job"}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"actions","subcategory":"workflow-jobs"}}},"/repos/{owner}/{repo}/actions/runs":{"get":{"summary":"List workflow runs for a repository","description":"Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.","tags":["actions"],"operationId":"actions/list-workflow-runs-for-repo","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/actor"},{"$ref":"#/components/parameters/workflow-run-branch"},{"$ref":"#/components/parameters/event"},{"$ref":"#/components/parameters/workflow-run-status"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/created"},{"$ref":"#/components/parameters/exclude-pull-requests"},{"$ref":"#/components/parameters/workflow-run-check-suite-id"},{"$ref":"#/components/parameters/workflow-run-head-sha"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"object","required":["total_count","workflow_runs"],"properties":{"total_count":{"type":"integer"},"workflow_runs":{"type":"array","items":{"$ref":"#/components/schemas/workflow-run"}}}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"actions","subcategory":"workflow-runs"}}},"/repos/{owner}/{repo}/actions/runs/{run_id}":{"delete":{"summary":"Delete a workflow run","description":"Deletes a specific workflow run.\n\nAnyone with write access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","operationId":"actions/delete-workflow-run","tags":["actions"],"externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/run-id"}],"responses":{"204":{"description":"Response"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"actions","subcategory":"workflow-runs"}},"get":{"summary":"Get a workflow run","description":"Gets a specific workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.","tags":["actions"],"operationId":"actions/get-workflow-run","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/run-id"},{"$ref":"#/components/parameters/exclude-pull-requests"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workflow-run"}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"actions","subcategory":"workflow-runs"}}},"/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts":{"get":{"summary":"List workflow run artifacts","description":"Lists artifacts for a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.","tags":["actions"],"operationId":"actions/list-workflow-run-artifacts","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/run-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/artifact-name"},{"$ref":"#/components/parameters/direction"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"object","required":["total_count","artifacts"],"properties":{"total_count":{"type":"integer"},"artifacts":{"type":"array","items":{"$ref":"#/components/schemas/artifact"}}}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"actions","subcategory":"artifacts"}}},"/repos/{owner}/{repo}/actions/runs/{run_id}/jobs":{"get":{"summary":"List jobs for a workflow run","description":"Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.","tags":["actions"],"operationId":"actions/list-jobs-for-workflow-run","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/run-id"},{"name":"filter","description":"Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run.","in":"query","required":false,"schema":{"type":"string","enum":["latest","all"],"default":"latest"}},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"object","required":["total_count","jobs"],"properties":{"total_count":{"type":"integer"},"jobs":{"type":"array","items":{"$ref":"#/components/schemas/job"}}}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"actions","subcategory":"workflow-jobs"}}},"/repos/{owner}/{repo}/actions/workflows":{"get":{"summary":"List repository workflows","description":"Lists the workflows in a repository.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.","tags":["actions"],"operationId":"actions/list-repo-workflows","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/actions/workflows#list-repository-workflows"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"object","required":["total_count","workflows"],"properties":{"total_count":{"type":"integer"},"workflows":{"type":"array","items":{"$ref":"#/components/schemas/workflow"}}}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"actions","subcategory":"workflows"}}},"/repos/{owner}/{repo}/actions/workflows/{workflow_id}":{"get":{"summary":"Get a workflow","description":"Gets a specific workflow. You can replace `workflow_id` with the workflow\nfile name. For example, you could use `main.yaml`.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.","tags":["actions"],"operationId":"actions/get-workflow","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/actions/workflows#get-a-workflow"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/workflow-id"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workflow"}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"actions","subcategory":"workflows"}}},"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs":{"get":{"summary":"List workflow runs for a workflow","description":"List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.","tags":["actions"],"operationId":"actions/list-workflow-runs","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/workflow-id"},{"$ref":"#/components/parameters/actor"},{"$ref":"#/components/parameters/workflow-run-branch"},{"$ref":"#/components/parameters/event"},{"$ref":"#/components/parameters/workflow-run-status"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/created"},{"$ref":"#/components/parameters/exclude-pull-requests"},{"$ref":"#/components/parameters/workflow-run-check-suite-id"},{"$ref":"#/components/parameters/workflow-run-head-sha"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"object","required":["total_count","workflow_runs"],"properties":{"total_count":{"type":"integer"},"workflow_runs":{"type":"array","items":{"$ref":"#/components/schemas/workflow-run"}}}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"actions","subcategory":"workflow-runs"}}},"/repos/{owner}/{repo}/branches":{"get":{"summary":"List branches","description":"","tags":["repos"],"operationId":"repos/list-branches","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/branches/branches#list-branches"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"name":"protected","description":"Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.","in":"query","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/short-branch"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"branches","subcategory":"branches"}}},"/repos/{owner}/{repo}/branches/{branch}":{"get":{"summary":"Get a branch","description":"","tags":["repos"],"operationId":"repos/get-branch","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/branches/branches#get-a-branch"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/branch-with-protection"}}}},"301":{"$ref":"#/components/responses/moved_permanently"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"branches","subcategory":"branches"}}},"/repos/{owner}/{repo}/check-runs":{"post":{"summary":"Create a check run","description":"Creates a new check run for a specific commit in a repository.\n\nTo create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.\n\n> [!NOTE]\n> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.","tags":["checks"],"operationId":"checks/create","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/checks/runs#create-a-check-run"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check. For example, \"code-coverage\"."},"head_sha":{"type":"string","description":"The SHA of the commit."},"details_url":{"type":"string","description":"The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used."},"external_id":{"type":"string","description":"A reference for the run on the integrator's system."},"status":{"type":"string","description":"The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.","enum":["queued","in_progress","completed","waiting","requested","pending"],"default":"queued"},"started_at":{"type":"string","format":"date-time","description":"The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."},"conclusion":{"type":"string","description":"**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.","enum":["action_required","cancelled","failure","neutral","success","skipped","stale","timed_out"]},"completed_at":{"type":"string","format":"date-time","description":"The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."},"output":{"type":"object","description":"Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.","properties":{"title":{"type":"string","description":"The title of the check run."},"summary":{"type":"string","maxLength":65535,"description":"The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."},"text":{"type":"string","maxLength":65535,"description":"The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."},"annotations":{"type":"array","description":"Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".","maxItems":50,"items":{"type":"object","properties":{"path":{"type":"string","description":"The path of the file to add an annotation to. For example, `assets/css/main.css`."},"start_line":{"type":"integer","description":"The start line of the annotation. Line numbers start at 1."},"end_line":{"type":"integer","description":"The end line of the annotation."},"start_column":{"type":"integer","description":"The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1."},"end_column":{"type":"integer","description":"The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values."},"annotation_level":{"type":"string","description":"The level of the annotation.","enum":["notice","warning","failure"]},"message":{"type":"string","description":"A short description of the feedback for these lines of code. The maximum size is 64 KB."},"title":{"type":"string","description":"The title that represents the annotation. The maximum size is 255 characters."},"raw_details":{"type":"string","description":"Details about this annotation. The maximum size is 64 KB."}},"required":["path","start_line","end_line","annotation_level","message"]}},"images":{"type":"array","description":"Adds images to the output displayed in the GitHub pull request UI.","items":{"type":"object","properties":{"alt":{"type":"string","description":"The alternative text for the image."},"image_url":{"type":"string","description":"The full URL of the image."},"caption":{"type":"string","description":"A short image description."}},"required":["alt","image_url"]}}},"required":["title","summary"]},"actions":{"type":"array","description":"Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"","maxItems":3,"items":{"type":"object","properties":{"label":{"type":"string","maxLength":20,"description":"The text to be displayed on a button in the web UI. The maximum size is 20 characters."},"description":{"type":"string","maxLength":40,"description":"A short explanation of what this action would do. The maximum size is 40 characters."},"identifier":{"type":"string","maxLength":20,"description":"A reference for the action on the integrator's system. The maximum size is 20 characters."}},"required":["label","description","identifier"]}}},"required":["name","head_sha"],"discriminator":{"propertyName":"status"},"oneOf":[{"properties":{"status":{"enum":["completed"]}},"required":["status","conclusion"],"additionalProperties":true},{"properties":{"status":{"enum":["queued","in_progress"]}},"additionalProperties":true}]}}}},"responses":{"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/check-run"}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"checks","subcategory":"runs"}}},"/repos/{owner}/{repo}/check-runs/{check_run_id}":{"get":{"summary":"Get a check run","description":"Gets a single check run using its `id`.\n\n> [!NOTE]\n> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.","tags":["checks"],"operationId":"checks/get","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/checks/runs#get-a-check-run"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/check-run-id"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/check-run"}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"checks","subcategory":"runs"}},"patch":{"summary":"Update a check run","description":"Updates a check run for a specific commit in a repository.\n\n> [!NOTE]\n> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.","tags":["checks"],"operationId":"checks/update","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/checks/runs#update-a-check-run"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/check-run-id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check. For example, \"code-coverage\"."},"details_url":{"type":"string","description":"The URL of the integrator's site that has the full details of the check."},"external_id":{"type":"string","description":"A reference for the run on the integrator's system."},"started_at":{"type":"string","format":"date-time","description":"This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."},"status":{"type":"string","description":"The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.","enum":["queued","in_progress","completed","waiting","requested","pending"]},"conclusion":{"type":"string","description":"**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.","enum":["action_required","cancelled","failure","neutral","success","skipped","stale","timed_out"]},"completed_at":{"type":"string","format":"date-time","description":"The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."},"output":{"type":"object","description":"Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.","properties":{"title":{"type":"string","description":"**Required**."},"summary":{"type":"string","description":"Can contain Markdown.","maxLength":65535},"text":{"type":"string","description":"Can contain Markdown.","maxLength":65535},"annotations":{"type":"array","description":"Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".","maxItems":50,"items":{"type":"object","properties":{"path":{"type":"string","description":"The path of the file to add an annotation to. For example, `assets/css/main.css`."},"start_line":{"type":"integer","description":"The start line of the annotation. Line numbers start at 1."},"end_line":{"type":"integer","description":"The end line of the annotation."},"start_column":{"type":"integer","description":"The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1."},"end_column":{"type":"integer","description":"The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values."},"annotation_level":{"type":"string","description":"The level of the annotation.","enum":["notice","warning","failure"]},"message":{"type":"string","description":"A short description of the feedback for these lines of code. The maximum size is 64 KB."},"title":{"type":"string","description":"The title that represents the annotation. The maximum size is 255 characters."},"raw_details":{"type":"string","description":"Details about this annotation. The maximum size is 64 KB."}},"required":["path","start_line","end_line","annotation_level","message"]}},"images":{"type":"array","description":"Adds images to the output displayed in the GitHub pull request UI.","items":{"type":"object","properties":{"alt":{"type":"string","description":"The alternative text for the image."},"image_url":{"type":"string","description":"The full URL of the image."},"caption":{"type":"string","description":"A short image description."}},"required":["alt","image_url"]}}},"required":["summary"]},"actions":{"type":"array","description":"Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"","maxItems":3,"items":{"type":"object","properties":{"label":{"type":"string","maxLength":20,"description":"The text to be displayed on a button in the web UI. The maximum size is 20 characters."},"description":{"type":"string","maxLength":40,"description":"A short explanation of what this action would do. The maximum size is 40 characters."},"identifier":{"type":"string","maxLength":20,"description":"A reference for the action on the integrator's system. The maximum size is 20 characters."}},"required":["label","description","identifier"]}}},"anyOf":[{"properties":{"status":{"enum":["completed"]}},"required":["conclusion"],"additionalProperties":true},{"properties":{"status":{"enum":["queued","in_progress"]}},"additionalProperties":true}]}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/check-run"}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"checks","subcategory":"runs"}}},"/repos/{owner}/{repo}/check-suites/{check_suite_id}":{"get":{"summary":"Get a check suite","description":"Gets a single check suite using its `id`.\n\n> [!NOTE]\n> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.","tags":["checks"],"operationId":"checks/get-suite","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/checks/suites#get-a-check-suite"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/check-suite-id"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/check-suite"}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"checks","subcategory":"suites"}}},"/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs":{"get":{"summary":"List check runs in a check suite","description":"Lists check runs for a check suite using its `id`.\n\n> [!NOTE]\n> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.","tags":["checks"],"operationId":"checks/list-for-suite","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/check-suite-id"},{"$ref":"#/components/parameters/check-name"},{"$ref":"#/components/parameters/status"},{"name":"filter","description":"Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.","in":"query","required":false,"schema":{"type":"string","enum":["latest","all"],"default":"latest"}},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"object","required":["total_count","check_runs"],"properties":{"total_count":{"type":"integer"},"check_runs":{"type":"array","items":{"$ref":"#/components/schemas/check-run"}}}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"checks","subcategory":"runs"}}},"/repos/{owner}/{repo}/code-scanning/alerts":{"get":{"summary":"List code scanning alerts for a repository","description":"Lists code scanning alerts.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch (or for the specified Git reference if you used `ref` in the request).\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.","tags":["code-scanning"],"operationId":"code-scanning/list-alerts-for-repo","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/tool-name"},{"$ref":"#/components/parameters/tool-guid"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/git-ref"},{"$ref":"#/components/parameters/pr-alias"},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/pagination-before"},{"$ref":"#/components/parameters/pagination-after"},{"name":"sort","description":"The property by which to sort the results.","in":"query","required":false,"schema":{"type":"string","enum":["created","updated"],"default":"created"}},{"name":"state","description":"If specified, only code scanning alerts with this state will be returned.","in":"query","required":false,"schema":{"$ref":"#/components/schemas/code-scanning-alert-state-query"}},{"name":"severity","description":"If specified, only code scanning alerts with this severity will be returned.","in":"query","required":false,"schema":{"$ref":"#/components/schemas/code-scanning-alert-severity"}},{"name":"assignees","description":"Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`).\nUse `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.\n","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/code-scanning-alert-items"}}}}},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/code_scanning_forbidden_read"},"404":{"$ref":"#/components/responses/not_found"},"503":{"$ref":"#/components/responses/service_unavailable"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"code-scanning","subcategory":"code-scanning"}}},"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}":{"get":{"summary":"Get a code scanning alert","description":"Gets a single code scanning alert.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.","tags":["code-scanning"],"operationId":"code-scanning/get-alert","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/alert-number"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/code-scanning-alert"}}}},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/code_scanning_forbidden_read"},"404":{"$ref":"#/components/responses/not_found"},"503":{"$ref":"#/components/responses/service_unavailable"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"code-scanning","subcategory":"code-scanning"}},"patch":{"summary":"Update a code scanning alert","description":"Updates the status of a single code scanning alert.\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.","operationId":"code-scanning/update-alert","tags":["code-scanning"],"externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/alert-number"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/code-scanning-alert-set-state"},"dismissed_reason":{"$ref":"#/components/schemas/code-scanning-alert-dismissed-reason"},"dismissed_comment":{"$ref":"#/components/schemas/code-scanning-alert-dismissed-comment"},"create_request":{"$ref":"#/components/schemas/code-scanning-alert-create-request"},"assignees":{"$ref":"#/components/schemas/code-scanning-alert-assignees"}},"anyOf":[{"required":["state"]},{"required":["assignees"]}]}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/code-scanning-alert"}}}},"400":{"$ref":"#/components/responses/bad_request"},"403":{"$ref":"#/components/responses/code_scanning_forbidden_write"},"404":{"$ref":"#/components/responses/not_found"},"503":{"$ref":"#/components/responses/service_unavailable"}},"x-github":{"enabledForGitHubApps":true,"githubCloudOnly":false,"category":"code-scanning","subcategory":"code-scanning"}}},"/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.\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"],"operationId":"repos/list-collaborators","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"name":"affiliation","description":"Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. `all` means all collaborators the authenticated user can see.","in":"query","required":false,"schema":{"type":"string","enum":["outside","direct","all"],"default":"all"}},{"name":"permission","description":"Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.","in":"query","required":false,"schema":{"type":"string","enum":["pull","triage","push","maintain","admin"]}},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/collaborator"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"collaborators","subcategory":"collaborators"}}},"/repos/{owner}/{repo}/collaborators/{username}":{"delete":{"summary":"Remove a repository collaborator","description":"Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations sent by the collaborator\n- Unassigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n> [!NOTE]\n> A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".","tags":["repos"],"operationId":"repos/remove-collaborator","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/username"}],"responses":{"204":{"description":"No Content when collaborator was removed from the repository."},"422":{"$ref":"#/components/responses/validation_failed"},"403":{"$ref":"#/components/responses/forbidden"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"collaborators","subcategory":"collaborators"}},"get":{"summary":"Check if a user is a repository collaborator","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.\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.","tags":["repos"],"operationId":"repos/check-collaborator","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/username"}],"responses":{"204":{"description":"Response if user is a collaborator"},"404":{"description":"Not Found if user is not a collaborator"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"collaborators","subcategory":"collaborators"}},"put":{"summary":"Add a repository collaborator","description":"Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an \"outside collaborator\" (if they are not an Enterprise Managed User) or a \"repository collaborator\" if they are an Enterprise Managed User. These users are exempt from some organization policies - see \"[Adding outside collaborators to repositories](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)\" to learn more about these collaborator types.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).\n\nAdding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)\" and \"[Setting permissions for adding outside collaborators](https://docs.github.com/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)\" for organization settings.\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations).\n\nFor Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise.\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.","tags":["repos"],"operationId":"repos/add-collaborator","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/username"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"permission":{"type":"string","description":"The permission to grant the collaborator. **Only valid on organization-owned repositories.** We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any.","default":"push"}}}}}},"responses":{"201":{"description":"Response when a new invitation is created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/repository-invitation"}}}},"204":{"description":"Response when:\n- an existing collaborator is added as a collaborator\n- an organization member is added as an individual collaborator\n- an existing team member (whose team is also a repository collaborator) is added as an individual collaborator"},"422":{"description":"Response when:\n- validation failed, or the endpoint has been spammed\n- an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validation-error"}}}},"403":{"$ref":"#/components/responses/forbidden"}},"x-github":{"triggersNotification":true,"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"collaborators","subcategory":"collaborators"}}},"/repos/{owner}/{repo}/collaborators/{username}/permission":{"get":{"summary":"Get repository permissions for a user","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"],"operationId":"repos/get-collaborator-permission-level","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/username"}],"responses":{"200":{"description":"if user has admin permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/repository-collaborator-permission"}}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"collaborators","subcategory":"collaborators"}}},"/repos/{owner}/{repo}/comments":{"get":{"summary":"List commit comments for a repository","description":"Lists the commit comments for a specified repository. Comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["repos"],"operationId":"repos/list-commit-comments-for-repo","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/commit-comment"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"commits","subcategory":"comments"}}},"/repos/{owner}/{repo}/comments/{comment_id}":{"delete":{"summary":"Delete a commit comment","description":"","tags":["repos"],"operationId":"repos/delete-commit-comment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/commits/comments#delete-a-commit-comment"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"responses":{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"commits","subcategory":"comments"}},"get":{"summary":"Get a commit comment","description":"Gets a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["repos"],"operationId":"repos/get-commit-comment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/commits/comments#get-a-commit-comment"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/commit-comment"}}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"commits","subcategory":"comments"}},"patch":{"summary":"Update a commit comment","description":"Updates the contents of a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["repos"],"operationId":"repos/update-commit-comment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/commits/comments#update-a-commit-comment"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"The contents of the comment"}},"required":["body"]}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/commit-comment"}}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"commits","subcategory":"comments"}}},"/repos/{owner}/{repo}/commits":{"get":{"summary":"List commits","description":"**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |","tags":["repos"],"operationId":"repos/list-commits","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/commits/commits#list-commits"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"name":"sha","description":"SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).","in":"query","required":false,"schema":{"type":"string"}},{"name":"path","description":"Only commits containing this file path will be returned.","in":"query","required":false,"schema":{"type":"string"}},{"name":"author","description":"GitHub username or email address to use to filter by commit author.","in":"query","required":false,"schema":{"type":"string"}},{"name":"committer","description":"GitHub username or email address to use to filter by commit committer.","in":"query","required":false,"schema":{"type":"string"}},{"name":"since","description":"Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"until","description":"Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/commit"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"500":{"$ref":"#/components/responses/internal_error"},"400":{"$ref":"#/components/responses/bad_request"},"404":{"$ref":"#/components/responses/not_found"},"409":{"$ref":"#/components/responses/conflict"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"commits","subcategory":"commits"}}},"/repos/{owner}/{repo}/commits/{commit_sha}/comments":{"get":{"summary":"List commit comments","description":"Lists the comments for a specified commit.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["repos"],"operationId":"repos/list-comments-for-commit","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/commits/comments#list-commit-comments"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/commit-sha"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/commit-comment"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"commits","subcategory":"comments"}},"post":{"summary":"Create a commit comment","description":"Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["repos"],"operationId":"repos/create-commit-comment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/commits/comments#create-a-commit-comment"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/commit-sha"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"The contents of the comment."},"path":{"type":"string","description":"Relative path of the file to comment on."},"position":{"type":"integer","description":"Line index in the diff to comment on."},"line":{"type":"integer","description":"**Closing down notice**. Use **position** parameter instead. Line number in the file to comment on."}},"required":["body"]}}}},"responses":{"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/commit-comment"}}},"headers":{"Location":{"schema":{"type":"string"}}}},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"}},"x-github":{"triggersNotification":true,"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"commits","subcategory":"comments"}}},"/repos/{owner}/{repo}/commits/{ref}":{"get":{"summary":"Get a commit","description":"Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n> [!NOTE]\n> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |","tags":["repos"],"operationId":"repos/get-commit","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/commits/commits#get-a-commit"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/commit-ref"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/commit"}},"application/vnd.github.diff":{"schema":{"type":"string"}},"application/vnd.github.patch":{"schema":{"type":"string"}},"application/vnd.github.sha":{"schema":{"type":"string"}}}},"422":{"$ref":"#/components/responses/validation_failed"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_error"},"503":{"$ref":"#/components/responses/service_unavailable"},"409":{"$ref":"#/components/responses/conflict"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"commits","subcategory":"commits"}}},"/repos/{owner}/{repo}/commits/{ref}/check-runs":{"get":{"summary":"List check runs for a Git reference","description":"Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.","tags":["checks"],"operationId":"checks/list-for-ref","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/commit-ref"},{"$ref":"#/components/parameters/check-name"},{"$ref":"#/components/parameters/status"},{"name":"filter","description":"Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.","in":"query","required":false,"schema":{"type":"string","enum":["latest","all"],"default":"latest"}},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"name":"app_id","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"object","required":["total_count","check_runs"],"properties":{"total_count":{"type":"integer"},"check_runs":{"type":"array","items":{"$ref":"#/components/schemas/check-run"}}}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"checks","subcategory":"runs"}}},"/repos/{owner}/{repo}/commits/{ref}/check-suites":{"get":{"summary":"List check suites for a Git reference","description":"Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.","tags":["checks"],"operationId":"checks/list-suites-for-ref","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/commit-ref"},{"name":"app_id","description":"Filters check suites by GitHub App `id`.","in":"query","required":false,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/check-name"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"object","required":["total_count","check_suites"],"properties":{"total_count":{"type":"integer"},"check_suites":{"type":"array","items":{"$ref":"#/components/schemas/check-suite"}}}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"checks","subcategory":"suites"}}},"/repos/{owner}/{repo}/commits/{ref}/statuses":{"get":{"summary":"List commit statuses for a reference","description":"Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.\n\nThis resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.","tags":["repos"],"operationId":"repos/list-commit-statuses-for-ref","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/commit-ref"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/status"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"301":{"$ref":"#/components/responses/moved_permanently"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"commits","subcategory":"statuses"}}},"/repos/{owner}/{repo}/dependabot/alerts":{"get":{"summary":"List Dependabot alerts for a repository","description":"OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.","tags":["dependabot"],"operationId":"dependabot/list-alerts-for-repo","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-classifications"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-states"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-severities"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-ecosystems"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-packages"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-manifests"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-epss"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-has"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-assignees"},{"$ref":"#/components/parameters/dependabot-alert-scope"},{"$ref":"#/components/parameters/dependabot-alert-relationship"},{"$ref":"#/components/parameters/dependabot-alert-sort"},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/pagination-before"},{"$ref":"#/components/parameters/pagination-after"},{"$ref":"#/components/parameters/per-page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/dependabot-alert"}}}}},"304":{"$ref":"#/components/responses/not_modified"},"400":{"$ref":"#/components/responses/bad_request"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed_simple"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"previews":[],"category":"dependabot","subcategory":"alerts"}}},"/repos/{owner}/{repo}/dependabot/alerts/{alert_number}":{"get":{"summary":"Get a Dependabot alert","description":"OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.","tags":["dependabot"],"operationId":"dependabot/get-alert","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/dependabot-alert-number"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dependabot-alert"}}}},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"previews":[],"category":"dependabot","subcategory":"alerts"}},"patch":{"summary":"Update a Dependabot alert","description":"The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.","tags":["dependabot"],"operationId":"dependabot/update-alert","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/dependabot-alert-number"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"string","description":"The state of the Dependabot alert.\nA `dismissed_reason` must be provided when setting the state to `dismissed`.","enum":["dismissed","open"]},"dismissed_reason":{"type":"string","description":"**Required when `state` is `dismissed`.** A reason for dismissing the alert.","enum":["fix_started","inaccurate","no_bandwidth","not_used","tolerable_risk"]},"dismissed_comment":{"type":"string","description":"An optional comment associated with dismissing the alert.","maxLength":280},"assignees":{"type":"array","description":"Usernames to assign to this Dependabot Alert.\nPass one or more user logins to _replace_ the set of assignees on this alert.\nSend an empty array (`[]`) to clear all assignees from the alert.\nTo assign an AI agent, include the bot login (for example, `copilot-swe-agent[bot]`).","items":{"type":"string"}},"agent_assignment":{"type":"object","description":"Parameters for AI agent assignment. Only used when an agent bot login is\nincluded in `assignees`. Ignored when no agent is being assigned.","properties":{"custom_instructions":{"type":"string","description":"Custom instructions for the agent."},"custom_agent":{"type":"string","description":"A custom agent identifier."},"model":{"type":"string","description":"The model to use for the agent."}},"additionalProperties":false}},"anyOf":[{"required":["state"]},{"required":["assignees"]}],"additionalProperties":false}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dependabot-alert"}}}},"400":{"$ref":"#/components/responses/bad_request"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"409":{"$ref":"#/components/responses/conflict"},"410":{"$ref":"#/components/responses/gone"},"422":{"$ref":"#/components/responses/validation_failed_simple"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"previews":[],"category":"dependabot","subcategory":"alerts"}}},"/repos/{owner}/{repo}/deployments":{"get":{"summary":"List deployments","description":"Simple filtering of deployments is available via query parameters:","tags":["repos"],"operationId":"repos/list-deployments","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/deployments/deployments#list-deployments"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"name":"sha","description":"The SHA recorded at creation time.","in":"query","required":false,"schema":{"type":"string","default":"none"}},{"name":"ref","description":"The name of the ref. This can be a branch, tag, or SHA.","in":"query","required":false,"schema":{"type":"string","default":"none"}},{"name":"task","description":"The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).","in":"query","required":false,"schema":{"type":"string","default":"none"}},{"name":"environment","description":"The name of the environment that was deployed to (e.g., `staging` or `production`).","in":"query","required":false,"schema":{"type":"string","default":"none","nullable":true}},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/deployment"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"deployments","subcategory":"deployments"}},"post":{"summary":"Create a deployment","description":"Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nMerged branch response:\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\nMerge conflict response:\n\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\nFailed commit status checks:\n\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.","tags":["repos"],"operationId":"repos/create-deployment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/deployments/deployments#create-a-deployment"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ref":{"type":"string","description":"The ref to deploy. This can be a branch, tag, or SHA."},"task":{"type":"string","description":"Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).","default":"deploy"},"auto_merge":{"type":"boolean","description":"Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.","default":true},"required_contexts":{"type":"array","description":"The [status](https://docs.github.com/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.","items":{"type":"string"}},"payload":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string","description":"JSON payload with extra information about the deployment.","default":""}]},"environment":{"type":"string","description":"Name for the target deployment environment (e.g., `production`, `staging`, `qa`).","default":"production"},"description":{"type":"string","description":"Short description of the deployment.","default":"","nullable":true},"transient_environment":{"type":"boolean","description":"Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false`","default":false},"production_environment":{"type":"boolean","description":"Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise."}},"required":["ref"]}}}},"responses":{"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment"}}}},"202":{"description":"Merged branch response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"409":{"description":"Conflict when there is a merge conflict or the commit's status checks failed"},"422":{"$ref":"#/components/responses/validation_failed"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"deployments","subcategory":"deployments"}}},"/repos/{owner}/{repo}/deployments/{deployment_id}":{"delete":{"summary":"Delete a deployment","description":"If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.","tags":["repos"],"operationId":"repos/delete-deployment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/deployments/deployments#delete-a-deployment"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/deployment-id"}],"responses":{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed_simple"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"deployments","subcategory":"deployments"}},"get":{"summary":"Get a deployment","description":"","tags":["repos"],"operationId":"repos/get-deployment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/deployments/deployments#get-a-deployment"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/deployment-id"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment"}}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"deployments","subcategory":"deployments"}}},"/repos/{owner}/{repo}/deployments/{deployment_id}/statuses":{"get":{"summary":"List deployment statuses","description":"Users with pull access can view deployment statuses for a deployment:","tags":["repos"],"operationId":"repos/list-deployment-statuses","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/deployments/statuses#list-deployment-statuses"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/deployment-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/deployment-status"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"deployments","subcategory":"statuses"}},"post":{"summary":"Create a deployment status","description":"Users with `push` access can create deployment statuses for a given deployment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint.","tags":["repos"],"operationId":"repos/create-deployment-status","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/deployments/statuses#create-a-deployment-status"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/deployment-id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"string","description":"The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.","enum":["error","failure","inactive","in_progress","queued","pending","success"]},"target_url":{"type":"string","description":"The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.\n\n> [!NOTE]\n> It's recommended to use the `log_url` parameter, which replaces `target_url`.","default":""},"log_url":{"type":"string","description":"The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"`","default":""},"description":{"type":"string","description":"A short description of the status. The maximum description length is 140 characters.","default":""},"environment":{"type":"string","description":"Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used."},"environment_url":{"type":"string","description":"Sets the URL for accessing your environment. Default: `\"\"`","default":""},"auto_inactive":{"type":"boolean","description":"Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true`"}},"required":["state"]}}}},"responses":{"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment-status"}}},"headers":{"Location":{"schema":{"type":"string"}}}},"422":{"$ref":"#/components/responses/validation_failed"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"deployments","subcategory":"statuses"}}},"/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}":{"get":{"summary":"Get a deployment status","description":"Users with pull access can view a deployment status for a deployment:","tags":["repos"],"operationId":"repos/get-deployment-status","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/deployments/statuses#get-a-deployment-status"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/deployment-id"},{"name":"status_id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment-status"}}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"deployments","subcategory":"statuses"}}},"/repos/{owner}/{repo}/environments":{"get":{"summary":"List environments","description":"Lists the environments for a repository.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.","tags":["repos"],"operationId":"repos/get-all-environments","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/deployments/environments#list-environments"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"object","properties":{"total_count":{"description":"The number of environments in this repository","type":"integer"},"environments":{"type":"array","items":{"$ref":"#/components/schemas/environment"}}}}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"deployments","subcategory":"environments"}}},"/repos/{owner}/{repo}/environments/{environment_name}":{"delete":{"summary":"Delete an environment","description":"OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","tags":["repos"],"operationId":"repos/delete-an-environment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/deployments/environments#delete-an-environment"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/environment-name"}],"responses":{"204":{"description":"Default response"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"deployments","subcategory":"environments"}},"get":{"summary":"Get an environment","description":"> [!NOTE]\n> To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.","tags":["repos"],"operationId":"repos/get-environment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/deployments/environments#get-an-environment"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/environment-name"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/environment"}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"deployments","subcategory":"environments"}},"put":{"summary":"Create or update an environment","description":"Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n> [!NOTE]\n> To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n> [!NOTE]\n> To create or update secrets for an environment, see \"[GitHub Actions secrets](/rest/actions/secrets).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","tags":["repos"],"operationId":"repos/create-or-update-environment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/deployments/environments#create-or-update-an-environment"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/environment-name"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","nullable":true,"properties":{"wait_timer":{"$ref":"#/components/schemas/wait-timer"},"prevent_self_review":{"$ref":"#/components/schemas/prevent-self-review"},"reviewers":{"type":"array","nullable":true,"description":"The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.","items":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/deployment-reviewer-type"},"id":{"type":"integer","description":"The id of the user or team who can review the deployment"}}}},"deployment_branch_policy":{"$ref":"#/components/schemas/deployment-branch-policy-settings"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/environment"}}}},"422":{"description":"Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value","content":{"application/json":{"schema":{"$ref":"#/components/schemas/basic-error"}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"deployments","subcategory":"environments"}}},"/repos/{owner}/{repo}/git/matching-refs/{ref}":{"get":{"summary":"List matching references","description":"Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/<branch name>` for branches and `tags/<tag name>` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.","tags":["git"],"operationId":"git/list-matching-refs","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/git/refs#list-matching-references"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/git-ref-only"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/git-ref"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"409":{"$ref":"#/components/responses/conflict"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"git","subcategory":"refs"}}},"/repos/{owner}/{repo}/git/ref/{ref}":{"get":{"summary":"Get a reference","description":"Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/<branch name>` for branches and `tags/<tag name>` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".","tags":["git"],"operationId":"git/get-ref","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/git/refs#get-a-reference"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/git-ref-only"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/git-ref"}}}},"404":{"$ref":"#/components/responses/not_found"},"409":{"$ref":"#/components/responses/conflict"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"git","subcategory":"refs"}}},"/repos/{owner}/{repo}/git/refs":{"post":{"summary":"Create a reference","description":"Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.","tags":["git"],"operationId":"git/create-ref","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/git/refs#create-a-reference"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ref":{"type":"string","description":"The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected."},"sha":{"type":"string","description":"The SHA1 value for this reference."}},"required":["ref","sha"]}}}},"responses":{"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/git-ref"}}},"headers":{"Location":{"schema":{"type":"string"}}}},"422":{"$ref":"#/components/responses/validation_failed"},"409":{"$ref":"#/components/responses/conflict"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"git","subcategory":"refs"}}},"/repos/{owner}/{repo}/git/refs/{ref}":{"delete":{"summary":"Delete a reference","description":"Deletes the provided reference.","tags":["git"],"operationId":"git/delete-ref","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/git/refs#delete-a-reference"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/git-ref-only"}],"responses":{"204":{"description":"Response"},"422":{"description":"Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed."},"409":{"$ref":"#/components/responses/conflict"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"git","subcategory":"refs"}},"patch":{"summary":"Update a reference","description":"Updates the provided reference to point to a new SHA. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.","tags":["git"],"operationId":"git/update-ref","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/git/refs#update-a-reference"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/git-ref-only"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sha":{"type":"string","description":"The SHA1 value to set this reference to"},"force":{"type":"boolean","description":"Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.","default":false}},"required":["sha"]}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/git-ref"}}}},"422":{"$ref":"#/components/responses/validation_failed"},"409":{"$ref":"#/components/responses/conflict"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"git","subcategory":"refs"}}},"/repos/{owner}/{repo}/hooks":{"get":{"summary":"List repository webhooks","description":"Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.","tags":["repos"],"operationId":"repos/list-webhooks","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/repos/webhooks#list-repository-webhooks"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/hook"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"repos","subcategory":"webhooks"}},"post":{"summary":"Create a repository webhook","description":"Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can\nshare the same `config` as long as those webhooks do not have any `events` that overlap.","tags":["repos"],"operationId":"repos/create-webhook","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","nullable":true,"properties":{"name":{"type":"string","description":"Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`."},"config":{"type":"object","description":"Key/value pairs to provide settings for this webhook.","properties":{"url":{"$ref":"#/components/schemas/webhook-config-url"},"content_type":{"$ref":"#/components/schemas/webhook-config-content-type"},"secret":{"$ref":"#/components/schemas/webhook-config-secret"},"insecure_ssl":{"$ref":"#/components/schemas/webhook-config-insecure-ssl"}}},"events":{"type":"array","description":"Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.","default":["push"],"items":{"type":"string"}},"active":{"type":"boolean","description":"Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.","default":true}},"additionalProperties":false}}}},"responses":{"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hook"}}},"headers":{"Location":{"schema":{"type":"string"}}}},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"},"403":{"$ref":"#/components/responses/forbidden"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"repos","subcategory":"webhooks"}}},"/repos/{owner}/{repo}/hooks/{hook_id}":{"delete":{"summary":"Delete a repository webhook","description":"Delete a webhook for an organization.\n\nThe authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook.","tags":["repos"],"operationId":"repos/delete-webhook","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/hook-id"}],"responses":{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"repos","subcategory":"webhooks"}},"get":{"summary":"Get a repository webhook","description":"Returns a webhook configured in a repository. To get only the webhook `config` properties, see \"[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository).\"","tags":["repos"],"operationId":"repos/get-webhook","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/hook-id"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hook"}}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"repos","subcategory":"webhooks"}},"patch":{"summary":"Update a repository webhook","description":"Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository).\"","tags":["repos"],"operationId":"repos/update-webhook","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/hook-id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"config":{"$ref":"#/components/schemas/webhook-config"},"events":{"type":"array","description":"Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.","default":["push"],"items":{"type":"string"}},"add_events":{"type":"array","description":"Determines a list of events to be added to the list of events that the Hook triggers for.","items":{"type":"string"}},"remove_events":{"type":"array","description":"Determines a list of events to be removed from the list of events that the Hook triggers for.","items":{"type":"string"}},"active":{"type":"boolean","description":"Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.","default":true}}}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hook"}}}},"422":{"$ref":"#/components/responses/validation_failed"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"repos","subcategory":"webhooks"}}},"/repos/{owner}/{repo}/installation":{"get":{"summary":"Get a repository installation for the authenticated app","description":"Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","tags":["apps"],"operationId":"apps/get-repo-installation","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/installation"}}}},"301":{"$ref":"#/components/responses/moved_permanently"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":false,"category":"apps","subcategory":"apps"}}},"/repos/{owner}/{repo}/invitations":{"get":{"summary":"List repository invitations","description":"When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.","tags":["repos"],"operationId":"repos/list-invitations","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/collaborators/invitations#list-repository-invitations"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/repository-invitation"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"collaborators","subcategory":"invitations"}}},"/repos/{owner}/{repo}/invitations/{invitation_id}":{"delete":{"summary":"Delete a repository invitation","description":"","tags":["repos"],"operationId":"repos/delete-invitation","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/invitation-id"}],"responses":{"204":{"description":"Response"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"collaborators","subcategory":"invitations"}},"patch":{"summary":"Update a repository invitation","description":"","tags":["repos"],"operationId":"repos/update-invitation","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/invitation-id"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"permissions":{"type":"string","description":"The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.","enum":["read","write","maintain","triage","admin"]}}}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/repository-invitation"}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"collaborators","subcategory":"invitations"}}},"/repos/{owner}/{repo}/issues":{"get":{"summary":"List repository issues","description":"List issues in a repository. Only open issues will be listed.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["issues"],"operationId":"issues/list-for-repo","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/issues#list-repository-issues"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"name":"milestone","description":"If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.","in":"query","required":false,"schema":{"type":"string"}},{"name":"state","description":"Indicates the state of the issues to return.","in":"query","required":false,"schema":{"type":"string","enum":["open","closed","all"],"default":"open"}},{"name":"assignee","description":"Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.","in":"query","required":false,"schema":{"type":"string"}},{"name":"type","description":"Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned.","in":"query","required":false,"schema":{"type":"string"}},{"name":"creator","description":"The user that created the issue.","in":"query","required":false,"schema":{"type":"string"}},{"name":"mentioned","description":"A user that's mentioned in the issue.","in":"query","required":false,"schema":{"type":"string"}},{"name":"issue_field_values","description":"A comma-separated list of issue field filters in `field_slug:value` format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Issue fields are\nnot available for user-owned repositories, and field availability for\norganization-owned public repositories depends on the organization's\nvisibility settings. For example, `priority:Urgent,severity:High` filters\nissues where the `priority` field is `Urgent` AND the `severity` field is\n`High`.","in":"query","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/labels"},{"name":"sort","description":"What to sort results by.","in":"query","required":false,"schema":{"type":"string","enum":["created","updated","comments"],"default":"created"}},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/issue"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"301":{"$ref":"#/components/responses/moved_permanently"},"422":{"$ref":"#/components/responses/validation_failed"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"issues"}},"post":{"summary":"Create an issue","description":"Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["issues"],"operationId":"issues/create","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/issues#create-an-issue"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"oneOf":[{"type":"string"},{"type":"integer"}],"description":"The title of the issue."},"body":{"type":"string","description":"The contents of the issue."},"assignee":{"type":"string","description":"Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_","nullable":true},"milestone":{"oneOf":[{"type":"string"},{"type":"integer","description":"The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._"}],"nullable":true},"labels":{"type":"array","description":"Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._","items":{"oneOf":[{"type":"string"},{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"color":{"type":"string","nullable":true}}}]}},"assignees":{"type":"array","description":"Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._","items":{"type":"string"}},"issue_field_values":{"type":"array","description":"An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields are only available for organization-owned repositories with the feature enabled. Field values are silently dropped otherwise.","items":{"type":"object","properties":{"field_id":{"type":"integer","description":"The ID of the issue field to set"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}}],"description":"The value to set for the field. For multi-select fields, provide an array of option names."}},"required":["field_id","value"],"additionalProperties":false}},"type":{"type":"string","description":"The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._","nullable":true},"parent_issue_id":{"type":"integer","description":"The id of the parent issue to add this issue to as a sub-issue. _NOTE: Only users with triage access to both the parent issue's repository and this repository can set the parent issue._"}},"required":["title"]}}}},"responses":{"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue"}}},"headers":{"Location":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/bad_request"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"},"503":{"$ref":"#/components/responses/service_unavailable"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"}},"x-github":{"triggersNotification":true,"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"issues"},"x-github-breaking-changes":[{"changeset":"remove_singular_assignee_from_issues_and_pull_requests","patch":{"requestBody":{"content":{"application/json":{"schema":{"properties":{"assignee":null}}}}}},"version":"2026-03-10"}]}},"/repos/{owner}/{repo}/issues/comments":{"get":{"summary":"List issue comments for a repository","description":"You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["issues"],"operationId":"issues/list-comments-for-repo","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/sort"},{"name":"direction","description":"Either `asc` or `desc`. Ignored without the `sort` parameter.","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"]}},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/issue-comment"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"422":{"$ref":"#/components/responses/validation_failed"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"comments"}}},"/repos/{owner}/{repo}/issues/comments/{comment_id}":{"delete":{"summary":"Delete an issue comment","description":"You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.","tags":["issues"],"operationId":"issues/delete-comment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/comments#delete-an-issue-comment"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"responses":{"204":{"description":"Response"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"comments"}},"get":{"summary":"Get an issue comment","description":"You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["issues"],"operationId":"issues/get-comment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/comments#get-an-issue-comment"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue-comment"}}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"comments"}},"patch":{"summary":"Update an issue comment","description":"You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["issues"],"operationId":"issues/update-comment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/comments#update-an-issue-comment"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"The contents of the comment."}},"required":["body"]}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue-comment"}}}},"422":{"$ref":"#/components/responses/validation_failed"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"comments"}}},"/repos/{owner}/{repo}/issues/events":{"get":{"summary":"List issue events for a repository","description":"Lists events for a repository.","tags":["issues"],"operationId":"issues/list-events-for-repo","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/issue-event"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"422":{"$ref":"#/components/responses/validation_failed"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"events"}}},"/repos/{owner}/{repo}/issues/events/{event_id}":{"get":{"summary":"Get an issue event","description":"Gets a single event by the event id.","tags":["issues"],"operationId":"issues/get-event","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/events#get-an-issue-event"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"name":"event_id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue-event"}}}},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"},"403":{"$ref":"#/components/responses/forbidden"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"events"}}},"/repos/{owner}/{repo}/issues/{issue_number}":{"get":{"summary":"Get an issue","description":"The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["issues"],"operationId":"issues/get","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/issues#get-an-issue"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue"}}}},"301":{"$ref":"#/components/responses/moved_permanently"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"},"304":{"$ref":"#/components/responses/not_modified"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"issues"}},"patch":{"summary":"Update an issue","description":"Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["issues"],"operationId":"issues/update","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/issues#update-an-issue"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"oneOf":[{"type":"string"},{"type":"integer"}],"description":"The title of the issue.","nullable":true},"body":{"type":"string","description":"The contents of the issue.","nullable":true},"assignee":{"type":"string","nullable":true,"description":"Username to assign to this issue. **This field is closing down.**"},"state":{"type":"string","description":"The open or closed state of the issue.","enum":["open","closed"]},"state_reason":{"type":"string","enum":["completed","not_planned","duplicate","reopened"],"nullable":true,"description":"The reason for the state change. Ignored unless `state` is changed."},"duplicate_issue_id":{"type":"integer","description":"The ID of the issue to mark as the canonical duplicate when `state_reason` is `duplicate`. The issue must exist and be accessible to the authenticated user. Ignored when `state_reason` is not `duplicate`."},"milestone":{"oneOf":[{"type":"string"},{"type":"integer","description":"The `number` of the milestone to associate this issue with or use `null` to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped."}],"nullable":true},"labels":{"type":"array","description":"Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.","items":{"oneOf":[{"type":"string"},{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"rationale":{"type":"string","description":"Optional reasoning for selecting this label."},"suggest":{"type":"boolean","description":"If `true`, the change is stored as a pending suggestion for human review rather than applied directly."},"confidence":{"type":"string","description":"The confidence level for this label choice.","enum":["low","medium","high"]}}}]}},"assignees":{"type":"array","description":"Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.","items":{"oneOf":[{"type":"string"},{"type":"object","properties":{"login":{"type":"string"},"rationale":{"type":"string","description":"Optional reasoning for selecting this assignee."},"suggest":{"type":"boolean","description":"If `true`, the change is stored as a pending suggestion for human review rather than applied directly."},"confidence":{"type":"string","description":"The confidence level for this assignee choice.","enum":["low","medium","high"]}}}]}},"issue_field_values":{"type":"array","description":"An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Only users with push access can set field values for issues","items":{"type":"object","properties":{"field_id":{"type":"integer","description":"The ID of the issue field to set"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}}],"description":"The value to set for the field. For multi-select fields, provide an array of option names."},"rationale":{"type":"string","description":"Optional reasoning for setting this field value."},"suggest":{"type":"boolean","description":"If `true`, the change is stored as a pending suggestion for human review rather than applied directly."},"confidence":{"type":"string","description":"The confidence level for this field value choice.","enum":["low","medium","high"]}},"required":["field_id","value"],"additionalProperties":false}},"type":{"description":"The issue type to associate with this issue. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped.","nullable":true,"oneOf":[{"type":"string","description":"The name of the issue type."},{"type":"object","description":"The issue type with optional metadata.","properties":{"value":{"type":"string","description":"The name of the issue type to associate with this issue, or `null` to remove the current issue type.","nullable":true},"rationale":{"type":"string","description":"Optional reasoning for selecting this type."},"suggest":{"type":"boolean","description":"If `true`, the change is stored as a pending suggestion for human review rather than applied directly."},"confidence":{"type":"string","description":"The confidence level for this type choice.","enum":["low","medium","high"]}}}]}}}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/issue"},{"type":"object","properties":{"suggestions":{"type":"object","description":"Pending suggestions for each suggestible field (`type`,\n`issue_field_values`, `labels`, `assignees`, `state`) the\nrequest touched. Omitted for fields not in the request or\nwith no pending or ignored suggestions. Items tagged\n`ignored` are echoes of the current request's inputs that\nwere not persisted as pending suggestions.\n","properties":{"type":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"rationale":{"type":"string"},"suggest":{"type":"boolean"},"confidence":{"type":"string","enum":["low","medium","high"]},"ignored":{"type":"boolean"},"ignored_reason":{"type":"string","enum":["already_applied","issue_already_closed"]}}}},"issue_field_values":{"type":"array","items":{"type":"object","properties":{"field_id":{"type":"integer"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}}]},"rationale":{"type":"string"},"suggest":{"type":"boolean"},"confidence":{"type":"string","enum":["low","medium","high"]},"ignored":{"type":"boolean"},"ignored_reason":{"type":"string","enum":["already_applied","issue_already_closed"]}}}},"labels":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"rationale":{"type":"string"},"suggest":{"type":"boolean"},"confidence":{"type":"string","enum":["low","medium","high"]},"ignored":{"type":"boolean"},"ignored_reason":{"type":"string","enum":["already_applied","issue_already_closed"]}}}},"assignees":{"type":"array","items":{"type":"object","properties":{"login":{"type":"string"},"rationale":{"type":"string"},"suggest":{"type":"boolean"},"confidence":{"type":"string","enum":["low","medium","high"]},"ignored":{"type":"boolean"},"ignored_reason":{"type":"string","enum":["already_applied","issue_already_closed"]}}}},"state":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"state_reason":{"type":"string"},"duplicate_issue_id":{"type":"integer"},"rationale":{"type":"string"},"suggest":{"type":"boolean"},"confidence":{"type":"string","enum":["low","medium","high"]},"ignored":{"type":"boolean"},"ignored_reason":{"type":"string","enum":["already_applied","issue_already_closed"]}}}}}}}}]}}}},"422":{"$ref":"#/components/responses/validation_failed"},"503":{"$ref":"#/components/responses/service_unavailable"},"403":{"$ref":"#/components/responses/forbidden"},"301":{"$ref":"#/components/responses/moved_permanently"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"issues"},"x-github-breaking-changes":[{"changeset":"remove_singular_assignee_from_issues_and_pull_requests","patch":{"requestBody":{"content":{"application/json":{"schema":{"properties":{"assignee":null}}}}}},"version":"2026-03-10"}]}},"/repos/{owner}/{repo}/issues/{issue_number}/assignees":{"delete":{"summary":"Remove assignees from an issue","description":"Removes one or more assignees from an issue.","tags":["issues"],"operationId":"issues/remove-assignees","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"assignees":{"type":"array","description":"Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue"}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"assignees"}},"post":{"summary":"Add assignees to an issue","description":"Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.","tags":["issues"],"operationId":"issues/add-assignees","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"assignees":{"type":"array","description":"Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._","items":{"oneOf":[{"type":"string"},{"type":"object","properties":{"login":{"type":"string","description":"The login of the user to assign."},"rationale":{"type":"string","description":"Optional reasoning for adding this assignee."},"suggest":{"type":"boolean","description":"If `true`, the assignee is stored as a pending suggestion for human review rather than applied directly."},"confidence":{"type":"string","description":"The confidence level for this assignee choice.","enum":["low","medium","high"]}},"required":["login"]}]}}}}}}},"responses":{"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue"}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"assignees"}}},"/repos/{owner}/{repo}/issues/{issue_number}/comments":{"get":{"summary":"List issue comments","description":"You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["issues"],"operationId":"issues/list-comments","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/comments#list-issue-comments"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/issue-comment"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"comments"}},"post":{"summary":"Create an issue comment","description":"You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["issues"],"operationId":"issues/create-comment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/comments#create-an-issue-comment"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"The contents of the comment."}},"required":["body"]}}}},"responses":{"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue-comment"}}},"headers":{"Location":{"schema":{"type":"string"}}}},"403":{"$ref":"#/components/responses/forbidden"},"410":{"$ref":"#/components/responses/gone"},"422":{"$ref":"#/components/responses/validation_failed"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"triggersNotification":true,"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"comments"}}},"/repos/{owner}/{repo}/issues/{issue_number}/events":{"get":{"summary":"List issue events","description":"Lists all events for an issue.","tags":["issues"],"operationId":"issues/list-events","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/events#list-issue-events"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/issue-event-for-issue"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"410":{"$ref":"#/components/responses/gone"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"events"}}},"/repos/{owner}/{repo}/issues/{issue_number}/labels":{"delete":{"summary":"Remove all labels from an issue","description":"Removes all labels from an issue.","tags":["issues"],"operationId":"issues/remove-all-labels","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"responses":{"204":{"description":"Response"},"301":{"$ref":"#/components/responses/moved_permanently"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"labels"}},"get":{"summary":"List labels for an issue","description":"Lists all labels for an issue.","tags":["issues"],"operationId":"issues/list-labels-on-issue","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/labels#list-labels-for-an-issue"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/label"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"301":{"$ref":"#/components/responses/moved_permanently"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"labels"}},"post":{"summary":"Add labels to an issue","description":"Adds labels to an issue.","tags":["issues"],"operationId":"issues/add-labels","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/labels#add-labels-to-an-issue"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"labels":{"type":"array","minItems":1,"description":"The labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use \"[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue).\"","items":{"oneOf":[{"type":"string"},{"type":"object","properties":{"name":{"type":"string","description":"The name of the label to add."},"rationale":{"type":"string","description":"Optional reasoning for adding this label."},"suggest":{"type":"boolean","description":"If `true`, the label is stored as a pending suggestion for human review rather than applied directly."},"confidence":{"type":"string","description":"The confidence level for this label choice.","enum":["low","medium","high"]}},"required":["name"]}]}}}},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"rationale":{"type":"string","description":"Optional reasoning for adding this label."},"suggest":{"type":"boolean","description":"If `true`, the label is stored as a pending suggestion for human review rather than applied directly."},"confidence":{"type":"string","description":"The confidence level for this label choice.","enum":["low","medium","high"]}},"required":["name"]}}]}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/label"}}}}},"301":{"$ref":"#/components/responses/moved_permanently"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"},"422":{"$ref":"#/components/responses/validation_failed"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"labels"}},"put":{"summary":"Set labels for an issue","description":"Removes any previous labels and sets the new labels for an issue.","tags":["issues"],"operationId":"issues/set-labels","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/labels#set-labels-for-an-issue"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"labels":{"type":"array","minItems":1,"description":"The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue).\"","items":{"type":"string"}}}},{"type":"array","minItems":1,"items":{"type":"string"}},{"type":"object","properties":{"labels":{"type":"array","minItems":1,"items":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}}}},{"type":"array","minItems":1,"items":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}},{"type":"string"}]}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/label"}}}}},"301":{"$ref":"#/components/responses/moved_permanently"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"},"422":{"$ref":"#/components/responses/validation_failed"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"labels"}}},"/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}":{"delete":{"summary":"Remove a label from an issue","description":"Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.","tags":["issues"],"operationId":"issues/remove-label","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"},{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/label"}}}}},"301":{"$ref":"#/components/responses/moved_permanently"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"labels"}}},"/repos/{owner}/{repo}/issues/{issue_number}/lock":{"delete":{"summary":"Unlock an issue","description":"Users with push access can unlock an issue's conversation.","tags":["issues"],"operationId":"issues/unlock","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/issues#unlock-an-issue"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"responses":{"204":{"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"issues"}},"put":{"summary":"Lock an issue","description":"Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"","tags":["issues"],"operationId":"issues/lock","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/issues#lock-an-issue"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","nullable":true,"properties":{"lock_reason":{"type":"string","description":"The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n * `off-topic` \n * `too heated` \n * `resolved` \n * `spam`","enum":["off-topic","too heated","resolved","spam"]}}}}}},"responses":{"204":{"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"410":{"$ref":"#/components/responses/gone"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"issues"}}},"/repos/{owner}/{repo}/labels":{"get":{"summary":"List labels for a repository","description":"Lists all labels for a repository.","tags":["issues"],"operationId":"issues/list-labels-for-repo","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/labels#list-labels-for-a-repository"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/label"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"labels"}},"post":{"summary":"Create a label","description":"Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/).","tags":["issues"],"operationId":"issues/create-label","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/labels#create-a-label"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\""},"color":{"type":"string","description":"The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`."},"description":{"type":"string","description":"A short description of the label. Must be 100 characters or fewer."}},"required":["name"]}}}},"responses":{"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/label"}}},"headers":{"Location":{"schema":{"type":"string"}}}},"422":{"$ref":"#/components/responses/validation_failed"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"labels"}}},"/repos/{owner}/{repo}/labels/{name}":{"delete":{"summary":"Delete a label","description":"Deletes a label using the given label name.","tags":["issues"],"operationId":"issues/delete-label","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/labels#delete-a-label"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Response"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"labels"}},"get":{"summary":"Get a label","description":"Gets a label using the given name.","tags":["issues"],"operationId":"issues/get-label","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/labels#get-a-label"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/label"}}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"labels"}},"patch":{"summary":"Update a label","description":"Updates a label using the given label name.","tags":["issues"],"operationId":"issues/update-label","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/labels#update-a-label"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"new_name":{"type":"string","description":"The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\""},"color":{"type":"string","description":"The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`."},"description":{"type":"string","description":"A short description of the label. Must be 100 characters or fewer."},"archived":{"type":"boolean","description":"Whether to archive or unarchive the label. Archived labels cannot be added to issues or pull requests. For more information, see \"[Archiving labels](https://docs.github.com/issues/organizing-your-work-with-labels/managing-labels).\""}}}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/label"}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"labels"}}},"/repos/{owner}/{repo}/milestones":{"get":{"summary":"List milestones","description":"Lists milestones for a repository.","tags":["issues"],"operationId":"issues/list-milestones","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/milestones#list-milestones"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"name":"state","description":"The state of the milestone. Either `open`, `closed`, or `all`.","in":"query","required":false,"schema":{"type":"string","enum":["open","closed","all"],"default":"open"}},{"name":"sort","description":"What to sort results by. Either `due_on` or `completeness`.","in":"query","required":false,"schema":{"type":"string","enum":["due_on","completeness"],"default":"due_on"}},{"name":"direction","description":"The direction of the sort. Either `asc` or `desc`.","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/milestone"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"milestones"}},"post":{"summary":"Create a milestone","description":"Creates a milestone.","tags":["issues"],"operationId":"issues/create-milestone","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/milestones#create-a-milestone"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","description":"The title of the milestone."},"state":{"type":"string","description":"The state of the milestone. Either `open` or `closed`.","enum":["open","closed"],"default":"open"},"description":{"type":"string","description":"A description of the milestone."},"due_on":{"type":"string","format":"date-time","description":"The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."}},"required":["title"]}}}},"responses":{"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/milestone"}}},"headers":{"Location":{"schema":{"type":"string"}}}},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"milestones"}}},"/repos/{owner}/{repo}/milestones/{milestone_number}":{"delete":{"summary":"Delete a milestone","description":"Deletes a milestone using the given milestone number.","tags":["issues"],"operationId":"issues/delete-milestone","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/milestones#delete-a-milestone"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/milestone-number"}],"responses":{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"milestones"}},"get":{"summary":"Get a milestone","description":"Gets a milestone using the given milestone number.","tags":["issues"],"operationId":"issues/get-milestone","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/milestones#get-a-milestone"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/milestone-number"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/milestone"}}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"milestones"}},"patch":{"summary":"Update a milestone","description":"","tags":["issues"],"operationId":"issues/update-milestone","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/milestones#update-a-milestone"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/milestone-number"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","description":"The title of the milestone."},"state":{"type":"string","description":"The state of the milestone. Either `open` or `closed`.","enum":["open","closed"],"default":"open"},"description":{"type":"string","description":"A description of the milestone."},"due_on":{"type":"string","format":"date-time","description":"The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."}}}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/milestone"}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"milestones"}}},"/repos/{owner}/{repo}/milestones/{milestone_number}/labels":{"get":{"summary":"List labels for issues in a milestone","description":"Lists labels for issues in a milestone.","tags":["issues"],"operationId":"issues/list-labels-for-milestone","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/milestone-number"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/label"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"issues","subcategory":"labels"}}},"/repos/{owner}/{repo}/pulls":{"get":{"summary":"List pull requests","description":"Lists pull requests in a specified repository.\n\nDraft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)\nin the GitHub Help documentation.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["pulls"],"operationId":"pulls/list","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/pulls#list-pull-requests"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"name":"state","description":"Either `open`, `closed`, or `all` to filter by state.","in":"query","required":false,"schema":{"type":"string","enum":["open","closed","all"],"default":"open"}},{"name":"head","description":"Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.","in":"query","required":false,"schema":{"type":"string"}},{"name":"base","description":"Filter pulls by base branch name. Example: `gh-pages`.","in":"query","required":false,"schema":{"type":"string"}},{"name":"sort","description":"What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.","in":"query","required":false,"schema":{"type":"string","enum":["created","updated","popularity","long-running"],"default":"created"}},{"name":"direction","description":"The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"]}},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pull-request-simple"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"422":{"$ref":"#/components/responses/validation_failed"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"pulls"}},"post":{"summary":"Create a pull request","description":"Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["pulls"],"operationId":"pulls/create","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/pulls#create-a-pull-request"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","description":"The title of the new pull request. Required unless `issue` is specified."},"head":{"type":"string","description":"The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`."},"head_repo":{"type":"string","description":"The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization.","format":"repo.nwo"},"base":{"type":"string","description":"The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository."},"body":{"type":"string","description":"The contents of the pull request."},"maintainer_can_modify":{"type":"boolean","description":"Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request."},"draft":{"type":"boolean","description":"Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more."},"issue":{"type":"integer","format":"int64","description":"An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified."}},"required":["head","base"]}}}},"responses":{"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pull-request"}}},"headers":{"Location":{"schema":{"type":"string"}}}},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"}},"x-github":{"triggersNotification":true,"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"pulls"}}},"/repos/{owner}/{repo}/pulls/comments":{"get":{"summary":"List review comments in a repository","description":"Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["pulls"],"operationId":"pulls/list-review-comments-for-repo","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["created","updated","created_at"]}},{"name":"direction","description":"The direction to sort results. Ignored without `sort` parameter.","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"]}},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pull-request-review-comment"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"comments"}}},"/repos/{owner}/{repo}/pulls/comments/{comment_id}":{"delete":{"summary":"Delete a review comment for a pull request","description":"Deletes a review comment.","tags":["pulls"],"operationId":"pulls/delete-review-comment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"responses":{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"comments"}},"get":{"summary":"Get a review comment for a pull request","description":"Provides details for a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["pulls"],"operationId":"pulls/get-review-comment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pull-request-review-comment"}}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"comments"}},"patch":{"summary":"Update a review comment for a pull request","description":"Edits the content of a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["pulls"],"operationId":"pulls/update-review-comment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"The text of the reply to the review comment."}},"required":["body"]}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pull-request-review-comment"}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"comments"}}},"/repos/{owner}/{repo}/pulls/{pull_number}":{"get":{"summary":"Get a pull request","description":"Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.","tags":["pulls"],"operationId":"pulls/get","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/pulls#get-a-pull-request"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"}],"responses":{"200":{"description":"Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pull-request"}}}},"304":{"$ref":"#/components/responses/not_modified"},"404":{"$ref":"#/components/responses/not_found"},"406":{"$ref":"#/components/responses/unacceptable"},"500":{"$ref":"#/components/responses/internal_error"},"503":{"$ref":"#/components/responses/service_unavailable"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"pulls"}},"patch":{"summary":"Update a pull request","description":"Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["pulls"],"operationId":"pulls/update","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/pulls#update-a-pull-request"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","description":"The title of the pull request."},"body":{"type":"string","description":"The contents of the pull request."},"state":{"type":"string","description":"State of this Pull Request. Either `open` or `closed`.","enum":["open","closed"]},"base":{"type":"string","description":"The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository."},"maintainer_can_modify":{"type":"boolean","description":"Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request."}}}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pull-request"}}}},"422":{"$ref":"#/components/responses/validation_failed"},"403":{"$ref":"#/components/responses/forbidden"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"pulls"}}},"/repos/{owner}/{repo}/pulls/{pull_number}/comments":{"get":{"summary":"List review comments on a pull request","description":"Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["pulls"],"operationId":"pulls/list-review-comments","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"},{"$ref":"#/components/parameters/sort"},{"name":"direction","description":"The direction to sort results. Ignored without `sort` parameter.","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"]}},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pull-request-review-comment"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"comments"}},"post":{"summary":"Create a review comment for a pull request","description":"Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["pulls"],"operationId":"pulls/create-review-comment","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"The text of the review comment."},"commit_id":{"type":"string","description":"The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`."},"path":{"type":"string","description":"The relative path to the file that necessitates a comment."},"position":{"type":"integer","description":"**This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.","deprecated":true,"x-github":{"deprecationDate":"2022-11-01"}},"side":{"type":"string","description":"In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.","enum":["LEFT","RIGHT"]},"line":{"type":"integer","description":"**Required unless using `subject_type:file`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to."},"start_line":{"type":"integer","description":"**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation."},"start_side":{"type":"string","description":"**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.","enum":["LEFT","RIGHT","side"]},"in_reply_to":{"type":"integer","description":"The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored."},"subject_type":{"type":"string","description":"The level at which the comment is targeted.","enum":["line","file"]}},"required":["body","commit_id","path"]}}}},"responses":{"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pull-request-review-comment"}}},"headers":{"Location":{"schema":{"type":"string"}}}},"422":{"$ref":"#/components/responses/validation_failed"},"403":{"$ref":"#/components/responses/forbidden"}},"x-github":{"triggersNotification":true,"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"comments"}}},"/repos/{owner}/{repo}/pulls/{pull_number}/commits":{"get":{"summary":"List commits on a pull request","description":"Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits)\nendpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["pulls"],"operationId":"pulls/list-commits","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/commit"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"pulls"}}},"/repos/{owner}/{repo}/pulls/{pull_number}/merge":{"get":{"summary":"Check if a pull request has been merged","description":"Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.","tags":["pulls"],"operationId":"pulls/check-if-merged","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"}],"responses":{"204":{"description":"Response if pull request has been merged"},"404":{"description":"Not Found if pull request has not been merged"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"pulls"}},"put":{"summary":"Merge a pull request","description":"Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"","tags":["pulls"],"operationId":"pulls/merge","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/pulls#merge-a-pull-request"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","nullable":true,"properties":{"commit_title":{"type":"string","description":"Title for the automatic commit message."},"commit_message":{"type":"string","description":"Extra detail to append to automatic commit message."},"sha":{"type":"string","description":"SHA that pull request head must match to allow merge."},"merge_method":{"type":"string","description":"The merge method to use.","enum":["merge","squash","rebase"]}}}}}},"responses":{"200":{"description":"if merge was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pull-request-merge-result"}}}},"405":{"description":"Method Not Allowed if merge cannot be performed","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"documentation_url":{"type":"string"}}}}}},"409":{"description":"Conflict if sha was provided and pull request head did not match","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"documentation_url":{"type":"string"}}}}}},"422":{"$ref":"#/components/responses/validation_failed"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"triggersNotification":true,"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"pulls"}}},"/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers":{"delete":{"summary":"Remove requested reviewers from a pull request","description":"Removes review requests from a pull request for a given set of users and/or teams.","tags":["pulls"],"operationId":"pulls/remove-requested-reviewers","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reviewers":{"type":"array","description":"An array of user `login`s that will be removed.","items":{"type":"string"}},"team_reviewers":{"type":"array","description":"An array of team `slug`s that will be removed.","items":{"type":"string"}}},"required":["reviewers"]}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pull-request-simple"}}}},"422":{"$ref":"#/components/responses/validation_failed"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"review-requests"}},"get":{"summary":"Get all requested reviewers for a pull request","description":"Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.","tags":["pulls"],"operationId":"pulls/list-requested-reviewers","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pull-request-review-request"}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"review-requests"}},"post":{"summary":"Request reviewers for a pull request","description":"Requests reviews for a pull request from a given set of users and/or teams.\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"","tags":["pulls"],"operationId":"pulls/request-reviewers","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"reviewers":{"type":"array","description":"An array of user `login`s that will be requested.","items":{"type":"string"}},"team_reviewers":{"type":"array","description":"An array of team `slug`s that will be requested.","items":{"type":"string"}}},"anyOf":[{"required":["reviewers"]},{"required":["team_reviewers"]}]}}}},"responses":{"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pull-request-simple"}}}},"422":{"description":"Unprocessable Entity if user is not a collaborator"},"403":{"$ref":"#/components/responses/forbidden"}},"x-github":{"triggersNotification":true,"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"review-requests"}}},"/repos/{owner}/{repo}/pulls/{pull_number}/reviews":{"get":{"summary":"List reviews for a pull request","description":"Lists all reviews for a specified pull request. The list of reviews returns in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["pulls"],"operationId":"pulls/list-reviews","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"The list of reviews returns in chronological order.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pull-request-review"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"reviews"}},"post":{"summary":"Create a review for a pull request","description":"Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n> [!NOTE]\n> To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["pulls"],"operationId":"pulls/create-review","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"commit_id":{"type":"string","description":"The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value."},"body":{"type":"string","description":"**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review."},"event":{"type":"string","description":"The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.","enum":["APPROVE","REQUEST_CHANGES","COMMENT"]},"comments":{"type":"array","description":"Use the following table to specify the location, destination, and contents of the draft review comment.","items":{"type":"object","properties":{"path":{"type":"string","description":"The relative path to the file that necessitates a review comment."},"position":{"type":"integer","description":"The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file."},"body":{"type":"string","description":"Text of the review comment."},"line":{"type":"integer"},"side":{"type":"string"},"start_line":{"type":"integer"},"start_side":{"type":"string"}},"required":["path","body"]}}}}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pull-request-review"}}}},"422":{"$ref":"#/components/responses/validation_failed_simple"},"403":{"$ref":"#/components/responses/forbidden"}},"x-github":{"triggersNotification":true,"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"reviews"}}},"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}":{"delete":{"summary":"Delete a pending review for a pull request","description":"Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["pulls"],"operationId":"pulls/delete-pending-review","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"},{"$ref":"#/components/parameters/review-id"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pull-request-review"}}}},"422":{"$ref":"#/components/responses/validation_failed_simple"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"reviews"}},"get":{"summary":"Get a review for a pull request","description":"Retrieves a pull request review by its ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["pulls"],"operationId":"pulls/get-review","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"},{"$ref":"#/components/parameters/review-id"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pull-request-review"}}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"reviews"}},"put":{"summary":"Update a review for a pull request","description":"Updates the contents of a specified review summary comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["pulls"],"operationId":"pulls/update-review","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"},{"$ref":"#/components/parameters/review-id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"The body text of the pull request review."}},"required":["body"]}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pull-request-review"}}}},"422":{"$ref":"#/components/responses/validation_failed_simple"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"reviews"}}},"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments":{"get":{"summary":"List comments for a pull request review","description":"Lists comments for a specific pull request review.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","tags":["pulls"],"operationId":"pulls/list-comments-for-review","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"},{"$ref":"#/components/parameters/review-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/review-comment"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"pulls","subcategory":"reviews"}}},"/repos/{owner}/{repo}/releases":{"get":{"summary":"List releases","description":"This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/repos/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.","tags":["repos"],"operationId":"repos/list-releases","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/releases/releases#list-releases"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/release"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"releases","subcategory":"releases"}},"post":{"summary":"Create a release","description":"Users with push access to the repository can create a release.\n\n> [!NOTE]\n> If the commit identified by `target_commitish` (or, when `target_commitish` is omitted, the latest commit on the default branch) adds or modifies any file under `.github/workflows/` relative to the repository's default branch, the authenticating token must be authorized to modify workflows. Otherwise, this endpoint returns `404 Not Found`; some authentication paths surface `403 Resource not accessible by integration` instead.\n\nOAuth app tokens and personal access tokens (classic) need the `workflow` scope when the resolved target commit modifies workflow files. Fine-grained access tokens and GitHub App installation tokens also need the \"Workflows\" repository permission (write). The `GITHUB_TOKEN` available to GitHub Actions cannot be authorized for this; for more information, see \"[Automatic token authentication](https://docs.github.com/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"","tags":["repos"],"operationId":"repos/create-release","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/releases/releases#create-a-release"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tag_name":{"type":"string","description":"The name of the tag."},"target_commitish":{"type":"string","description":"Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch."},"name":{"type":"string","description":"The name of the release."},"body":{"type":"string","description":"Text describing the contents of the tag."},"draft":{"type":"boolean","description":"`true` to create a draft (unpublished) release, `false` to create a published one.","default":false},"prerelease":{"type":"boolean","description":"`true` to identify the release as a prerelease. `false` to identify the release as a full release.","default":false},"discussion_category_name":{"type":"string","description":"If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\""},"generate_release_notes":{"type":"boolean","description":"Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.","default":false},"make_latest":{"type":"string","description":"Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version.","enum":["true","false","legacy"],"default":"true"}},"required":["tag_name"]}}}},"responses":{"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/release"}}},"headers":{"Location":{"schema":{"type":"string"}}}},"404":{"description":"Not Found if the discussion category name is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/basic-error"}}}},"422":{"$ref":"#/components/responses/validation_failed"}},"x-github":{"triggersNotification":true,"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"releases","subcategory":"releases"}}},"/repos/{owner}/{repo}/releases/assets/{asset_id}":{"delete":{"summary":"Delete a release asset","description":"","tags":["repos"],"operationId":"repos/delete-release-asset","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/releases/assets#delete-a-release-asset"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/asset-id"}],"responses":{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"releases","subcategory":"assets"}},"get":{"summary":"Get a release asset","description":"To download the asset's binary content:\n\n- If within a browser, fetch the location specified in the `browser_download_url` key provided in the response.\n- Alternatively, set the `Accept` header of the request to \n [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). \n The API will either redirect the client to the location, or stream it directly if possible.\n API clients should handle both a `200` or `302` response.","tags":["repos"],"operationId":"repos/get-release-asset","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/releases/assets#get-a-release-asset"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/asset-id"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/release-asset"}}}},"404":{"$ref":"#/components/responses/not_found"},"302":{"$ref":"#/components/responses/found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"releases","subcategory":"assets"}},"patch":{"summary":"Update a release asset","description":"Users with push access to the repository can edit a release asset.","tags":["repos"],"operationId":"repos/update-release-asset","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/releases/assets#update-a-release-asset"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/asset-id"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The file name of the asset."},"label":{"type":"string","description":"An alternate short description of the asset. Used in place of the filename."},"state":{"type":"string"}}}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/release-asset"}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"releases","subcategory":"assets"}}},"/repos/{owner}/{repo}/releases/latest":{"get":{"summary":"Get the latest release","description":"View the latest published full release for the repository.\n\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.","tags":["repos"],"operationId":"repos/get-latest-release","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/releases/releases#get-the-latest-release"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/release"}}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"releases","subcategory":"releases"}}},"/repos/{owner}/{repo}/releases/tags/{tag}":{"get":{"summary":"Get a release by tag name","description":"Get a published release with the specified tag.","tags":["repos"],"operationId":"repos/get-release-by-tag","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"name":"tag","description":"tag parameter","in":"path","required":true,"schema":{"type":"string"},"x-multi-segment":true}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/release"}}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"releases","subcategory":"releases"}}},"/repos/{owner}/{repo}/releases/{release_id}":{"delete":{"summary":"Delete a release","description":"Users with push access to the repository can delete a release.","tags":["repos"],"operationId":"repos/delete-release","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/releases/releases#delete-a-release"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/release-id"}],"responses":{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"releases","subcategory":"releases"}},"get":{"summary":"Get a release","description":"Gets a public release with the specified release ID.\n\n> [!NOTE]\n> This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"","tags":["repos"],"operationId":"repos/get-release","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/releases/releases#get-a-release"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/release-id"}],"responses":{"200":{"description":"**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/release"}}}},"401":{"description":"Unauthorized"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"releases","subcategory":"releases"}},"patch":{"summary":"Update a release","description":"Users with push access to the repository can edit a release.\n\n> [!NOTE]\n> If the resolved target commit (the new value of `target_commitish` if you are changing it, otherwise the existing target) adds or modifies any file under `.github/workflows/` relative to the repository's default branch, the authenticating token must be authorized to modify workflows. Otherwise, this endpoint returns `404 Not Found`; some authentication paths surface `403 Resource not accessible by integration` instead.\n\nOAuth app tokens and personal access tokens (classic) need the `workflow` scope when the resolved target commit modifies workflow files. Fine-grained access tokens and GitHub App installation tokens also need the \"Workflows\" repository permission (write). The `GITHUB_TOKEN` available to GitHub Actions cannot be authorized for this; for more information, see \"[Automatic token authentication](https://docs.github.com/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token)\".","tags":["repos"],"operationId":"repos/update-release","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/releases/releases#update-a-release"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/release-id"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"tag_name":{"type":"string","description":"The name of the tag."},"target_commitish":{"type":"string","description":"Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch."},"name":{"type":"string","description":"The name of the release."},"body":{"type":"string","description":"Text describing the contents of the tag."},"draft":{"type":"boolean","description":"`true` makes the release a draft, and `false` publishes the release."},"prerelease":{"type":"boolean","description":"`true` to identify the release as a prerelease, `false` to identify the release as a full release."},"make_latest":{"type":"string","description":"Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version.","enum":["true","false","legacy"],"default":"true"},"discussion_category_name":{"type":"string","description":"If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\""}}}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/release"}}}},"404":{"description":"Not Found if the discussion category name is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/basic-error"}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"releases","subcategory":"releases"}}},"/repos/{owner}/{repo}/releases/{release_id}/assets":{"get":{"summary":"List release assets","description":"","tags":["repos"],"operationId":"repos/list-release-assets","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/releases/assets#list-release-assets"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/release-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/release-asset"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"releases","subcategory":"assets"}}},"/repos/{owner}/{repo}/secret-scanning/alerts":{"get":{"summary":"List secret scanning alerts for a repository","description":"Lists secret scanning alerts for an eligible repository, from newest to oldest.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.","tags":["secret-scanning"],"operationId":"secret-scanning/list-alerts-for-repo","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/secret-scanning-alert-state"},{"$ref":"#/components/parameters/secret-scanning-alert-secret-type"},{"$ref":"#/components/parameters/secret-scanning-alert-exclude-secret-types"},{"$ref":"#/components/parameters/secret-scanning-alert-exclude-providers"},{"$ref":"#/components/parameters/secret-scanning-alert-providers"},{"$ref":"#/components/parameters/secret-scanning-alert-resolution"},{"$ref":"#/components/parameters/secret-scanning-alert-assignee"},{"$ref":"#/components/parameters/secret-scanning-alert-sort"},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/secret-scanning-pagination-before-org-repo"},{"$ref":"#/components/parameters/secret-scanning-pagination-after-org-repo"},{"$ref":"#/components/parameters/secret-scanning-alert-validity"},{"$ref":"#/components/parameters/secret-scanning-alert-publicly-leaked"},{"$ref":"#/components/parameters/secret-scanning-alert-multi-repo"},{"$ref":"#/components/parameters/secret-scanning-alert-hide-secret"},{"$ref":"#/components/parameters/secret-scanning-alert-bypassed"},{"$ref":"#/components/parameters/secret-scanning-alert-included-metadata"},{"$ref":"#/components/parameters/secret-scanning-alert-owner-email-hash"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/secret-scanning-alert"}}}}},"404":{"description":"Repository is public or secret scanning is disabled for the repository"},"503":{"$ref":"#/components/responses/service_unavailable"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"secret-scanning","subcategory":"secret-scanning"}}},"/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}":{"get":{"summary":"Get a secret scanning alert","description":"Gets a single secret scanning alert detected in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.","tags":["secret-scanning"],"operationId":"secret-scanning/get-alert","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/alert-number"},{"$ref":"#/components/parameters/secret-scanning-alert-hide-secret"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/secret-scanning-alert-with-metadata"}}}},"304":{"$ref":"#/components/responses/not_modified"},"404":{"description":"Repository is public, or secret scanning is disabled for the repository, or the resource is not found"},"503":{"$ref":"#/components/responses/service_unavailable"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"secret-scanning","subcategory":"secret-scanning"}},"patch":{"summary":"Update a secret scanning alert","description":"Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.","operationId":"secret-scanning/update-alert","tags":["secret-scanning"],"externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/alert-number"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/secret-scanning-alert-state"},"resolution":{"$ref":"#/components/schemas/secret-scanning-alert-resolution"},"resolution_comment":{"$ref":"#/components/schemas/secret-scanning-alert-resolution-comment"},"assignee":{"$ref":"#/components/schemas/secret-scanning-alert-assignee"},"validity":{"type":"string","nullable":true,"enum":["active","inactive"],"description":"Sets the validity of the secret scanning alert. Can be `active`, `inactive`, or `null` to clear the override."}},"anyOf":[{"required":["state"]},{"required":["assignee"]},{"required":["validity"]}]}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/secret-scanning-alert-with-metadata"}}}},"400":{"description":"Bad request, resolution comment is invalid or the resolution was not changed."},"403":{"description":"Delegated alert dismissal is enabled and the authenticated user is not a valid reviewer."},"404":{"description":"Repository is public, or secret scanning is disabled for the repository, or the resource is not found"},"422":{"description":"State does not match the resolution or resolution comment, assignee does not have write access to the repository, or the requested validity change could not be applied to this alert"},"503":{"$ref":"#/components/responses/service_unavailable"}},"x-github":{"enabledForGitHubApps":true,"githubCloudOnly":false,"category":"secret-scanning","subcategory":"secret-scanning"}}},"/repos/{owner}/{repo}/stargazers":{"get":{"summary":"List stargazers","description":"Lists the people that have starred the repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.","tags":["activity"],"operationId":"activity/list-stargazers-for-repo","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/activity/starring#list-stargazers"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/simple-user"}},{"type":"array","items":{"$ref":"#/components/schemas/stargazer"}}]}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"422":{"$ref":"#/components/responses/validation_failed"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"activity","subcategory":"starring"}}},"/repos/{owner}/{repo}/statuses/{sha}":{"post":{"summary":"Create a commit status","description":"Users with push access in a repository can create commit statuses for a given SHA.\n\nNote: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.","tags":["repos"],"operationId":"repos/create-commit-status","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/commits/statuses#create-a-commit-status"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"name":"sha","in":"path","required":true,"schema":{"type":"string"},"x-multi-segment":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"string","description":"The state of the status.","enum":["error","failure","pending","success"]},"target_url":{"type":"string","nullable":true,"description":"The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`"},"description":{"type":"string","nullable":true,"description":"A short description of the status."},"context":{"type":"string","description":"A string label to differentiate this status from the status of other systems. This field is case-insensitive.","default":"default"}},"required":["state"]}}}},"responses":{"201":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/status"}}},"headers":{"Location":{"schema":{"type":"string"}}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"commits","subcategory":"statuses"}}},"/repos/{owner}/{repo}/tags":{"get":{"summary":"List repository tags","description":"","tags":["repos"],"operationId":"repos/list-tags","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/repos/repos#list-repository-tags"},"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/tag"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"repos","subcategory":"repos"}}},"/repositories":{"get":{"summary":"List public repositories","description":"Lists all public repositories in the order that they were created.\n\nNote:\n- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.","tags":["repos"],"operationId":"repos/list-public","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/repos/repos#list-public-repositories"},"parameters":[{"$ref":"#/components/parameters/since-repo"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/minimal-repository"}}}},"headers":{"Link":{"schema":{"type":"string"}}}},"422":{"$ref":"#/components/responses/validation_failed"},"304":{"$ref":"#/components/responses/not_modified"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"repos","subcategory":"repos"}}},"/search/commits":{"get":{"summary":"Search commits","description":"Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`","tags":["search"],"operationId":"search/commits","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/search/search#search-commits"},"parameters":[{"name":"q","description":"The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)\" for a detailed list of qualifiers.","in":"query","required":true,"schema":{"type":"string"}},{"name":"sort","description":"Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)","in":"query","required":false,"schema":{"type":"string","enum":["author-date","committer-date"]}},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"object","required":["total_count","incomplete_results","items"],"properties":{"total_count":{"type":"integer"},"incomplete_results":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/commit-search-result-item"}}}}}}},"304":{"$ref":"#/components/responses/not_modified"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"search","subcategory":"search"}}},"/search/issues":{"get":{"summary":"Search issues and pull requests","description":"Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n> [!NOTE]\n> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"","tags":["search"],"operationId":"search/issues-and-pull-requests","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/search/search#search-issues-and-pull-requests"},"parameters":[{"name":"q","description":"The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers.","in":"query","required":true,"schema":{"type":"string"}},{"name":"sort","description":"Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)","in":"query","required":false,"schema":{"type":"string","enum":["comments","reactions","reactions-+1","reactions--1","reactions-smile","reactions-thinking_face","reactions-heart","reactions-tada","interactions","created","updated"]}},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/issues-advanced-search"},{"$ref":"#/components/parameters/search-type"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"object","required":["total_count","incomplete_results","items","search_type"],"properties":{"total_count":{"type":"integer"},"incomplete_results":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/issue-search-result-item"}},"search_type":{"type":"string","description":"The type of search that was performed. Possible values are `lexical`, `semantic`, or `hybrid`.","enum":["lexical","semantic","hybrid"]},"lexical_fallback_reason":{"type":"array","description":"When a semantic or hybrid search falls back to lexical search, this field contains the reasons for the fallback. Only present when a fallback occurred.","items":{"type":"string","enum":["no_text_terms","quoted_text","non_issue_target","or_boolean_not_supported","no_accessible_repos","server_error","only_non_semantic_fields_requested","service_unavailable"]}}}}}}},"503":{"$ref":"#/components/responses/service_unavailable"},"422":{"$ref":"#/components/responses/validation_failed"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"401":{"$ref":"#/components/responses/requires_authentication"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"search","subcategory":"search"}}},"/search/labels":{"get":{"summary":"Search labels","description":"Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.","tags":["search"],"operationId":"search/labels","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/search/search#search-labels"},"parameters":[{"name":"repository_id","description":"The id of the repository.","in":"query","required":true,"schema":{"type":"integer"}},{"name":"q","description":"The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query).","in":"query","required":true,"schema":{"type":"string"}},{"name":"sort","description":"Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)","in":"query","required":false,"schema":{"type":"string","enum":["created","updated"]}},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"object","required":["total_count","incomplete_results","items"],"properties":{"total_count":{"type":"integer"},"incomplete_results":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/label-search-result-item"}}}}}}},"304":{"$ref":"#/components/responses/not_modified"},"404":{"$ref":"#/components/responses/not_found"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"search","subcategory":"search"}}},"/search/repositories":{"get":{"summary":"Search repositories","description":"Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.","tags":["search"],"operationId":"search/repos","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/search/search#search-repositories"},"parameters":[{"name":"q","description":"The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.","in":"query","required":true,"schema":{"type":"string"}},{"name":"sort","description":"Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)","in":"query","required":false,"schema":{"type":"string","enum":["stars","forks","help-wanted-issues","updated"]}},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"object","required":["total_count","incomplete_results","items"],"properties":{"total_count":{"type":"integer"},"incomplete_results":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/repo-search-result-item"}}}}}}},"503":{"$ref":"#/components/responses/service_unavailable"},"422":{"$ref":"#/components/responses/validation_failed"},"304":{"$ref":"#/components/responses/not_modified"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"search","subcategory":"search"}}},"/search/users":{"get":{"summary":"Search users","description":"Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.\n\nThis endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search).\"","tags":["search"],"operationId":"search/users","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/search/search#search-users"},"parameters":[{"name":"q","description":"The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.","in":"query","required":true,"schema":{"type":"string"}},{"name":"sort","description":"Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)","in":"query","required":false,"schema":{"type":"string","enum":["followers","repositories","joined"]}},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"object","required":["total_count","incomplete_results","items"],"properties":{"total_count":{"type":"integer"},"incomplete_results":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/user-search-result-item"}}}}}}},"304":{"$ref":"#/components/responses/not_modified"},"503":{"$ref":"#/components/responses/service_unavailable"},"422":{"$ref":"#/components/responses/validation_failed"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"search","subcategory":"search"}}},"/user/{account_id}":{"get":{"summary":"Get a user using their ID","description":"Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).","tags":["users"],"operationId":"users/get-by-id","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/users/users#get-a-user-using-their-id"},"parameters":[{"$ref":"#/components/parameters/account-id"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/private-user"},{"$ref":"#/components/schemas/public-user"}],"discriminator":{"propertyName":"user_view_type","mapping":{"public":"#/components/schemas/public-user","private":"#/components/schemas/private-user"}}}}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"users","subcategory":"users"}}},"/users":{"get":{"summary":"List users","description":"Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.","tags":["users"],"operationId":"users/list","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/users/users#list-users"},"parameters":[{"$ref":"#/components/parameters/since-user"},{"$ref":"#/components/parameters/per-page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/simple-user"}}}},"headers":{"Link":{"schema":{"type":"string"}}}},"304":{"$ref":"#/components/responses/not_modified"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"users","subcategory":"users"}}},"/users/{username}":{"get":{"summary":"Get a user","description":"Provides publicly available information about someone with a GitHub account.\n\nIf the specified user has a [private profile](https://docs.github.com/account-and-profile/concepts/personal-profile#private-profiles), the `followers` and `following` values are `0` unless the request is authenticated as that user. A request authenticated as the specified user returns the actual values even if the token has no OAuth scopes.\n\nThe `events_url` value is a URI template. Replace `{/privacy}` with `/public` to retrieve only public events. Omit it to retrieve public events and, when authenticated as the user, private events. For more information, see \"[List events for the authenticated user](https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user).\"\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).","tags":["users"],"operationId":"users/get-by-username","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/users/users#get-a-user"},"parameters":[{"$ref":"#/components/parameters/username"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/private-user"},{"$ref":"#/components/schemas/public-user"}],"discriminator":{"propertyName":"user_view_type","mapping":{"public":"#/components/schemas/public-user","private":"#/components/schemas/private-user"}}}}}},"404":{"$ref":"#/components/responses/not_found"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"users","subcategory":"users"}}},"/users/{username}/gists":{"get":{"summary":"List gists for a user","description":"Lists public gists for the specified user:","tags":["gists"],"operationId":"gists/list-for-user","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/gists/gists#list-gists-for-a-user"},"parameters":[{"$ref":"#/components/parameters/username"},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/base-gist"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}},"422":{"$ref":"#/components/responses/validation_failed"}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":false,"category":"gists","subcategory":"gists"}}},"/users/{username}/orgs":{"get":{"summary":"List organizations for a user","description":"List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.","tags":["orgs"],"operationId":"orgs/list-for-user","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user"},"parameters":[{"$ref":"#/components/parameters/username"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/organization-simple"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"orgs","subcategory":"orgs"}}},"/users/{username}/repos":{"get":{"summary":"List repositories for a user","description":"Lists public repositories for the specified user.","tags":["repos"],"operationId":"repos/list-for-user","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/repos/repos#list-repositories-for-a-user"},"parameters":[{"$ref":"#/components/parameters/username"},{"name":"type","description":"Limit results to repositories of the specified type.","in":"query","required":false,"schema":{"type":"string","enum":["all","owner","member"],"default":"owner"}},{"name":"sort","description":"The property to sort the results by.","in":"query","required":false,"schema":{"type":"string","enum":["created","updated","pushed","full_name"],"default":"full_name"}},{"name":"direction","description":"The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"]}},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/minimal-repository"}}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"repos","subcategory":"repos"}}},"/users/{username}/starred":{"get":{"summary":"List repositories starred by a user","description":"Lists repositories a user has starred.\n\nIf the specified user has a [private profile](https://docs.github.com/account-and-profile/concepts/personal-profile#private-profiles), this endpoint returns an empty list unless the request is authenticated as that user. A request authenticated as the specified user returns starred repositories visible to the token even if the token has no OAuth scopes.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.","tags":["activity"],"operationId":"activity/list-repos-starred-by-user","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user"},"parameters":[{"$ref":"#/components/parameters/username"},{"$ref":"#/components/parameters/sort-starred"},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/starred-repository"}},{"type":"array","items":{"$ref":"#/components/schemas/repository"}}]}}},"headers":{"Link":{"$ref":"#/components/headers/link"}}}},"x-github":{"githubCloudOnly":false,"enabledForGitHubApps":true,"category":"activity","subcategory":"starring"}}}},"components":{"headers":{"link":{"schema":{"type":"string"}}},"parameters":{"account-id":{"name":"account_id","description":"account_id parameter","in":"path","required":true,"schema":{"type":"integer"}},"actor":{"name":"actor","description":"Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.","in":"query","required":false,"schema":{"type":"string"}},"alert-number":{"name":"alert_number","in":"path","description":"The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.","required":true,"schema":{"$ref":"#/components/schemas/alert-number"}},"app-slug":{"name":"app_slug","in":"path","required":true,"schema":{"type":"string"}},"artifact-id":{"name":"artifact_id","description":"The unique identifier of the artifact.","in":"path","required":true,"schema":{"type":"integer"}},"artifact-name":{"name":"name","description":"The name field of an artifact. When specified, only artifacts with this name will be returned.","in":"query","required":false,"schema":{"type":"string"}},"asset-id":{"name":"asset_id","description":"The unique identifier of the asset.","in":"path","required":true,"schema":{"type":"integer"}},"branch":{"name":"branch","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","in":"path","required":true,"schema":{"type":"string"},"x-multi-segment":true},"check-name":{"name":"check_name","description":"Returns check runs with the specified `name`.","in":"query","required":false,"schema":{"type":"string"}},"check-run-id":{"name":"check_run_id","description":"The unique identifier of the check run.","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},"check-suite-id":{"name":"check_suite_id","description":"The unique identifier of the check suite.","in":"path","required":true,"schema":{"type":"integer"}},"comment-id":{"name":"comment_id","description":"The unique identifier of the comment.","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},"commit-ref":{"name":"ref","description":"The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.","in":"path","required":true,"schema":{"type":"string"},"x-multi-segment":true},"commit-sha":{"name":"commit_sha","description":"The SHA of the commit.","in":"path","required":true,"schema":{"type":"string"},"x-multi-segment":true},"created":{"name":"created","description":"Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},"dependabot-alert-comma-separated-artifact-registry":{"name":"artifact_registry","in":"query","description":"A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned.\n\nCan be: `jfrog-artifactory`","schema":{"type":"string"}},"dependabot-alert-comma-separated-artifact-registry-urls":{"name":"artifact_registry_url","in":"query","description":"A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.","schema":{"type":"string"}},"dependabot-alert-comma-separated-assignees":{"name":"assignee","in":"query","description":"Filter alerts by assignees.\nProvide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users.\nUse `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.","schema":{"type":"string"}},"dependabot-alert-comma-separated-classifications":{"name":"classification","in":"query","description":"A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned.\n\nCan be: `malware`, `general`","schema":{"type":"string"}},"dependabot-alert-comma-separated-ecosystems":{"name":"ecosystem","in":"query","description":"A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`","schema":{"type":"string"}},"dependabot-alert-comma-separated-epss":{"name":"epss_percentage","in":"query","description":"CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `<n`, `>=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.","schema":{"type":"string"}},"dependabot-alert-comma-separated-has":{"name":"has","in":"query","description":"Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported.","schema":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string","enum":["patch"]}}]}},"dependabot-alert-comma-separated-manifests":{"name":"manifest","in":"query","description":"A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned.","schema":{"type":"string"}},"dependabot-alert-comma-separated-packages":{"name":"package","in":"query","description":"A comma-separated list of package names. If specified, only alerts for these packages will be returned.","schema":{"type":"string"}},"dependabot-alert-comma-separated-runtime-risk":{"name":"runtime_risk","in":"query","description":"A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned.\n\nCan be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement`","schema":{"type":"string"}},"dependabot-alert-comma-separated-severities":{"name":"severity","in":"query","description":"A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`","schema":{"type":"string"}},"dependabot-alert-comma-separated-states":{"name":"state","in":"query","description":"A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`","schema":{"type":"string"}},"dependabot-alert-number":{"name":"alert_number","in":"path","description":"The number that identifies a Dependabot alert in its repository.\nYou can find this at the end of the URL for a Dependabot alert within GitHub,\nor in `number` fields in the response from the\n`GET /repos/{owner}/{repo}/dependabot/alerts` operation.","required":true,"schema":{"$ref":"#/components/schemas/alert-number"}},"dependabot-alert-org-scope-comma-separated-has":{"name":"has","in":"query","description":"Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values.","schema":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string","enum":["patch","deployment"]}}]}},"dependabot-alert-relationship":{"name":"relationship","in":"query","description":"A comma-separated list of relationships of the vulnerable dependency to your project. If specified, only alerts with these relationships will be returned.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.","schema":{"type":"string"}},"dependabot-alert-scope":{"name":"scope","in":"query","description":"The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.","schema":{"type":"string","enum":["development","runtime"]}},"dependabot-alert-sort":{"name":"sort","in":"query","description":"The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.","schema":{"type":"string","enum":["created","updated","epss_percentage"],"default":"created"}},"deployment-id":{"name":"deployment_id","description":"deployment_id parameter","in":"path","required":true,"schema":{"type":"integer"}},"direction":{"name":"direction","description":"The direction to sort the results by.","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"desc"}},"environment-name":{"name":"environment_name","in":"path","required":true,"description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","schema":{"type":"string"}},"event":{"name":"event","description":"Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"","in":"query","required":false,"schema":{"type":"string"}},"exclude-pull-requests":{"name":"exclude_pull_requests","description":"If `true` pull requests are omitted from the response (empty array).","in":"query","required":false,"schema":{"type":"boolean","default":false}},"gist-id":{"name":"gist_id","description":"The unique identifier of the gist.","in":"path","required":true,"schema":{"type":"string"}},"git-ref":{"name":"ref","description":"The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/<branch name>` or simply `<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.","in":"query","required":false,"schema":{"$ref":"#/components/schemas/code-scanning-ref"}},"git-ref-only":{"name":"ref","description":"The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.","in":"path","required":true,"schema":{"type":"string"},"x-multi-segment":true},"hook-id":{"name":"hook_id","description":"The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.","in":"path","required":true,"schema":{"type":"integer"}},"installation-id":{"name":"installation_id","description":"The unique identifier of the installation.","in":"path","required":true,"schema":{"type":"integer"}},"invitation-id":{"name":"invitation_id","description":"The unique identifier of the invitation.","in":"path","required":true,"schema":{"type":"integer"}},"issue-number":{"name":"issue_number","description":"The number that identifies the issue.","in":"path","required":true,"schema":{"type":"integer"}},"issue-type-id":{"name":"issue_type_id","description":"The unique identifier of the issue type.","in":"path","required":true,"schema":{"type":"integer"}},"issues-advanced-search":{"name":"advanced_search","description":"Set to `true` to use advanced search.\nExample: `http://api.github.com/search/issues?q={query}&advanced_search=true`","in":"query","required":false,"schema":{"type":"string"}},"job-id":{"name":"job_id","description":"The unique identifier of the job.","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},"labels":{"name":"labels","description":"A list of comma separated label names. Example: `bug,ui,@high`","in":"query","required":false,"schema":{"type":"string"}},"milestone-number":{"name":"milestone_number","description":"The number that identifies the milestone.","in":"path","required":true,"schema":{"type":"integer"}},"order":{"name":"order","description":"Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.","in":"query","required":false,"schema":{"type":"string","enum":["desc","asc"],"default":"desc"}},"org":{"name":"org","description":"The organization name. The name is not case sensitive.","in":"path","required":true,"schema":{"type":"string"}},"owner":{"name":"owner","description":"The account owner of the repository. The name is not case sensitive.","in":"path","required":true,"schema":{"type":"string"}},"page":{"name":"page","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","in":"query","schema":{"type":"integer","default":1}},"pagination-after":{"name":"after","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","in":"query","required":false,"schema":{"type":"string"}},"pagination-before":{"name":"before","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","in":"query","required":false,"schema":{"type":"string"}},"per-page":{"name":"per_page","description":"The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","in":"query","schema":{"type":"integer","default":30}},"pr-alias":{"name":"pr","description":"The number of the pull request for the results you want to list.","in":"query","required":false,"schema":{"type":"integer"}},"pull-number":{"name":"pull_number","description":"The number that identifies the pull request.","in":"path","required":true,"schema":{"type":"integer"}},"release-id":{"name":"release_id","description":"The unique identifier of the release.","in":"path","required":true,"schema":{"type":"integer"}},"repo":{"name":"repo","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","in":"path","required":true,"schema":{"type":"string"}},"review-id":{"name":"review_id","description":"The unique identifier of the review.","in":"path","required":true,"schema":{"type":"integer"}},"run-id":{"name":"run_id","description":"The unique identifier of the workflow run.","in":"path","required":true,"schema":{"type":"integer"}},"search-type":{"name":"search_type","description":"The type of search to perform on issues. When not specified, the default is lexical search.\n\n- `semantic` — performs a pure semantic (vector) search using embedding-based understanding.\n- `hybrid` — combines semantic search with lexical search for best results.\n\nSemantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (`/search/issues`).","in":"query","required":false,"schema":{"type":"string","enum":["semantic","hybrid"]}},"secret-scanning-alert-assignee":{"name":"assignee","in":"query","description":"Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.","required":false,"schema":{"type":"string"}},"secret-scanning-alert-bypassed":{"name":"is_bypassed","in":"query","description":"A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.","required":false,"schema":{"type":"boolean"}},"secret-scanning-alert-exclude-providers":{"name":"exclude_providers","in":"query","description":"A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`).\nYou can find the provider slug in the `provider_slug` field of each alert.\nCannot be combined with the `providers` parameter.","required":false,"schema":{"type":"string"}},"secret-scanning-alert-exclude-secret-types":{"name":"exclude_secret_types","in":"query","description":"A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.","required":false,"schema":{"type":"string"}},"secret-scanning-alert-hide-secret":{"name":"hide_secret","in":"query","description":"A boolean value representing whether or not to hide literal secrets in the results.","required":false,"schema":{"type":"boolean","default":false}},"secret-scanning-alert-included-metadata":{"name":"included_metadata","in":"query","description":"A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the\nspecified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`,\n`owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`,\n`organization-id`, `last-used-date`, and `has-organization-access`.","required":false,"schema":{"type":"string"}},"secret-scanning-alert-multi-repo":{"name":"is_multi_repo","in":"query","description":"A boolean value representing whether or not to filter alerts by the multi-repo tag being present.","required":false,"schema":{"type":"boolean","default":false}},"secret-scanning-alert-owner-email-hash":{"name":"owner_email_hash","in":"query","description":"Filters alerts to only those whose attached `owner_email` metadata field matches the\nprovided value. The value must be the lowercase hex-encoded SHA-256 hash of the email\naddress to match (for example, the SHA-256 of `user@example.com`). Only alerts that\nhave an `owner_email` metadata value whose SHA-256 hash equals this parameter are\nreturned.","required":false,"schema":{"type":"string"}},"secret-scanning-alert-providers":{"name":"providers","in":"query","description":"A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`).\nYou can find the provider slug in the `provider_slug` field of each alert.\nCannot be combined with the `exclude_providers` parameter.","required":false,"schema":{"type":"string"}},"secret-scanning-alert-publicly-leaked":{"name":"is_publicly_leaked","in":"query","description":"A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.","required":false,"schema":{"type":"boolean","default":false}},"secret-scanning-alert-resolution":{"name":"resolution","in":"query","description":"A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.","required":false,"schema":{"type":"string"}},"secret-scanning-alert-secret-type":{"name":"secret_type","in":"query","description":"A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.","required":false,"schema":{"type":"string"}},"secret-scanning-alert-sort":{"name":"sort","description":"The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.","in":"query","required":false,"schema":{"type":"string","enum":["created","updated"],"default":"created"}},"secret-scanning-alert-state":{"name":"state","in":"query","description":"Set to `open` or `resolved` to only list secret scanning alerts in a specific state.","required":false,"schema":{"type":"string","enum":["open","resolved"]}},"secret-scanning-alert-validity":{"name":"validity","in":"query","description":"A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.","required":false,"schema":{"type":"string"}},"secret-scanning-pagination-after-org-repo":{"name":"after","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.","in":"query","required":false,"schema":{"type":"string"}},"secret-scanning-pagination-before-org-repo":{"name":"before","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.","in":"query","required":false,"schema":{"type":"string"}},"since":{"name":"since","description":"Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},"since-org":{"name":"since","description":"An organization ID. Only return organizations with an ID greater than this ID.","in":"query","required":false,"schema":{"type":"integer"}},"since-repo":{"name":"since","description":"A repository ID. Only return repositories with an ID greater than this ID.","in":"query","required":false,"schema":{"type":"integer"}},"since-user":{"name":"since","description":"A user ID. Only return users with an ID greater than this ID.","in":"query","required":false,"schema":{"type":"integer"}},"sort":{"name":"sort","description":"The property to sort the results by.","in":"query","required":false,"schema":{"type":"string","enum":["created","updated"],"default":"created"}},"sort-starred":{"name":"sort","description":"The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.","in":"query","required":false,"schema":{"type":"string","enum":["created","updated"],"default":"created"}},"status":{"name":"status","description":"Returns check runs with the specified `status`.","in":"query","required":false,"schema":{"type":"string","enum":["queued","in_progress","completed"]}},"team-slug":{"name":"team_slug","description":"The slug of the team name.","in":"path","required":true,"schema":{"type":"string"}},"team-type":{"name":"team_type","description":"Filter team results by their type. For more information, see \"[What kind of team should I use?](https://docs.github.com/enterprise-cloud@latest/admin/concepts/enterprise-fundamentals/teams-in-an-enterprise#what-kind-of-team-should-i-use)\"","in":"query","required":false,"schema":{"type":"string","enum":["all","enterprise","organization"],"default":"all"}},"tool-guid":{"name":"tool_guid","description":"The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.","in":"query","required":false,"schema":{"$ref":"#/components/schemas/code-scanning-analysis-tool-guid"}},"tool-name":{"name":"tool_name","description":"The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.","in":"query","required":false,"schema":{"$ref":"#/components/schemas/code-scanning-analysis-tool-name"}},"username":{"name":"username","description":"The handle for the GitHub user account.","in":"path","required":true,"schema":{"type":"string"}},"workflow-id":{"name":"workflow_id","in":"path","description":"The ID of the workflow. You can also pass the workflow file name as a string.","required":true,"schema":{"oneOf":[{"type":"integer"},{"type":"string"}]}},"workflow-run-branch":{"name":"branch","description":"Returns workflow runs associated with a branch. Use the name of the branch of the `push`.","in":"query","required":false,"schema":{"type":"string"}},"workflow-run-check-suite-id":{"name":"check_suite_id","description":"Returns workflow runs with the `check_suite_id` that you specify.","in":"query","schema":{"type":"integer","format":"int64"}},"workflow-run-head-sha":{"name":"head_sha","description":"Only returns workflow runs that are associated with the specified `head_sha`.","in":"query","required":false,"schema":{"type":"string"}},"workflow-run-status":{"name":"status","description":"Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.","in":"query","required":false,"schema":{"type":"string","enum":["completed","action_required","cancelled","failure","neutral","skipped","stale","success","timed_out","in_progress","queued","requested","waiting","pending"]}}},"responses":{"bad_request":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/basic-error"}},"application/scim+json":{"schema":{"$ref":"#/components/schemas/scim-error"}}}},"code_scanning_forbidden_read":{"description":"Response if GitHub Advanced Security is not enabled for this repository","content":{"application/json":{"schema":{"$ref":"#/components/schemas/basic-error"}}}},"code_scanning_forbidden_write":{"description":"Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository","content":{"application/json":{"schema":{"$ref":"#/components/schemas/basic-error"}}}},"conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/basic-error"}}}},"enterprise_team_unsupported":{"description":"Unprocessable entity if you attempt to modify an enterprise team at the organization level."},"forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/basic-error"}}}},"forbidden_gist":{"description":"Forbidden Gist","content":{"application/json":{"schema":{"type":"object","properties":{"block":{"type":"object","properties":{"reason":{"type":"string"},"created_at":{"type":"string"},"html_url":{"type":"string","nullable":true}}},"message":{"type":"string"},"documentation_url":{"type":"string"}}}}}},"found":{"description":"Found"},"gone":{"description":"Gone","content":{"application/json":{"schema":{"$ref":"#/components/schemas/basic-error"}}}},"internal_error":{"description":"Internal Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/basic-error"}}}},"moved_permanently":{"description":"Moved permanently","content":{"application/json":{"schema":{"$ref":"#/components/schemas/basic-error"}}}},"not_found":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/basic-error"}}}},"not_modified":{"description":"Not modified"},"requires_authentication":{"description":"Requires authentication","content":{"application/json":{"schema":{"$ref":"#/components/schemas/basic-error"}}}},"service_unavailable":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"documentation_url":{"type":"string"}}}}}},"temporary_redirect":{"description":"Temporary Redirect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/basic-error"}}}},"unacceptable":{"description":"Unacceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/basic-error"}}}},"validation_failed":{"description":"Validation failed, or the endpoint has been spammed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validation-error"}}}},"validation_failed_simple":{"description":"Validation failed, or the endpoint has been spammed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validation-error-simple"}}}}},"schemas":{"added-to-project-issue-event":{"title":"Added to Project Issue Event","description":"Added to Project Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"project_card":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string","format":"uri"},"project_id":{"type":"integer"},"project_url":{"type":"string","format":"uri"},"column_name":{"type":"string"},"previous_column_name":{"type":"string"}},"required":["id","url","project_id","project_url","column_name"]}},"required":["id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"alert-auto-dismissed-at":{"type":"string","description":"The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.","format":"date-time","readOnly":true,"nullable":true},"alert-created-at":{"type":"string","description":"The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.","format":"date-time","readOnly":true},"alert-dismissed-at":{"type":"string","description":"The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.","format":"date-time","readOnly":true,"nullable":true},"alert-fixed-at":{"type":"string","description":"The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.","format":"date-time","readOnly":true,"nullable":true},"alert-html-url":{"type":"string","description":"The GitHub URL of the alert resource.","format":"uri","readOnly":true},"alert-instances-url":{"type":"string","description":"The REST API URL for fetching the list of instances for an alert.","format":"uri","readOnly":true},"alert-number":{"type":"integer","description":"The security alert number.","readOnly":true},"alert-updated-at":{"type":"string","description":"The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.","format":"date-time","readOnly":true},"alert-url":{"type":"string","description":"The REST API URL of the alert resource.","format":"uri","readOnly":true},"app-permissions":{"title":"App Permissions","type":"object","description":"The permissions granted to the fine-grained access token.","properties":{"actions":{"type":"string","description":"The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.","enum":["read","write"]},"administration":{"type":"string","description":"The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.","enum":["read","write"]},"artifact_metadata":{"type":"string","description":"The level of permission to grant the access token to create and retrieve build artifact metadata records.","enum":["read","write"]},"attestations":{"type":"string","description":"The level of permission to create and retrieve the access token for repository attestations.","enum":["read","write"]},"checks":{"type":"string","description":"The level of permission to grant the access token for checks on code.","enum":["read","write"]},"code_quality":{"type":"string","description":"The level of permission to grant the access token to view and manage code quality data.","enum":["read","write"]},"codespaces":{"type":"string","description":"The level of permission to grant the access token to create, edit, delete, and list Codespaces.","enum":["read","write"]},"contents":{"type":"string","description":"The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.","enum":["read","write"]},"dependabot_secrets":{"type":"string","description":"The level of permission to grant the access token to manage Dependabot secrets.","enum":["read","write"]},"deployments":{"type":"string","description":"The level of permission to grant the access token for deployments and deployment statuses.","enum":["read","write"]},"discussions":{"type":"string","description":"The level of permission to grant the access token for discussions and related comments and labels.","enum":["read","write"]},"environments":{"type":"string","description":"The level of permission to grant the access token for managing repository environments.","enum":["read","write"]},"issues":{"type":"string","description":"The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.","enum":["read","write"]},"merge_queues":{"type":"string","description":"The level of permission to grant the access token to manage the merge queues for a repository.","enum":["read","write"]},"metadata":{"type":"string","description":"The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.","enum":["read","write"]},"packages":{"type":"string","description":"The level of permission to grant the access token for packages published to GitHub Packages.","enum":["read","write"]},"pages":{"type":"string","description":"The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.","enum":["read","write"]},"pull_requests":{"type":"string","description":"The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.","enum":["read","write"]},"repository_custom_properties":{"type":"string","description":"The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.","enum":["read","write"]},"repository_hooks":{"type":"string","description":"The level of permission to grant the access token to manage the post-receive hooks for a repository.","enum":["read","write"]},"repository_projects":{"type":"string","description":"The level of permission to grant the access token to manage repository projects, columns, and cards.","enum":["read","write","admin"]},"secret_scanning_alerts":{"type":"string","description":"The level of permission to grant the access token to view and manage secret scanning alerts.","enum":["read","write"]},"secrets":{"type":"string","description":"The level of permission to grant the access token to manage repository secrets.","enum":["read","write"]},"security_events":{"type":"string","description":"The level of permission to grant the access token to view and manage security events like code scanning alerts.","enum":["read","write"]},"single_file":{"type":"string","description":"The level of permission to grant the access token to manage just a single file.","enum":["read","write"]},"statuses":{"type":"string","description":"The level of permission to grant the access token for commit statuses.","enum":["read","write"]},"vulnerability_alerts":{"type":"string","description":"The level of permission to grant the access token to manage Dependabot alerts.","enum":["read","write"]},"workflows":{"type":"string","description":"The level of permission to grant the access token to update GitHub Actions workflow files.","enum":["write"]},"custom_properties_for_organizations":{"type":"string","description":"The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.","enum":["read","write"]},"members":{"type":"string","description":"The level of permission to grant the access token for organization teams and members.","enum":["read","write"]},"organization_administration":{"type":"string","description":"The level of permission to grant the access token to manage access to an organization.","enum":["read","write"]},"organization_custom_roles":{"type":"string","description":"The level of permission to grant the access token for custom repository roles management.","enum":["read","write"]},"organization_custom_org_roles":{"type":"string","description":"The level of permission to grant the access token for custom organization roles management.","enum":["read","write"]},"organization_custom_properties":{"type":"string","description":"The level of permission to grant the access token for repository custom properties management at the organization level.","enum":["read","write","admin"]},"organization_copilot_seat_management":{"type":"string","description":"The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.","enum":["read","write"]},"organization_copilot_agent_settings":{"type":"string","description":"The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.","enum":["read","write"]},"organization_announcement_banners":{"type":"string","description":"The level of permission to grant the access token to view and manage announcement banners for an organization.","enum":["read","write"]},"organization_events":{"type":"string","description":"The level of permission to grant the access token to view events triggered by an activity in an organization.","enum":["read"]},"organization_hooks":{"type":"string","description":"The level of permission to grant the access token to manage the post-receive hooks for an organization.","enum":["read","write"]},"organization_personal_access_tokens":{"type":"string","description":"The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.","enum":["read","write"]},"organization_personal_access_token_requests":{"type":"string","description":"The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.","enum":["read","write"]},"organization_plan":{"type":"string","description":"The level of permission to grant the access token for viewing an organization's plan.","enum":["read"]},"organization_projects":{"type":"string","description":"The level of permission to grant the access token to manage organization projects and projects public preview (where available).","enum":["read","write","admin"]},"organization_packages":{"type":"string","description":"The level of permission to grant the access token for organization packages published to GitHub Packages.","enum":["read","write"]},"organization_secrets":{"type":"string","description":"The level of permission to grant the access token to manage organization secrets.","enum":["read","write"]},"organization_self_hosted_runners":{"type":"string","description":"The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.","enum":["read","write"]},"organization_user_blocking":{"type":"string","description":"The level of permission to grant the access token to view and manage users blocked by the organization.","enum":["read","write"]},"email_addresses":{"type":"string","description":"The level of permission to grant the access token to manage the email addresses belonging to a user.","enum":["read","write"]},"followers":{"type":"string","description":"The level of permission to grant the access token to manage the followers belonging to a user.","enum":["read","write"]},"git_ssh_keys":{"type":"string","description":"The level of permission to grant the access token to manage git SSH keys.","enum":["read","write"]},"gpg_keys":{"type":"string","description":"The level of permission to grant the access token to view and manage GPG keys belonging to a user.","enum":["read","write"]},"interaction_limits":{"type":"string","description":"The level of permission to grant the access token to view and manage interaction limits on a repository.","enum":["read","write"]},"profile":{"type":"string","description":"The level of permission to grant the access token to manage the profile settings belonging to a user.","enum":["write"]},"starring":{"type":"string","description":"The level of permission to grant the access token to list and manage repositories a user is starring.","enum":["read","write"]},"enterprise_custom_properties_for_organizations":{"type":"string","description":"The level of permission to grant the access token for organization custom properties management at the enterprise level.","enum":["read","write","admin"]}}},"artifact":{"title":"Artifact","description":"An artifact","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"name":{"description":"The name of the artifact.","type":"string"},"size_in_bytes":{"description":"The size in bytes of the artifact.","type":"integer"},"url":{"type":"string"},"archive_download_url":{"type":"string"},"expired":{"description":"Whether or not the artifact has expired.","type":"boolean"},"created_at":{"type":"string","format":"date-time","nullable":true},"expires_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true},"digest":{"type":"string","description":"The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null.","nullable":true},"workflow_run":{"type":"object","nullable":true,"properties":{"id":{"type":"integer"},"repository_id":{"type":"integer"},"head_repository_id":{"type":"integer"},"head_branch":{"type":"string"},"head_sha":{"type":"string"}}}},"required":["id","node_id","name","size_in_bytes","url","archive_download_url","expired","created_at","expires_at","updated_at"]},"assigned-issue-event":{"title":"Assigned Issue Event","description":"Assigned Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/integration"},"assignee":{"$ref":"#/components/schemas/simple-user"},"assigner":{"$ref":"#/components/schemas/simple-user"},"intent":{"$ref":"#/components/schemas/nullable-issue-event-intent"}},"required":["id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app","assignee","assigner"]},"author-association":{"title":"author_association","type":"string","description":"How the author is associated with the repository.","enum":["COLLABORATOR","CONTRIBUTOR","FIRST_TIMER","FIRST_TIME_CONTRIBUTOR","MANNEQUIN","MEMBER","NONE","OWNER"]},"auto-merge":{"title":"Auto merge","description":"The status of auto merging a pull request.","type":"object","properties":{"enabled_by":{"$ref":"#/components/schemas/simple-user"},"merge_method":{"type":"string","description":"The merge method to use.","enum":["merge","squash","rebase"]},"commit_title":{"type":"string","description":"Title for the merge commit message."},"commit_message":{"type":"string","description":"Commit message for the merge commit."}},"required":["enabled_by","merge_method","commit_title","commit_message"],"nullable":true},"base-gist":{"title":"Base Gist","description":"Base Gist","type":"object","properties":{"url":{"type":"string","format":"uri"},"forks_url":{"type":"string","format":"uri"},"commits_url":{"type":"string","format":"uri"},"id":{"type":"string"},"node_id":{"type":"string"},"git_pull_url":{"type":"string","format":"uri"},"git_push_url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"files":{"type":"object","additionalProperties":{"type":"object","properties":{"filename":{"type":"string"},"type":{"type":"string"},"language":{"type":"string"},"raw_url":{"type":"string"},"size":{"type":"integer"},"encoding":{"type":"string","description":"The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.","default":"utf-8"}}}},"public":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"description":{"type":"string","nullable":true},"comments":{"type":"integer"},"comments_enabled":{"type":"boolean"},"user":{"$ref":"#/components/schemas/nullable-simple-user"},"comments_url":{"type":"string","format":"uri"},"owner":{"$ref":"#/components/schemas/simple-user"},"truncated":{"type":"boolean"},"forks":{"type":"array","items":{}},"history":{"type":"array","items":{}}},"required":["id","node_id","url","forks_url","commits_url","git_pull_url","git_push_url","html_url","comments_url","public","description","comments","user","files","created_at","updated_at"],"x-github-breaking-changes":[{"changeset":"deprecate_beta_media_type","patch":{"properties":{"user":null},"required":["id","node_id","url","forks_url","commits_url","git_pull_url","git_push_url","html_url","comments_url","public","description","comments","files","created_at","updated_at"]},"version":"2026-03-10"},{"changeset":"remove_forks_history_from_base_gist","patch":[{"op":"remove","path":"/properties/forks"},{"op":"remove","path":"/properties/history"}],"version":"2026-03-10"}]},"basic-error":{"title":"Basic Error","description":"Basic Error","type":"object","properties":{"message":{"type":"string"},"documentation_url":{"type":"string"},"url":{"type":"string"},"status":{"type":"string"}}},"blocked-by-added-issue-event":{"title":"Blocked-by Added Issue Event","description":"Blocked-by Added Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"blocked_by":{"$ref":"#/components/schemas/nullable-issue-reference"}},"required":["blocked_by","id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"blocked-by-removed-issue-event":{"title":"Blocked-by Removed Issue Event","description":"Blocked-by Removed Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"blocked_by":{"$ref":"#/components/schemas/nullable-issue-reference"}},"required":["blocked_by","id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"blocking-added-issue-event":{"title":"Blocking Added Issue Event","description":"Blocking Added Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"blocking":{"$ref":"#/components/schemas/nullable-issue-reference"}},"required":["blocking","id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"blocking-removed-issue-event":{"title":"Blocking Removed Issue Event","description":"Blocking Removed Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"blocking":{"$ref":"#/components/schemas/nullable-issue-reference"}},"required":["blocking","id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"branch-protection":{"title":"Branch Protection","description":"Branch Protection","type":"object","properties":{"url":{"type":"string"},"enabled":{"type":"boolean"},"required_status_checks":{"$ref":"#/components/schemas/protected-branch-required-status-check"},"enforce_admins":{"$ref":"#/components/schemas/protected-branch-admin-enforced"},"required_pull_request_reviews":{"$ref":"#/components/schemas/protected-branch-pull-request-review"},"restrictions":{"$ref":"#/components/schemas/branch-restriction-policy"},"required_linear_history":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"allow_force_pushes":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"allow_deletions":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"block_creations":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"required_conversation_resolution":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"name":{"type":"string"},"protection_url":{"type":"string"},"required_signatures":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"enabled":{"type":"boolean"}},"required":["url","enabled"]},"lock_branch":{"type":"object","description":"Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.","properties":{"enabled":{"default":false,"type":"boolean"}}},"allow_fork_syncing":{"type":"object","description":"Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing.","properties":{"enabled":{"default":false,"type":"boolean"}}}}},"branch-restriction-policy":{"title":"Branch Restriction Policy","description":"Branch Restriction Policy","type":"object","properties":{"url":{"type":"string","format":"uri"},"users_url":{"type":"string","format":"uri"},"teams_url":{"type":"string","format":"uri"},"apps_url":{"type":"string","format":"uri"},"users":{"type":"array","items":{"type":"object","properties":{"login":{"type":"string"},"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"avatar_url":{"type":"string"},"gravatar_id":{"type":"string"},"url":{"type":"string"},"html_url":{"type":"string"},"followers_url":{"type":"string"},"following_url":{"type":"string"},"gists_url":{"type":"string"},"starred_url":{"type":"string"},"subscriptions_url":{"type":"string"},"organizations_url":{"type":"string"},"repos_url":{"type":"string"},"events_url":{"type":"string"},"received_events_url":{"type":"string"},"type":{"type":"string"},"site_admin":{"type":"boolean"},"user_view_type":{"type":"string"}}}},"teams":{"type":"array","items":{"$ref":"#/components/schemas/team"}},"apps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"slug":{"type":"string"},"node_id":{"type":"string"},"owner":{"type":"object","properties":{"login":{"type":"string"},"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"repos_url":{"type":"string"},"events_url":{"type":"string"},"hooks_url":{"type":"string"},"issues_url":{"type":"string"},"members_url":{"type":"string"},"public_members_url":{"type":"string"},"avatar_url":{"type":"string"},"description":{"type":"string"},"gravatar_id":{"type":"string"},"html_url":{"type":"string"},"followers_url":{"type":"string"},"following_url":{"type":"string"},"gists_url":{"type":"string"},"starred_url":{"type":"string"},"subscriptions_url":{"type":"string"},"organizations_url":{"type":"string"},"received_events_url":{"type":"string"},"type":{"type":"string"},"site_admin":{"type":"boolean"},"user_view_type":{"type":"string"}}},"name":{"type":"string"},"client_id":{"type":"string"},"description":{"type":"string"},"external_url":{"type":"string"},"html_url":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"permissions":{"type":"object","properties":{"metadata":{"type":"string"},"contents":{"type":"string"},"issues":{"type":"string"},"single_file":{"type":"string"}}},"events":{"type":"array","items":{"type":"string"}}}}}},"required":["url","users_url","teams_url","apps_url","users","teams","apps"]},"branch-with-protection":{"title":"Branch With Protection","description":"Branch With Protection","type":"object","properties":{"name":{"type":"string"},"commit":{"$ref":"#/components/schemas/commit"},"_links":{"type":"object","properties":{"html":{"type":"string"},"self":{"type":"string","format":"uri"}},"required":["html","self"]},"protected":{"type":"boolean"},"protection":{"$ref":"#/components/schemas/branch-protection"},"protection_url":{"type":"string","format":"uri"},"pattern":{"type":"string"},"required_approving_review_count":{"type":"integer"}},"required":["name","commit","_links","protection","protected","protection_url"]},"check-run":{"title":"CheckRun","description":"A check performed on the code of a given code change","type":"object","properties":{"id":{"description":"The id of the check.","type":"integer","format":"int64"},"head_sha":{"description":"The SHA of the commit that is being checked.","type":"string"},"node_id":{"type":"string"},"external_id":{"type":"string","nullable":true},"url":{"type":"string"},"html_url":{"type":"string","nullable":true},"details_url":{"type":"string","nullable":true},"status":{"description":"The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.","type":"string","enum":["queued","in_progress","completed","waiting","requested","pending"]},"conclusion":{"type":"string","enum":["success","failure","neutral","cancelled","skipped","timed_out","action_required"],"nullable":true},"started_at":{"type":"string","format":"date-time","nullable":true},"completed_at":{"type":"string","format":"date-time","nullable":true},"output":{"type":"object","properties":{"title":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"text":{"type":"string","nullable":true},"annotations_count":{"type":"integer"},"annotations_url":{"type":"string","format":"uri"}},"required":["title","summary","text","annotations_count","annotations_url"]},"name":{"description":"The name of the check.","type":"string"},"check_suite":{"type":"object","properties":{"id":{"type":"integer"}},"required":["id"],"nullable":true},"app":{"$ref":"#/components/schemas/nullable-integration"},"pull_requests":{"description":"Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check.","type":"array","items":{"$ref":"#/components/schemas/pull-request-minimal"}},"deployment":{"$ref":"#/components/schemas/deployment-simple"}},"required":["id","node_id","head_sha","name","url","html_url","details_url","status","conclusion","started_at","completed_at","external_id","check_suite","output","app","pull_requests"]},"check-suite":{"title":"CheckSuite","description":"A suite of checks performed on the code of a given code change","type":"object","properties":{"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"head_branch":{"type":"string","nullable":true},"head_sha":{"description":"The SHA of the head commit that is being checked.","type":"string"},"status":{"type":"string","description":"The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.","enum":["queued","in_progress","completed","waiting","requested","pending"],"nullable":true},"conclusion":{"type":"string","enum":["success","failure","neutral","cancelled","skipped","timed_out","action_required","startup_failure","stale",null],"nullable":true},"url":{"type":"string","nullable":true},"before":{"type":"string","nullable":true},"after":{"type":"string","nullable":true},"pull_requests":{"type":"array","items":{"$ref":"#/components/schemas/pull-request-minimal"},"nullable":true},"app":{"$ref":"#/components/schemas/nullable-integration"},"repository":{"$ref":"#/components/schemas/minimal-repository"},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true},"head_commit":{"$ref":"#/components/schemas/simple-commit"},"latest_check_runs_count":{"type":"integer"},"check_runs_url":{"type":"string"},"rerequestable":{"type":"boolean"},"runs_rerequestable":{"type":"boolean"}},"required":["id","node_id","head_branch","status","conclusion","head_sha","url","before","after","created_at","updated_at","app","head_commit","repository","latest_check_runs_count","check_runs_url","pull_requests"]},"code-of-conduct":{"title":"Code Of Conduct","description":"Code Of Conduct","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"url":{"type":"string","format":"uri"},"body":{"type":"string"},"html_url":{"type":"string","format":"uri","nullable":true}},"required":["url","html_url","key","name"]},"code-of-conduct-simple":{"title":"Code Of Conduct Simple","description":"Code of Conduct Simple","type":"object","properties":{"url":{"type":"string","format":"uri"},"key":{"type":"string"},"name":{"type":"string"},"html_url":{"type":"string","nullable":true,"format":"uri"}},"required":["url","key","name","html_url"]},"code-scanning-alert":{"type":"object","properties":{"number":{"$ref":"#/components/schemas/alert-number"},"created_at":{"$ref":"#/components/schemas/alert-created-at"},"updated_at":{"$ref":"#/components/schemas/alert-updated-at"},"url":{"$ref":"#/components/schemas/alert-url"},"html_url":{"$ref":"#/components/schemas/alert-html-url"},"instances_url":{"$ref":"#/components/schemas/alert-instances-url"},"state":{"$ref":"#/components/schemas/code-scanning-alert-state"},"fixed_at":{"$ref":"#/components/schemas/alert-fixed-at"},"dismissed_by":{"$ref":"#/components/schemas/nullable-simple-user"},"dismissed_at":{"$ref":"#/components/schemas/alert-dismissed-at"},"dismissed_reason":{"$ref":"#/components/schemas/code-scanning-alert-dismissed-reason"},"dismissed_comment":{"$ref":"#/components/schemas/code-scanning-alert-dismissed-comment"},"rule":{"$ref":"#/components/schemas/code-scanning-alert-rule"},"tool":{"$ref":"#/components/schemas/code-scanning-analysis-tool"},"most_recent_instance":{"$ref":"#/components/schemas/code-scanning-alert-instance"},"dismissal_approved_by":{"$ref":"#/components/schemas/nullable-simple-user"},"assignees":{"type":"array","items":{"$ref":"#/components/schemas/simple-user"}},"linked_pull_requests":{"description":"Pull requests linked to this alert.","type":"array","items":{"$ref":"#/components/schemas/pull-request-simple"}}},"required":["number","created_at","url","html_url","instances_url","state","dismissed_by","dismissed_at","dismissed_reason","rule","tool","most_recent_instance"]},"code-scanning-alert-assignees":{"description":"The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert.","type":"array","items":{"type":"string"}},"code-scanning-alert-classification":{"type":"string","description":"A classification of the file. For example to identify it as generated.","nullable":true,"enum":["source","generated","test","library"]},"code-scanning-alert-create-request":{"type":"boolean","description":"If `true`, attempt to create an alert dismissal request."},"code-scanning-alert-dismissed-comment":{"type":"string","description":"The dismissal comment associated with the dismissal of the alert.","nullable":true,"maxLength":280},"code-scanning-alert-dismissed-reason":{"type":"string","description":"**Required when the state is dismissed.** The reason for dismissing or closing the alert.","nullable":true,"enum":["false positive","won't fix","used in tests","mitigated"]},"code-scanning-alert-environment":{"type":"string","description":"Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed."},"code-scanning-alert-instance":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/code-scanning-ref"},"analysis_key":{"$ref":"#/components/schemas/code-scanning-analysis-analysis-key"},"environment":{"$ref":"#/components/schemas/code-scanning-alert-environment"},"category":{"$ref":"#/components/schemas/code-scanning-analysis-category"},"state":{"$ref":"#/components/schemas/code-scanning-alert-state"},"commit_sha":{"type":"string"},"message":{"type":"object","properties":{"text":{"type":"string"},"markdown":{"type":"string","description":"The message text as GitHub-flavored Markdown, with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance."}}},"location":{"$ref":"#/components/schemas/code-scanning-alert-location"},"html_url":{"type":"string"},"classifications":{"type":"array","description":"Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.","items":{"$ref":"#/components/schemas/code-scanning-alert-classification"}}}},"code-scanning-alert-items":{"type":"object","properties":{"number":{"$ref":"#/components/schemas/alert-number"},"created_at":{"$ref":"#/components/schemas/alert-created-at"},"updated_at":{"$ref":"#/components/schemas/alert-updated-at"},"url":{"$ref":"#/components/schemas/alert-url"},"html_url":{"$ref":"#/components/schemas/alert-html-url"},"instances_url":{"$ref":"#/components/schemas/alert-instances-url"},"state":{"$ref":"#/components/schemas/code-scanning-alert-state"},"fixed_at":{"$ref":"#/components/schemas/alert-fixed-at"},"dismissed_by":{"$ref":"#/components/schemas/nullable-simple-user"},"dismissed_at":{"$ref":"#/components/schemas/alert-dismissed-at"},"dismissed_reason":{"$ref":"#/components/schemas/code-scanning-alert-dismissed-reason"},"dismissed_comment":{"$ref":"#/components/schemas/code-scanning-alert-dismissed-comment"},"rule":{"$ref":"#/components/schemas/code-scanning-alert-rule-summary"},"tool":{"$ref":"#/components/schemas/code-scanning-analysis-tool"},"most_recent_instance":{"$ref":"#/components/schemas/code-scanning-alert-instance"},"dismissal_approved_by":{"$ref":"#/components/schemas/nullable-simple-user"},"assignees":{"type":"array","items":{"$ref":"#/components/schemas/simple-user"}}},"required":["number","created_at","url","html_url","instances_url","state","dismissed_by","dismissed_at","dismissed_reason","rule","tool","most_recent_instance"]},"code-scanning-alert-location":{"type":"object","description":"Describe a region within a file for the alert.","properties":{"path":{"type":"string"},"start_line":{"type":"integer"},"end_line":{"type":"integer"},"start_column":{"type":"integer"},"end_column":{"type":"integer"}}},"code-scanning-alert-rule":{"type":"object","properties":{"id":{"nullable":true,"type":"string","description":"A unique identifier for the rule used to detect the alert."},"name":{"type":"string","description":"The name of the rule used to detect the alert."},"severity":{"nullable":true,"type":"string","description":"The severity of the alert.","enum":["none","note","warning","error"]},"security_severity_level":{"nullable":true,"type":"string","description":"The security severity of the alert.","enum":["low","medium","high","critical"]},"description":{"type":"string","description":"A short description of the rule used to detect the alert."},"full_description":{"type":"string","description":"A description of the rule used to detect the alert."},"tags":{"nullable":true,"type":"array","description":"A set of tags applicable for the rule.","items":{"type":"string"}},"help":{"nullable":true,"type":"string","description":"Detailed documentation for the rule as GitHub Flavored Markdown."},"help_uri":{"nullable":true,"type":"string","description":"A link to the documentation for the rule used to detect the alert."}}},"code-scanning-alert-rule-summary":{"type":"object","properties":{"id":{"nullable":true,"type":"string","description":"A unique identifier for the rule used to detect the alert."},"name":{"type":"string","description":"The name of the rule used to detect the alert."},"severity":{"nullable":true,"type":"string","description":"The severity of the alert.","enum":["none","note","warning","error"]},"security_severity_level":{"nullable":true,"type":"string","description":"The security severity of the alert.","enum":["low","medium","high","critical"]},"description":{"type":"string","description":"A short description of the rule used to detect the alert."},"full_description":{"type":"string","description":"A description of the rule used to detect the alert."},"tags":{"nullable":true,"type":"array","description":"A set of tags applicable for the rule.","items":{"type":"string"}},"help":{"nullable":true,"type":"string","description":"Detailed documentation for the rule as GitHub Flavored Markdown."},"help_uri":{"nullable":true,"type":"string","description":"A link to the documentation for the rule used to detect the alert."}}},"code-scanning-alert-set-state":{"description":"Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.","type":"string","enum":["open","dismissed"]},"code-scanning-alert-severity":{"type":"string","description":"Severity of a code scanning alert.","enum":["critical","high","medium","low","warning","note","error"]},"code-scanning-alert-state":{"type":"string","description":"State of a code scanning alert.","nullable":true,"enum":["open","dismissed","fixed"]},"code-scanning-alert-state-query":{"type":"string","description":"State of a code scanning alert.","enum":["open","closed","dismissed","fixed"]},"code-scanning-analysis-analysis-key":{"type":"string","description":"Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name."},"code-scanning-analysis-category":{"type":"string","description":"Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code."},"code-scanning-analysis-tool":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/code-scanning-analysis-tool-name"},"version":{"$ref":"#/components/schemas/code-scanning-analysis-tool-version"},"guid":{"$ref":"#/components/schemas/code-scanning-analysis-tool-guid"}}},"code-scanning-analysis-tool-guid":{"nullable":true,"type":"string","description":"The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data."},"code-scanning-analysis-tool-name":{"type":"string","description":"The name of the tool used to generate the code scanning analysis."},"code-scanning-analysis-tool-version":{"nullable":true,"type":"string","description":"The version of the tool used to generate the code scanning analysis."},"code-scanning-organization-alert-items":{"type":"object","properties":{"number":{"$ref":"#/components/schemas/alert-number"},"created_at":{"$ref":"#/components/schemas/alert-created-at"},"updated_at":{"$ref":"#/components/schemas/alert-updated-at"},"url":{"$ref":"#/components/schemas/alert-url"},"html_url":{"$ref":"#/components/schemas/alert-html-url"},"instances_url":{"$ref":"#/components/schemas/alert-instances-url"},"state":{"$ref":"#/components/schemas/code-scanning-alert-state"},"fixed_at":{"$ref":"#/components/schemas/alert-fixed-at"},"dismissed_by":{"$ref":"#/components/schemas/nullable-simple-user"},"dismissed_at":{"$ref":"#/components/schemas/alert-dismissed-at"},"dismissed_reason":{"$ref":"#/components/schemas/code-scanning-alert-dismissed-reason"},"dismissed_comment":{"$ref":"#/components/schemas/code-scanning-alert-dismissed-comment"},"rule":{"$ref":"#/components/schemas/code-scanning-alert-rule-summary"},"tool":{"$ref":"#/components/schemas/code-scanning-analysis-tool"},"most_recent_instance":{"$ref":"#/components/schemas/code-scanning-alert-instance"},"repository":{"$ref":"#/components/schemas/simple-repository"},"dismissal_approved_by":{"$ref":"#/components/schemas/nullable-simple-user"},"assignees":{"type":"array","items":{"$ref":"#/components/schemas/simple-user"}}},"required":["number","created_at","url","html_url","instances_url","state","dismissed_by","dismissed_at","dismissed_reason","rule","tool","most_recent_instance","repository"]},"code-scanning-ref":{"type":"string","description":"The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`,\n`refs/heads/<branch name>` or simply `<branch name>`."},"collaborator":{"title":"Collaborator","description":"Collaborator","type":"object","properties":{"login":{"type":"string"},"id":{"type":"integer","format":"int64"},"email":{"nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"node_id":{"type":"string"},"avatar_url":{"type":"string","format":"uri"},"gravatar_id":{"type":"string","nullable":true},"url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"followers_url":{"type":"string","format":"uri"},"following_url":{"type":"string"},"gists_url":{"type":"string"},"starred_url":{"type":"string"},"subscriptions_url":{"type":"string","format":"uri"},"organizations_url":{"type":"string","format":"uri"},"repos_url":{"type":"string","format":"uri"},"events_url":{"type":"string"},"received_events_url":{"type":"string","format":"uri"},"type":{"type":"string"},"site_admin":{"type":"boolean"},"permissions":{"type":"object","properties":{"pull":{"type":"boolean"},"triage":{"type":"boolean"},"push":{"type":"boolean"},"maintain":{"type":"boolean"},"admin":{"type":"boolean"}},"required":["pull","push","admin"]},"role_name":{"type":"string"},"user_view_type":{"type":"string"}},"required":["avatar_url","events_url","followers_url","following_url","gists_url","gravatar_id","html_url","id","node_id","login","organizations_url","received_events_url","repos_url","site_admin","starred_url","subscriptions_url","type","url","role_name"]},"commit":{"title":"Commit","description":"Commit","type":"object","properties":{"url":{"type":"string","format":"uri"},"sha":{"type":"string"},"node_id":{"type":"string"},"html_url":{"type":"string","format":"uri"},"comments_url":{"type":"string","format":"uri"},"commit":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"author":{"$ref":"#/components/schemas/nullable-git-user"},"committer":{"$ref":"#/components/schemas/nullable-git-user"},"message":{"type":"string"},"comment_count":{"type":"integer"},"tree":{"type":"object","properties":{"sha":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["sha","url"]},"verification":{"$ref":"#/components/schemas/verification"}},"required":["author","committer","comment_count","message","tree","url"]},"author":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/simple-user"},{"$ref":"#/components/schemas/empty-object"}]},"committer":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/simple-user"},{"$ref":"#/components/schemas/empty-object"}]},"parents":{"type":"array","items":{"type":"object","properties":{"sha":{"type":"string"},"url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"}},"required":["sha","url"]}},"stats":{"type":"object","properties":{"additions":{"type":"integer"},"deletions":{"type":"integer"},"total":{"type":"integer"}}},"files":{"type":"array","items":{"$ref":"#/components/schemas/diff-entry"}}},"required":["url","sha","node_id","html_url","comments_url","commit","author","committer","parents"]},"commit-comment":{"title":"Commit Comment","description":"Commit Comment","type":"object","properties":{"html_url":{"type":"string","format":"uri"},"url":{"type":"string","format":"uri"},"id":{"type":"integer"},"node_id":{"type":"string"},"body":{"type":"string"},"path":{"type":"string","nullable":true},"position":{"type":"integer","nullable":true},"line":{"type":"integer","nullable":true},"commit_id":{"type":"string"},"user":{"$ref":"#/components/schemas/nullable-simple-user"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"author_association":{"$ref":"#/components/schemas/author-association"},"reactions":{"$ref":"#/components/schemas/reaction-rollup"}},"required":["url","html_url","id","node_id","user","position","line","path","commit_id","body","author_association","created_at","updated_at"]},"commit-search-result-item":{"title":"Commit Search Result Item","description":"Commit Search Result Item","type":"object","properties":{"url":{"type":"string","format":"uri"},"sha":{"type":"string"},"html_url":{"type":"string","format":"uri"},"comments_url":{"type":"string","format":"uri"},"commit":{"type":"object","properties":{"author":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"date":{"type":"string","format":"date-time"}},"required":["name","email","date"]},"committer":{"$ref":"#/components/schemas/nullable-git-user"},"comment_count":{"type":"integer"},"message":{"type":"string"},"tree":{"type":"object","properties":{"sha":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["sha","url"]},"url":{"type":"string","format":"uri"},"verification":{"$ref":"#/components/schemas/verification"}},"required":["author","committer","comment_count","message","tree","url"]},"author":{"$ref":"#/components/schemas/nullable-simple-user"},"committer":{"$ref":"#/components/schemas/nullable-git-user"},"parents":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"html_url":{"type":"string"},"sha":{"type":"string"}}}},"repository":{"$ref":"#/components/schemas/minimal-repository"},"score":{"type":"number"},"node_id":{"type":"string"},"text_matches":{"$ref":"#/components/schemas/search-result-text-matches"}},"required":["sha","node_id","url","html_url","author","committer","parents","comments_url","commit","repository","score"]},"converted-note-to-issue-issue-event":{"title":"Converted Note to Issue Issue Event","description":"Converted Note to Issue Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/integration"},"project_card":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string","format":"uri"},"project_id":{"type":"integer"},"project_url":{"type":"string","format":"uri"},"column_name":{"type":"string"},"previous_column_name":{"type":"string"}},"required":["id","url","project_id","project_url","column_name"]}},"required":["id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"cvss-severities":{"type":"object","nullable":true,"properties":{"cvss_v3":{"type":"object","nullable":true,"properties":{"vector_string":{"type":"string","description":"The CVSS 3 vector string.","nullable":true},"score":{"type":"number","description":"The CVSS 3 score.","minimum":0,"maximum":10,"nullable":true,"readOnly":true}},"required":["vector_string","score"]},"cvss_v4":{"type":"object","nullable":true,"properties":{"vector_string":{"type":"string","description":"The CVSS 4 vector string.","nullable":true},"score":{"type":"number","description":"The CVSS 4 score.","minimum":0,"maximum":10,"nullable":true,"readOnly":true}},"required":["vector_string","score"]}}},"demilestoned-issue-event":{"title":"Demilestoned Issue Event","description":"Demilestoned Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"milestone":{"type":"object","properties":{"title":{"type":"string"}},"required":["title"]}},"required":["milestone","id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"dependabot-alert":{"type":"object","description":"A Dependabot alert.","properties":{"number":{"$ref":"#/components/schemas/alert-number"},"state":{"type":"string","description":"The state of the Dependabot alert.","readOnly":true,"enum":["auto_dismissed","dismissed","fixed","open"]},"dependency":{"type":"object","description":"Details for the vulnerable dependency.","readOnly":true,"properties":{"package":{"$ref":"#/components/schemas/dependabot-alert-package"},"manifest_path":{"type":"string","description":"The full path to the dependency manifest file, relative to the root of the repository.","readOnly":true},"scope":{"type":"string","description":"The execution scope of the vulnerable dependency.","readOnly":true,"nullable":true,"enum":["development","runtime"]},"relationship":{"type":"string","description":"The vulnerable dependency's relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.\n","readOnly":true,"nullable":true,"enum":["unknown","direct","transitive","inconclusive"]}}},"security_advisory":{"$ref":"#/components/schemas/dependabot-alert-security-advisory"},"security_vulnerability":{"$ref":"#/components/schemas/dependabot-alert-security-vulnerability"},"url":{"$ref":"#/components/schemas/alert-url"},"html_url":{"$ref":"#/components/schemas/alert-html-url"},"created_at":{"$ref":"#/components/schemas/alert-created-at"},"updated_at":{"$ref":"#/components/schemas/alert-updated-at"},"dismissed_at":{"$ref":"#/components/schemas/alert-dismissed-at"},"dismissed_by":{"$ref":"#/components/schemas/nullable-simple-user"},"dismissed_reason":{"type":"string","description":"The reason that the alert was dismissed.","nullable":true,"enum":["fix_started","inaccurate","no_bandwidth","not_used","tolerable_risk"]},"dismissed_comment":{"type":"string","description":"An optional comment associated with the alert's dismissal.","nullable":true,"maxLength":280},"fixed_at":{"$ref":"#/components/schemas/alert-fixed-at"},"auto_dismissed_at":{"$ref":"#/components/schemas/alert-auto-dismissed-at"},"dismissal_request":{"$ref":"#/components/schemas/dependabot-alert-dismissal-request-simple"},"assignees":{"type":"array","description":"The users assigned to this alert.","readOnly":true,"items":{"$ref":"#/components/schemas/simple-user"}}},"required":["number","state","dependency","security_advisory","security_vulnerability","url","html_url","created_at","updated_at","dismissed_at","dismissed_by","dismissed_reason","dismissed_comment","fixed_at"],"additionalProperties":false},"dependabot-alert-dismissal-request-simple":{"title":"Dependabot alert dismissal request","description":"Information about an active dismissal request for this Dependabot alert.","type":"object","nullable":true,"properties":{"id":{"type":"integer","description":"The unique identifier of the dismissal request."},"status":{"type":"string","description":"The current status of the dismissal request.","enum":["pending","approved","rejected","cancelled"]},"requester":{"type":"object","description":"The user who requested the dismissal.","properties":{"id":{"type":"integer","description":"The unique identifier of the user."},"login":{"type":"string","description":"The login name of the user."}}},"created_at":{"type":"string","format":"date-time","description":"The date and time when the dismissal request was created."},"url":{"type":"string","format":"uri","description":"The API URL to get more information about this dismissal request."}}},"dependabot-alert-package":{"type":"object","description":"Details for the vulnerable package.","readOnly":true,"properties":{"ecosystem":{"type":"string","description":"The package's language or package management ecosystem.","readOnly":true},"name":{"type":"string","description":"The unique package name within its ecosystem.","readOnly":true}},"required":["ecosystem","name"],"additionalProperties":false},"dependabot-alert-security-advisory":{"type":"object","description":"Details for the GitHub Security Advisory.","readOnly":true,"properties":{"ghsa_id":{"type":"string","description":"The unique GitHub Security Advisory ID assigned to the advisory.","readOnly":true},"cve_id":{"type":"string","description":"The unique CVE ID assigned to the advisory.","readOnly":true,"nullable":true},"summary":{"type":"string","description":"A short, plain text summary of the advisory.","readOnly":true,"maxLength":1024},"description":{"type":"string","description":"A long-form Markdown-supported description of the advisory.","readOnly":true},"vulnerabilities":{"type":"array","description":"Vulnerable version range information for the advisory.","readOnly":true,"items":{"$ref":"#/components/schemas/dependabot-alert-security-vulnerability"}},"severity":{"type":"string","description":"The severity of the advisory.","readOnly":true,"enum":["low","medium","high","critical"]},"classification":{"type":"string","description":"The classification of the advisory.","readOnly":true,"enum":["general","malware"]},"cvss":{"type":"object","description":"Details for the advisory pertaining to the Common Vulnerability Scoring System.","readOnly":true,"properties":{"score":{"type":"number","description":"The overall CVSS score of the advisory.","minimum":0,"maximum":10,"readOnly":true},"vector_string":{"type":"string","description":"The full CVSS vector string for the advisory.","readOnly":true,"nullable":true}},"required":["score","vector_string"],"additionalProperties":false},"cvss_severities":{"$ref":"#/components/schemas/cvss-severities"},"epss":{"$ref":"#/components/schemas/security-advisory-epss"},"cwes":{"type":"array","description":"Details for the advisory pertaining to Common Weakness Enumeration.","readOnly":true,"items":{"type":"object","description":"A CWE weakness assigned to the advisory.","readOnly":true,"properties":{"cwe_id":{"type":"string","description":"The unique CWE ID.","readOnly":true},"name":{"type":"string","description":"The short, plain text name of the CWE.","readOnly":true}},"required":["cwe_id","name"],"additionalProperties":false}},"identifiers":{"type":"array","description":"Values that identify this advisory among security information sources.","readOnly":true,"items":{"type":"object","description":"An advisory identifier.","readOnly":true,"properties":{"type":{"type":"string","description":"The type of advisory identifier.","readOnly":true,"enum":["CVE","GHSA"]},"value":{"type":"string","description":"The value of the advisory identifer.","readOnly":true}},"required":["value","type"],"additionalProperties":false}},"references":{"type":"array","description":"Links to additional advisory information.","readOnly":true,"items":{"type":"object","description":"A link to additional advisory information.","readOnly":true,"properties":{"url":{"type":"string","description":"The URL of the reference.","format":"uri","readOnly":true}},"required":["url"],"additionalProperties":false}},"published_at":{"type":"string","description":"The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.","format":"date-time","readOnly":true},"updated_at":{"type":"string","description":"The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.","format":"date-time","readOnly":true},"withdrawn_at":{"type":"string","description":"The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.","format":"date-time","readOnly":true,"nullable":true}},"required":["ghsa_id","cve_id","summary","description","vulnerabilities","severity","cvss","cwes","identifiers","references","published_at","updated_at","withdrawn_at"],"additionalProperties":false,"x-github-breaking-changes":[{"changeset":"deprecate_cvss","patch":{"properties":{"cvss":null},"required":["ghsa_id","cve_id","summary","description","vulnerabilities","severity","cwes","identifiers","references","published_at","updated_at","withdrawn_at"]},"version":"2026-03-10"}]},"dependabot-alert-security-vulnerability":{"type":"object","description":"Details pertaining to one vulnerable version range for the advisory.","readOnly":true,"properties":{"package":{"$ref":"#/components/schemas/dependabot-alert-package"},"severity":{"type":"string","description":"The severity of the vulnerability.","readOnly":true,"enum":["low","medium","high","critical"]},"vulnerable_version_range":{"type":"string","description":"Conditions that identify vulnerable versions of this vulnerability's package.","readOnly":true},"first_patched_version":{"type":"object","description":"Details pertaining to the package version that patches this vulnerability.","readOnly":true,"nullable":true,"properties":{"identifier":{"type":"string","description":"The package version that patches this vulnerability.","readOnly":true}},"required":["identifier"],"additionalProperties":false}},"required":["package","severity","vulnerable_version_range","first_patched_version"],"additionalProperties":false},"dependabot-alert-with-repository":{"type":"object","description":"A Dependabot alert.","properties":{"number":{"$ref":"#/components/schemas/alert-number"},"state":{"type":"string","description":"The state of the Dependabot alert.","readOnly":true,"enum":["auto_dismissed","dismissed","fixed","open"]},"dependency":{"type":"object","description":"Details for the vulnerable dependency.","readOnly":true,"properties":{"package":{"$ref":"#/components/schemas/dependabot-alert-package"},"manifest_path":{"type":"string","description":"The full path to the dependency manifest file, relative to the root of the repository.","readOnly":true},"scope":{"type":"string","description":"The execution scope of the vulnerable dependency.","readOnly":true,"nullable":true,"enum":["development","runtime"]},"relationship":{"type":"string","description":"The vulnerable dependency's relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.\n","readOnly":true,"nullable":true,"enum":["unknown","direct","transitive","inconclusive"]}}},"security_advisory":{"$ref":"#/components/schemas/dependabot-alert-security-advisory"},"security_vulnerability":{"$ref":"#/components/schemas/dependabot-alert-security-vulnerability"},"url":{"$ref":"#/components/schemas/alert-url"},"html_url":{"$ref":"#/components/schemas/alert-html-url"},"created_at":{"$ref":"#/components/schemas/alert-created-at"},"updated_at":{"$ref":"#/components/schemas/alert-updated-at"},"dismissed_at":{"$ref":"#/components/schemas/alert-dismissed-at"},"dismissed_by":{"$ref":"#/components/schemas/nullable-simple-user"},"dismissed_reason":{"type":"string","description":"The reason that the alert was dismissed.","nullable":true,"enum":["fix_started","inaccurate","no_bandwidth","not_used","tolerable_risk"]},"dismissed_comment":{"type":"string","description":"An optional comment associated with the alert's dismissal.","nullable":true,"maxLength":280},"fixed_at":{"$ref":"#/components/schemas/alert-fixed-at"},"auto_dismissed_at":{"$ref":"#/components/schemas/alert-auto-dismissed-at"},"dismissal_request":{"$ref":"#/components/schemas/dependabot-alert-dismissal-request-simple"},"assignees":{"type":"array","description":"The users assigned to this alert.","readOnly":true,"items":{"$ref":"#/components/schemas/simple-user"}},"repository":{"$ref":"#/components/schemas/simple-repository"}},"required":["number","state","dependency","security_advisory","security_vulnerability","url","html_url","created_at","updated_at","dismissed_at","dismissed_by","dismissed_reason","dismissed_comment","fixed_at","repository"],"additionalProperties":false},"deployment":{"title":"Deployment","description":"A request for a specific ref(branch,sha,tag) to be deployed","type":"object","properties":{"url":{"type":"string","format":"uri"},"id":{"description":"Unique identifier of the deployment","type":"integer","format":"int64"},"node_id":{"type":"string"},"sha":{"type":"string"},"ref":{"description":"The ref to deploy. This can be a branch, tag, or sha.","type":"string"},"task":{"description":"Parameter to specify a task to execute","type":"string"},"payload":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}]},"original_environment":{"type":"string"},"environment":{"description":"Name for the target deployment environment.","type":"string"},"description":{"type":"string","nullable":true},"creator":{"$ref":"#/components/schemas/nullable-simple-user"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"statuses_url":{"type":"string","format":"uri"},"repository_url":{"type":"string","format":"uri"},"transient_environment":{"description":"Specifies if the given environment is will no longer exist at some point in the future. Default: false.","type":"boolean"},"production_environment":{"description":"Specifies if the given environment is one that end-users directly interact with. Default: false.","type":"boolean"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"}},"required":["id","node_id","sha","ref","task","environment","creator","payload","description","statuses_url","repository_url","url","created_at","updated_at"]},"deployment-branch-policy-settings":{"type":"object","description":"The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.","properties":{"protected_branches":{"type":"boolean","description":"Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`."},"custom_branch_policies":{"type":"boolean","description":"Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`."}},"nullable":true,"required":["protected_branches","custom_branch_policies"]},"deployment-reviewer-type":{"type":"string","description":"The type of reviewer.","enum":["User","Team"]},"deployment-simple":{"title":"Deployment","description":"A deployment created as the result of an Actions check run from a workflow that references an environment","type":"object","properties":{"url":{"type":"string","format":"uri"},"id":{"description":"Unique identifier of the deployment","type":"integer"},"node_id":{"type":"string"},"task":{"description":"Parameter to specify a task to execute","type":"string"},"original_environment":{"type":"string"},"environment":{"description":"Name for the target deployment environment.","type":"string"},"description":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"statuses_url":{"type":"string","format":"uri"},"repository_url":{"type":"string","format":"uri"},"transient_environment":{"description":"Specifies if the given environment is will no longer exist at some point in the future. Default: false.","type":"boolean"},"production_environment":{"description":"Specifies if the given environment is one that end-users directly interact with. Default: false.","type":"boolean"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"}},"required":["id","node_id","task","environment","description","statuses_url","repository_url","url","created_at","updated_at"]},"deployment-status":{"title":"Deployment Status","description":"The status of a deployment.","type":"object","properties":{"url":{"type":"string","format":"uri"},"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"state":{"description":"The state of the status.","enum":["error","failure","inactive","pending","success","queued","in_progress"],"type":"string"},"creator":{"$ref":"#/components/schemas/nullable-simple-user"},"description":{"description":"A short description of the status.","default":"","type":"string","maxLength":140},"environment":{"description":"The environment of the deployment that the status is for.","default":"","type":"string"},"target_url":{"description":"Closing down notice: the URL to associate with this status.","default":"","type":"string","format":"uri"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"deployment_url":{"type":"string","format":"uri"},"repository_url":{"type":"string","format":"uri"},"environment_url":{"description":"The URL for accessing your environment.","default":"","type":"string","format":"uri"},"log_url":{"description":"The URL to associate with this status.","default":"","type":"string","format":"uri"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"}},"required":["id","node_id","state","creator","description","deployment_url","target_url","repository_url","url","created_at","updated_at"]},"diff-entry":{"title":"Diff Entry","description":"Diff Entry","type":"object","properties":{"sha":{"type":"string","nullable":true},"filename":{"type":"string"},"status":{"type":"string","enum":["added","removed","modified","renamed","copied","changed","unchanged"]},"additions":{"type":"integer"},"deletions":{"type":"integer"},"changes":{"type":"integer"},"blob_url":{"type":"string","format":"uri"},"raw_url":{"type":"string","format":"uri"},"contents_url":{"type":"string","format":"uri"},"patch":{"type":"string"},"previous_filename":{"type":"string"}},"required":["additions","blob_url","changes","contents_url","deletions","filename","raw_url","sha","status"]},"empty-object":{"title":"Empty Object","description":"An object without any properties.","type":"object","properties":{},"additionalProperties":false},"enterprise":{"title":"Enterprise","description":"An enterprise on GitHub.","type":"object","properties":{"description":{"description":"A short description of the enterprise.","type":"string","nullable":true},"html_url":{"type":"string","format":"uri"},"website_url":{"description":"The enterprise's website URL.","type":"string","nullable":true,"format":"uri"},"id":{"description":"Unique identifier of the enterprise","type":"integer"},"node_id":{"type":"string"},"name":{"description":"The name of the enterprise.","type":"string"},"slug":{"description":"The slug url identifier for the enterprise.","type":"string"},"created_at":{"type":"string","nullable":true,"format":"date-time"},"updated_at":{"type":"string","nullable":true,"format":"date-time"},"avatar_url":{"type":"string","format":"uri"}},"required":["id","node_id","name","slug","html_url","created_at","updated_at","avatar_url"]},"environment":{"title":"Environment","description":"Details of a deployment environment","type":"object","properties":{"id":{"description":"The id of the environment.","type":"integer","format":"int64"},"node_id":{"type":"string"},"name":{"description":"The name of the environment.","type":"string"},"url":{"type":"string"},"html_url":{"type":"string"},"created_at":{"description":"The time that the environment was created, in ISO 8601 format.","format":"date-time","type":"string"},"updated_at":{"description":"The time that the environment was last updated, in ISO 8601 format.","format":"date-time","type":"string"},"protection_rules":{"type":"array","description":"Built-in deployment protection rules for the environment.","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"type":{"type":"string"},"wait_timer":{"$ref":"#/components/schemas/wait-timer"}},"required":["id","node_id","type"]},{"type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"prevent_self_review":{"type":"boolean","description":"Whether deployments to this environment can be approved by the user who created the deployment."},"type":{"type":"string"},"reviewers":{"type":"array","description":"The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.","items":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/deployment-reviewer-type"},"reviewer":{"anyOf":[{"$ref":"#/components/schemas/simple-user"},{"$ref":"#/components/schemas/team"}]}}}}},"required":["id","node_id","type"]},{"type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"type":{"type":"string"}},"required":["id","node_id","type"]}]}},"deployment_branch_policy":{"$ref":"#/components/schemas/deployment-branch-policy-settings"}},"required":["id","node_id","name","url","html_url","created_at","updated_at"]},"full-repository":{"title":"Full Repository","description":"Full Repository","type":"object","properties":{"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"name":{"type":"string"},"full_name":{"type":"string"},"owner":{"$ref":"#/components/schemas/simple-user"},"private":{"type":"boolean"},"html_url":{"type":"string","format":"uri"},"description":{"type":"string","nullable":true},"fork":{"type":"boolean"},"url":{"type":"string","format":"uri"},"archive_url":{"type":"string"},"assignees_url":{"type":"string"},"blobs_url":{"type":"string"},"branches_url":{"type":"string"},"collaborators_url":{"type":"string"},"comments_url":{"type":"string"},"commits_url":{"type":"string"},"compare_url":{"type":"string"},"contents_url":{"type":"string"},"contributors_url":{"type":"string","format":"uri"},"deployments_url":{"type":"string","format":"uri"},"downloads_url":{"type":"string","format":"uri"},"events_url":{"type":"string","format":"uri"},"forks_url":{"type":"string","format":"uri"},"git_commits_url":{"type":"string"},"git_refs_url":{"type":"string"},"git_tags_url":{"type":"string"},"git_url":{"type":"string"},"issue_comment_url":{"type":"string"},"issue_events_url":{"type":"string"},"issues_url":{"type":"string"},"keys_url":{"type":"string"},"labels_url":{"type":"string"},"languages_url":{"type":"string","format":"uri"},"merges_url":{"type":"string","format":"uri"},"milestones_url":{"type":"string"},"notifications_url":{"type":"string"},"pulls_url":{"type":"string"},"releases_url":{"type":"string"},"ssh_url":{"type":"string"},"stargazers_url":{"type":"string","format":"uri"},"statuses_url":{"type":"string"},"subscribers_url":{"type":"string","format":"uri"},"subscription_url":{"type":"string","format":"uri"},"tags_url":{"type":"string","format":"uri"},"teams_url":{"type":"string","format":"uri"},"trees_url":{"type":"string"},"clone_url":{"type":"string"},"mirror_url":{"type":"string","format":"uri","nullable":true},"hooks_url":{"type":"string","format":"uri"},"svn_url":{"type":"string","format":"uri"},"homepage":{"type":"string","format":"uri","nullable":true},"language":{"type":"string","nullable":true},"forks_count":{"type":"integer"},"stargazers_count":{"type":"integer"},"watchers_count":{"type":"integer"},"size":{"description":"The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.","type":"integer"},"default_branch":{"type":"string"},"open_issues_count":{"type":"integer"},"is_template":{"type":"boolean"},"topics":{"type":"array","items":{"type":"string"}},"has_issues":{"type":"boolean"},"has_projects":{"type":"boolean"},"has_wiki":{"type":"boolean"},"has_pages":{"type":"boolean"},"has_downloads":{"type":"boolean"},"has_discussions":{"type":"boolean"},"has_pull_requests":{"type":"boolean"},"pull_request_creation_policy":{"description":"The policy controlling who can create pull requests: all or collaborators_only.","type":"string","enum":["all","collaborators_only"]},"archived":{"type":"boolean"},"disabled":{"type":"boolean","description":"Returns whether or not this repository disabled."},"visibility":{"description":"The repository visibility: public, private, or internal.","type":"string"},"pushed_at":{"type":"string","format":"date-time"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"permissions":{"type":"object","properties":{"admin":{"type":"boolean"},"maintain":{"type":"boolean"},"push":{"type":"boolean"},"triage":{"type":"boolean"},"pull":{"type":"boolean"}},"required":["admin","pull","push"]},"allow_rebase_merge":{"type":"boolean"},"template_repository":{"$ref":"#/components/schemas/nullable-repository"},"temp_clone_token":{"type":"string","nullable":true},"allow_squash_merge":{"type":"boolean"},"allow_auto_merge":{"type":"boolean"},"delete_branch_on_merge":{"type":"boolean"},"allow_merge_commit":{"type":"boolean"},"allow_update_branch":{"type":"boolean"},"use_squash_pr_title_as_default":{"type":"boolean"},"squash_merge_commit_title":{"type":"string","enum":["PR_TITLE","COMMIT_OR_PR_TITLE"],"description":"The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."},"squash_merge_commit_message":{"type":"string","enum":["PR_BODY","COMMIT_MESSAGES","BLANK"],"description":"The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."},"merge_commit_title":{"type":"string","enum":["PR_TITLE","MERGE_MESSAGE"],"description":"The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."},"merge_commit_message":{"type":"string","enum":["PR_BODY","PR_TITLE","BLANK"],"description":"The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."},"allow_forking":{"type":"boolean"},"web_commit_signoff_required":{"type":"boolean"},"subscribers_count":{"type":"integer"},"network_count":{"type":"integer"},"license":{"$ref":"#/components/schemas/nullable-license-simple"},"organization":{"$ref":"#/components/schemas/nullable-simple-user"},"parent":{"$ref":"#/components/schemas/repository"},"source":{"$ref":"#/components/schemas/repository"},"forks":{"type":"integer"},"master_branch":{"type":"string"},"open_issues":{"type":"integer"},"watchers":{"type":"integer"},"anonymous_access_enabled":{"description":"Whether anonymous git access is allowed.","default":true,"type":"boolean"},"code_of_conduct":{"$ref":"#/components/schemas/code-of-conduct-simple"},"security_and_analysis":{"$ref":"#/components/schemas/security-and-analysis"},"custom_properties":{"type":"object","description":"The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.","additionalProperties":true}},"required":["archive_url","assignees_url","blobs_url","branches_url","collaborators_url","comments_url","commits_url","compare_url","contents_url","contributors_url","deployments_url","description","downloads_url","events_url","fork","forks_url","full_name","git_commits_url","git_refs_url","git_tags_url","hooks_url","html_url","id","node_id","issue_comment_url","issue_events_url","issues_url","keys_url","labels_url","languages_url","merges_url","milestones_url","name","notifications_url","owner","private","pulls_url","releases_url","stargazers_url","statuses_url","subscribers_url","subscription_url","tags_url","teams_url","trees_url","url","clone_url","default_branch","forks","forks_count","git_url","has_issues","has_projects","has_wiki","has_pages","has_discussions","homepage","language","archived","disabled","mirror_url","open_issues","open_issues_count","license","pushed_at","size","ssh_url","stargazers_count","svn_url","watchers","watchers_count","created_at","updated_at","network_count","subscribers_count"],"x-github-breaking-changes":[{"changeset":"remove_use_squash_pr_title_as_default","patch":{"properties":{"use_squash_pr_title_as_default":null}},"version":"2026-03-10"},{"changeset":"remove_has_downloads","patch":{"properties":{"has_downloads":null}},"version":"2026-03-10"}]},"gist-comment":{"title":"Gist Comment","description":"A comment made to a gist.","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string","format":"uri"},"body":{"description":"The comment text.","type":"string","maxLength":65535},"user":{"$ref":"#/components/schemas/nullable-simple-user"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"author_association":{"$ref":"#/components/schemas/author-association"}},"required":["url","id","node_id","user","body","author_association","created_at","updated_at"]},"gist-history":{"title":"Gist History","description":"Gist History","type":"object","properties":{"user":{"$ref":"#/components/schemas/nullable-simple-user"},"version":{"type":"string"},"committed_at":{"type":"string","format":"date-time"},"change_status":{"type":"object","properties":{"total":{"type":"integer"},"additions":{"type":"integer"},"deletions":{"type":"integer"}}},"url":{"type":"string","format":"uri"}}},"gist-simple":{"title":"Gist Simple","description":"Gist Simple","type":"object","properties":{"forks":{"deprecated":true,"nullable":true,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string","format":"uri"},"user":{"$ref":"#/components/schemas/public-user"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"history":{"deprecated":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/gist-history"}},"fork_of":{"nullable":true,"title":"Gist","description":"Gist","type":"object","properties":{"url":{"type":"string","format":"uri"},"forks_url":{"type":"string","format":"uri"},"commits_url":{"type":"string","format":"uri"},"id":{"type":"string"},"node_id":{"type":"string"},"git_pull_url":{"type":"string","format":"uri"},"git_push_url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"files":{"type":"object","additionalProperties":{"type":"object","properties":{"filename":{"type":"string"},"type":{"type":"string"},"language":{"type":"string"},"raw_url":{"type":"string"},"size":{"type":"integer"}}}},"public":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"description":{"type":"string","nullable":true},"comments":{"type":"integer"},"comments_enabled":{"type":"boolean"},"user":{"$ref":"#/components/schemas/nullable-simple-user"},"comments_url":{"type":"string","format":"uri"},"owner":{"$ref":"#/components/schemas/nullable-simple-user"},"truncated":{"type":"boolean"},"forks":{"type":"array","items":{}},"history":{"type":"array","items":{}}},"required":["id","node_id","url","forks_url","commits_url","git_pull_url","git_push_url","html_url","comments_url","public","description","comments","user","files","created_at","updated_at"]},"url":{"type":"string"},"forks_url":{"type":"string"},"commits_url":{"type":"string"},"id":{"type":"string"},"node_id":{"type":"string"},"git_pull_url":{"type":"string"},"git_push_url":{"type":"string"},"html_url":{"type":"string"},"files":{"type":"object","additionalProperties":{"nullable":true,"type":"object","properties":{"filename":{"type":"string"},"type":{"type":"string"},"language":{"type":"string"},"raw_url":{"type":"string"},"size":{"type":"integer"},"truncated":{"type":"boolean"},"content":{"type":"string"},"encoding":{"type":"string","description":"The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.","default":"utf-8"}}}},"public":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"description":{"type":"string","nullable":true},"comments":{"type":"integer"},"comments_enabled":{"type":"boolean"},"user":{"type":"string","nullable":true},"comments_url":{"type":"string"},"owner":{"$ref":"#/components/schemas/simple-user"},"truncated":{"type":"boolean"}},"x-github-breaking-changes":[{"changeset":"remove_forks_history_from_base_gist","patch":[{"op":"remove","path":"/properties/forks"},{"op":"remove","path":"/properties/history"}],"version":"2026-03-10"}]},"git-ref":{"title":"Git Reference","description":"Git references within a repository","type":"object","properties":{"ref":{"type":"string"},"node_id":{"type":"string"},"url":{"type":"string","format":"uri"},"object":{"type":"object","properties":{"type":{"type":"string"},"sha":{"description":"SHA for the reference","type":"string","minLength":40,"maxLength":40},"url":{"type":"string","format":"uri"}},"required":["type","sha","url"]}},"required":["ref","node_id","url","object"]},"hook":{"title":"Webhook","description":"Webhooks for repositories.","type":"object","properties":{"type":{"type":"string"},"id":{"description":"Unique identifier of the webhook.","type":"integer"},"name":{"description":"The name of a valid service, use 'web' for a webhook.","type":"string"},"active":{"description":"Determines whether the hook is actually triggered on pushes.","type":"boolean"},"events":{"description":"Determines what events the hook is triggered for. Default: ['push'].","type":"array","items":{"type":"string"}},"config":{"$ref":"#/components/schemas/webhook-config"},"updated_at":{"type":"string","format":"date-time"},"created_at":{"type":"string","format":"date-time"},"url":{"type":"string","format":"uri"},"test_url":{"type":"string","format":"uri"},"ping_url":{"type":"string","format":"uri"},"deliveries_url":{"type":"string","format":"uri"},"last_response":{"$ref":"#/components/schemas/hook-response"}},"required":["id","url","type","name","active","events","config","ping_url","created_at","updated_at","last_response","test_url"]},"hook-response":{"title":"Hook Response","type":"object","properties":{"code":{"type":"integer","nullable":true},"status":{"type":"string","nullable":true},"message":{"type":"string","nullable":true}},"required":["code","status","message"]},"installation":{"title":"Installation","description":"Installation","type":"object","properties":{"id":{"description":"The ID of the installation.","type":"integer"},"account":{"nullable":true,"anyOf":[{"$ref":"#/components/schemas/simple-user"},{"$ref":"#/components/schemas/enterprise"}]},"repository_selection":{"description":"Describe whether all repositories have been selected or there's a selection involved","type":"string","enum":["all","selected"]},"access_tokens_url":{"type":"string","format":"uri"},"repositories_url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"app_id":{"type":"integer"},"client_id":{"type":"string"},"target_id":{"description":"The ID of the user or organization this token is being scoped to.","type":"integer"},"target_type":{"type":"string"},"permissions":{"$ref":"#/components/schemas/app-permissions"},"events":{"type":"array","items":{"type":"string"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"single_file_name":{"type":"string","nullable":true},"has_multiple_single_files":{"type":"boolean"},"single_file_paths":{"type":"array","items":{"type":"string"}},"app_slug":{"type":"string"},"suspended_by":{"$ref":"#/components/schemas/nullable-simple-user"},"suspended_at":{"type":"string","format":"date-time","nullable":true},"contact_email":{"type":"string","nullable":true}},"required":["id","app_id","app_slug","target_id","target_type","single_file_name","repository_selection","access_tokens_url","html_url","repositories_url","events","account","permissions","created_at","updated_at","suspended_by","suspended_at"]},"integration":{"title":"GitHub app","description":"GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.","type":"object","nullable":true,"properties":{"id":{"description":"Unique identifier of the GitHub app","type":"integer"},"slug":{"description":"The slug name of the GitHub app","type":"string"},"node_id":{"type":"string"},"client_id":{"type":"string"},"owner":{"oneOf":[{"$ref":"#/components/schemas/simple-user"},{"$ref":"#/components/schemas/enterprise"}]},"name":{"description":"The name of the GitHub app","type":"string"},"description":{"type":"string","nullable":true},"external_url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"permissions":{"description":"The set of permissions for the GitHub app","type":"object","properties":{"issues":{"type":"string"},"checks":{"type":"string"},"metadata":{"type":"string"},"contents":{"type":"string"},"deployments":{"type":"string"}},"additionalProperties":{"type":"string"}},"events":{"description":"The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.","type":"array","items":{"type":"string"}},"installations_count":{"description":"The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.","type":"integer"}},"required":["id","node_id","owner","name","description","external_url","html_url","created_at","updated_at","permissions","events"]},"issue":{"title":"Issue","description":"Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.","type":"object","properties":{"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"url":{"description":"URL for the issue","type":"string","format":"uri"},"repository_url":{"type":"string","format":"uri"},"labels_url":{"type":"string"},"comments_url":{"type":"string","format":"uri"},"events_url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"number":{"description":"Number uniquely identifying the issue within its repository","type":"integer"},"state":{"description":"State of the issue; either 'open' or 'closed'","type":"string"},"state_reason":{"description":"The reason for the current state","type":"string","nullable":true,"enum":["completed","reopened","not_planned","duplicate"]},"title":{"description":"Title of the issue","type":"string"},"body":{"description":"Contents of the issue","type":"string","nullable":true},"user":{"$ref":"#/components/schemas/nullable-simple-user"},"labels":{"description":"Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository","type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"url":{"type":"string","format":"uri"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"default":{"type":"boolean"},"archived_by":{"description":"The user who archived the label, or `null` if it has not been archived.","nullable":true,"allOf":[{"$ref":"#/components/schemas/simple-user"}]}}}]}},"assignee":{"$ref":"#/components/schemas/nullable-simple-user"},"assignees":{"type":"array","items":{"$ref":"#/components/schemas/simple-user"}},"milestone":{"$ref":"#/components/schemas/nullable-milestone"},"locked":{"type":"boolean"},"active_lock_reason":{"type":"string","nullable":true},"comments":{"type":"integer"},"pull_request":{"type":"object","properties":{"merged_at":{"type":"string","format":"date-time","nullable":true},"diff_url":{"type":"string","format":"uri","nullable":true},"html_url":{"type":"string","format":"uri","nullable":true},"patch_url":{"type":"string","format":"uri","nullable":true},"url":{"type":"string","format":"uri","nullable":true}},"required":["diff_url","html_url","patch_url","url"]},"closed_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"draft":{"type":"boolean"},"closed_by":{"$ref":"#/components/schemas/nullable-simple-user"},"body_html":{"type":"string"},"body_text":{"type":"string"},"timeline_url":{"type":"string","format":"uri"},"type":{"$ref":"#/components/schemas/issue-type"},"repository":{"$ref":"#/components/schemas/repository"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"author_association":{"$ref":"#/components/schemas/author-association"},"reactions":{"$ref":"#/components/schemas/reaction-rollup"},"sub_issues_summary":{"$ref":"#/components/schemas/sub-issues-summary"},"parent_issue_url":{"description":"URL to get the parent issue of this issue, if it is a sub-issue","type":"string","format":"uri","nullable":true},"pinned_comment":{"$ref":"#/components/schemas/nullable-issue-comment"},"issue_dependencies_summary":{"$ref":"#/components/schemas/issue-dependencies-summary"},"issue_field_values":{"type":"array","items":{"$ref":"#/components/schemas/issue-field-value"}}},"required":["assignee","closed_at","comments","comments_url","events_url","html_url","id","node_id","labels","labels_url","milestone","number","repository_url","state","locked","title","url","user","created_at","updated_at"],"x-github-breaking-changes":[{"changeset":"deprecate_beta_media_type","patch":{"properties":{"pull_request":{"type":"object","properties":{"merged_at":{"nullable":false},"diff_url":{"nullable":false},"html_url":{"nullable":false},"patch_url":{"nullable":false},"url":{"nullable":false}}}}},"version":"2026-03-10"},{"changeset":"remove_singular_assignee_from_issues_and_pull_requests","patch":{"properties":{"assignee":null},"required":["closed_at","comments","comments_url","events_url","html_url","id","node_id","labels","labels_url","milestone","number","repository_url","state","locked","title","url","user","created_at","updated_at"]},"version":"2026-03-10"}]},"issue-comment":{"title":"Issue Comment","description":"Comments provide a way for people to collaborate on an issue.","type":"object","properties":{"id":{"description":"Unique identifier of the issue comment","type":"integer","format":"int64"},"node_id":{"type":"string"},"url":{"description":"URL for the issue comment","type":"string","format":"uri"},"body":{"description":"Contents of the issue comment","type":"string"},"body_text":{"type":"string"},"body_html":{"type":"string"},"html_url":{"type":"string","format":"uri"},"user":{"$ref":"#/components/schemas/nullable-simple-user"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"issue_url":{"type":"string","format":"uri"},"author_association":{"$ref":"#/components/schemas/author-association"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"reactions":{"$ref":"#/components/schemas/reaction-rollup"},"pin":{"$ref":"#/components/schemas/nullable-pinned-issue-comment"},"minimized":{"$ref":"#/components/schemas/nullable-issue-comment-minimized"}},"required":["id","node_id","html_url","issue_url","user","url","created_at","updated_at"]},"issue-dependencies-summary":{"title":"Issue Dependencies Summary","type":"object","properties":{"blocked_by":{"type":"integer"},"blocking":{"type":"integer"},"total_blocked_by":{"type":"integer"},"total_blocking":{"type":"integer"}},"required":["blocked_by","blocking","total_blocked_by","total_blocking"]},"issue-event":{"title":"Issue Event","description":"Issue Event","type":"object","properties":{"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"url":{"type":"string","format":"uri"},"actor":{"$ref":"#/components/schemas/nullable-simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"issue":{"$ref":"#/components/schemas/nullable-issue"},"label":{"$ref":"#/components/schemas/issue-event-label"},"assignee":{"$ref":"#/components/schemas/nullable-simple-user"},"assigner":{"$ref":"#/components/schemas/nullable-simple-user"},"review_requester":{"$ref":"#/components/schemas/nullable-simple-user"},"requested_reviewer":{"$ref":"#/components/schemas/nullable-simple-user"},"requested_team":{"$ref":"#/components/schemas/team"},"dismissed_review":{"$ref":"#/components/schemas/issue-event-dismissed-review"},"milestone":{"$ref":"#/components/schemas/issue-event-milestone"},"project_card":{"$ref":"#/components/schemas/issue-event-project-card"},"rename":{"$ref":"#/components/schemas/issue-event-rename"},"issue_type":{"$ref":"#/components/schemas/issue-type-webhook"},"prev_issue_type":{"$ref":"#/components/schemas/issue-type-webhook"},"sub_issue":{"$ref":"#/components/schemas/nullable-issue-reference"},"parent_issue":{"$ref":"#/components/schemas/nullable-issue-reference"},"blocked_by":{"$ref":"#/components/schemas/nullable-issue-reference"},"blocking":{"$ref":"#/components/schemas/nullable-issue-reference"},"intent":{"$ref":"#/components/schemas/nullable-issue-event-intent"},"author_association":{"$ref":"#/components/schemas/author-association"},"lock_reason":{"type":"string","nullable":true},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"}},"required":["id","node_id","url","actor","event","commit_id","commit_url","created_at"]},"issue-event-dismissed-review":{"title":"Issue Event Dismissed Review","type":"object","properties":{"state":{"type":"string"},"review_id":{"type":"integer"},"dismissal_message":{"type":"string","nullable":true},"dismissal_commit_id":{"type":"string","nullable":true}},"required":["state","review_id","dismissal_message"]},"issue-event-for-issue":{"title":"Issue Event for Issue","description":"Issue Event for Issue","anyOf":[{"$ref":"#/components/schemas/labeled-issue-event"},{"$ref":"#/components/schemas/unlabeled-issue-event"},{"$ref":"#/components/schemas/assigned-issue-event"},{"$ref":"#/components/schemas/unassigned-issue-event"},{"$ref":"#/components/schemas/milestoned-issue-event"},{"$ref":"#/components/schemas/demilestoned-issue-event"},{"$ref":"#/components/schemas/renamed-issue-event"},{"$ref":"#/components/schemas/review-requested-issue-event"},{"$ref":"#/components/schemas/review-request-removed-issue-event"},{"$ref":"#/components/schemas/review-dismissed-issue-event"},{"$ref":"#/components/schemas/locked-issue-event"},{"$ref":"#/components/schemas/added-to-project-issue-event"},{"$ref":"#/components/schemas/moved-column-in-project-issue-event"},{"$ref":"#/components/schemas/removed-from-project-issue-event"},{"$ref":"#/components/schemas/converted-note-to-issue-issue-event"},{"$ref":"#/components/schemas/issue-type-added-issue-event"},{"$ref":"#/components/schemas/issue-type-removed-issue-event"},{"$ref":"#/components/schemas/issue-type-changed-issue-event"},{"$ref":"#/components/schemas/sub-issue-added-issue-event"},{"$ref":"#/components/schemas/sub-issue-removed-issue-event"},{"$ref":"#/components/schemas/parent-issue-added-issue-event"},{"$ref":"#/components/schemas/parent-issue-removed-issue-event"},{"$ref":"#/components/schemas/blocked-by-added-issue-event"},{"$ref":"#/components/schemas/blocked-by-removed-issue-event"},{"$ref":"#/components/schemas/blocking-added-issue-event"},{"$ref":"#/components/schemas/blocking-removed-issue-event"}]},"issue-event-label":{"title":"Issue Event Label","description":"Issue Event Label","type":"object","properties":{"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true}},"required":["name","color"]},"issue-event-milestone":{"title":"Issue Event Milestone","description":"Issue Event Milestone","type":"object","properties":{"title":{"type":"string"}},"required":["title"]},"issue-event-project-card":{"title":"Issue Event Project Card","description":"Issue Event Project Card","type":"object","properties":{"url":{"type":"string","format":"uri"},"id":{"type":"integer"},"project_url":{"type":"string","format":"uri"},"project_id":{"type":"integer"},"column_name":{"type":"string"},"previous_column_name":{"type":"string"}},"required":["url","id","project_url","project_id","column_name"]},"issue-event-rename":{"title":"Issue Event Rename","description":"Issue Event Rename","type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]},"issue-field-value":{"title":"Issue Field Value","description":"A value assigned to an issue field","type":"object","properties":{"issue_field_id":{"description":"Unique identifier for the issue field.","type":"integer","format":"int64"},"issue_field_name":{"description":"The human-readable name of the issue field.","type":"string"},"node_id":{"type":"string"},"data_type":{"description":"The data type of the issue field","type":"string","enum":["text","single_select","multi_select","number","date"]},"value":{"description":"The value of the issue field","anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"}],"nullable":true},"single_select_option":{"description":"Details about the selected option (only present for single_select fields)","type":"object","properties":{"id":{"description":"Unique identifier for the option.","type":"integer","format":"int64"},"name":{"description":"The name of the option","type":"string"},"color":{"description":"The color of the option","type":"string"}},"required":["id","name","color"],"nullable":true},"multi_select_options":{"description":"Details about the selected options","type":"array","items":{"type":"object","properties":{"id":{"description":"Unique identifier for the option.","type":"integer","format":"int64"},"name":{"description":"The name of the option","type":"string"},"color":{"description":"The color of the option","type":"string"}},"required":["id","name","color"]},"nullable":true}},"required":["issue_field_id","node_id","data_type","value"]},"issue-search-result-item":{"title":"Issue Search Result Item","description":"Issue Search Result Item","type":"object","properties":{"url":{"type":"string","format":"uri"},"repository_url":{"type":"string","format":"uri"},"labels_url":{"type":"string"},"comments_url":{"type":"string","format":"uri"},"events_url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"number":{"type":"integer"},"title":{"type":"string"},"locked":{"type":"boolean"},"active_lock_reason":{"type":"string","nullable":true},"assignees":{"type":"array","items":{"$ref":"#/components/schemas/simple-user"},"nullable":true},"user":{"$ref":"#/components/schemas/nullable-simple-user"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"},"default":{"type":"boolean"},"description":{"type":"string","nullable":true},"archived_at":{"description":"Timestamp indicating when the label was archived, or `null` if it has not been archived.","type":"string","nullable":true,"format":"date-time"},"archived_by":{"description":"The user who archived the label, or `null` if it has not been archived.","nullable":true,"allOf":[{"$ref":"#/components/schemas/simple-user"}]}}}},"sub_issues_summary":{"$ref":"#/components/schemas/sub-issues-summary"},"issue_dependencies_summary":{"$ref":"#/components/schemas/issue-dependencies-summary"},"issue_field_values":{"type":"array","items":{"$ref":"#/components/schemas/issue-field-value"}},"state":{"type":"string"},"state_reason":{"type":"string","nullable":true},"assignee":{"$ref":"#/components/schemas/nullable-simple-user"},"milestone":{"$ref":"#/components/schemas/nullable-milestone"},"comments":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"closed_at":{"type":"string","format":"date-time","nullable":true},"text_matches":{"$ref":"#/components/schemas/search-result-text-matches"},"pull_request":{"type":"object","properties":{"merged_at":{"type":"string","format":"date-time","nullable":true},"diff_url":{"type":"string","format":"uri","nullable":true},"html_url":{"type":"string","format":"uri","nullable":true},"patch_url":{"type":"string","format":"uri","nullable":true},"url":{"type":"string","format":"uri","nullable":true}},"required":["diff_url","html_url","patch_url","url"]},"body":{"type":"string"},"score":{"type":"number"},"author_association":{"$ref":"#/components/schemas/author-association"},"draft":{"type":"boolean"},"repository":{"$ref":"#/components/schemas/repository"},"body_html":{"type":"string"},"body_text":{"type":"string"},"timeline_url":{"type":"string","format":"uri"},"type":{"$ref":"#/components/schemas/issue-type"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"pinned_comment":{"$ref":"#/components/schemas/nullable-issue-comment"},"reactions":{"$ref":"#/components/schemas/reaction-rollup"}},"required":["assignee","closed_at","comments","comments_url","events_url","html_url","id","node_id","labels","labels_url","milestone","number","repository_url","state","locked","title","url","user","author_association","created_at","updated_at","score"],"x-github-breaking-changes":[{"changeset":"remove_singular_assignee_from_issues_and_pull_requests","patch":{"properties":{"assignee":null},"required":["closed_at","comments","comments_url","events_url","html_url","id","node_id","labels","labels_url","milestone","number","repository_url","state","locked","title","url","user","author_association","created_at","updated_at","score"]},"version":"2026-03-10"}]},"issue-type":{"title":"Issue Type","description":"The type assigned to the issue. This is only present for issues in repositories where issue types are supported.","type":"object","nullable":true,"properties":{"id":{"type":"integer","description":"The unique identifier of the issue type."},"node_id":{"type":"string","description":"The node identifier of the issue type."},"name":{"type":"string","description":"The name of the issue type."},"description":{"type":"string","description":"The description of the issue type.","nullable":true},"color":{"type":"string","description":"The color of the issue type.","enum":["gray","blue","green","yellow","orange","red","pink","purple"],"nullable":true},"created_at":{"type":"string","description":"The time the issue type created.","format":"date-time"},"updated_at":{"type":"string","description":"The time the issue type last updated.","format":"date-time"},"is_enabled":{"type":"boolean","description":"The enabled state of the issue type."}},"required":["id","node_id","name","description"]},"issue-type-added-issue-event":{"title":"Issue Type Added Issue Event","description":"Issue Type Added Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"issue_type":{"$ref":"#/components/schemas/issue-type-webhook"},"intent":{"$ref":"#/components/schemas/nullable-issue-event-intent"}},"required":["issue_type","id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"issue-type-changed-issue-event":{"title":"Issue Type Changed Issue Event","description":"Issue Type Changed Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"issue_type":{"$ref":"#/components/schemas/issue-type-webhook"},"prev_issue_type":{"$ref":"#/components/schemas/issue-type-webhook"},"intent":{"$ref":"#/components/schemas/nullable-issue-event-intent"}},"required":["issue_type","prev_issue_type","id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"issue-type-removed-issue-event":{"title":"Issue Type Removed Issue Event","description":"Issue Type Removed Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"prev_issue_type":{"$ref":"#/components/schemas/issue-type-webhook"},"intent":{"$ref":"#/components/schemas/nullable-issue-event-intent"}},"required":["prev_issue_type","id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"issue-type-webhook":{"title":"Issue Type","description":"The type of issue.","type":"object","nullable":true,"properties":{"id":{"type":"integer","description":"The unique identifier of the issue type."},"name":{"type":"string","description":"The name of the issue type."},"color":{"type":"string","description":"The color of the issue type.","enum":["gray","blue","green","yellow","orange","red","pink","purple"],"nullable":true}},"required":["id","name"]},"job":{"title":"Job","description":"Information of a job execution in a workflow run","type":"object","properties":{"id":{"description":"The id of the job.","type":"integer","format":"int64"},"run_id":{"description":"The id of the associated workflow run.","type":"integer","format":"int64"},"run_url":{"type":"string"},"run_attempt":{"type":"integer","description":"Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run."},"node_id":{"type":"string"},"head_sha":{"description":"The SHA of the commit that is being run.","type":"string"},"url":{"type":"string"},"html_url":{"type":"string","nullable":true},"status":{"description":"The phase of the lifecycle that the job is currently in.","type":"string","enum":["queued","in_progress","completed","waiting","requested","pending"]},"conclusion":{"description":"The outcome of the job.","type":"string","nullable":true,"enum":["success","failure","neutral","cancelled","skipped","timed_out","action_required"]},"created_at":{"description":"The time that the job created, in ISO 8601 format.","format":"date-time","type":"string"},"started_at":{"description":"The time that the job started, in ISO 8601 format.","format":"date-time","type":"string"},"completed_at":{"description":"The time that the job finished, in ISO 8601 format.","format":"date-time","type":"string","nullable":true},"name":{"description":"The name of the job.","type":"string"},"steps":{"description":"Steps in this job.","type":"array","items":{"type":"object","required":["name","status","conclusion","number"],"properties":{"status":{"description":"The phase of the lifecycle that the job is currently in.","type":"string","enum":["queued","in_progress","completed"]},"conclusion":{"description":"The outcome of the job.","type":"string","nullable":true},"name":{"description":"The name of the job.","type":"string"},"number":{"type":"integer"},"started_at":{"description":"The time that the step started, in ISO 8601 format.","format":"date-time","type":"string","nullable":true},"completed_at":{"description":"The time that the job finished, in ISO 8601 format.","format":"date-time","type":"string","nullable":true}}}},"check_run_url":{"type":"string"},"labels":{"type":"array","items":{"type":"string"},"description":"Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file."},"runner_id":{"type":"integer","nullable":true,"description":"The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)"},"runner_name":{"type":"string","nullable":true,"description":"The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)"},"runner_group_id":{"type":"integer","nullable":true,"description":"The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)"},"runner_group_name":{"type":"string","nullable":true,"description":"The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)"},"workflow_name":{"type":"string","description":"The name of the workflow.","nullable":true},"head_branch":{"type":"string","description":"The name of the current branch.","nullable":true}},"required":["id","node_id","run_id","run_url","head_sha","workflow_name","head_branch","name","url","html_url","status","conclusion","started_at","completed_at","check_run_url","labels","runner_id","runner_name","runner_group_id","runner_group_name","created_at"]},"label":{"title":"Label","description":"Color-coded labels help you categorize and filter your issues (just like labels in Gmail).","type":"object","properties":{"id":{"description":"Unique identifier for the label.","type":"integer","format":"int64"},"node_id":{"type":"string"},"url":{"description":"URL for the label","type":"string","format":"uri"},"name":{"description":"The name of the label.","type":"string"},"description":{"description":"Optional description of the label, such as its purpose.","type":"string","nullable":true},"color":{"description":"6-character hex code, without the leading #, identifying the color","type":"string"},"default":{"description":"Whether this label comes by default in a new repository.","type":"boolean"},"archived_at":{"description":"Timestamp indicating when the label was archived, or `null` if it has not been archived.","type":"string","nullable":true,"format":"date-time"},"archived_by":{"description":"The user who archived the label, or `null` if it has not been archived.","nullable":true,"allOf":[{"$ref":"#/components/schemas/simple-user"}]}},"required":["id","node_id","url","name","description","color","default","archived_at","archived_by"]},"label-search-result-item":{"title":"Label Search Result Item","description":"Label Search Result Item","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string","format":"uri"},"name":{"type":"string"},"color":{"type":"string"},"default":{"type":"boolean"},"description":{"type":"string","nullable":true},"archived_at":{"description":"Timestamp indicating when the label was archived, or `null` if it has not been archived.","type":"string","format":"date-time","nullable":true},"archived_by":{"description":"The user who archived the label, or `null` if it has not been archived.","nullable":true,"allOf":[{"$ref":"#/components/schemas/simple-user"}]},"score":{"type":"number"},"text_matches":{"$ref":"#/components/schemas/search-result-text-matches"}},"required":["id","node_id","url","name","color","default","description","archived_at","archived_by","score"]},"labeled-issue-event":{"title":"Labeled Issue Event","description":"Labeled Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"label":{"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string"}},"required":["name","color"]},"intent":{"$ref":"#/components/schemas/nullable-issue-event-intent"}},"required":["label","id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"ldap-dn":{"type":"string","description":"The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team."},"license":{"title":"License","description":"License","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"spdx_id":{"type":"string","nullable":true},"url":{"type":"string","format":"uri","nullable":true},"node_id":{"type":"string"},"html_url":{"type":"string","format":"uri"},"description":{"type":"string"},"implementation":{"type":"string"},"permissions":{"type":"array","items":{"type":"string"}},"conditions":{"type":"array","items":{"type":"string"}},"limitations":{"type":"array","items":{"type":"string"}},"body":{"type":"string"},"featured":{"type":"boolean"}},"required":["key","name","url","spdx_id","node_id","html_url","description","implementation","permissions","conditions","limitations","body","featured"]},"license-simple":{"title":"License Simple","description":"License Simple","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"url":{"type":"string","nullable":true,"format":"uri"},"spdx_id":{"type":"string","nullable":true},"node_id":{"type":"string"},"html_url":{"type":"string","format":"uri"}},"required":["key","name","url","spdx_id","node_id"]},"link":{"title":"Link","description":"Hypermedia Link","type":"object","properties":{"href":{"type":"string"}},"required":["href"]},"locked-issue-event":{"title":"Locked Issue Event","description":"Locked Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"lock_reason":{"type":"string","nullable":true}},"required":["lock_reason","id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"milestone":{"title":"Milestone","description":"A collection of related issues and pull requests.","type":"object","properties":{"url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"labels_url":{"type":"string","format":"uri"},"id":{"type":"integer"},"node_id":{"type":"string"},"number":{"description":"The number of the milestone.","type":"integer"},"state":{"description":"The state of the milestone.","type":"string","enum":["open","closed"],"default":"open"},"title":{"description":"The title of the milestone.","type":"string"},"description":{"type":"string","nullable":true},"creator":{"$ref":"#/components/schemas/nullable-simple-user"},"open_issues":{"type":"integer"},"closed_issues":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"closed_at":{"type":"string","format":"date-time","nullable":true},"due_on":{"type":"string","format":"date-time","nullable":true}},"required":["closed_issues","creator","description","due_on","closed_at","id","node_id","labels_url","html_url","number","open_issues","state","title","url","created_at","updated_at"]},"milestoned-issue-event":{"title":"Milestoned Issue Event","description":"Milestoned Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"milestone":{"type":"object","properties":{"title":{"type":"string"}},"required":["title"]}},"required":["milestone","id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"minimal-repository":{"title":"Minimal Repository","description":"Minimal Repository","type":"object","properties":{"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"name":{"type":"string"},"full_name":{"type":"string"},"owner":{"$ref":"#/components/schemas/simple-user"},"private":{"type":"boolean"},"html_url":{"type":"string","format":"uri"},"description":{"type":"string","nullable":true},"fork":{"type":"boolean"},"url":{"type":"string","format":"uri"},"archive_url":{"type":"string"},"assignees_url":{"type":"string"},"blobs_url":{"type":"string"},"branches_url":{"type":"string"},"collaborators_url":{"type":"string"},"comments_url":{"type":"string"},"commits_url":{"type":"string"},"compare_url":{"type":"string"},"contents_url":{"type":"string"},"contributors_url":{"type":"string","format":"uri"},"deployments_url":{"type":"string","format":"uri"},"downloads_url":{"type":"string","format":"uri"},"events_url":{"type":"string","format":"uri"},"forks_url":{"type":"string","format":"uri"},"git_commits_url":{"type":"string"},"git_refs_url":{"type":"string"},"git_tags_url":{"type":"string"},"git_url":{"type":"string"},"issue_comment_url":{"type":"string"},"issue_events_url":{"type":"string"},"issues_url":{"type":"string"},"keys_url":{"type":"string"},"labels_url":{"type":"string"},"languages_url":{"type":"string","format":"uri"},"merges_url":{"type":"string","format":"uri"},"milestones_url":{"type":"string"},"notifications_url":{"type":"string"},"pulls_url":{"type":"string"},"releases_url":{"type":"string"},"ssh_url":{"type":"string"},"stargazers_url":{"type":"string","format":"uri"},"statuses_url":{"type":"string"},"subscribers_url":{"type":"string","format":"uri"},"subscription_url":{"type":"string","format":"uri"},"tags_url":{"type":"string","format":"uri"},"teams_url":{"type":"string","format":"uri"},"trees_url":{"type":"string"},"clone_url":{"type":"string"},"mirror_url":{"type":"string","nullable":true},"hooks_url":{"type":"string","format":"uri"},"svn_url":{"type":"string"},"homepage":{"type":"string","nullable":true},"language":{"type":"string","nullable":true},"forks_count":{"type":"integer"},"stargazers_count":{"type":"integer"},"watchers_count":{"type":"integer"},"size":{"description":"The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.","type":"integer"},"default_branch":{"type":"string"},"open_issues_count":{"type":"integer"},"is_template":{"type":"boolean"},"topics":{"type":"array","items":{"type":"string"}},"has_issues":{"type":"boolean"},"has_projects":{"type":"boolean"},"has_wiki":{"type":"boolean"},"has_pages":{"type":"boolean"},"has_downloads":{"type":"boolean"},"has_discussions":{"type":"boolean"},"has_pull_requests":{"type":"boolean"},"pull_request_creation_policy":{"description":"The policy controlling who can create pull requests: all or collaborators_only.","type":"string","enum":["all","collaborators_only"]},"archived":{"type":"boolean"},"disabled":{"type":"boolean"},"visibility":{"type":"string"},"pushed_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true},"permissions":{"type":"object","properties":{"admin":{"type":"boolean"},"maintain":{"type":"boolean"},"push":{"type":"boolean"},"triage":{"type":"boolean"},"pull":{"type":"boolean"}}},"role_name":{"type":"string"},"temp_clone_token":{"type":"string"},"delete_branch_on_merge":{"type":"boolean"},"subscribers_count":{"type":"integer"},"network_count":{"type":"integer"},"code_of_conduct":{"$ref":"#/components/schemas/code-of-conduct"},"license":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"spdx_id":{"type":"string"},"url":{"type":"string","nullable":true},"node_id":{"type":"string"}},"nullable":true},"forks":{"type":"integer"},"open_issues":{"type":"integer"},"watchers":{"type":"integer"},"allow_forking":{"type":"boolean"},"web_commit_signoff_required":{"type":"boolean"},"security_and_analysis":{"$ref":"#/components/schemas/security-and-analysis"},"custom_properties":{"type":"object","description":"The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.","additionalProperties":true}},"required":["archive_url","assignees_url","blobs_url","branches_url","collaborators_url","comments_url","commits_url","compare_url","contents_url","contributors_url","deployments_url","description","downloads_url","events_url","fork","forks_url","full_name","git_commits_url","git_refs_url","git_tags_url","hooks_url","html_url","id","node_id","issue_comment_url","issue_events_url","issues_url","keys_url","labels_url","languages_url","merges_url","milestones_url","name","notifications_url","owner","private","pulls_url","releases_url","stargazers_url","statuses_url","subscribers_url","subscription_url","tags_url","teams_url","trees_url","url"],"x-github-breaking-changes":[{"changeset":"remove_has_downloads","patch":{"properties":{"has_downloads":null}},"version":"2026-03-10"}]},"moved-column-in-project-issue-event":{"title":"Moved Column in Project Issue Event","description":"Moved Column in Project Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"project_card":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string","format":"uri"},"project_id":{"type":"integer"},"project_url":{"type":"string","format":"uri"},"column_name":{"type":"string"},"previous_column_name":{"type":"string"}},"required":["id","url","project_id","project_url","column_name"]}},"required":["id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"nullable-alert-updated-at":{"type":"string","description":"The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.","format":"date-time","readOnly":true,"nullable":true},"nullable-collaborator":{"title":"Collaborator","description":"Collaborator","type":"object","properties":{"login":{"type":"string"},"id":{"type":"integer","format":"int64"},"email":{"nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"node_id":{"type":"string"},"avatar_url":{"type":"string","format":"uri"},"gravatar_id":{"type":"string","nullable":true},"url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"followers_url":{"type":"string","format":"uri"},"following_url":{"type":"string"},"gists_url":{"type":"string"},"starred_url":{"type":"string"},"subscriptions_url":{"type":"string","format":"uri"},"organizations_url":{"type":"string","format":"uri"},"repos_url":{"type":"string","format":"uri"},"events_url":{"type":"string"},"received_events_url":{"type":"string","format":"uri"},"type":{"type":"string"},"site_admin":{"type":"boolean"},"permissions":{"type":"object","properties":{"pull":{"type":"boolean"},"triage":{"type":"boolean"},"push":{"type":"boolean"},"maintain":{"type":"boolean"},"admin":{"type":"boolean"}},"required":["pull","push","admin"]},"role_name":{"type":"string"},"user_view_type":{"type":"string"}},"required":["avatar_url","events_url","followers_url","following_url","gists_url","gravatar_id","html_url","id","node_id","login","organizations_url","received_events_url","repos_url","site_admin","starred_url","subscriptions_url","type","url","role_name"],"nullable":true},"nullable-git-user":{"title":"Git User","description":"Metaproperties for Git author/committer information.","type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"date":{"type":"string","format":"date-time"}},"nullable":true},"nullable-integration":{"title":"GitHub app","description":"GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.","type":"object","nullable":true,"properties":{"id":{"description":"Unique identifier of the GitHub app","type":"integer"},"slug":{"description":"The slug name of the GitHub app","type":"string"},"node_id":{"type":"string"},"client_id":{"type":"string"},"owner":{"oneOf":[{"$ref":"#/components/schemas/simple-user"},{"$ref":"#/components/schemas/enterprise"}]},"name":{"description":"The name of the GitHub app","type":"string"},"description":{"type":"string","nullable":true},"external_url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"permissions":{"description":"The set of permissions for the GitHub app","type":"object","properties":{"issues":{"type":"string"},"checks":{"type":"string"},"metadata":{"type":"string"},"contents":{"type":"string"},"deployments":{"type":"string"}},"additionalProperties":{"type":"string"}},"events":{"description":"The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.","type":"array","items":{"type":"string"}},"installations_count":{"description":"The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.","type":"integer"}},"required":["id","node_id","owner","name","description","external_url","html_url","created_at","updated_at","permissions","events"]},"nullable-issue":{"title":"Issue","description":"Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.","type":"object","properties":{"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"url":{"description":"URL for the issue","type":"string","format":"uri"},"repository_url":{"type":"string","format":"uri"},"labels_url":{"type":"string"},"comments_url":{"type":"string","format":"uri"},"events_url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"number":{"description":"Number uniquely identifying the issue within its repository","type":"integer"},"state":{"description":"State of the issue; either 'open' or 'closed'","type":"string"},"state_reason":{"description":"The reason for the current state","type":"string","nullable":true,"enum":["completed","reopened","not_planned","duplicate"]},"title":{"description":"Title of the issue","type":"string"},"body":{"description":"Contents of the issue","type":"string","nullable":true},"user":{"$ref":"#/components/schemas/nullable-simple-user"},"labels":{"description":"Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository","type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"url":{"type":"string","format":"uri"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"default":{"type":"boolean"},"archived_by":{"description":"The user who archived the label, or `null` if it has not been archived.","nullable":true,"allOf":[{"$ref":"#/components/schemas/simple-user"}]}}}]}},"assignee":{"$ref":"#/components/schemas/nullable-simple-user"},"assignees":{"type":"array","items":{"$ref":"#/components/schemas/simple-user"}},"milestone":{"$ref":"#/components/schemas/nullable-milestone"},"locked":{"type":"boolean"},"active_lock_reason":{"type":"string","nullable":true},"comments":{"type":"integer"},"pull_request":{"type":"object","properties":{"merged_at":{"type":"string","format":"date-time","nullable":true},"diff_url":{"type":"string","format":"uri","nullable":true},"html_url":{"type":"string","format":"uri","nullable":true},"patch_url":{"type":"string","format":"uri","nullable":true},"url":{"type":"string","format":"uri","nullable":true}},"required":["diff_url","html_url","patch_url","url"]},"closed_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"draft":{"type":"boolean"},"closed_by":{"$ref":"#/components/schemas/nullable-simple-user"},"body_html":{"type":"string"},"body_text":{"type":"string"},"timeline_url":{"type":"string","format":"uri"},"type":{"$ref":"#/components/schemas/issue-type"},"repository":{"$ref":"#/components/schemas/repository"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"author_association":{"$ref":"#/components/schemas/author-association"},"reactions":{"$ref":"#/components/schemas/reaction-rollup"},"sub_issues_summary":{"$ref":"#/components/schemas/sub-issues-summary"},"parent_issue_url":{"description":"URL to get the parent issue of this issue, if it is a sub-issue","type":"string","format":"uri","nullable":true},"pinned_comment":{"$ref":"#/components/schemas/nullable-issue-comment"},"issue_dependencies_summary":{"$ref":"#/components/schemas/issue-dependencies-summary"},"issue_field_values":{"type":"array","items":{"$ref":"#/components/schemas/issue-field-value"}}},"required":["assignee","closed_at","comments","comments_url","events_url","html_url","id","node_id","labels","labels_url","milestone","number","repository_url","state","locked","title","url","user","created_at","updated_at"],"x-github-breaking-changes":[{"changeset":"deprecate_beta_media_type","patch":{"properties":{"pull_request":{"type":"object","properties":{"merged_at":{"nullable":false},"diff_url":{"nullable":false},"html_url":{"nullable":false},"patch_url":{"nullable":false},"url":{"nullable":false}}}}},"version":"2026-03-10"},{"changeset":"remove_singular_assignee_from_issues_and_pull_requests","patch":{"properties":{"assignee":null},"required":["closed_at","comments","comments_url","events_url","html_url","id","node_id","labels","labels_url","milestone","number","repository_url","state","locked","title","url","user","created_at","updated_at"]},"version":"2026-03-10"}],"nullable":true},"nullable-issue-comment":{"title":"Issue Comment","description":"Comments provide a way for people to collaborate on an issue.","type":"object","properties":{"id":{"description":"Unique identifier of the issue comment","type":"integer","format":"int64"},"node_id":{"type":"string"},"url":{"description":"URL for the issue comment","type":"string","format":"uri"},"body":{"description":"Contents of the issue comment","type":"string"},"body_text":{"type":"string"},"body_html":{"type":"string"},"html_url":{"type":"string","format":"uri"},"user":{"$ref":"#/components/schemas/nullable-simple-user"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"issue_url":{"type":"string","format":"uri"},"author_association":{"$ref":"#/components/schemas/author-association"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"reactions":{"$ref":"#/components/schemas/reaction-rollup"},"pin":{"$ref":"#/components/schemas/nullable-pinned-issue-comment"},"minimized":{"$ref":"#/components/schemas/nullable-issue-comment-minimized"}},"required":["id","node_id","html_url","issue_url","user","url","created_at","updated_at"],"nullable":true},"nullable-issue-comment-minimized":{"title":"Minimized Issue Comment","description":"Details about why an issue comment was minimized.","type":"object","properties":{"reason":{"description":"The reason the comment was minimized.","type":"string","nullable":true}},"required":["reason"],"nullable":true},"nullable-issue-event-intent":{"title":"Issue Event Intent","description":"The intent behind an agent's action on an issue, including the rationale and confidence. Present (and `null` when the event carried no agent intent) on supported event types while the issue suggestions feature is enabled for the repository; the property is omitted entirely when the feature is disabled or the event type does not support intent.","type":"object","nullable":true,"properties":{"rationale":{"type":"string","description":"The reasoning the agent provided for the change.","nullable":true},"confidence":{"type":"string","description":"The confidence level the agent had when performing this action.","enum":["LOW","MEDIUM","HIGH"],"nullable":true}}},"nullable-issue-reference":{"title":"Issue Reference","description":"A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency events).","type":"object","nullable":true,"properties":{"number":{"type":"integer","description":"The number of the referenced issue."},"title":{"type":"string","description":"The title of the referenced issue."},"state":{"type":"string","description":"The state of the referenced issue."},"state_reason":{"type":"string","description":"The reason for the referenced issue's state.","nullable":true},"repository":{"$ref":"#/components/schemas/simple-repository"},"issue_type":{"title":"Issue Type","description":"The type of the referenced issue.","type":"object","nullable":true,"properties":{"id":{"type":"integer","description":"The unique identifier of the issue type."},"node_id":{"type":"string","description":"The node identifier of the issue type."},"name":{"type":"string","description":"The name of the issue type."},"color":{"type":"string","description":"The color of the issue type.","nullable":true}},"required":["id","node_id","name"]}},"required":["number","title","state","repository","issue_type"]},"nullable-license-simple":{"title":"License Simple","description":"License Simple","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"url":{"type":"string","nullable":true,"format":"uri"},"spdx_id":{"type":"string","nullable":true},"node_id":{"type":"string"},"html_url":{"type":"string","format":"uri"}},"required":["key","name","url","spdx_id","node_id"],"nullable":true},"nullable-milestone":{"title":"Milestone","description":"A collection of related issues and pull requests.","type":"object","properties":{"url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"labels_url":{"type":"string","format":"uri"},"id":{"type":"integer"},"node_id":{"type":"string"},"number":{"description":"The number of the milestone.","type":"integer"},"state":{"description":"The state of the milestone.","type":"string","enum":["open","closed"],"default":"open"},"title":{"description":"The title of the milestone.","type":"string"},"description":{"type":"string","nullable":true},"creator":{"$ref":"#/components/schemas/nullable-simple-user"},"open_issues":{"type":"integer"},"closed_issues":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"closed_at":{"type":"string","format":"date-time","nullable":true},"due_on":{"type":"string","format":"date-time","nullable":true}},"required":["closed_issues","creator","description","due_on","closed_at","id","node_id","labels_url","html_url","number","open_issues","state","title","url","created_at","updated_at"],"nullable":true},"nullable-pinned-issue-comment":{"title":"Pinned Issue Comment","description":"Context around who pinned an issue comment and when it was pinned.","type":"object","properties":{"pinned_at":{"type":"string","format":"date-time"},"pinned_by":{"$ref":"#/components/schemas/nullable-simple-user"}},"required":["pinned_at","pinned_by"],"nullable":true},"nullable-repository":{"title":"Repository","description":"A repository on GitHub.","type":"object","properties":{"id":{"description":"Unique identifier of the repository","type":"integer","format":"int64"},"node_id":{"type":"string"},"name":{"description":"The name of the repository.","type":"string"},"full_name":{"type":"string"},"license":{"$ref":"#/components/schemas/nullable-license-simple"},"forks":{"type":"integer"},"permissions":{"type":"object","properties":{"admin":{"type":"boolean"},"pull":{"type":"boolean"},"triage":{"type":"boolean"},"push":{"type":"boolean"},"maintain":{"type":"boolean"}},"required":["admin","pull","push"]},"owner":{"$ref":"#/components/schemas/simple-user"},"private":{"description":"Whether the repository is private or public.","default":false,"type":"boolean"},"html_url":{"type":"string","format":"uri"},"description":{"type":"string","nullable":true},"fork":{"type":"boolean"},"url":{"type":"string","format":"uri"},"archive_url":{"type":"string"},"assignees_url":{"type":"string"},"blobs_url":{"type":"string"},"branches_url":{"type":"string"},"collaborators_url":{"type":"string"},"comments_url":{"type":"string"},"commits_url":{"type":"string"},"compare_url":{"type":"string"},"contents_url":{"type":"string"},"contributors_url":{"type":"string","format":"uri"},"deployments_url":{"type":"string","format":"uri"},"downloads_url":{"type":"string","format":"uri"},"events_url":{"type":"string","format":"uri"},"forks_url":{"type":"string","format":"uri"},"git_commits_url":{"type":"string"},"git_refs_url":{"type":"string"},"git_tags_url":{"type":"string"},"git_url":{"type":"string"},"issue_comment_url":{"type":"string"},"issue_events_url":{"type":"string"},"issues_url":{"type":"string"},"keys_url":{"type":"string"},"labels_url":{"type":"string"},"languages_url":{"type":"string","format":"uri"},"merges_url":{"type":"string","format":"uri"},"milestones_url":{"type":"string"},"notifications_url":{"type":"string"},"pulls_url":{"type":"string"},"releases_url":{"type":"string"},"ssh_url":{"type":"string"},"stargazers_url":{"type":"string","format":"uri"},"statuses_url":{"type":"string"},"subscribers_url":{"type":"string","format":"uri"},"subscription_url":{"type":"string","format":"uri"},"tags_url":{"type":"string","format":"uri"},"teams_url":{"type":"string","format":"uri"},"trees_url":{"type":"string"},"clone_url":{"type":"string"},"mirror_url":{"type":"string","format":"uri","nullable":true},"hooks_url":{"type":"string","format":"uri"},"svn_url":{"type":"string","format":"uri"},"homepage":{"type":"string","format":"uri","nullable":true},"language":{"type":"string","nullable":true},"forks_count":{"type":"integer"},"stargazers_count":{"type":"integer"},"watchers_count":{"type":"integer"},"size":{"description":"The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.","type":"integer"},"default_branch":{"description":"The default branch of the repository.","type":"string"},"open_issues_count":{"type":"integer"},"is_template":{"description":"Whether this repository acts as a template that can be used to generate new repositories.","default":false,"type":"boolean"},"topics":{"type":"array","items":{"type":"string"}},"has_issues":{"description":"Whether issues are enabled.","default":true,"type":"boolean"},"has_projects":{"description":"Whether projects are enabled.","default":true,"type":"boolean"},"has_wiki":{"description":"Whether the wiki is enabled.","default":true,"type":"boolean"},"has_pages":{"type":"boolean"},"has_downloads":{"description":"Whether downloads are enabled.","default":true,"type":"boolean","deprecated":true},"has_discussions":{"description":"Whether discussions are enabled.","default":false,"type":"boolean"},"has_pull_requests":{"description":"Whether pull requests are enabled.","default":true,"type":"boolean"},"pull_request_creation_policy":{"description":"The policy controlling who can create pull requests: all or collaborators_only.","type":"string","enum":["all","collaborators_only"]},"archived":{"description":"Whether the repository is archived.","default":false,"type":"boolean"},"disabled":{"type":"boolean","description":"Returns whether or not this repository disabled."},"visibility":{"description":"The repository visibility: public, private, or internal.","default":"public","type":"string"},"pushed_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true},"allow_rebase_merge":{"description":"Whether to allow rebase merges for pull requests.","default":true,"type":"boolean"},"temp_clone_token":{"type":"string"},"allow_squash_merge":{"description":"Whether to allow squash merges for pull requests.","default":true,"type":"boolean"},"allow_auto_merge":{"description":"Whether to allow Auto-merge to be used on pull requests.","default":false,"type":"boolean"},"delete_branch_on_merge":{"description":"Whether to delete head branches when pull requests are merged","default":false,"type":"boolean"},"allow_update_branch":{"description":"Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.","default":false,"type":"boolean"},"use_squash_pr_title_as_default":{"type":"boolean","description":"Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.","default":false,"deprecated":true},"squash_merge_commit_title":{"type":"string","enum":["PR_TITLE","COMMIT_OR_PR_TITLE"],"description":"The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."},"squash_merge_commit_message":{"type":"string","enum":["PR_BODY","COMMIT_MESSAGES","BLANK"],"description":"The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."},"merge_commit_title":{"type":"string","enum":["PR_TITLE","MERGE_MESSAGE"],"description":"The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."},"merge_commit_message":{"type":"string","enum":["PR_BODY","PR_TITLE","BLANK"],"description":"The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."},"allow_merge_commit":{"description":"Whether to allow merge commits for pull requests.","default":true,"type":"boolean"},"allow_forking":{"description":"Whether to allow forking this repo","type":"boolean"},"web_commit_signoff_required":{"description":"Whether to require contributors to sign off on web-based commits","default":false,"type":"boolean"},"open_issues":{"type":"integer"},"watchers":{"type":"integer"},"master_branch":{"type":"string"},"starred_at":{"type":"string"},"anonymous_access_enabled":{"type":"boolean","description":"Whether anonymous git access is enabled for this repository"},"code_search_index_status":{"type":"object","description":"The status of the code search index for this repository","properties":{"lexical_search_ok":{"type":"boolean"},"lexical_commit_sha":{"type":"string"}}}},"required":["archive_url","assignees_url","blobs_url","branches_url","collaborators_url","comments_url","commits_url","compare_url","contents_url","contributors_url","deployments_url","description","downloads_url","events_url","fork","forks_url","full_name","git_commits_url","git_refs_url","git_tags_url","hooks_url","html_url","id","node_id","issue_comment_url","issue_events_url","issues_url","keys_url","labels_url","languages_url","merges_url","milestones_url","name","notifications_url","owner","private","pulls_url","releases_url","stargazers_url","statuses_url","subscribers_url","subscription_url","tags_url","teams_url","trees_url","url","clone_url","default_branch","forks","forks_count","git_url","has_downloads","has_issues","has_projects","has_wiki","has_pages","homepage","language","archived","disabled","mirror_url","open_issues","open_issues_count","license","pushed_at","size","ssh_url","stargazers_count","svn_url","watchers","watchers_count","created_at","updated_at"],"x-github-breaking-changes":[{"changeset":"remove_use_squash_pr_title_as_default","patch":{"properties":{"use_squash_pr_title_as_default":null}},"version":"2026-03-10"},{"changeset":"deprecate_beta_media_type","patch":{"properties":{"master_branch":null}},"version":"2026-03-10"},{"changeset":"remove_has_downloads","patch":{"properties":{"has_downloads":null},"required":["archive_url","assignees_url","blobs_url","branches_url","collaborators_url","comments_url","commits_url","compare_url","contents_url","contributors_url","deployments_url","description","downloads_url","events_url","fork","forks_url","full_name","git_commits_url","git_refs_url","git_tags_url","hooks_url","html_url","id","node_id","issue_comment_url","issue_events_url","issues_url","keys_url","labels_url","languages_url","merges_url","milestones_url","name","notifications_url","owner","private","pulls_url","releases_url","stargazers_url","statuses_url","subscribers_url","subscription_url","tags_url","teams_url","trees_url","url","clone_url","default_branch","forks","forks_count","git_url","has_issues","has_projects","has_wiki","has_pages","homepage","language","archived","disabled","mirror_url","open_issues","open_issues_count","license","pushed_at","size","ssh_url","stargazers_count","svn_url","watchers","watchers_count","created_at","updated_at"]},"version":"2026-03-10"}],"nullable":true},"nullable-secret-scanning-first-detected-location":{"description":"Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n","oneOf":[{"$ref":"#/components/schemas/secret-scanning-location-commit"},{"$ref":"#/components/schemas/secret-scanning-location-wiki-commit"},{"$ref":"#/components/schemas/secret-scanning-location-issue-title"},{"$ref":"#/components/schemas/secret-scanning-location-issue-body"},{"$ref":"#/components/schemas/secret-scanning-location-issue-comment"},{"$ref":"#/components/schemas/secret-scanning-location-discussion-title"},{"$ref":"#/components/schemas/secret-scanning-location-discussion-body"},{"$ref":"#/components/schemas/secret-scanning-location-discussion-comment"},{"$ref":"#/components/schemas/secret-scanning-location-pull-request-title"},{"$ref":"#/components/schemas/secret-scanning-location-pull-request-body"},{"$ref":"#/components/schemas/secret-scanning-location-pull-request-comment"},{"$ref":"#/components/schemas/secret-scanning-location-pull-request-review"},{"$ref":"#/components/schemas/secret-scanning-location-pull-request-review-comment"}],"nullable":true},"nullable-simple-commit":{"title":"Simple Commit","description":"A commit.","type":"object","properties":{"id":{"type":"string","description":"SHA for the commit"},"tree_id":{"type":"string","description":"SHA for the commit's tree"},"message":{"description":"Message describing the purpose of the commit","type":"string"},"timestamp":{"description":"Timestamp of the commit","format":"date-time","type":"string"},"author":{"type":"object","description":"Information about the Git author","properties":{"name":{"description":"Name of the commit's author","type":"string"},"email":{"description":"Git email address of the commit's author","type":"string","format":"email"}},"required":["name","email"],"nullable":true},"committer":{"type":"object","description":"Information about the Git committer","properties":{"name":{"description":"Name of the commit's committer","type":"string"},"email":{"description":"Git email address of the commit's committer","type":"string","format":"email"}},"required":["name","email"],"nullable":true}},"required":["id","tree_id","message","timestamp","author","committer"],"nullable":true},"nullable-simple-user":{"title":"Simple User","description":"A GitHub user.","type":"object","properties":{"name":{"nullable":true,"type":"string"},"email":{"nullable":true,"type":"string"},"login":{"type":"string"},"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"avatar_url":{"type":"string","format":"uri"},"gravatar_id":{"type":"string","nullable":true},"url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"followers_url":{"type":"string","format":"uri"},"following_url":{"type":"string"},"gists_url":{"type":"string"},"starred_url":{"type":"string"},"subscriptions_url":{"type":"string","format":"uri"},"organizations_url":{"type":"string","format":"uri"},"repos_url":{"type":"string","format":"uri"},"events_url":{"type":"string"},"received_events_url":{"type":"string","format":"uri"},"type":{"type":"string"},"site_admin":{"type":"boolean"},"starred_at":{"type":"string"},"user_view_type":{"type":"string"}},"required":["avatar_url","events_url","followers_url","following_url","gists_url","gravatar_id","html_url","id","node_id","login","organizations_url","received_events_url","repos_url","site_admin","starred_url","subscriptions_url","type","url"],"nullable":true},"nullable-team-simple":{"title":"Team Simple","description":"Groups of organization members that gives permissions on specified repositories.","type":"object","properties":{"id":{"description":"Unique identifier of the team","type":"integer"},"node_id":{"type":"string"},"url":{"description":"URL for the team","type":"string","format":"uri"},"members_url":{"type":"string"},"name":{"description":"Name of the team","type":"string"},"description":{"description":"Description of the team","type":"string","nullable":true},"permission":{"description":"Permission that the team will have for its repositories","type":"string"},"privacy":{"description":"The level of privacy this team should have","type":"string"},"notification_setting":{"description":"The notification setting the team has set","type":"string"},"html_url":{"type":"string","format":"uri"},"repositories_url":{"type":"string","format":"uri"},"slug":{"type":"string"},"ldap_dn":{"description":"Distinguished Name (DN) that team maps to within LDAP environment","type":"string"},"type":{"description":"The ownership type of the team","type":"string","enum":["enterprise","organization"]},"organization_id":{"type":"integer","description":"Unique identifier of the organization to which this team belongs"},"enterprise_id":{"type":"integer","description":"Unique identifier of the enterprise to which this team belongs"}},"required":["id","node_id","url","members_url","name","description","permission","html_url","repositories_url","slug","type"],"nullable":true},"org-membership":{"title":"Org Membership","description":"Org Membership","type":"object","properties":{"url":{"type":"string","format":"uri"},"state":{"type":"string","description":"The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.","enum":["active","pending"]},"role":{"type":"string","description":"The user's membership type in the organization.","enum":["admin","member","billing_manager"]},"direct_membership":{"type":"boolean","description":"Whether the user has direct membership in the organization."},"enterprise_teams_providing_indirect_membership":{"type":"array","description":"The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.","maxItems":100,"items":{"type":"string"}},"organization_url":{"type":"string","format":"uri"},"organization":{"$ref":"#/components/schemas/organization-simple"},"user":{"$ref":"#/components/schemas/nullable-simple-user"},"permissions":{"type":"object","properties":{"can_create_repository":{"type":"boolean"}},"required":["can_create_repository"]}},"required":["state","role","organization_url","url","organization","user"]},"organization-create-issue-type":{"type":"object","properties":{"name":{"description":"Name of the issue type.","type":"string"},"is_enabled":{"description":"Whether or not the issue type is enabled at the organization level.","type":"boolean"},"description":{"description":"Description of the issue type.","type":"string","nullable":true},"color":{"description":"Color for the issue type.","type":"string","enum":["gray","blue","green","yellow","orange","red","pink","purple"],"nullable":true}},"required":["name","is_enabled"]},"organization-full":{"title":"Organization Full","description":"Organization Full","type":"object","properties":{"login":{"type":"string"},"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string","format":"uri"},"repos_url":{"type":"string","format":"uri"},"events_url":{"type":"string","format":"uri"},"hooks_url":{"type":"string"},"issues_url":{"type":"string"},"members_url":{"type":"string"},"public_members_url":{"type":"string"},"avatar_url":{"type":"string"},"description":{"type":"string","nullable":true},"name":{"type":"string"},"company":{"type":"string","nullable":true},"blog":{"type":"string","format":"uri","nullable":true},"location":{"type":"string","nullable":true},"email":{"type":"string","format":"email","nullable":true},"twitter_username":{"type":"string","nullable":true},"is_verified":{"type":"boolean"},"has_organization_projects":{"type":"boolean"},"has_repository_projects":{"type":"boolean"},"public_repos":{"type":"integer"},"public_gists":{"type":"integer"},"followers":{"type":"integer"},"following":{"type":"integer"},"html_url":{"type":"string","format":"uri"},"type":{"type":"string"},"total_private_repos":{"type":"integer"},"owned_private_repos":{"type":"integer"},"private_gists":{"type":"integer","nullable":true},"disk_usage":{"type":"integer","nullable":true},"collaborators":{"type":"integer","nullable":true,"description":"The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000."},"billing_email":{"type":"string","format":"email","nullable":true},"plan":{"type":"object","properties":{"name":{"type":"string"},"space":{"type":"integer"},"private_repos":{"type":"integer"},"filled_seats":{"type":"integer"},"seats":{"type":"integer"}},"required":["name","space","private_repos"]},"default_repository_permission":{"type":"string","nullable":true},"default_repository_branch":{"type":"string","nullable":true,"description":"The default branch for repositories created in this organization."},"members_can_create_repositories":{"type":"boolean","nullable":true},"two_factor_requirement_enabled":{"type":"boolean","nullable":true},"members_allowed_repository_creation_type":{"type":"string"},"members_can_create_public_repositories":{"type":"boolean"},"members_can_create_private_repositories":{"type":"boolean"},"members_can_create_internal_repositories":{"type":"boolean"},"members_can_create_pages":{"type":"boolean"},"members_can_create_public_pages":{"type":"boolean"},"members_can_create_private_pages":{"type":"boolean"},"members_can_delete_repositories":{"type":"boolean"},"members_can_change_repo_visibility":{"type":"boolean"},"members_can_invite_outside_collaborators":{"type":"boolean"},"members_can_delete_issues":{"type":"boolean"},"display_commenter_full_name_setting_enabled":{"type":"boolean"},"readers_can_create_discussions":{"type":"boolean"},"members_can_create_teams":{"type":"boolean"},"members_can_view_dependency_insights":{"type":"boolean"},"members_can_fork_private_repositories":{"type":"boolean","nullable":true},"web_commit_signoff_required":{"type":"boolean"},"advanced_security_enabled_for_new_repositories":{"type":"boolean","description":"**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.","deprecated":true},"dependabot_alerts_enabled_for_new_repositories":{"type":"boolean","description":"**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.","deprecated":true},"dependabot_security_updates_enabled_for_new_repositories":{"type":"boolean","description":"**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.","deprecated":true},"dependency_graph_enabled_for_new_repositories":{"type":"boolean","description":"**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.","deprecated":true},"secret_scanning_enabled_for_new_repositories":{"type":"boolean","description":"**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.","deprecated":true},"secret_scanning_push_protection_enabled_for_new_repositories":{"type":"boolean","description":"**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.","deprecated":true},"secret_scanning_push_protection_custom_link_enabled":{"type":"boolean","description":"Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection."},"secret_scanning_push_protection_custom_link":{"type":"string","nullable":true,"description":"An optional URL string to display to contributors who are blocked from pushing a secret."},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"archived_at":{"type":"string","format":"date-time","nullable":true},"deploy_keys_enabled_for_repositories":{"type":"boolean","description":"Controls whether or not deploy keys may be added and used for repositories in the organization."}},"required":["login","url","id","node_id","repos_url","events_url","hooks_url","issues_url","members_url","public_members_url","avatar_url","description","html_url","has_organization_projects","has_repository_projects","public_repos","public_gists","followers","following","type","created_at","updated_at","archived_at"],"x-github-breaking-changes":[{"changeset":"remove_secret_scanning_custom_link_enablement_field","patch":[{"op":"remove","path":"/properties/secret_scanning_push_protection_custom_link_enabled"}],"version":"2026-03-10"}]},"organization-secret-scanning-alert":{"type":"object","properties":{"number":{"$ref":"#/components/schemas/alert-number"},"created_at":{"$ref":"#/components/schemas/alert-created-at"},"updated_at":{"$ref":"#/components/schemas/nullable-alert-updated-at"},"url":{"$ref":"#/components/schemas/alert-url"},"html_url":{"$ref":"#/components/schemas/alert-html-url"},"locations_url":{"type":"string","format":"uri","description":"The REST API URL of the code locations for this alert."},"state":{"$ref":"#/components/schemas/secret-scanning-alert-state"},"resolution":{"$ref":"#/components/schemas/secret-scanning-alert-resolution"},"resolved_at":{"type":"string","format":"date-time","description":"The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.","nullable":true},"resolved_by":{"$ref":"#/components/schemas/nullable-simple-user"},"secret_type":{"type":"string","description":"The type of secret that secret scanning detected."},"secret_type_display_name":{"type":"string","description":"User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\""},"provider":{"type":"string","description":"The provider of the secret that was detected.","nullable":true},"provider_slug":{"type":"string","description":"The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters.","nullable":true},"secret":{"type":"string","description":"The secret that was detected."},"repository":{"$ref":"#/components/schemas/simple-repository"},"push_protection_bypassed":{"type":"boolean","description":"Whether push protection was bypassed for the detected secret.","nullable":true},"push_protection_bypassed_by":{"$ref":"#/components/schemas/nullable-simple-user"},"push_protection_bypassed_at":{"type":"string","format":"date-time","description":"The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.","nullable":true},"push_protection_bypass_request_reviewer":{"$ref":"#/components/schemas/nullable-simple-user"},"push_protection_bypass_request_reviewer_comment":{"type":"string","description":"An optional comment when reviewing a push protection bypass.","nullable":true},"push_protection_bypass_request_comment":{"type":"string","description":"An optional comment when requesting a push protection bypass.","nullable":true},"push_protection_bypass_request_html_url":{"type":"string","format":"uri","description":"The URL to a push protection bypass request.","nullable":true},"resolution_comment":{"type":"string","description":"The comment that was optionally added when this alert was closed","nullable":true},"validity":{"type":"string","description":"The token status as of the latest validity check.","enum":["active","inactive","unknown"]},"publicly_leaked":{"type":"boolean","description":"Whether the secret was publicly leaked.","nullable":true},"multi_repo":{"type":"boolean","description":"Whether the detected secret was found in multiple repositories in the same organization or enterprise.","nullable":true},"is_base64_encoded":{"type":"boolean","description":"A boolean value representing whether or not alert is base64 encoded","nullable":true},"first_location_detected":{"$ref":"#/components/schemas/nullable-secret-scanning-first-detected-location"},"has_more_locations":{"type":"boolean","description":"A boolean value representing whether or not the token in the alert was detected in more than one location."},"assigned_to":{"$ref":"#/components/schemas/nullable-simple-user"},"closure_request_comment":{"type":"string","description":"An optional comment from the closure request author.","nullable":true},"closure_request_reviewer_comment":{"type":"string","description":"An optional comment from the closure request reviewer.","nullable":true},"closure_request_reviewer":{"$ref":"#/components/schemas/nullable-simple-user"}}},"organization-simple":{"title":"Organization Simple","description":"A GitHub organization.","type":"object","properties":{"login":{"type":"string"},"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string","format":"uri"},"repos_url":{"type":"string","format":"uri"},"events_url":{"type":"string","format":"uri"},"hooks_url":{"type":"string"},"issues_url":{"type":"string"},"members_url":{"type":"string"},"public_members_url":{"type":"string"},"avatar_url":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["login","url","id","node_id","repos_url","events_url","hooks_url","issues_url","members_url","public_members_url","avatar_url","description"]},"organization-update-issue-type":{"type":"object","properties":{"name":{"description":"Name of the issue type.","type":"string"},"is_enabled":{"description":"Whether or not the issue type is enabled at the organization level.","type":"boolean"},"description":{"description":"Description of the issue type.","type":"string","nullable":true},"color":{"description":"Color for the issue type.","type":"string","enum":["gray","blue","green","yellow","orange","red","pink","purple"],"nullable":true}},"required":["name","is_enabled"]},"parent-issue-added-issue-event":{"title":"Parent-issue Added Issue Event","description":"Parent-issue Added Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"parent_issue":{"$ref":"#/components/schemas/nullable-issue-reference"}},"required":["parent_issue","id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"parent-issue-removed-issue-event":{"title":"Parent-issue Removed Issue Event","description":"Parent-issue Removed Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"parent_issue":{"$ref":"#/components/schemas/nullable-issue-reference"}},"required":["parent_issue","id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"prevent-self-review":{"type":"boolean","description":"Whether or not a user who created the job is prevented from approving their own job."},"private-user":{"title":"Private User","description":"Private User","type":"object","properties":{"login":{"type":"string"},"id":{"type":"integer","format":"int64"},"user_view_type":{"type":"string"},"node_id":{"type":"string"},"avatar_url":{"type":"string","format":"uri"},"gravatar_id":{"type":"string","nullable":true},"url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"followers_url":{"type":"string","format":"uri"},"following_url":{"type":"string"},"gists_url":{"type":"string"},"starred_url":{"type":"string"},"subscriptions_url":{"type":"string","format":"uri"},"organizations_url":{"type":"string","format":"uri"},"repos_url":{"type":"string","format":"uri"},"events_url":{"type":"string"},"received_events_url":{"type":"string","format":"uri"},"type":{"type":"string"},"site_admin":{"type":"boolean"},"name":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"blog":{"type":"string","nullable":true},"location":{"type":"string","nullable":true},"email":{"type":"string","format":"email","nullable":true},"notification_email":{"type":"string","format":"email","nullable":true},"hireable":{"type":"boolean","nullable":true},"bio":{"type":"string","nullable":true},"twitter_username":{"type":"string","nullable":true},"public_repos":{"type":"integer"},"public_gists":{"type":"integer"},"followers":{"type":"integer"},"following":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"private_gists":{"type":"integer"},"total_private_repos":{"type":"integer"},"owned_private_repos":{"type":"integer"},"disk_usage":{"type":"integer"},"collaborators":{"type":"integer"},"two_factor_authentication":{"type":"boolean"},"plan":{"type":"object","properties":{"collaborators":{"type":"integer"},"name":{"type":"string"},"space":{"type":"integer"},"private_repos":{"type":"integer"}},"required":["collaborators","name","space","private_repos"]},"business_plus":{"type":"boolean"},"ldap_dn":{"type":"string"}},"required":["avatar_url","events_url","followers_url","following_url","gists_url","gravatar_id","html_url","id","node_id","login","organizations_url","received_events_url","repos_url","site_admin","starred_url","subscriptions_url","type","url","bio","blog","company","email","followers","following","hireable","location","name","public_gists","public_repos","created_at","updated_at","collaborators","disk_usage","owned_private_repos","private_gists","total_private_repos","two_factor_authentication"]},"protected-branch-admin-enforced":{"title":"Protected Branch Admin Enforced","description":"Protected Branch Admin Enforced","type":"object","properties":{"url":{"type":"string","format":"uri"},"enabled":{"type":"boolean"}},"required":["url","enabled"]},"protected-branch-pull-request-review":{"title":"Protected Branch Pull Request Review","description":"Protected Branch Pull Request Review","type":"object","properties":{"url":{"type":"string","format":"uri"},"dismissal_restrictions":{"type":"object","properties":{"users":{"description":"The list of users with review dismissal access.","type":"array","items":{"$ref":"#/components/schemas/simple-user"}},"teams":{"description":"The list of teams with review dismissal access.","type":"array","items":{"$ref":"#/components/schemas/team"}},"apps":{"description":"The list of apps with review dismissal access.","type":"array","items":{"$ref":"#/components/schemas/integration"}},"url":{"type":"string"},"users_url":{"type":"string"},"teams_url":{"type":"string"}}},"bypass_pull_request_allowances":{"type":"object","description":"Allow specific users, teams, or apps to bypass pull request requirements.","properties":{"users":{"description":"The list of users allowed to bypass pull request requirements.","type":"array","items":{"$ref":"#/components/schemas/simple-user"}},"teams":{"description":"The list of teams allowed to bypass pull request requirements.","type":"array","items":{"$ref":"#/components/schemas/team"}},"apps":{"description":"The list of apps allowed to bypass pull request requirements.","type":"array","items":{"$ref":"#/components/schemas/integration"}}}},"dismiss_stale_reviews":{"type":"boolean"},"require_code_owner_reviews":{"type":"boolean"},"required_approving_review_count":{"type":"integer","minimum":0,"maximum":6},"require_last_push_approval":{"description":"Whether the most recent push must be approved by someone other than the person who pushed it.","type":"boolean","default":false}},"required":["dismiss_stale_reviews","require_code_owner_reviews"]},"protected-branch-required-status-check":{"title":"Protected Branch Required Status Check","description":"Protected Branch Required Status Check","type":"object","properties":{"url":{"type":"string"},"enforcement_level":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"checks":{"type":"array","items":{"type":"object","properties":{"context":{"type":"string"},"app_id":{"type":"integer","nullable":true}},"required":["context","app_id"]}},"contexts_url":{"type":"string"},"strict":{"type":"boolean"}},"required":["contexts","checks"]},"public-user":{"title":"Public User","description":"Public User","type":"object","properties":{"login":{"type":"string"},"id":{"type":"integer","format":"int64"},"user_view_type":{"type":"string"},"node_id":{"type":"string"},"avatar_url":{"type":"string","format":"uri"},"gravatar_id":{"type":"string","nullable":true},"url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"followers_url":{"type":"string","format":"uri"},"following_url":{"type":"string"},"gists_url":{"type":"string"},"starred_url":{"type":"string"},"subscriptions_url":{"type":"string","format":"uri"},"organizations_url":{"type":"string","format":"uri"},"repos_url":{"type":"string","format":"uri"},"events_url":{"type":"string"},"received_events_url":{"type":"string","format":"uri"},"type":{"type":"string"},"site_admin":{"type":"boolean"},"name":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"blog":{"type":"string","nullable":true},"location":{"type":"string","nullable":true},"email":{"type":"string","format":"email","nullable":true},"notification_email":{"type":"string","format":"email","nullable":true},"hireable":{"type":"boolean","nullable":true},"bio":{"type":"string","nullable":true},"twitter_username":{"type":"string","nullable":true},"public_repos":{"type":"integer"},"public_gists":{"type":"integer"},"followers":{"type":"integer"},"following":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"plan":{"type":"object","properties":{"collaborators":{"type":"integer"},"name":{"type":"string"},"space":{"type":"integer"},"private_repos":{"type":"integer"}},"required":["collaborators","name","space","private_repos"]},"private_gists":{"type":"integer"},"total_private_repos":{"type":"integer"},"owned_private_repos":{"type":"integer"},"disk_usage":{"type":"integer"},"collaborators":{"type":"integer"}},"required":["avatar_url","events_url","followers_url","following_url","gists_url","gravatar_id","html_url","id","node_id","login","organizations_url","received_events_url","repos_url","site_admin","starred_url","subscriptions_url","type","url","bio","blog","company","email","followers","following","hireable","location","name","public_gists","public_repos","created_at","updated_at"],"additionalProperties":false},"pull-request":{"type":"object","title":"Pull Request","description":"Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.","properties":{"url":{"type":"string","format":"uri"},"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"html_url":{"type":"string","format":"uri"},"diff_url":{"type":"string","format":"uri"},"patch_url":{"type":"string","format":"uri"},"issue_url":{"type":"string","format":"uri"},"commits_url":{"type":"string","format":"uri"},"review_comments_url":{"type":"string","format":"uri"},"review_comment_url":{"type":"string"},"comments_url":{"type":"string","format":"uri"},"statuses_url":{"type":"string","format":"uri"},"number":{"description":"Number uniquely identifying the pull request within its repository.","type":"integer"},"state":{"description":"State of this Pull Request. Either `open` or `closed`.","enum":["open","closed"],"type":"string"},"locked":{"type":"boolean"},"title":{"description":"The title of the pull request.","type":"string"},"user":{"$ref":"#/components/schemas/simple-user"},"body":{"type":"string","nullable":true},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"color":{"type":"string"},"default":{"type":"boolean"},"archived_by":{"description":"The user who archived the label, or `null` if it has not been archived.","nullable":true,"allOf":[{"$ref":"#/components/schemas/simple-user"}]}},"required":["id","node_id","url","name","description","color","default","archived_at","archived_by"]}},"milestone":{"$ref":"#/components/schemas/nullable-milestone"},"active_lock_reason":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"closed_at":{"type":"string","format":"date-time","nullable":true},"merged_at":{"type":"string","format":"date-time","nullable":true},"merge_commit_sha":{"type":"string","nullable":true},"assignee":{"$ref":"#/components/schemas/nullable-simple-user"},"assignees":{"type":"array","items":{"$ref":"#/components/schemas/simple-user"}},"requested_reviewers":{"type":"array","items":{"$ref":"#/components/schemas/simple-user"}},"requested_teams":{"type":"array","items":{"$ref":"#/components/schemas/team-simple"}},"head":{"type":"object","properties":{"label":{"type":"string"},"ref":{"type":"string"},"repo":{"$ref":"#/components/schemas/repository"},"sha":{"type":"string"},"user":{"$ref":"#/components/schemas/simple-user"}},"required":["label","ref","repo","sha","user"]},"base":{"type":"object","properties":{"label":{"type":"string"},"ref":{"type":"string"},"repo":{"$ref":"#/components/schemas/repository"},"sha":{"type":"string"},"user":{"$ref":"#/components/schemas/simple-user"}},"required":["label","ref","repo","sha","user"]},"_links":{"type":"object","properties":{"comments":{"$ref":"#/components/schemas/link"},"commits":{"$ref":"#/components/schemas/link"},"statuses":{"$ref":"#/components/schemas/link"},"html":{"$ref":"#/components/schemas/link"},"issue":{"$ref":"#/components/schemas/link"},"review_comments":{"$ref":"#/components/schemas/link"},"review_comment":{"$ref":"#/components/schemas/link"},"self":{"$ref":"#/components/schemas/link"}},"required":["comments","commits","statuses","html","issue","review_comments","review_comment","self"]},"author_association":{"$ref":"#/components/schemas/author-association"},"auto_merge":{"$ref":"#/components/schemas/auto-merge"},"stack":{"$ref":"#/components/schemas/pull-request-stack"},"draft":{"description":"Indicates whether or not the pull request is a draft.","type":"boolean"},"merged":{"type":"boolean"},"mergeable":{"type":"boolean","nullable":true},"rebaseable":{"type":"boolean","nullable":true},"mergeable_state":{"type":"string"},"merged_by":{"$ref":"#/components/schemas/nullable-simple-user"},"comments":{"type":"integer"},"review_comments":{"type":"integer"},"maintainer_can_modify":{"description":"Indicates whether maintainers can modify the pull request.","type":"boolean"},"commits":{"type":"integer"},"additions":{"type":"integer"},"deletions":{"type":"integer"},"changed_files":{"type":"integer"}},"required":["_links","assignee","labels","base","body","closed_at","comments_url","commits_url","created_at","diff_url","head","html_url","id","node_id","issue_url","merge_commit_sha","merged_at","milestone","number","patch_url","review_comment_url","review_comments_url","statuses_url","state","locked","title","updated_at","url","user","author_association","auto_merge","additions","changed_files","comments","commits","deletions","mergeable","mergeable_state","merged","maintainer_can_modify","merged_by","review_comments"],"x-github-breaking-changes":[{"changeset":"remove_pull_request_merge_commit_sha","patch":{"properties":{"merge_commit_sha":null},"required":["_links","assignee","labels","base","body","closed_at","comments_url","commits_url","created_at","diff_url","head","html_url","id","node_id","issue_url","merged_at","milestone","number","patch_url","review_comment_url","review_comments_url","statuses_url","state","locked","title","updated_at","url","user","author_association","auto_merge","additions","changed_files","comments","commits","deletions","mergeable","mergeable_state","merged","maintainer_can_modify","merged_by","review_comments"]},"version":"2026-03-10"},{"changeset":"remove_singular_assignee_from_issues_and_pull_requests","patch":{"properties":{"assignee":null},"required":["_links","labels","base","body","closed_at","comments_url","commits_url","created_at","diff_url","head","html_url","id","node_id","issue_url","merged_at","milestone","number","patch_url","review_comment_url","review_comments_url","statuses_url","state","locked","title","updated_at","url","user","author_association","auto_merge","additions","changed_files","comments","commits","deletions","mergeable","mergeable_state","merged","maintainer_can_modify","merged_by","review_comments"]},"version":"2026-03-10"}]},"pull-request-merge-result":{"title":"Pull Request Merge Result","description":"Pull Request Merge Result","type":"object","properties":{"sha":{"type":"string"},"merged":{"type":"boolean"},"message":{"type":"string"}},"required":["merged","message","sha"]},"pull-request-minimal":{"title":"Pull Request Minimal","type":"object","properties":{"id":{"type":"integer","format":"int64"},"number":{"type":"integer"},"url":{"type":"string"},"head":{"type":"object","properties":{"ref":{"type":"string"},"sha":{"type":"string"},"repo":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"url":{"type":"string"},"name":{"type":"string"}},"required":["id","url","name"]}},"required":["ref","sha","repo"]},"base":{"type":"object","properties":{"ref":{"type":"string"},"sha":{"type":"string"},"repo":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"url":{"type":"string"},"name":{"type":"string"}},"required":["id","url","name"]}},"required":["ref","sha","repo"]}},"required":["id","number","url","head","base"]},"pull-request-review":{"title":"Pull Request Review","description":"Pull Request Reviews are reviews on pull requests.","type":"object","properties":{"id":{"description":"Unique identifier of the review","type":"integer","format":"int64"},"node_id":{"type":"string"},"user":{"$ref":"#/components/schemas/nullable-simple-user"},"body":{"description":"The text of the review.","type":"string"},"state":{"type":"string"},"html_url":{"type":"string","format":"uri"},"pull_request_url":{"type":"string","format":"uri"},"_links":{"type":"object","properties":{"html":{"type":"object","properties":{"href":{"type":"string"}},"required":["href"]},"pull_request":{"type":"object","properties":{"href":{"type":"string"}},"required":["href"]}},"required":["html","pull_request"]},"submitted_at":{"type":"string","format":"date-time"},"commit_id":{"description":"A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`.","type":"string","nullable":true},"body_html":{"type":"string"},"body_text":{"type":"string"},"author_association":{"$ref":"#/components/schemas/author-association"}},"required":["id","node_id","user","body","state","commit_id","html_url","pull_request_url","_links","author_association"]},"pull-request-review-comment":{"title":"Pull Request Review Comment","description":"Pull Request Review Comments are comments on a portion of the Pull Request's diff.","type":"object","properties":{"url":{"description":"URL for the pull request review comment","type":"string"},"pull_request_review_id":{"description":"The ID of the pull request review to which the comment belongs.","type":"integer","format":"int64","nullable":true},"id":{"description":"The ID of the pull request review comment.","type":"integer","format":"int64"},"node_id":{"description":"The node ID of the pull request review comment.","type":"string"},"diff_hunk":{"description":"The diff of the line that the comment refers to.","type":"string"},"path":{"description":"The relative path of the file to which the comment applies.","type":"string"},"position":{"description":"The line index in the diff to which the comment applies. This field is closing down; use `line` instead.","type":"integer"},"original_position":{"description":"The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.","type":"integer"},"commit_id":{"description":"The SHA of the commit to which the comment applies.","type":"string"},"original_commit_id":{"description":"The SHA of the original commit to which the comment applies.","type":"string"},"in_reply_to_id":{"description":"The comment ID to reply to.","type":"integer"},"user":{"$ref":"#/components/schemas/nullable-simple-user"},"body":{"description":"The text of the comment.","type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"html_url":{"description":"HTML URL for the pull request review comment.","type":"string","format":"uri"},"pull_request_url":{"description":"URL for the pull request that the review comment belongs to.","type":"string","format":"uri"},"author_association":{"$ref":"#/components/schemas/author-association"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"uri"}},"required":["href"]},"html":{"type":"object","properties":{"href":{"type":"string","format":"uri"}},"required":["href"]},"pull_request":{"type":"object","properties":{"href":{"type":"string","format":"uri"}},"required":["href"]}},"required":["self","html","pull_request"]},"start_line":{"type":"integer","description":"The first line of the range for a multi-line comment.","nullable":true},"original_start_line":{"type":"integer","description":"The first line of the range for a multi-line comment.","nullable":true},"start_side":{"type":"string","description":"The side of the first line of the range for a multi-line comment.","enum":["LEFT","RIGHT"],"default":"RIGHT","nullable":true},"line":{"description":"The line of the blob to which the comment applies. The last line of the range for a multi-line comment","type":"integer"},"original_line":{"description":"The line of the blob to which the comment applies. The last line of the range for a multi-line comment","type":"integer"},"side":{"description":"The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment","enum":["LEFT","RIGHT"],"default":"RIGHT","type":"string"},"subject_type":{"description":"The level at which the comment is targeted, can be a diff line or a file.","type":"string","enum":["line","file"]},"reactions":{"$ref":"#/components/schemas/reaction-rollup"},"body_html":{"type":"string"},"body_text":{"type":"string"}},"required":["url","id","node_id","pull_request_review_id","diff_hunk","path","commit_id","original_commit_id","user","body","created_at","updated_at","html_url","pull_request_url","author_association","_links"]},"pull-request-review-request":{"title":"Pull Request Review Request","description":"Pull Request Review Request","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/simple-user"}},"teams":{"type":"array","items":{"$ref":"#/components/schemas/team"}}},"required":["users","teams"]},"pull-request-simple":{"title":"Pull Request Simple","description":"Pull Request Simple","type":"object","properties":{"url":{"type":"string","format":"uri"},"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"html_url":{"type":"string","format":"uri"},"diff_url":{"type":"string","format":"uri"},"patch_url":{"type":"string","format":"uri"},"issue_url":{"type":"string","format":"uri"},"commits_url":{"type":"string","format":"uri"},"review_comments_url":{"type":"string","format":"uri"},"review_comment_url":{"type":"string"},"comments_url":{"type":"string","format":"uri"},"statuses_url":{"type":"string","format":"uri"},"number":{"type":"integer"},"state":{"type":"string"},"locked":{"type":"boolean"},"title":{"type":"string"},"user":{"$ref":"#/components/schemas/nullable-simple-user"},"body":{"type":"string","nullable":true},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"default":{"type":"boolean"},"archived_by":{"description":"The user who archived the label, or `null` if it has not been archived.","nullable":true,"allOf":[{"$ref":"#/components/schemas/simple-user"}]}},"required":["id","node_id","url","name","description","color","default","archived_at","archived_by"]}},"milestone":{"$ref":"#/components/schemas/nullable-milestone"},"active_lock_reason":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"closed_at":{"type":"string","format":"date-time","nullable":true},"merged_at":{"type":"string","format":"date-time","nullable":true},"merge_commit_sha":{"type":"string","nullable":true},"assignee":{"$ref":"#/components/schemas/nullable-simple-user"},"assignees":{"type":"array","items":{"$ref":"#/components/schemas/simple-user"}},"requested_reviewers":{"type":"array","items":{"$ref":"#/components/schemas/simple-user"}},"requested_teams":{"type":"array","items":{"$ref":"#/components/schemas/team"}},"head":{"type":"object","properties":{"label":{"type":"string"},"ref":{"type":"string"},"repo":{"$ref":"#/components/schemas/repository"},"sha":{"type":"string"},"user":{"$ref":"#/components/schemas/nullable-simple-user"}},"required":["label","ref","repo","sha","user"]},"base":{"type":"object","properties":{"label":{"type":"string"},"ref":{"type":"string"},"repo":{"$ref":"#/components/schemas/repository"},"sha":{"type":"string"},"user":{"$ref":"#/components/schemas/nullable-simple-user"}},"required":["label","ref","repo","sha","user"]},"_links":{"type":"object","properties":{"comments":{"$ref":"#/components/schemas/link"},"commits":{"$ref":"#/components/schemas/link"},"statuses":{"$ref":"#/components/schemas/link"},"html":{"$ref":"#/components/schemas/link"},"issue":{"$ref":"#/components/schemas/link"},"review_comments":{"$ref":"#/components/schemas/link"},"review_comment":{"$ref":"#/components/schemas/link"},"self":{"$ref":"#/components/schemas/link"}},"required":["comments","commits","statuses","html","issue","review_comments","review_comment","self"]},"author_association":{"$ref":"#/components/schemas/author-association"},"auto_merge":{"$ref":"#/components/schemas/auto-merge"},"stack":{"$ref":"#/components/schemas/pull-request-stack"},"draft":{"description":"Indicates whether or not the pull request is a draft.","type":"boolean"}},"required":["_links","assignee","labels","base","body","closed_at","comments_url","commits_url","created_at","diff_url","head","html_url","id","node_id","issue_url","merge_commit_sha","merged_at","milestone","number","patch_url","review_comment_url","review_comments_url","statuses_url","state","locked","title","updated_at","url","user","author_association","auto_merge"],"x-github-breaking-changes":[{"changeset":"remove_pull_request_merge_commit_sha","patch":{"properties":{"merge_commit_sha":null},"required":["_links","assignee","labels","base","body","closed_at","comments_url","commits_url","created_at","diff_url","head","html_url","id","node_id","issue_url","merged_at","milestone","number","patch_url","review_comment_url","review_comments_url","statuses_url","state","locked","title","updated_at","url","user","author_association","auto_merge"]},"version":"2026-03-10"},{"changeset":"remove_singular_assignee_from_issues_and_pull_requests","patch":{"properties":{"assignee":null},"required":["_links","labels","base","body","closed_at","comments_url","commits_url","created_at","diff_url","head","html_url","id","node_id","issue_url","merged_at","milestone","number","patch_url","review_comment_url","review_comments_url","statuses_url","state","locked","title","updated_at","url","user","author_association","auto_merge"]},"version":"2026-03-10"}]},"pull-request-stack":{"title":"Pull Request Stack","description":"The stack information associated with a pull request.","type":"object","properties":{"base":{"type":"object","properties":{"ref":{"type":"string","description":"The base ref of the stack this pull request belongs to."},"sha":{"type":"string","description":"The base SHA of the stack this pull request belongs to."}},"required":["ref","sha"]},"size":{"type":"integer","description":"The total number of pull requests in the stack."},"position":{"type":"integer","description":"The one-based position of this pull request within the stack, where 1 is the bottom of the stack."},"id":{"type":"integer","description":"The ID of the stack that this pull request belongs to."},"number":{"type":"integer","description":"The number of the stack that this pull request belongs to."}},"required":["base"],"nullable":true},"reaction-rollup":{"title":"Reaction Rollup","type":"object","properties":{"url":{"type":"string","format":"uri"},"total_count":{"type":"integer"},"+1":{"type":"integer"},"-1":{"type":"integer"},"laugh":{"type":"integer"},"confused":{"type":"integer"},"heart":{"type":"integer"},"hooray":{"type":"integer"},"eyes":{"type":"integer"},"rocket":{"type":"integer"}},"required":["url","total_count","+1","-1","laugh","confused","heart","hooray","eyes","rocket"]},"referenced-workflow":{"title":"Referenced workflow","description":"A workflow referenced/reused by the initial caller workflow","type":"object","properties":{"path":{"type":"string"},"sha":{"type":"string"},"ref":{"type":"string"}},"required":["path","sha"]},"release":{"title":"Release","description":"A release.","type":"object","properties":{"url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"assets_url":{"type":"string","format":"uri"},"upload_url":{"type":"string"},"tarball_url":{"type":"string","format":"uri","nullable":true},"zipball_url":{"type":"string","format":"uri","nullable":true},"id":{"type":"integer"},"node_id":{"type":"string"},"tag_name":{"description":"The name of the tag.","type":"string"},"target_commitish":{"description":"Specifies the commitish value that determines where the Git tag is created from.","type":"string"},"name":{"type":"string","nullable":true},"body":{"type":"string","nullable":true},"draft":{"description":"true to create a draft (unpublished) release, false to create a published one.","type":"boolean"},"prerelease":{"description":"Whether to identify the release as a prerelease or a full release.","type":"boolean"},"immutable":{"description":"Whether or not the release is immutable.","type":"boolean"},"created_at":{"type":"string","format":"date-time"},"published_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","nullable":true,"format":"date-time"},"author":{"$ref":"#/components/schemas/simple-user"},"assets":{"type":"array","items":{"$ref":"#/components/schemas/release-asset"}},"body_html":{"type":"string"},"body_text":{"type":"string"},"mentions_count":{"type":"integer"},"discussion_url":{"description":"The URL of the release discussion.","type":"string","format":"uri"},"reactions":{"$ref":"#/components/schemas/reaction-rollup"}},"required":["assets_url","upload_url","tarball_url","zipball_url","created_at","published_at","draft","id","node_id","author","html_url","name","prerelease","tag_name","target_commitish","assets","url"]},"release-asset":{"title":"Release Asset","description":"Data related to a release.","type":"object","properties":{"url":{"type":"string","format":"uri"},"browser_download_url":{"type":"string","format":"uri"},"id":{"type":"integer"},"node_id":{"type":"string"},"name":{"description":"The file name of the asset.","type":"string"},"label":{"type":"string","nullable":true},"state":{"description":"State of the release asset.","type":"string","enum":["uploaded","open"]},"content_type":{"type":"string"},"size":{"type":"integer"},"digest":{"type":"string","nullable":true},"download_count":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"uploader":{"$ref":"#/components/schemas/nullable-simple-user"}},"required":["id","name","content_type","size","digest","state","url","node_id","download_count","label","uploader","browser_download_url","created_at","updated_at"]},"removed-from-project-issue-event":{"title":"Removed from Project Issue Event","description":"Removed from Project Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"project_card":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string","format":"uri"},"project_id":{"type":"integer"},"project_url":{"type":"string","format":"uri"},"column_name":{"type":"string"},"previous_column_name":{"type":"string"}},"required":["id","url","project_id","project_url","column_name"]}},"required":["id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"renamed-issue-event":{"title":"Renamed Issue Event","description":"Renamed Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"rename":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]}},"required":["rename","id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"repo-search-result-item":{"title":"Repo Search Result Item","description":"Repo Search Result Item","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"name":{"type":"string"},"full_name":{"type":"string"},"owner":{"$ref":"#/components/schemas/nullable-simple-user"},"private":{"type":"boolean"},"html_url":{"type":"string","format":"uri"},"description":{"type":"string","nullable":true},"fork":{"type":"boolean"},"url":{"type":"string","format":"uri"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"pushed_at":{"type":"string","format":"date-time"},"homepage":{"type":"string","format":"uri","nullable":true},"size":{"type":"integer"},"stargazers_count":{"type":"integer"},"watchers_count":{"type":"integer"},"language":{"type":"string","nullable":true},"forks_count":{"type":"integer"},"open_issues_count":{"type":"integer"},"master_branch":{"type":"string"},"default_branch":{"type":"string"},"score":{"type":"number"},"forks_url":{"type":"string","format":"uri"},"keys_url":{"type":"string"},"collaborators_url":{"type":"string"},"teams_url":{"type":"string","format":"uri"},"hooks_url":{"type":"string","format":"uri"},"issue_events_url":{"type":"string"},"events_url":{"type":"string","format":"uri"},"assignees_url":{"type":"string"},"branches_url":{"type":"string"},"tags_url":{"type":"string","format":"uri"},"blobs_url":{"type":"string"},"git_tags_url":{"type":"string"},"git_refs_url":{"type":"string"},"trees_url":{"type":"string"},"statuses_url":{"type":"string"},"languages_url":{"type":"string","format":"uri"},"stargazers_url":{"type":"string","format":"uri"},"contributors_url":{"type":"string","format":"uri"},"subscribers_url":{"type":"string","format":"uri"},"subscription_url":{"type":"string","format":"uri"},"commits_url":{"type":"string"},"git_commits_url":{"type":"string"},"comments_url":{"type":"string"},"issue_comment_url":{"type":"string"},"contents_url":{"type":"string"},"compare_url":{"type":"string"},"merges_url":{"type":"string","format":"uri"},"archive_url":{"type":"string"},"downloads_url":{"type":"string","format":"uri"},"issues_url":{"type":"string"},"pulls_url":{"type":"string"},"milestones_url":{"type":"string"},"notifications_url":{"type":"string"},"labels_url":{"type":"string"},"releases_url":{"type":"string"},"deployments_url":{"type":"string","format":"uri"},"git_url":{"type":"string"},"ssh_url":{"type":"string"},"clone_url":{"type":"string"},"svn_url":{"type":"string","format":"uri"},"forks":{"type":"integer"},"open_issues":{"type":"integer"},"watchers":{"type":"integer"},"topics":{"type":"array","items":{"type":"string"}},"mirror_url":{"type":"string","format":"uri","nullable":true},"has_issues":{"type":"boolean"},"has_projects":{"type":"boolean"},"has_pages":{"type":"boolean"},"has_wiki":{"type":"boolean"},"has_downloads":{"type":"boolean"},"has_discussions":{"type":"boolean"},"has_pull_requests":{"type":"boolean"},"pull_request_creation_policy":{"description":"The policy controlling who can create pull requests: all or collaborators_only.","type":"string","enum":["all","collaborators_only"]},"archived":{"type":"boolean"},"disabled":{"type":"boolean","description":"Returns whether or not this repository disabled."},"visibility":{"description":"The repository visibility: public, private, or internal.","type":"string"},"license":{"$ref":"#/components/schemas/nullable-license-simple"},"permissions":{"type":"object","properties":{"admin":{"type":"boolean"},"maintain":{"type":"boolean"},"push":{"type":"boolean"},"triage":{"type":"boolean"},"pull":{"type":"boolean"}},"required":["admin","pull","push"]},"text_matches":{"$ref":"#/components/schemas/search-result-text-matches"},"temp_clone_token":{"type":"string"},"allow_merge_commit":{"type":"boolean"},"allow_squash_merge":{"type":"boolean"},"allow_rebase_merge":{"type":"boolean"},"allow_auto_merge":{"type":"boolean"},"delete_branch_on_merge":{"type":"boolean"},"allow_forking":{"type":"boolean"},"is_template":{"type":"boolean"},"web_commit_signoff_required":{"type":"boolean"}},"required":["archive_url","assignees_url","blobs_url","branches_url","collaborators_url","comments_url","commits_url","compare_url","contents_url","contributors_url","deployments_url","description","downloads_url","events_url","fork","forks_url","full_name","git_commits_url","git_refs_url","git_tags_url","hooks_url","html_url","id","node_id","issue_comment_url","issue_events_url","issues_url","keys_url","labels_url","languages_url","merges_url","milestones_url","name","notifications_url","owner","private","pulls_url","releases_url","stargazers_url","statuses_url","subscribers_url","subscription_url","tags_url","teams_url","trees_url","url","clone_url","default_branch","forks","forks_count","git_url","has_downloads","has_issues","has_projects","has_wiki","has_pages","homepage","language","archived","disabled","mirror_url","open_issues","open_issues_count","license","pushed_at","size","ssh_url","stargazers_count","svn_url","watchers","watchers_count","created_at","updated_at","score"]},"repository":{"title":"Repository","description":"A repository on GitHub.","type":"object","properties":{"id":{"description":"Unique identifier of the repository","type":"integer","format":"int64"},"node_id":{"type":"string"},"name":{"description":"The name of the repository.","type":"string"},"full_name":{"type":"string"},"license":{"$ref":"#/components/schemas/nullable-license-simple"},"forks":{"type":"integer"},"permissions":{"type":"object","properties":{"admin":{"type":"boolean"},"pull":{"type":"boolean"},"triage":{"type":"boolean"},"push":{"type":"boolean"},"maintain":{"type":"boolean"}},"required":["admin","pull","push"]},"owner":{"$ref":"#/components/schemas/simple-user"},"private":{"description":"Whether the repository is private or public.","default":false,"type":"boolean"},"html_url":{"type":"string","format":"uri"},"description":{"type":"string","nullable":true},"fork":{"type":"boolean"},"url":{"type":"string","format":"uri"},"archive_url":{"type":"string"},"assignees_url":{"type":"string"},"blobs_url":{"type":"string"},"branches_url":{"type":"string"},"collaborators_url":{"type":"string"},"comments_url":{"type":"string"},"commits_url":{"type":"string"},"compare_url":{"type":"string"},"contents_url":{"type":"string"},"contributors_url":{"type":"string","format":"uri"},"deployments_url":{"type":"string","format":"uri"},"downloads_url":{"type":"string","format":"uri"},"events_url":{"type":"string","format":"uri"},"forks_url":{"type":"string","format":"uri"},"git_commits_url":{"type":"string"},"git_refs_url":{"type":"string"},"git_tags_url":{"type":"string"},"git_url":{"type":"string"},"issue_comment_url":{"type":"string"},"issue_events_url":{"type":"string"},"issues_url":{"type":"string"},"keys_url":{"type":"string"},"labels_url":{"type":"string"},"languages_url":{"type":"string","format":"uri"},"merges_url":{"type":"string","format":"uri"},"milestones_url":{"type":"string"},"notifications_url":{"type":"string"},"pulls_url":{"type":"string"},"releases_url":{"type":"string"},"ssh_url":{"type":"string"},"stargazers_url":{"type":"string","format":"uri"},"statuses_url":{"type":"string"},"subscribers_url":{"type":"string","format":"uri"},"subscription_url":{"type":"string","format":"uri"},"tags_url":{"type":"string","format":"uri"},"teams_url":{"type":"string","format":"uri"},"trees_url":{"type":"string"},"clone_url":{"type":"string"},"mirror_url":{"type":"string","format":"uri","nullable":true},"hooks_url":{"type":"string","format":"uri"},"svn_url":{"type":"string","format":"uri"},"homepage":{"type":"string","format":"uri","nullable":true},"language":{"type":"string","nullable":true},"forks_count":{"type":"integer"},"stargazers_count":{"type":"integer"},"watchers_count":{"type":"integer"},"size":{"description":"The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.","type":"integer"},"default_branch":{"description":"The default branch of the repository.","type":"string"},"open_issues_count":{"type":"integer"},"is_template":{"description":"Whether this repository acts as a template that can be used to generate new repositories.","default":false,"type":"boolean"},"topics":{"type":"array","items":{"type":"string"}},"has_issues":{"description":"Whether issues are enabled.","default":true,"type":"boolean"},"has_projects":{"description":"Whether projects are enabled.","default":true,"type":"boolean"},"has_wiki":{"description":"Whether the wiki is enabled.","default":true,"type":"boolean"},"has_pages":{"type":"boolean"},"has_downloads":{"description":"Whether downloads are enabled.","default":true,"type":"boolean","deprecated":true},"has_discussions":{"description":"Whether discussions are enabled.","default":false,"type":"boolean"},"has_pull_requests":{"description":"Whether pull requests are enabled.","default":true,"type":"boolean"},"pull_request_creation_policy":{"description":"The policy controlling who can create pull requests: all or collaborators_only.","type":"string","enum":["all","collaborators_only"]},"archived":{"description":"Whether the repository is archived.","default":false,"type":"boolean"},"disabled":{"type":"boolean","description":"Returns whether or not this repository disabled."},"visibility":{"description":"The repository visibility: public, private, or internal.","default":"public","type":"string"},"pushed_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true},"allow_rebase_merge":{"description":"Whether to allow rebase merges for pull requests.","default":true,"type":"boolean"},"temp_clone_token":{"type":"string"},"allow_squash_merge":{"description":"Whether to allow squash merges for pull requests.","default":true,"type":"boolean"},"allow_auto_merge":{"description":"Whether to allow Auto-merge to be used on pull requests.","default":false,"type":"boolean"},"delete_branch_on_merge":{"description":"Whether to delete head branches when pull requests are merged","default":false,"type":"boolean"},"allow_update_branch":{"description":"Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.","default":false,"type":"boolean"},"use_squash_pr_title_as_default":{"type":"boolean","description":"Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.","default":false,"deprecated":true},"squash_merge_commit_title":{"type":"string","enum":["PR_TITLE","COMMIT_OR_PR_TITLE"],"description":"The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."},"squash_merge_commit_message":{"type":"string","enum":["PR_BODY","COMMIT_MESSAGES","BLANK"],"description":"The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."},"merge_commit_title":{"type":"string","enum":["PR_TITLE","MERGE_MESSAGE"],"description":"The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."},"merge_commit_message":{"type":"string","enum":["PR_BODY","PR_TITLE","BLANK"],"description":"The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."},"allow_merge_commit":{"description":"Whether to allow merge commits for pull requests.","default":true,"type":"boolean"},"allow_forking":{"description":"Whether to allow forking this repo","type":"boolean"},"web_commit_signoff_required":{"description":"Whether to require contributors to sign off on web-based commits","default":false,"type":"boolean"},"open_issues":{"type":"integer"},"watchers":{"type":"integer"},"master_branch":{"type":"string"},"starred_at":{"type":"string"},"anonymous_access_enabled":{"type":"boolean","description":"Whether anonymous git access is enabled for this repository"},"code_search_index_status":{"type":"object","description":"The status of the code search index for this repository","properties":{"lexical_search_ok":{"type":"boolean"},"lexical_commit_sha":{"type":"string"}}}},"required":["archive_url","assignees_url","blobs_url","branches_url","collaborators_url","comments_url","commits_url","compare_url","contents_url","contributors_url","deployments_url","description","downloads_url","events_url","fork","forks_url","full_name","git_commits_url","git_refs_url","git_tags_url","hooks_url","html_url","id","node_id","issue_comment_url","issue_events_url","issues_url","keys_url","labels_url","languages_url","merges_url","milestones_url","name","notifications_url","owner","private","pulls_url","releases_url","stargazers_url","statuses_url","subscribers_url","subscription_url","tags_url","teams_url","trees_url","url","clone_url","default_branch","forks","forks_count","git_url","has_downloads","has_issues","has_projects","has_wiki","has_pages","homepage","language","archived","disabled","mirror_url","open_issues","open_issues_count","license","pushed_at","size","ssh_url","stargazers_count","svn_url","watchers","watchers_count","created_at","updated_at"],"x-github-breaking-changes":[{"changeset":"remove_use_squash_pr_title_as_default","patch":{"properties":{"use_squash_pr_title_as_default":null}},"version":"2026-03-10"},{"changeset":"deprecate_beta_media_type","patch":{"properties":{"master_branch":null}},"version":"2026-03-10"},{"changeset":"remove_has_downloads","patch":{"properties":{"has_downloads":null},"required":["archive_url","assignees_url","blobs_url","branches_url","collaborators_url","comments_url","commits_url","compare_url","contents_url","contributors_url","deployments_url","description","downloads_url","events_url","fork","forks_url","full_name","git_commits_url","git_refs_url","git_tags_url","hooks_url","html_url","id","node_id","issue_comment_url","issue_events_url","issues_url","keys_url","labels_url","languages_url","merges_url","milestones_url","name","notifications_url","owner","private","pulls_url","releases_url","stargazers_url","statuses_url","subscribers_url","subscription_url","tags_url","teams_url","trees_url","url","clone_url","default_branch","forks","forks_count","git_url","has_issues","has_projects","has_wiki","has_pages","homepage","language","archived","disabled","mirror_url","open_issues","open_issues_count","license","pushed_at","size","ssh_url","stargazers_count","svn_url","watchers","watchers_count","created_at","updated_at"]},"version":"2026-03-10"}]},"repository-collaborator-permission":{"title":"Repository Collaborator Permission","description":"Repository Collaborator Permission","type":"object","properties":{"permission":{"type":"string"},"role_name":{"type":"string"},"user":{"$ref":"#/components/schemas/nullable-collaborator"}},"required":["permission","role_name","user"]},"repository-invitation":{"title":"Repository Invitation","description":"Repository invitations let you manage who you collaborate with.","type":"object","properties":{"id":{"description":"Unique identifier of the repository invitation.","type":"integer","format":"int64"},"repository":{"$ref":"#/components/schemas/minimal-repository"},"invitee":{"$ref":"#/components/schemas/nullable-simple-user"},"inviter":{"$ref":"#/components/schemas/nullable-simple-user"},"permissions":{"description":"The permission associated with the invitation.","type":"string","enum":["read","write","admin","triage","maintain"]},"created_at":{"type":"string","format":"date-time"},"expired":{"description":"Whether or not the invitation has expired","type":"boolean"},"url":{"description":"URL for the repository invitation","type":"string"},"html_url":{"type":"string"},"node_id":{"type":"string"}},"required":["id","node_id","permissions","inviter","invitee","repository","url","html_url","created_at"]},"review-comment":{"title":"Legacy Review Comment","description":"Legacy Review Comment","type":"object","properties":{"url":{"type":"string","format":"uri"},"pull_request_review_id":{"type":"integer","format":"int64","nullable":true},"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"diff_hunk":{"type":"string"},"path":{"type":"string"},"position":{"type":"integer","nullable":true},"original_position":{"type":"integer"},"commit_id":{"type":"string"},"original_commit_id":{"type":"string"},"in_reply_to_id":{"type":"integer"},"user":{"$ref":"#/components/schemas/nullable-simple-user"},"body":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"html_url":{"type":"string","format":"uri"},"pull_request_url":{"type":"string","format":"uri"},"author_association":{"$ref":"#/components/schemas/author-association"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/link"},"html":{"$ref":"#/components/schemas/link"},"pull_request":{"$ref":"#/components/schemas/link"}},"required":["self","html","pull_request"]},"body_text":{"type":"string"},"body_html":{"type":"string"},"reactions":{"$ref":"#/components/schemas/reaction-rollup"},"side":{"description":"The side of the first line of the range for a multi-line comment.","enum":["LEFT","RIGHT"],"default":"RIGHT","type":"string"},"start_side":{"type":"string","description":"The side of the first line of the range for a multi-line comment.","enum":["LEFT","RIGHT"],"default":"RIGHT","nullable":true},"line":{"description":"The line of the blob to which the comment applies. The last line of the range for a multi-line comment","type":"integer"},"original_line":{"description":"The original line of the blob to which the comment applies. The last line of the range for a multi-line comment","type":"integer"},"start_line":{"description":"The first line of the range for a multi-line comment.","type":"integer","nullable":true},"original_start_line":{"description":"The original first line of the range for a multi-line comment.","type":"integer","nullable":true},"subject_type":{"description":"The level at which the comment is targeted, can be a diff line or a file.","type":"string","enum":["line","file"]}},"required":["id","node_id","url","body","diff_hunk","path","position","original_position","commit_id","original_commit_id","user","pull_request_review_id","html_url","pull_request_url","_links","author_association","created_at","updated_at"]},"review-dismissed-issue-event":{"title":"Review Dismissed Issue Event","description":"Review Dismissed Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"dismissed_review":{"type":"object","properties":{"state":{"type":"string"},"review_id":{"type":"integer"},"dismissal_message":{"nullable":true,"type":"string"},"dismissal_commit_id":{"type":"string"}},"required":["state","review_id","dismissal_message"]}},"required":["dismissed_review","id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"review-request-removed-issue-event":{"title":"Review Request Removed Issue Event","description":"Review Request Removed Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"review_requester":{"$ref":"#/components/schemas/simple-user"},"requested_team":{"$ref":"#/components/schemas/team"},"requested_reviewer":{"$ref":"#/components/schemas/simple-user"}},"required":["review_requester","id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"review-requested-issue-event":{"title":"Review Requested Issue Event","description":"Review Requested Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"review_requester":{"$ref":"#/components/schemas/simple-user"},"requested_team":{"$ref":"#/components/schemas/team"},"requested_reviewer":{"$ref":"#/components/schemas/simple-user"}},"required":["review_requester","id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"scim-error":{"title":"Scim Error","description":"Scim Error","type":"object","properties":{"message":{"type":"string","nullable":true},"documentation_url":{"type":"string","nullable":true},"detail":{"type":"string","nullable":true},"status":{"type":"integer"},"scimType":{"type":"string","nullable":true},"schemas":{"type":"array","items":{"type":"string"}}}},"search-result-text-matches":{"title":"Search Result Text Matches","type":"array","items":{"type":"object","properties":{"object_url":{"type":"string"},"object_type":{"nullable":true,"type":"string"},"property":{"type":"string"},"fragment":{"type":"string"},"matches":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"indices":{"type":"array","items":{"type":"integer"}}}}}}}},"secret-scanning-alert":{"type":"object","properties":{"number":{"$ref":"#/components/schemas/alert-number"},"created_at":{"$ref":"#/components/schemas/alert-created-at"},"updated_at":{"$ref":"#/components/schemas/nullable-alert-updated-at"},"url":{"$ref":"#/components/schemas/alert-url"},"html_url":{"$ref":"#/components/schemas/alert-html-url"},"locations_url":{"type":"string","format":"uri","description":"The REST API URL of the code locations for this alert."},"state":{"$ref":"#/components/schemas/secret-scanning-alert-state"},"resolution":{"$ref":"#/components/schemas/secret-scanning-alert-resolution"},"resolved_at":{"type":"string","format":"date-time","description":"The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.","nullable":true},"resolved_by":{"$ref":"#/components/schemas/nullable-simple-user"},"resolution_comment":{"type":"string","description":"An optional comment to resolve an alert.","nullable":true},"secret_type":{"type":"string","description":"The type of secret that secret scanning detected."},"secret_type_display_name":{"type":"string","description":"User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\""},"provider":{"type":"string","description":"The provider of the secret that was detected.","nullable":true},"provider_slug":{"type":"string","description":"The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters.","nullable":true},"secret":{"type":"string","description":"The secret that was detected."},"push_protection_bypassed":{"type":"boolean","description":"Whether push protection was bypassed for the detected secret.","nullable":true},"push_protection_bypassed_by":{"$ref":"#/components/schemas/nullable-simple-user"},"push_protection_bypassed_at":{"type":"string","format":"date-time","description":"The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.","nullable":true},"push_protection_bypass_request_reviewer":{"$ref":"#/components/schemas/nullable-simple-user"},"push_protection_bypass_request_reviewer_comment":{"type":"string","description":"An optional comment when reviewing a push protection bypass.","nullable":true},"push_protection_bypass_request_comment":{"type":"string","description":"An optional comment when requesting a push protection bypass.","nullable":true},"push_protection_bypass_request_html_url":{"type":"string","format":"uri","description":"The URL to a push protection bypass request.","nullable":true},"validity":{"type":"string","description":"The token status as of the latest validity check.","enum":["active","inactive","unknown"]},"publicly_leaked":{"type":"boolean","description":"Whether the detected secret was publicly leaked.","nullable":true},"multi_repo":{"type":"boolean","description":"Whether the detected secret was found in multiple repositories under the same organization or enterprise.","nullable":true},"is_base64_encoded":{"type":"boolean","description":"A boolean value representing whether or not alert is base64 encoded","nullable":true},"first_location_detected":{"$ref":"#/components/schemas/nullable-secret-scanning-first-detected-location"},"has_more_locations":{"type":"boolean","description":"A boolean value representing whether or not the token in the alert was detected in more than one location."},"assigned_to":{"$ref":"#/components/schemas/nullable-simple-user"},"closure_request_comment":{"type":"string","description":"An optional comment from the closure request author.","nullable":true},"closure_request_reviewer_comment":{"type":"string","description":"An optional comment from the closure request reviewer.","nullable":true},"closure_request_reviewer":{"$ref":"#/components/schemas/nullable-simple-user"}}},"secret-scanning-alert-assignee":{"description":"The username of the user to assign to the alert. Set to `null` to unassign the alert.","type":"string","nullable":true},"secret-scanning-alert-metadata":{"type":"array","description":"A list of metadata key/value pairs associated with the secret scanning alert.","readOnly":true,"items":{"type":"object","properties":{"key":{"type":"string","description":"The metadata key."},"value":{"type":"string","description":"The metadata value."}},"required":["key","value"]}},"secret-scanning-alert-resolution":{"type":"string","description":"**Required when the `state` is `resolved`.** The reason for resolving the alert.","nullable":true,"enum":["false_positive","wont_fix","revoked","used_in_tests"]},"secret-scanning-alert-resolution-comment":{"description":"An optional comment when closing or reopening an alert. Cannot be updated or deleted.","type":"string","nullable":true},"secret-scanning-alert-state":{"description":"Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.","type":"string","enum":["open","resolved"]},"secret-scanning-alert-with-metadata":{"type":"object","properties":{"number":{"$ref":"#/components/schemas/alert-number"},"created_at":{"$ref":"#/components/schemas/alert-created-at"},"updated_at":{"$ref":"#/components/schemas/nullable-alert-updated-at"},"url":{"$ref":"#/components/schemas/alert-url"},"html_url":{"$ref":"#/components/schemas/alert-html-url"},"locations_url":{"type":"string","format":"uri","description":"The REST API URL of the code locations for this alert."},"state":{"$ref":"#/components/schemas/secret-scanning-alert-state"},"resolution":{"$ref":"#/components/schemas/secret-scanning-alert-resolution"},"resolved_at":{"type":"string","format":"date-time","description":"The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.","nullable":true},"resolved_by":{"$ref":"#/components/schemas/nullable-simple-user"},"resolution_comment":{"type":"string","description":"An optional comment to resolve an alert.","nullable":true},"secret_type":{"type":"string","description":"The type of secret that secret scanning detected."},"secret_type_display_name":{"type":"string","description":"User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\""},"provider":{"type":"string","description":"The provider of the secret that was detected.","nullable":true},"provider_slug":{"type":"string","description":"The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters.","nullable":true},"secret":{"type":"string","description":"The secret that was detected."},"push_protection_bypassed":{"type":"boolean","description":"Whether push protection was bypassed for the detected secret.","nullable":true},"push_protection_bypassed_by":{"$ref":"#/components/schemas/nullable-simple-user"},"push_protection_bypassed_at":{"type":"string","format":"date-time","description":"The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.","nullable":true},"push_protection_bypass_request_reviewer":{"$ref":"#/components/schemas/nullable-simple-user"},"push_protection_bypass_request_reviewer_comment":{"type":"string","description":"An optional comment when reviewing a push protection bypass.","nullable":true},"push_protection_bypass_request_comment":{"type":"string","description":"An optional comment when requesting a push protection bypass.","nullable":true},"push_protection_bypass_request_html_url":{"type":"string","format":"uri","description":"The URL to a push protection bypass request.","nullable":true},"validity":{"type":"string","description":"The token status as of the latest validity check.","enum":["active","inactive","unknown"]},"publicly_leaked":{"type":"boolean","description":"Whether the detected secret was publicly leaked.","nullable":true},"multi_repo":{"type":"boolean","description":"Whether the detected secret was found in multiple repositories under the same organization or enterprise.","nullable":true},"is_base64_encoded":{"type":"boolean","description":"A boolean value representing whether or not alert is base64 encoded","nullable":true},"first_location_detected":{"$ref":"#/components/schemas/nullable-secret-scanning-first-detected-location"},"has_more_locations":{"type":"boolean","description":"A boolean value representing whether or not the token in the alert was detected in more than one location."},"assigned_to":{"$ref":"#/components/schemas/nullable-simple-user"},"closure_request_comment":{"type":"string","description":"An optional comment from the closure request author.","nullable":true},"closure_request_reviewer_comment":{"type":"string","description":"An optional comment from the closure request reviewer.","nullable":true},"closure_request_reviewer":{"$ref":"#/components/schemas/nullable-simple-user"},"metadata":{"$ref":"#/components/schemas/secret-scanning-alert-metadata"}}},"secret-scanning-location-commit":{"description":"Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.","type":"object","properties":{"path":{"type":"string","description":"The file path in the repository"},"start_line":{"type":"number","description":"Line number at which the secret starts in the file"},"end_line":{"type":"number","description":"Line number at which the secret ends in the file"},"start_column":{"type":"number","description":"The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII"},"end_column":{"type":"number","description":"The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII"},"blob_sha":{"type":"string","description":"SHA-1 hash ID of the associated blob"},"blob_url":{"type":"string","description":"The API URL to get the associated blob resource"},"commit_sha":{"type":"string","description":"SHA-1 hash ID of the associated commit"},"commit_url":{"type":"string","description":"The API URL to get the associated commit resource"},"html_url":{"type":"string","format":"uri","description":"The GitHub URL to get the associated commit resource."}},"required":["path","start_line","end_line","start_column","end_column","blob_sha","blob_url","commit_sha","commit_url"]},"secret-scanning-location-discussion-body":{"description":"Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.","type":"object","properties":{"discussion_body_url":{"type":"string","format":"uri","description":"The URL to the discussion where the secret was detected."}},"required":["discussion_body_url"]},"secret-scanning-location-discussion-comment":{"description":"Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.","type":"object","properties":{"discussion_comment_url":{"type":"string","format":"uri","description":"The API URL to get the discussion comment where the secret was detected."}},"required":["discussion_comment_url"]},"secret-scanning-location-discussion-title":{"description":"Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.","type":"object","properties":{"discussion_title_url":{"type":"string","format":"uri","description":"The URL to the discussion where the secret was detected."}},"required":["discussion_title_url"]},"secret-scanning-location-issue-body":{"description":"Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.","type":"object","properties":{"issue_body_url":{"type":"string","format":"uri","description":"The API URL to get the issue where the secret was detected."},"html_url":{"type":"string","format":"uri","description":"The GitHub URL for the issue where the secret was detected."}},"required":["issue_body_url"]},"secret-scanning-location-issue-comment":{"description":"Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.","type":"object","properties":{"issue_comment_url":{"type":"string","format":"uri","description":"The API URL to get the issue comment where the secret was detected."},"html_url":{"type":"string","format":"uri","description":"The GitHub URL for the issue comment where the secret was detected."}},"required":["issue_comment_url"]},"secret-scanning-location-issue-title":{"description":"Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.","type":"object","properties":{"issue_title_url":{"type":"string","format":"uri","description":"The API URL to get the issue where the secret was detected."},"html_url":{"type":"string","format":"uri","description":"The GitHub URL for the issue where the secret was detected."}},"required":["issue_title_url"]},"secret-scanning-location-pull-request-body":{"description":"Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.","type":"object","properties":{"pull_request_body_url":{"type":"string","format":"uri","description":"The API URL to get the pull request where the secret was detected."},"html_url":{"type":"string","format":"uri","description":"The GitHub URL for the pull request where the secret was detected."}},"required":["pull_request_body_url"]},"secret-scanning-location-pull-request-comment":{"description":"Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.","type":"object","properties":{"pull_request_comment_url":{"type":"string","format":"uri","description":"The API URL to get the pull request comment where the secret was detected."},"html_url":{"type":"string","format":"uri","description":"The GitHub URL for the pull request comment where the secret was detected."}},"required":["pull_request_comment_url"]},"secret-scanning-location-pull-request-review":{"description":"Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.","type":"object","properties":{"pull_request_review_url":{"type":"string","format":"uri","description":"The API URL to get the pull request review where the secret was detected."},"html_url":{"type":"string","format":"uri","description":"The GitHub URL for the pull request review where the secret was detected."}},"required":["pull_request_review_url"]},"secret-scanning-location-pull-request-review-comment":{"description":"Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.","type":"object","properties":{"pull_request_review_comment_url":{"type":"string","format":"uri","description":"The API URL to get the pull request review comment where the secret was detected."},"html_url":{"type":"string","format":"uri","description":"The GitHub URL for the pull request review comment where the secret was detected."}},"required":["pull_request_review_comment_url"]},"secret-scanning-location-pull-request-title":{"description":"Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.","type":"object","properties":{"pull_request_title_url":{"type":"string","format":"uri","description":"The API URL to get the pull request where the secret was detected."},"html_url":{"type":"string","format":"uri","description":"The GitHub URL for the pull request where the secret was detected."}},"required":["pull_request_title_url"]},"secret-scanning-location-wiki-commit":{"description":"Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.","type":"object","properties":{"path":{"type":"string","description":"The file path of the wiki page"},"start_line":{"type":"number","description":"Line number at which the secret starts in the file"},"end_line":{"type":"number","description":"Line number at which the secret ends in the file"},"start_column":{"type":"number","description":"The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII."},"end_column":{"type":"number","description":"The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII."},"blob_sha":{"type":"string","description":"SHA-1 hash ID of the associated blob"},"page_url":{"type":"string","description":"The GitHub URL to get the associated wiki page"},"commit_sha":{"type":"string","description":"SHA-1 hash ID of the associated commit"},"commit_url":{"type":"string","description":"The GitHub URL to get the associated wiki commit"}},"required":["path","start_line","end_line","start_column","end_column","blob_sha","page_url","commit_sha","commit_url"]},"security-advisory-epss":{"type":"object","nullable":true,"readOnly":true,"description":"The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).","properties":{"percentage":{"type":"number","minimum":0,"maximum":100},"percentile":{"type":"number","minimum":0,"maximum":100}}},"security-and-analysis":{"nullable":true,"type":"object","properties":{"advanced_security":{"description":"Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n","type":"object","properties":{"status":{"type":"string","enum":["enabled","disabled"]}}},"code_security":{"type":"object","properties":{"status":{"type":"string","enum":["enabled","disabled"]}}},"dependabot_security_updates":{"description":"Enable or disable Dependabot security updates for the repository.","type":"object","properties":{"status":{"description":"The enablement status of Dependabot security updates for the repository.","type":"string","enum":["enabled","disabled"]}}},"secret_scanning":{"type":"object","properties":{"status":{"type":"string","enum":["enabled","disabled"]}}},"secret_scanning_push_protection":{"type":"object","properties":{"status":{"type":"string","enum":["enabled","disabled"]}}},"secret_scanning_non_provider_patterns":{"type":"object","properties":{"status":{"type":"string","enum":["enabled","disabled"]}}},"secret_scanning_ai_detection":{"type":"object","properties":{"status":{"type":"string","enum":["enabled","disabled"]}}},"secret_scanning_delegated_alert_dismissal":{"type":"object","properties":{"status":{"type":"string","enum":["enabled","disabled"]}}},"secret_scanning_delegated_bypass":{"type":"object","properties":{"status":{"type":"string","enum":["enabled","disabled"]}}},"secret_scanning_delegated_bypass_options":{"type":"object","properties":{"reviewers":{"type":"array","description":"The bypass reviewers for secret scanning delegated bypass","items":{"type":"object","required":["reviewer_id","reviewer_type"],"properties":{"reviewer_id":{"type":"integer","description":"The ID of the team or role selected as a bypass reviewer"},"reviewer_type":{"type":"string","description":"The type of the bypass reviewer","enum":["TEAM","ROLE"]},"mode":{"type":"string","description":"The bypass mode for the reviewer","enum":["ALWAYS","EXEMPT"],"default":"ALWAYS"}}}}}}}},"short-branch":{"title":"Short Branch","description":"Short Branch","type":"object","properties":{"name":{"type":"string"},"commit":{"type":"object","properties":{"sha":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["sha","url"]},"protected":{"type":"boolean"},"protection":{"$ref":"#/components/schemas/branch-protection"},"protection_url":{"type":"string","format":"uri"}},"required":["name","commit","protected"]},"simple-commit":{"title":"Simple Commit","description":"A commit.","type":"object","properties":{"id":{"type":"string","description":"SHA for the commit"},"tree_id":{"type":"string","description":"SHA for the commit's tree"},"message":{"description":"Message describing the purpose of the commit","type":"string"},"timestamp":{"description":"Timestamp of the commit","format":"date-time","type":"string"},"author":{"type":"object","description":"Information about the Git author","properties":{"name":{"description":"Name of the commit's author","type":"string"},"email":{"description":"Git email address of the commit's author","type":"string","format":"email"}},"required":["name","email"],"nullable":true},"committer":{"type":"object","description":"Information about the Git committer","properties":{"name":{"description":"Name of the commit's committer","type":"string"},"email":{"description":"Git email address of the commit's committer","type":"string","format":"email"}},"required":["name","email"],"nullable":true}},"required":["id","tree_id","message","timestamp","author","committer"]},"simple-repository":{"title":"Simple Repository","description":"A GitHub repository.","type":"object","properties":{"id":{"type":"integer","format":"int64","description":"A unique identifier of the repository."},"node_id":{"type":"string","description":"The GraphQL identifier of the repository."},"name":{"type":"string","description":"The name of the repository."},"full_name":{"type":"string","description":"The full, globally unique, name of the repository."},"owner":{"$ref":"#/components/schemas/simple-user"},"private":{"type":"boolean","description":"Whether the repository is private."},"html_url":{"type":"string","format":"uri","description":"The URL to view the repository on GitHub.com."},"description":{"type":"string","nullable":true,"description":"The repository description."},"fork":{"type":"boolean","description":"Whether the repository is a fork."},"url":{"type":"string","format":"uri","description":"The URL to get more information about the repository from the GitHub API."},"archive_url":{"type":"string","description":"A template for the API URL to download the repository as an archive."},"assignees_url":{"type":"string","description":"A template for the API URL to list the available assignees for issues in the repository."},"blobs_url":{"type":"string","description":"A template for the API URL to create or retrieve a raw Git blob in the repository."},"branches_url":{"type":"string","description":"A template for the API URL to get information about branches in the repository."},"collaborators_url":{"type":"string","description":"A template for the API URL to get information about collaborators of the repository."},"comments_url":{"type":"string","description":"A template for the API URL to get information about comments on the repository."},"commits_url":{"type":"string","description":"A template for the API URL to get information about commits on the repository."},"compare_url":{"type":"string","description":"A template for the API URL to compare two commits or refs."},"contents_url":{"type":"string","description":"A template for the API URL to get the contents of the repository."},"contributors_url":{"type":"string","format":"uri","description":"A template for the API URL to list the contributors to the repository."},"deployments_url":{"type":"string","format":"uri","description":"The API URL to list the deployments of the repository."},"downloads_url":{"type":"string","format":"uri","description":"The API URL to list the downloads on the repository."},"events_url":{"type":"string","format":"uri","description":"The API URL to list the events of the repository."},"forks_url":{"type":"string","format":"uri","description":"The API URL to list the forks of the repository."},"git_commits_url":{"type":"string","description":"A template for the API URL to get information about Git commits of the repository."},"git_refs_url":{"type":"string","description":"A template for the API URL to get information about Git refs of the repository."},"git_tags_url":{"type":"string","description":"A template for the API URL to get information about Git tags of the repository."},"issue_comment_url":{"type":"string","description":"A template for the API URL to get information about issue comments on the repository."},"issue_events_url":{"type":"string","description":"A template for the API URL to get information about issue events on the repository."},"issues_url":{"type":"string","description":"A template for the API URL to get information about issues on the repository."},"keys_url":{"type":"string","description":"A template for the API URL to get information about deploy keys on the repository."},"labels_url":{"type":"string","description":"A template for the API URL to get information about labels of the repository."},"languages_url":{"type":"string","format":"uri","description":"The API URL to get information about the languages of the repository."},"merges_url":{"type":"string","format":"uri","description":"The API URL to merge branches in the repository."},"milestones_url":{"type":"string","description":"A template for the API URL to get information about milestones of the repository."},"notifications_url":{"type":"string","description":"A template for the API URL to get information about notifications on the repository."},"pulls_url":{"type":"string","description":"A template for the API URL to get information about pull requests on the repository."},"releases_url":{"type":"string","description":"A template for the API URL to get information about releases on the repository."},"stargazers_url":{"type":"string","format":"uri","description":"The API URL to list the stargazers on the repository."},"statuses_url":{"type":"string","description":"A template for the API URL to get information about statuses of a commit."},"subscribers_url":{"type":"string","format":"uri","description":"The API URL to list the subscribers on the repository."},"subscription_url":{"type":"string","format":"uri","description":"The API URL to subscribe to notifications for this repository."},"tags_url":{"type":"string","format":"uri","description":"The API URL to get information about tags on the repository."},"teams_url":{"type":"string","format":"uri","description":"The API URL to list the teams on the repository."},"trees_url":{"type":"string","description":"A template for the API URL to create or retrieve a raw Git tree of the repository."},"hooks_url":{"type":"string","format":"uri","description":"The API URL to list the hooks on the repository."}},"required":["archive_url","assignees_url","blobs_url","branches_url","collaborators_url","comments_url","commits_url","compare_url","contents_url","contributors_url","deployments_url","description","downloads_url","events_url","fork","forks_url","full_name","git_commits_url","git_refs_url","git_tags_url","hooks_url","html_url","id","node_id","issue_comment_url","issue_events_url","issues_url","keys_url","labels_url","languages_url","merges_url","milestones_url","name","notifications_url","owner","private","pulls_url","releases_url","stargazers_url","statuses_url","subscribers_url","subscription_url","tags_url","teams_url","trees_url","url"]},"simple-user":{"title":"Simple User","description":"A GitHub user.","type":"object","properties":{"name":{"nullable":true,"type":"string"},"email":{"nullable":true,"type":"string"},"login":{"type":"string"},"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"avatar_url":{"type":"string","format":"uri"},"gravatar_id":{"type":"string","nullable":true},"url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"followers_url":{"type":"string","format":"uri"},"following_url":{"type":"string"},"gists_url":{"type":"string"},"starred_url":{"type":"string"},"subscriptions_url":{"type":"string","format":"uri"},"organizations_url":{"type":"string","format":"uri"},"repos_url":{"type":"string","format":"uri"},"events_url":{"type":"string"},"received_events_url":{"type":"string","format":"uri"},"type":{"type":"string"},"site_admin":{"type":"boolean"},"starred_at":{"type":"string"},"user_view_type":{"type":"string"}},"required":["avatar_url","events_url","followers_url","following_url","gists_url","gravatar_id","html_url","id","node_id","login","organizations_url","received_events_url","repos_url","site_admin","starred_url","subscriptions_url","type","url"]},"stargazer":{"title":"Stargazer","description":"Stargazer","type":"object","properties":{"starred_at":{"type":"string","format":"date-time"},"user":{"$ref":"#/components/schemas/nullable-simple-user"}},"required":["starred_at","user"]},"starred-repository":{"title":"Starred Repository","description":"Starred Repository","type":"object","properties":{"starred_at":{"type":"string","format":"date-time"},"repo":{"$ref":"#/components/schemas/repository"}},"required":["starred_at","repo"]},"status":{"title":"Status","description":"The status of a commit.","type":"object","properties":{"url":{"type":"string"},"avatar_url":{"type":"string","nullable":true},"id":{"type":"integer"},"node_id":{"type":"string"},"state":{"type":"string"},"description":{"type":"string","nullable":true},"target_url":{"type":"string","nullable":true},"context":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"creator":{"$ref":"#/components/schemas/nullable-simple-user"}},"required":["url","avatar_url","id","node_id","state","description","target_url","context","created_at","updated_at","creator"]},"sub-issue-added-issue-event":{"title":"Sub-issue Added Issue Event","description":"Sub-issue Added Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"sub_issue":{"$ref":"#/components/schemas/nullable-issue-reference"}},"required":["sub_issue","id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"sub-issue-removed-issue-event":{"title":"Sub-issue Removed Issue Event","description":"Sub-issue Removed Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"sub_issue":{"$ref":"#/components/schemas/nullable-issue-reference"}},"required":["sub_issue","id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"sub-issues-summary":{"title":"Sub-issues Summary","type":"object","properties":{"total":{"type":"integer"},"completed":{"type":"integer"},"percent_completed":{"type":"integer"}},"required":["total","completed","percent_completed"]},"tag":{"title":"Tag","description":"Tag","type":"object","properties":{"name":{"type":"string"},"commit":{"type":"object","properties":{"sha":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["sha","url"]},"zipball_url":{"type":"string","format":"uri"},"tarball_url":{"type":"string","format":"uri"},"node_id":{"type":"string"}},"required":["name","node_id","commit","zipball_url","tarball_url"]},"team":{"title":"Team","description":"Groups of organization members that gives permissions on specified repositories.","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"description":{"type":"string","nullable":true},"privacy":{"type":"string"},"notification_setting":{"type":"string"},"permission":{"type":"string"},"permissions":{"type":"object","properties":{"pull":{"type":"boolean"},"triage":{"type":"boolean"},"push":{"type":"boolean"},"maintain":{"type":"boolean"},"admin":{"type":"boolean"}},"required":["pull","triage","push","maintain","admin"]},"url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"members_url":{"type":"string"},"repositories_url":{"type":"string","format":"uri"},"type":{"description":"The ownership type of the team","type":"string","enum":["enterprise","organization"]},"access_source":{"description":"How the team's access to the repository was granted. This property is only\npresent when the team is returned in a repository context, such as\n`GET /repos/{owner}/{repo}/teams`.","type":"string","enum":["direct","organization","enterprise"]},"organization_id":{"type":"integer","description":"Unique identifier of the organization to which this team belongs"},"enterprise_id":{"type":"integer","description":"Unique identifier of the enterprise to which this team belongs"},"parent":{"$ref":"#/components/schemas/nullable-team-simple"}},"required":["id","node_id","url","members_url","name","description","permission","html_url","repositories_url","slug","parent","type"]},"team-full":{"title":"Full Team","description":"Groups of organization members that gives permissions on specified repositories.","type":"object","properties":{"id":{"description":"Unique identifier of the team","type":"integer"},"node_id":{"type":"string"},"url":{"description":"URL for the team","type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"name":{"description":"Name of the team","type":"string"},"slug":{"type":"string"},"description":{"type":"string","nullable":true},"privacy":{"description":"The level of privacy this team should have","type":"string","enum":["closed","secret"]},"notification_setting":{"description":"The notification setting the team has set","type":"string","enum":["notifications_enabled","notifications_disabled"]},"permission":{"description":"Permission that the team will have for its repositories","type":"string"},"members_url":{"type":"string"},"repositories_url":{"type":"string","format":"uri"},"parent":{"$ref":"#/components/schemas/nullable-team-simple"},"members_count":{"type":"integer"},"repos_count":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization":{"$ref":"#/components/schemas/team-organization"},"ldap_dn":{"$ref":"#/components/schemas/ldap-dn"},"type":{"description":"The ownership type of the team","type":"string","enum":["enterprise","organization"]},"organization_id":{"type":"integer","description":"Unique identifier of the organization to which this team belongs"},"enterprise_id":{"type":"integer","description":"Unique identifier of the enterprise to which this team belongs"}},"required":["id","node_id","url","members_url","name","description","permission","html_url","repositories_url","slug","type","created_at","updated_at","members_count","repos_count","organization"]},"team-member":{"title":"Team Member","description":"A user that is a member of a team, including their role on the team and whether the membership is inherited from a child team.","type":"object","properties":{"name":{"nullable":true,"type":"string"},"email":{"nullable":true,"type":"string"},"login":{"type":"string"},"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"avatar_url":{"type":"string","format":"uri"},"gravatar_id":{"type":"string","nullable":true},"url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"followers_url":{"type":"string","format":"uri"},"following_url":{"type":"string"},"gists_url":{"type":"string"},"starred_url":{"type":"string"},"subscriptions_url":{"type":"string","format":"uri"},"organizations_url":{"type":"string","format":"uri"},"repos_url":{"type":"string","format":"uri"},"events_url":{"type":"string"},"received_events_url":{"type":"string","format":"uri"},"type":{"type":"string"},"site_admin":{"type":"boolean"},"starred_at":{"type":"string"},"user_view_type":{"type":"string"},"role":{"type":"string","description":"The member's role on the team. Only present on the `List team members` endpoint, and only when the feature is enabled for the organization.","enum":["member","maintainer"]},"inherited":{"type":"boolean","description":"Whether the user is a member of the team only through a child team. `true` means the membership is inherited from a child team; `false` means the user is a direct (immediate) member of the team. Only present on the `List team members` endpoint, and only when the feature is enabled for the organization."}},"required":["avatar_url","events_url","followers_url","following_url","gists_url","gravatar_id","html_url","id","node_id","login","organizations_url","received_events_url","repos_url","site_admin","starred_url","subscriptions_url","type","url"]},"team-membership":{"title":"Team Membership","description":"Team Membership","type":"object","properties":{"url":{"type":"string","format":"uri"},"role":{"description":"The role of the user in the team.","enum":["member","maintainer"],"default":"member","type":"string"},"state":{"description":"The state of the user's membership in the team.","type":"string","enum":["active","pending"]}},"required":["role","state","url"]},"team-organization":{"title":"Team Organization","description":"Team Organization","type":"object","properties":{"login":{"type":"string"},"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string","format":"uri"},"repos_url":{"type":"string","format":"uri"},"events_url":{"type":"string","format":"uri"},"hooks_url":{"type":"string"},"issues_url":{"type":"string"},"members_url":{"type":"string"},"public_members_url":{"type":"string"},"avatar_url":{"type":"string"},"description":{"type":"string","nullable":true},"name":{"type":"string"},"company":{"type":"string","nullable":true},"blog":{"type":"string","format":"uri","nullable":true},"location":{"type":"string","nullable":true},"email":{"type":"string","format":"email","nullable":true},"twitter_username":{"type":"string","nullable":true},"is_verified":{"type":"boolean"},"has_organization_projects":{"type":"boolean"},"has_repository_projects":{"type":"boolean"},"public_repos":{"type":"integer"},"public_gists":{"type":"integer"},"followers":{"type":"integer"},"following":{"type":"integer"},"html_url":{"type":"string","format":"uri"},"created_at":{"type":"string","format":"date-time"},"type":{"type":"string"},"total_private_repos":{"type":"integer"},"owned_private_repos":{"type":"integer"},"private_gists":{"type":"integer","nullable":true},"disk_usage":{"type":"integer","nullable":true},"collaborators":{"type":"integer","nullable":true},"billing_email":{"type":"string","format":"email","nullable":true},"plan":{"type":"object","properties":{"name":{"type":"string"},"space":{"type":"integer"},"private_repos":{"type":"integer"},"filled_seats":{"type":"integer"},"seats":{"type":"integer"}},"required":["name","space","private_repos"]},"default_repository_permission":{"type":"string","nullable":true},"members_can_create_repositories":{"type":"boolean","nullable":true},"two_factor_requirement_enabled":{"type":"boolean","nullable":true},"members_allowed_repository_creation_type":{"type":"string"},"members_can_create_public_repositories":{"type":"boolean"},"members_can_create_private_repositories":{"type":"boolean"},"members_can_create_internal_repositories":{"type":"boolean"},"members_can_create_pages":{"type":"boolean"},"members_can_create_public_pages":{"type":"boolean"},"members_can_create_private_pages":{"type":"boolean"},"members_can_fork_private_repositories":{"type":"boolean","nullable":true},"web_commit_signoff_required":{"type":"boolean"},"updated_at":{"type":"string","format":"date-time"},"archived_at":{"type":"string","format":"date-time","nullable":true}},"required":["login","url","id","node_id","repos_url","events_url","hooks_url","issues_url","members_url","public_members_url","avatar_url","description","html_url","has_organization_projects","has_repository_projects","public_repos","public_gists","followers","following","type","created_at","updated_at","archived_at"]},"team-repository":{"title":"Team Repository","description":"A team's access to a repository.","type":"object","properties":{"id":{"description":"Unique identifier of the repository","type":"integer"},"node_id":{"type":"string"},"name":{"description":"The name of the repository.","type":"string"},"full_name":{"type":"string"},"license":{"$ref":"#/components/schemas/nullable-license-simple"},"forks":{"type":"integer"},"permissions":{"type":"object","properties":{"admin":{"type":"boolean"},"pull":{"type":"boolean"},"triage":{"type":"boolean"},"push":{"type":"boolean"},"maintain":{"type":"boolean"}},"required":["admin","pull","push"]},"role_name":{"type":"string"},"owner":{"$ref":"#/components/schemas/nullable-simple-user"},"private":{"description":"Whether the repository is private or public.","default":false,"type":"boolean"},"html_url":{"type":"string","format":"uri"},"description":{"type":"string","nullable":true},"fork":{"type":"boolean"},"url":{"type":"string","format":"uri"},"archive_url":{"type":"string"},"assignees_url":{"type":"string"},"blobs_url":{"type":"string"},"branches_url":{"type":"string"},"collaborators_url":{"type":"string"},"comments_url":{"type":"string"},"commits_url":{"type":"string"},"compare_url":{"type":"string"},"contents_url":{"type":"string"},"contributors_url":{"type":"string","format":"uri"},"deployments_url":{"type":"string","format":"uri"},"downloads_url":{"type":"string","format":"uri"},"events_url":{"type":"string","format":"uri"},"forks_url":{"type":"string","format":"uri"},"git_commits_url":{"type":"string"},"git_refs_url":{"type":"string"},"git_tags_url":{"type":"string"},"git_url":{"type":"string"},"issue_comment_url":{"type":"string"},"issue_events_url":{"type":"string"},"issues_url":{"type":"string"},"keys_url":{"type":"string"},"labels_url":{"type":"string"},"languages_url":{"type":"string","format":"uri"},"merges_url":{"type":"string","format":"uri"},"milestones_url":{"type":"string"},"notifications_url":{"type":"string"},"pulls_url":{"type":"string"},"releases_url":{"type":"string"},"ssh_url":{"type":"string"},"stargazers_url":{"type":"string","format":"uri"},"statuses_url":{"type":"string"},"subscribers_url":{"type":"string","format":"uri"},"subscription_url":{"type":"string","format":"uri"},"tags_url":{"type":"string","format":"uri"},"teams_url":{"type":"string","format":"uri"},"trees_url":{"type":"string"},"clone_url":{"type":"string"},"mirror_url":{"type":"string","format":"uri","nullable":true},"hooks_url":{"type":"string","format":"uri"},"svn_url":{"type":"string","format":"uri"},"homepage":{"type":"string","format":"uri","nullable":true},"language":{"type":"string","nullable":true},"forks_count":{"type":"integer"},"stargazers_count":{"type":"integer"},"watchers_count":{"type":"integer"},"size":{"type":"integer"},"default_branch":{"description":"The default branch of the repository.","type":"string"},"open_issues_count":{"type":"integer"},"is_template":{"description":"Whether this repository acts as a template that can be used to generate new repositories.","default":false,"type":"boolean"},"topics":{"type":"array","items":{"type":"string"}},"has_issues":{"description":"Whether issues are enabled.","default":true,"type":"boolean"},"has_projects":{"description":"Whether projects are enabled.","default":true,"type":"boolean"},"has_wiki":{"description":"Whether the wiki is enabled.","default":true,"type":"boolean"},"has_pages":{"type":"boolean"},"has_downloads":{"description":"Whether downloads are enabled.","default":true,"type":"boolean"},"archived":{"description":"Whether the repository is archived.","default":false,"type":"boolean"},"disabled":{"type":"boolean","description":"Returns whether or not this repository disabled."},"visibility":{"description":"The repository visibility: public, private, or internal.","default":"public","type":"string"},"pushed_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true},"allow_rebase_merge":{"description":"Whether to allow rebase merges for pull requests.","default":true,"type":"boolean"},"temp_clone_token":{"type":"string"},"allow_squash_merge":{"description":"Whether to allow squash merges for pull requests.","default":true,"type":"boolean"},"allow_auto_merge":{"description":"Whether to allow Auto-merge to be used on pull requests.","default":false,"type":"boolean"},"delete_branch_on_merge":{"description":"Whether to delete head branches when pull requests are merged","default":false,"type":"boolean"},"allow_merge_commit":{"description":"Whether to allow merge commits for pull requests.","default":true,"type":"boolean"},"allow_forking":{"description":"Whether to allow forking this repo","default":false,"type":"boolean"},"web_commit_signoff_required":{"description":"Whether to require contributors to sign off on web-based commits","default":false,"type":"boolean"},"subscribers_count":{"type":"integer"},"network_count":{"type":"integer"},"open_issues":{"type":"integer"},"watchers":{"type":"integer"},"master_branch":{"type":"string"}},"required":["archive_url","assignees_url","blobs_url","branches_url","collaborators_url","comments_url","commits_url","compare_url","contents_url","contributors_url","deployments_url","description","downloads_url","events_url","fork","forks_url","full_name","git_commits_url","git_refs_url","git_tags_url","hooks_url","html_url","id","node_id","issue_comment_url","issue_events_url","issues_url","keys_url","labels_url","languages_url","merges_url","milestones_url","name","notifications_url","owner","private","pulls_url","releases_url","stargazers_url","statuses_url","subscribers_url","subscription_url","tags_url","teams_url","trees_url","url","clone_url","default_branch","forks","forks_count","git_url","has_downloads","has_issues","has_projects","has_wiki","has_pages","homepage","language","archived","disabled","mirror_url","open_issues","open_issues_count","license","pushed_at","size","ssh_url","stargazers_count","svn_url","watchers","watchers_count","created_at","updated_at"],"x-github-breaking-changes":[{"changeset":"remove_has_downloads","patch":{"properties":{"has_downloads":null},"required":["archive_url","assignees_url","blobs_url","branches_url","collaborators_url","comments_url","commits_url","compare_url","contents_url","contributors_url","deployments_url","description","downloads_url","events_url","fork","forks_url","full_name","git_commits_url","git_refs_url","git_tags_url","hooks_url","html_url","id","node_id","issue_comment_url","issue_events_url","issues_url","keys_url","labels_url","languages_url","merges_url","milestones_url","name","notifications_url","owner","private","pulls_url","releases_url","stargazers_url","statuses_url","subscribers_url","subscription_url","tags_url","teams_url","trees_url","url","clone_url","default_branch","forks","forks_count","git_url","has_issues","has_projects","has_wiki","has_pages","homepage","language","archived","disabled","mirror_url","open_issues","open_issues_count","license","pushed_at","size","ssh_url","stargazers_count","svn_url","watchers","watchers_count","created_at","updated_at"]},"version":"2026-03-10"}]},"team-simple":{"title":"Team Simple","description":"Groups of organization members that gives permissions on specified repositories.","type":"object","properties":{"id":{"description":"Unique identifier of the team","type":"integer"},"node_id":{"type":"string"},"url":{"description":"URL for the team","type":"string","format":"uri"},"members_url":{"type":"string"},"name":{"description":"Name of the team","type":"string"},"description":{"description":"Description of the team","type":"string","nullable":true},"permission":{"description":"Permission that the team will have for its repositories","type":"string"},"privacy":{"description":"The level of privacy this team should have","type":"string"},"notification_setting":{"description":"The notification setting the team has set","type":"string"},"html_url":{"type":"string","format":"uri"},"repositories_url":{"type":"string","format":"uri"},"slug":{"type":"string"},"ldap_dn":{"description":"Distinguished Name (DN) that team maps to within LDAP environment","type":"string"},"type":{"description":"The ownership type of the team","type":"string","enum":["enterprise","organization"]},"organization_id":{"type":"integer","description":"Unique identifier of the organization to which this team belongs"},"enterprise_id":{"type":"integer","description":"Unique identifier of the enterprise to which this team belongs"}},"required":["id","node_id","url","members_url","name","description","permission","html_url","repositories_url","slug","type"]},"unassigned-issue-event":{"title":"Unassigned Issue Event","description":"Unassigned Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"assignee":{"$ref":"#/components/schemas/simple-user"},"assigner":{"$ref":"#/components/schemas/simple-user"}},"required":["id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app","assignee","assigner"]},"unlabeled-issue-event":{"title":"Unlabeled Issue Event","description":"Unlabeled Issue Event","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/simple-user"},"event":{"type":"string"},"commit_id":{"type":"string","nullable":true},"commit_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"label":{"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string"}},"required":["name","color"]},"intent":{"$ref":"#/components/schemas/nullable-issue-event-intent"}},"required":["label","id","node_id","url","actor","event","commit_id","commit_url","created_at","performed_via_github_app"]},"user-search-result-item":{"title":"User Search Result Item","description":"User Search Result Item","type":"object","properties":{"login":{"type":"string"},"id":{"type":"integer","format":"int64"},"node_id":{"type":"string"},"avatar_url":{"type":"string","format":"uri"},"gravatar_id":{"type":"string","nullable":true},"url":{"type":"string","format":"uri"},"html_url":{"type":"string","format":"uri"},"followers_url":{"type":"string","format":"uri"},"subscriptions_url":{"type":"string","format":"uri"},"organizations_url":{"type":"string","format":"uri"},"repos_url":{"type":"string","format":"uri"},"received_events_url":{"type":"string","format":"uri"},"type":{"type":"string"},"score":{"type":"number"},"following_url":{"type":"string"},"gists_url":{"type":"string"},"starred_url":{"type":"string"},"events_url":{"type":"string"},"public_repos":{"type":"integer"},"public_gists":{"type":"integer"},"followers":{"type":"integer"},"following":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string","nullable":true},"bio":{"type":"string","nullable":true},"email":{"type":"string","format":"email","nullable":true},"location":{"type":"string","nullable":true},"site_admin":{"type":"boolean"},"hireable":{"type":"boolean","nullable":true},"text_matches":{"$ref":"#/components/schemas/search-result-text-matches"},"blog":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"suspended_at":{"type":"string","format":"date-time","nullable":true},"user_view_type":{"type":"string"}},"required":["avatar_url","events_url","followers_url","following_url","gists_url","gravatar_id","html_url","id","node_id","login","organizations_url","received_events_url","repos_url","site_admin","starred_url","subscriptions_url","type","url","score"]},"validation-error":{"title":"Validation Error","description":"Validation Error","type":"object","required":["message","documentation_url"],"properties":{"message":{"type":"string"},"documentation_url":{"type":"string"},"errors":{"type":"array","items":{"type":"object","required":["code"],"properties":{"resource":{"type":"string"},"field":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"index":{"type":"integer"},"value":{"oneOf":[{"type":"string","nullable":true},{"type":"integer","nullable":true},{"type":"array","nullable":true,"items":{"type":"string"}}]}}}}}},"validation-error-simple":{"title":"Validation Error Simple","description":"Validation Error Simple","type":"object","required":["message","documentation_url"],"properties":{"message":{"type":"string"},"documentation_url":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}}},"verification":{"title":"Verification","type":"object","properties":{"verified":{"type":"boolean"},"reason":{"type":"string"},"payload":{"type":"string","nullable":true},"signature":{"type":"string","nullable":true},"verified_at":{"type":"string","nullable":true}},"required":["verified","reason","payload","signature","verified_at"]},"wait-timer":{"type":"integer","description":"The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days)."},"webhook-config":{"title":"Webhook Configuration","description":"Configuration object of the webhook","type":"object","properties":{"url":{"$ref":"#/components/schemas/webhook-config-url"},"content_type":{"$ref":"#/components/schemas/webhook-config-content-type"},"secret":{"$ref":"#/components/schemas/webhook-config-secret"},"insecure_ssl":{"$ref":"#/components/schemas/webhook-config-insecure-ssl"}}},"webhook-config-content-type":{"type":"string","description":"The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`."},"webhook-config-insecure-ssl":{"oneOf":[{"type":"string","description":"Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**"},{"type":"number"}]},"webhook-config-secret":{"type":"string","description":"If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers)."},"webhook-config-url":{"type":"string","description":"The URL to which the payloads will be delivered.","format":"uri"},"workflow":{"title":"Workflow","description":"A GitHub Actions workflow","type":"object","properties":{"id":{"type":"integer"},"node_id":{"type":"string"},"name":{"type":"string"},"path":{"type":"string"},"state":{"type":"string","enum":["active","deleted","disabled_fork","disabled_inactivity","disabled_manually"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"url":{"type":"string"},"html_url":{"type":"string"},"badge_url":{"type":"string"},"deleted_at":{"type":"string","format":"date-time"}},"required":["id","node_id","name","path","state","url","html_url","badge_url","created_at","updated_at"]},"workflow-run":{"title":"Workflow Run","description":"An invocation of a workflow","type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The ID of the workflow run."},"name":{"type":"string","description":"The name of the workflow run.","nullable":true},"node_id":{"type":"string"},"check_suite_id":{"type":"integer","format":"int64","description":"The ID of the associated check suite."},"check_suite_node_id":{"type":"string","description":"The node ID of the associated check suite."},"head_branch":{"type":"string","nullable":true},"head_sha":{"description":"The SHA of the head commit that points to the version of the workflow being run.","type":"string"},"path":{"description":"The full path of the workflow","type":"string"},"run_number":{"type":"integer","description":"The auto incrementing run number for the workflow run."},"run_attempt":{"type":"integer","description":"Attempt number of the run, 1 for first attempt and higher if the workflow was re-run."},"referenced_workflows":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/referenced-workflow"}},"event":{"type":"string"},"status":{"type":"string","nullable":true},"conclusion":{"type":"string","nullable":true},"workflow_id":{"type":"integer","description":"The ID of the parent workflow."},"url":{"type":"string","description":"The URL to the workflow run."},"html_url":{"type":"string"},"pull_requests":{"description":"Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run.","type":"array","nullable":true,"items":{"$ref":"#/components/schemas/pull-request-minimal"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"actor":{"$ref":"#/components/schemas/simple-user"},"triggering_actor":{"$ref":"#/components/schemas/simple-user"},"run_started_at":{"type":"string","format":"date-time","description":"The start time of the latest run. Resets on re-run."},"jobs_url":{"description":"The URL to the jobs for the workflow run.","type":"string"},"logs_url":{"description":"The URL to download the logs for the workflow run.","type":"string"},"check_suite_url":{"description":"The URL to the associated check suite.","type":"string"},"artifacts_url":{"description":"The URL to the artifacts for the workflow run.","type":"string"},"cancel_url":{"description":"The URL to cancel the workflow run.","type":"string"},"rerun_url":{"description":"The URL to rerun the workflow run.","type":"string"},"previous_attempt_url":{"nullable":true,"description":"The URL to the previous attempted run of this workflow, if one exists.","type":"string"},"workflow_url":{"description":"The URL to the workflow.","type":"string"},"head_commit":{"$ref":"#/components/schemas/nullable-simple-commit"},"repository":{"$ref":"#/components/schemas/minimal-repository"},"head_repository":{"$ref":"#/components/schemas/minimal-repository"},"head_repository_id":{"type":"integer"},"display_title":{"type":"string","description":"The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow."}},"required":["id","node_id","head_branch","run_number","display_title","event","status","conclusion","head_sha","path","workflow_id","url","html_url","created_at","updated_at","head_commit","head_repository","repository","jobs_url","logs_url","check_suite_url","cancel_url","rerun_url","artifacts_url","workflow_url","pull_requests"]}}},"tags":[{"name":"actions","description":"Endpoints to manage GitHub Actions using the REST API."},{"name":"activity","description":"Activity APIs provide access to notifications, subscriptions, and timelines."},{"name":"apps","description":"Information for integrations and installations."},{"name":"checks","description":"Rich interactions with checks run by your integrations."},{"name":"code-scanning","description":"Retrieve code scanning alerts from a repository."},{"name":"dependabot","description":"Endpoints to manage Dependabot."},{"name":"gists","description":"View, modify your gists."},{"name":"git","description":"Raw Git functionality."},{"name":"issues","description":"Interact with GitHub Issues."},{"name":"licenses","description":"View various OSS licenses."},{"name":"orgs","description":"Interact with organizations."},{"name":"pulls","description":"Interact with GitHub Pull Requests."},{"name":"repos","description":"Interact with GitHub Repos."},{"name":"search","description":"Search for specific items on GitHub."},{"name":"secret-scanning","description":"Retrieve secret scanning alerts from a repository."},{"name":"teams","description":"Interact with GitHub Teams."},{"name":"users","description":"Interact with and view information about users and also current user."}]}