skillfullstack 0.0.0-stage → 1.0.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 (775) hide show
  1. package/.skillsRegistry/catalog.json +231 -0
  2. package/AGENTS.md +89 -0
  3. package/README.md +210 -2
  4. package/bin/index.js +508 -0
  5. package/package.json +57 -4
  6. package/skills/backend/apiEngineering/SKILL.md +102 -0
  7. package/skills/backend/apiEngineering/evals/evalApiEngineering.py +81 -0
  8. package/skills/backend/apiEngineering/evals/fixtures/invalid/sampleInvalidOpenApi.json +40 -0
  9. package/skills/backend/apiEngineering/evals/fixtures/valid/sampleValidOpenApi.json +47 -0
  10. package/skills/backend/apiEngineering/policies/compatibility.md +42 -0
  11. package/skills/backend/apiEngineering/policies/mandatory.md +48 -0
  12. package/skills/backend/apiEngineering/policies/performance.md +39 -0
  13. package/skills/backend/apiEngineering/policies/security.md +36 -0
  14. package/skills/backend/apiEngineering/references/apiObservability.md +39 -0
  15. package/skills/backend/apiEngineering/references/apiReference.md +3 -0
  16. package/skills/backend/apiEngineering/references/apiSecurityOwasp.md +47 -0
  17. package/skills/backend/apiEngineering/references/contractCompatibility.md +26 -0
  18. package/skills/backend/apiEngineering/references/databaseTransactions.md +40 -0
  19. package/skills/backend/apiEngineering/references/distributedReliability.md +26 -0
  20. package/skills/backend/apiEngineering/references/multiTenancy.md +27 -0
  21. package/skills/backend/apiEngineering/references/openApi32Standards.md +58 -0
  22. package/skills/backend/apiEngineering/references/paginationVersioning.md +57 -0
  23. package/skills/backend/apiEngineering/references/responseStandards.md +94 -0
  24. package/skills/backend/apiEngineering/scripts/auditApiContract.py +123 -0
  25. package/skills/backend/apiEngineering/scripts/checkBreakingChanges.py +77 -0
  26. package/skills/backend/apiEngineering/scripts/generateResponseEnvelope.py +88 -0
  27. package/skills/backend/apiEngineering/templates/apiChecklist.md +27 -0
  28. package/skills/backend/apiEngineering/templates/openapi.yaml +125 -0
  29. package/skills/backend/apiEngineering/templates/problemDetails.json +44 -0
  30. package/skills/backend/databaseArchitecture/SKILL.md +118 -0
  31. package/skills/backend/databaseArchitecture/evals/evalDatabaseArchitecture.py +85 -0
  32. package/skills/backend/databaseArchitecture/evals/fixtures/dangerousMigration.sql +4 -0
  33. package/skills/backend/databaseArchitecture/evals/fixtures/invalidSchema.sql +23 -0
  34. package/skills/backend/databaseArchitecture/evals/fixtures/safeMigration.sql +3 -0
  35. package/skills/backend/databaseArchitecture/evals/fixtures/validSchema.sql +37 -0
  36. package/skills/backend/databaseArchitecture/policies/integrity.md +25 -0
  37. package/skills/backend/databaseArchitecture/policies/mandatory.md +32 -0
  38. package/skills/backend/databaseArchitecture/policies/migration.md +22 -0
  39. package/skills/backend/databaseArchitecture/policies/normalization.md +25 -0
  40. package/skills/backend/databaseArchitecture/policies/performance.md +26 -0
  41. package/skills/backend/databaseArchitecture/policies/recovery.md +23 -0
  42. package/skills/backend/databaseArchitecture/policies/security.md +26 -0
  43. package/skills/backend/databaseArchitecture/policies/tableCreationChecklist.md +70 -0
  44. package/skills/backend/databaseArchitecture/references/analyticsWarehousing.md +32 -0
  45. package/skills/backend/databaseArchitecture/references/apiReference.md +3 -0
  46. package/skills/backend/databaseArchitecture/references/backupDisasterRecovery.md +27 -0
  47. package/skills/backend/databaseArchitecture/references/dataModelingLifecycle.md +30 -0
  48. package/skills/backend/databaseArchitecture/references/databaseTaxonomy.md +32 -0
  49. package/skills/backend/databaseArchitecture/references/indexingOptimization.md +32 -0
  50. package/skills/backend/databaseArchitecture/references/normalizationTheory.md +61 -0
  51. package/skills/backend/databaseArchitecture/references/scalabilitySharding.md +37 -0
  52. package/skills/backend/databaseArchitecture/references/transactionConcurrency.md +39 -0
  53. package/skills/backend/databaseArchitecture/scripts/analyzeMigration.py +99 -0
  54. package/skills/backend/databaseArchitecture/scripts/auditDatabaseSchema.py +177 -0
  55. package/skills/backend/databaseArchitecture/scripts/inspectDatabaseIndexes.py +149 -0
  56. package/skills/backend/databaseArchitecture/templates/adrTemplate.md +32 -0
  57. package/skills/backend/databaseArchitecture/templates/databaseChecklist.md +29 -0
  58. package/skills/backend/databaseArchitecture/templates/migrationPlan.md +40 -0
  59. package/skills/backend/durableBackgroundJobs/SKILL.md +112 -0
  60. package/skills/backend/durableBackgroundJobs/evals/durableJobVerification.json +14 -0
  61. package/skills/backend/durableBackgroundJobs/references/apiReference.md +3 -0
  62. package/skills/backend/durableBackgroundJobs/references/durableStepPatterns.md +6 -0
  63. package/skills/backend/durableBackgroundJobs/references/idempotencyKeys.md +5 -0
  64. package/skills/backend/durableBackgroundJobs/scripts/testWorkflowDispatch.py +24 -0
  65. package/skills/backend/golangStandard/SKILL.md +155 -0
  66. package/skills/backend/golangStandard/evals/goVerification.json +14 -0
  67. package/skills/backend/golangStandard/references/apiReference.md +3 -0
  68. package/skills/backend/golangStandard/references/layoutGuide.md +26 -0
  69. package/skills/backend/golangStandard/references/slogPatterns.md +26 -0
  70. package/skills/backend/golangStandard/scripts/scaffoldGoModule.py +105 -0
  71. package/skills/backend/pythonStandard/SKILL.md +138 -0
  72. package/skills/backend/pythonStandard/evals/pythonVerification.json +14 -0
  73. package/skills/backend/pythonStandard/references/apiReference.md +3 -0
  74. package/skills/backend/pythonStandard/references/pydanticPatterns.md +16 -0
  75. package/skills/backend/pythonStandard/references/pyprojectSpecs.md +37 -0
  76. package/skills/backend/pythonStandard/scripts/scaffoldUvProject.py +79 -0
  77. package/skills/backend/upstash/SKILL.md +98 -0
  78. package/skills/backend/upstash/evals/upstashVerification.json +14 -0
  79. package/skills/backend/upstash/references/apiReference.md +3 -0
  80. package/skills/backend/upstash/references/qstashFlowControl.md +34 -0
  81. package/skills/backend/upstash/references/ratelimitPatterns.md +53 -0
  82. package/skills/backend/upstash/references/workflowPatterns.md +35 -0
  83. package/skills/backend/upstash/scripts/testRedisConnection.py +36 -0
  84. package/skills/cicdDevops/cicdPipeline/SKILL.md +148 -0
  85. package/skills/cicdDevops/cicdPipeline/evals/evalCicd.py +37 -0
  86. package/skills/cicdDevops/cicdPipeline/references/apiReference.md +3 -0
  87. package/skills/cicdDevops/cicdPipeline/references/cicdDeploymentPatterns.md +27 -0
  88. package/skills/cicdDevops/cicdPipeline/scripts/auditDockerfileSecurity.py +56 -0
  89. package/skills/dataAi/mcpServerDevelopment/SKILL.md +123 -0
  90. package/skills/dataAi/mcpServerDevelopment/evals/mcpVerification.json +14 -0
  91. package/skills/dataAi/mcpServerDevelopment/references/apiReference.md +3 -0
  92. package/skills/dataAi/mcpServerDevelopment/references/mcpClientConfigs.md +38 -0
  93. package/skills/dataAi/mcpServerDevelopment/references/toolSchemaDesign.md +6 -0
  94. package/skills/dataAi/mcpServerDevelopment/scripts/runFastMcpBoilerplate.py +36 -0
  95. package/skills/dataAi/ragPipelineProduction/SKILL.md +113 -0
  96. package/skills/dataAi/ragPipelineProduction/evals/ragVerification.json +14 -0
  97. package/skills/dataAi/ragPipelineProduction/references/apiReference.md +3 -0
  98. package/skills/dataAi/ragPipelineProduction/references/chunkingStrategies.md +10 -0
  99. package/skills/dataAi/ragPipelineProduction/references/rrfAlgorithm.md +13 -0
  100. package/skills/dataAi/ragPipelineProduction/scripts/runHybridRrfSearch.py +33 -0
  101. package/skills/devopsCloud/cloudflare/SKILL.md +282 -0
  102. package/skills/devopsCloud/cloudflare/assets/README.md +48 -0
  103. package/skills/devopsCloud/cloudflare/assets/ai/agents-sdk.md +118 -0
  104. package/skills/devopsCloud/cloudflare/assets/ai/ai-gateway.md +105 -0
  105. package/skills/devopsCloud/cloudflare/assets/ai/ai-search.md +129 -0
  106. package/skills/devopsCloud/cloudflare/assets/ai/workers-ai.md +127 -0
  107. package/skills/devopsCloud/cloudflare/assets/cli/c3.md +292 -0
  108. package/skills/devopsCloud/cloudflare/assets/cli/cf-cli.md +90 -0
  109. package/skills/devopsCloud/cloudflare/assets/cli/wrangler.md +43 -0
  110. package/skills/devopsCloud/cloudflare/assets/compute/cron-triggers.md +486 -0
  111. package/skills/devopsCloud/cloudflare/assets/compute/service-bindings.md +251 -0
  112. package/skills/devopsCloud/cloudflare/assets/compute/smart-placement.md +435 -0
  113. package/skills/devopsCloud/cloudflare/assets/compute/static-assets.md +220 -0
  114. package/skills/devopsCloud/cloudflare/assets/compute/workers.md +129 -0
  115. package/skills/devopsCloud/cloudflare/assets/database-storage/d1.md +105 -0
  116. package/skills/devopsCloud/cloudflare/assets/database-storage/durable-objects.md +122 -0
  117. package/skills/devopsCloud/cloudflare/assets/database-storage/hyperdrive.md +210 -0
  118. package/skills/devopsCloud/cloudflare/assets/database-storage/kv.md +198 -0
  119. package/skills/devopsCloud/cloudflare/assets/database-storage/queues.md +105 -0
  120. package/skills/devopsCloud/cloudflare/assets/database-storage/r2.md +105 -0
  121. package/skills/devopsCloud/cloudflare/assets/database-storage/vectorize.md +97 -0
  122. package/skills/devopsCloud/cloudflare/assets/database-storage/workflows.md +141 -0
  123. package/skills/devopsCloud/cloudflare/assets/llms.txt +143 -0
  124. package/skills/devopsCloud/cloudflare/assets/networking-security/cache-cdn.md +109 -0
  125. package/skills/devopsCloud/cloudflare/assets/networking-security/dns.md +71 -0
  126. package/skills/devopsCloud/cloudflare/assets/networking-security/rate-limiting.md +130 -0
  127. package/skills/devopsCloud/cloudflare/assets/networking-security/tunnels.md +57 -0
  128. package/skills/devopsCloud/cloudflare/assets/networking-security/waf.md +143 -0
  129. package/skills/devopsCloud/cloudflare/assets/troubleshooting/1xxx-errors.md +209 -0
  130. package/skills/devopsCloud/cloudflare/assets/troubleshooting/5xx-errors.md +111 -0
  131. package/skills/devopsCloud/cloudflare/assets/troubleshooting/http-status-codes.md +38 -0
  132. package/skills/devopsCloud/cloudflare/evals/evals.json +75 -0
  133. package/skills/devopsCloud/cloudflare/references/ai-gateway/README.md +27 -0
  134. package/skills/devopsCloud/cloudflare/references/ai-gateway/configuration.md +18 -0
  135. package/skills/devopsCloud/cloudflare/references/ai-gateway/dynamic-routing.md +15 -0
  136. package/skills/devopsCloud/cloudflare/references/ai-gateway/features.md +22 -0
  137. package/skills/devopsCloud/cloudflare/references/ai-gateway/sdk-integration.md +19 -0
  138. package/skills/devopsCloud/cloudflare/references/ai-gateway/troubleshooting.md +16 -0
  139. package/skills/devopsCloud/cloudflare/references/ai-search/README.md +25 -0
  140. package/skills/devopsCloud/cloudflare/references/ai-search/api.md +13 -0
  141. package/skills/devopsCloud/cloudflare/references/ai-search/configuration.md +16 -0
  142. package/skills/devopsCloud/cloudflare/references/ai-search/gotchas.md +13 -0
  143. package/skills/devopsCloud/cloudflare/references/ai-search/patterns.md +15 -0
  144. package/skills/devopsCloud/cloudflare/references/bindings/README.md +16 -0
  145. package/skills/devopsCloud/cloudflare/references/bindings/api.md +19 -0
  146. package/skills/devopsCloud/cloudflare/references/bindings/configuration.md +20 -0
  147. package/skills/devopsCloud/cloudflare/references/bindings/gotchas.md +18 -0
  148. package/skills/devopsCloud/cloudflare/references/bindings/patterns.md +20 -0
  149. package/skills/devopsCloud/cloudflare/references/browser-rendering/README.md +18 -0
  150. package/skills/devopsCloud/cloudflare/references/browser-rendering/api.md +12 -0
  151. package/skills/devopsCloud/cloudflare/references/browser-rendering/configuration.md +12 -0
  152. package/skills/devopsCloud/cloudflare/references/browser-rendering/gotchas.md +15 -0
  153. package/skills/devopsCloud/cloudflare/references/browser-rendering/patterns.md +12 -0
  154. package/skills/devopsCloud/cloudflare/references/cliComparison.md +93 -0
  155. package/skills/devopsCloud/cloudflare/references/containers/README.md +23 -0
  156. package/skills/devopsCloud/cloudflare/references/containers/api.md +13 -0
  157. package/skills/devopsCloud/cloudflare/references/containers/configuration.md +15 -0
  158. package/skills/devopsCloud/cloudflare/references/containers/gotchas.md +16 -0
  159. package/skills/devopsCloud/cloudflare/references/containers/patterns.md +18 -0
  160. package/skills/devopsCloud/cloudflare/references/cron-triggers/README.md +20 -0
  161. package/skills/devopsCloud/cloudflare/references/cron-triggers/api.md +16 -0
  162. package/skills/devopsCloud/cloudflare/references/cron-triggers/configuration.md +16 -0
  163. package/skills/devopsCloud/cloudflare/references/cron-triggers/gotchas.md +17 -0
  164. package/skills/devopsCloud/cloudflare/references/cron-triggers/patterns.md +18 -0
  165. package/skills/devopsCloud/cloudflare/references/d1/README.md +15 -0
  166. package/skills/devopsCloud/cloudflare/references/d1/api.md +18 -0
  167. package/skills/devopsCloud/cloudflare/references/d1/configuration.md +18 -0
  168. package/skills/devopsCloud/cloudflare/references/d1/gotchas.md +18 -0
  169. package/skills/devopsCloud/cloudflare/references/d1/patterns.md +21 -0
  170. package/skills/devopsCloud/cloudflare/references/frameworkCompatibility.md +110 -0
  171. package/skills/devopsCloud/cloudflare/references/hyperdrive/README.md +28 -0
  172. package/skills/devopsCloud/cloudflare/references/hyperdrive/api.md +26 -0
  173. package/skills/devopsCloud/cloudflare/references/hyperdrive/configuration.md +34 -0
  174. package/skills/devopsCloud/cloudflare/references/hyperdrive/gotchas.md +20 -0
  175. package/skills/devopsCloud/cloudflare/references/hyperdrive/patterns.md +15 -0
  176. package/skills/devopsCloud/cloudflare/references/images/README.md +12 -0
  177. package/skills/devopsCloud/cloudflare/references/images/api.md +13 -0
  178. package/skills/devopsCloud/cloudflare/references/images/configuration.md +17 -0
  179. package/skills/devopsCloud/cloudflare/references/images/gotchas.md +16 -0
  180. package/skills/devopsCloud/cloudflare/references/images/patterns.md +16 -0
  181. package/skills/devopsCloud/cloudflare/references/kv/README.md +15 -0
  182. package/skills/devopsCloud/cloudflare/references/kv/api.md +18 -0
  183. package/skills/devopsCloud/cloudflare/references/kv/configuration.md +16 -0
  184. package/skills/devopsCloud/cloudflare/references/kv/gotchas.md +17 -0
  185. package/skills/devopsCloud/cloudflare/references/kv/patterns.md +21 -0
  186. package/skills/devopsCloud/cloudflare/references/miniflare/README.md +22 -0
  187. package/skills/devopsCloud/cloudflare/references/miniflare/api.md +16 -0
  188. package/skills/devopsCloud/cloudflare/references/miniflare/configuration.md +16 -0
  189. package/skills/devopsCloud/cloudflare/references/miniflare/gotchas.md +15 -0
  190. package/skills/devopsCloud/cloudflare/references/miniflare/patterns.md +19 -0
  191. package/skills/devopsCloud/cloudflare/references/observability/README.md +27 -0
  192. package/skills/devopsCloud/cloudflare/references/observability/api.md +20 -0
  193. package/skills/devopsCloud/cloudflare/references/observability/configuration.md +23 -0
  194. package/skills/devopsCloud/cloudflare/references/observability/gotchas.md +25 -0
  195. package/skills/devopsCloud/cloudflare/references/observability/patterns.md +14 -0
  196. package/skills/devopsCloud/cloudflare/references/pages/README.md +20 -0
  197. package/skills/devopsCloud/cloudflare/references/pages/api.md +13 -0
  198. package/skills/devopsCloud/cloudflare/references/pages/configuration.md +16 -0
  199. package/skills/devopsCloud/cloudflare/references/pages/gotchas.md +19 -0
  200. package/skills/devopsCloud/cloudflare/references/pages/patterns.md +15 -0
  201. package/skills/devopsCloud/cloudflare/references/pages-functions/README.md +20 -0
  202. package/skills/devopsCloud/cloudflare/references/pages-functions/api.md +13 -0
  203. package/skills/devopsCloud/cloudflare/references/pages-functions/configuration.md +14 -0
  204. package/skills/devopsCloud/cloudflare/references/pages-functions/gotchas.md +17 -0
  205. package/skills/devopsCloud/cloudflare/references/pages-functions/patterns.md +16 -0
  206. package/skills/devopsCloud/cloudflare/references/productSelectionMatrix.md +54 -0
  207. package/skills/devopsCloud/cloudflare/references/queues/README.md +24 -0
  208. package/skills/devopsCloud/cloudflare/references/queues/api.md +16 -0
  209. package/skills/devopsCloud/cloudflare/references/queues/configuration.md +20 -0
  210. package/skills/devopsCloud/cloudflare/references/queues/gotchas.md +18 -0
  211. package/skills/devopsCloud/cloudflare/references/queues/patterns.md +21 -0
  212. package/skills/devopsCloud/cloudflare/references/r2/README.md +26 -0
  213. package/skills/devopsCloud/cloudflare/references/r2/api.md +16 -0
  214. package/skills/devopsCloud/cloudflare/references/r2/configuration.md +19 -0
  215. package/skills/devopsCloud/cloudflare/references/r2/gotchas.md +17 -0
  216. package/skills/devopsCloud/cloudflare/references/r2/patterns.md +18 -0
  217. package/skills/devopsCloud/cloudflare/references/secrets-store/README.md +22 -0
  218. package/skills/devopsCloud/cloudflare/references/secrets-store/api.md +21 -0
  219. package/skills/devopsCloud/cloudflare/references/secrets-store/configuration.md +25 -0
  220. package/skills/devopsCloud/cloudflare/references/secrets-store/gotchas.md +19 -0
  221. package/skills/devopsCloud/cloudflare/references/secrets-store/patterns.md +27 -0
  222. package/skills/devopsCloud/cloudflare/references/skill-feedback.md +41 -0
  223. package/skills/devopsCloud/cloudflare/references/static-assets/README.md +21 -0
  224. package/skills/devopsCloud/cloudflare/references/static-assets/api.md +16 -0
  225. package/skills/devopsCloud/cloudflare/references/static-assets/configuration.md +16 -0
  226. package/skills/devopsCloud/cloudflare/references/static-assets/gotchas.md +18 -0
  227. package/skills/devopsCloud/cloudflare/references/static-assets/patterns.md +17 -0
  228. package/skills/devopsCloud/cloudflare/references/stream/README.md +22 -0
  229. package/skills/devopsCloud/cloudflare/references/stream/api-live.md +18 -0
  230. package/skills/devopsCloud/cloudflare/references/stream/api.md +21 -0
  231. package/skills/devopsCloud/cloudflare/references/stream/configuration.md +18 -0
  232. package/skills/devopsCloud/cloudflare/references/stream/gotchas.md +18 -0
  233. package/skills/devopsCloud/cloudflare/references/stream/patterns.md +22 -0
  234. package/skills/devopsCloud/cloudflare/references/tail-workers/README.md +21 -0
  235. package/skills/devopsCloud/cloudflare/references/tail-workers/api.md +13 -0
  236. package/skills/devopsCloud/cloudflare/references/tail-workers/configuration.md +15 -0
  237. package/skills/devopsCloud/cloudflare/references/tail-workers/gotchas.md +16 -0
  238. package/skills/devopsCloud/cloudflare/references/tail-workers/patterns.md +15 -0
  239. package/skills/devopsCloud/cloudflare/references/tunnel/README.md +20 -0
  240. package/skills/devopsCloud/cloudflare/references/tunnel/api.md +14 -0
  241. package/skills/devopsCloud/cloudflare/references/tunnel/configuration.md +14 -0
  242. package/skills/devopsCloud/cloudflare/references/tunnel/gotchas.md +15 -0
  243. package/skills/devopsCloud/cloudflare/references/tunnel/networking.md +14 -0
  244. package/skills/devopsCloud/cloudflare/references/tunnel/patterns.md +15 -0
  245. package/skills/devopsCloud/cloudflare/references/vectorize/README.md +22 -0
  246. package/skills/devopsCloud/cloudflare/references/vectorize/api.md +18 -0
  247. package/skills/devopsCloud/cloudflare/references/vectorize/configuration.md +19 -0
  248. package/skills/devopsCloud/cloudflare/references/vectorize/gotchas.md +15 -0
  249. package/skills/devopsCloud/cloudflare/references/vectorize/patterns.md +24 -0
  250. package/skills/devopsCloud/cloudflare/references/waf/README.md +21 -0
  251. package/skills/devopsCloud/cloudflare/references/waf/api.md +17 -0
  252. package/skills/devopsCloud/cloudflare/references/waf/configuration.md +18 -0
  253. package/skills/devopsCloud/cloudflare/references/waf/gotchas.md +19 -0
  254. package/skills/devopsCloud/cloudflare/references/waf/patterns.md +17 -0
  255. package/skills/devopsCloud/cloudflare/references/workers-ai/README.md +24 -0
  256. package/skills/devopsCloud/cloudflare/references/workers-ai/api.md +13 -0
  257. package/skills/devopsCloud/cloudflare/references/workers-ai/configuration.md +16 -0
  258. package/skills/devopsCloud/cloudflare/references/workers-ai/gotchas.md +15 -0
  259. package/skills/devopsCloud/cloudflare/references/workers-ai/patterns.md +14 -0
  260. package/skills/devopsCloud/cloudflare/references/workflows/README.md +23 -0
  261. package/skills/devopsCloud/cloudflare/references/workflows/api.md +17 -0
  262. package/skills/devopsCloud/cloudflare/references/workflows/configuration.md +18 -0
  263. package/skills/devopsCloud/cloudflare/references/workflows/gotchas.md +19 -0
  264. package/skills/devopsCloud/cloudflare/references/workflows/patterns.md +30 -0
  265. package/skills/devopsCloud/cloudflare/scripts/auditCloudflareProduction.py +95 -0
  266. package/skills/foundation/promptEvalTesting/SKILL.md +114 -0
  267. package/skills/foundation/promptEvalTesting/evals/promptEvalVerification.json +14 -0
  268. package/skills/foundation/promptEvalTesting/references/apiReference.md +3 -0
  269. package/skills/foundation/promptEvalTesting/references/evalMetricsCatalog.md +7 -0
  270. package/skills/foundation/promptEvalTesting/references/promptfooConfigSpecs.md +16 -0
  271. package/skills/foundation/promptEvalTesting/scripts/runPromptEvalSuite.py +29 -0
  272. package/skills/frontend/astro/SKILL.md +327 -0
  273. package/skills/frontend/astro/assets/README.md +71 -0
  274. package/skills/frontend/astro/assets/add-content-to-your-site/content-collections.md +1061 -0
  275. package/skills/frontend/astro/assets/add-content-to-your-site/data-fetching.md +109 -0
  276. package/skills/frontend/astro/assets/add-content-to-your-site/images.md +719 -0
  277. package/skills/frontend/astro/assets/add-content-to-your-site/markdown.md +725 -0
  278. package/skills/frontend/astro/assets/build-your-ui/components.md +402 -0
  279. package/skills/frontend/astro/assets/build-your-ui/fonts.md +437 -0
  280. package/skills/frontend/astro/assets/build-your-ui/front-end-frameworks.md +245 -0
  281. package/skills/frontend/astro/assets/build-your-ui/layouts.md +267 -0
  282. package/skills/frontend/astro/assets/build-your-ui/scripts-and-event-handling.md +229 -0
  283. package/skills/frontend/astro/assets/build-your-ui/styles-and-css.md +782 -0
  284. package/skills/frontend/astro/assets/build-your-ui/syntax-highlighting.md +269 -0
  285. package/skills/frontend/astro/assets/configuration/build-with-ai.md +389 -0
  286. package/skills/frontend/astro/assets/configuration/configuration-overview.md +122 -0
  287. package/skills/frontend/astro/assets/configuration/dev-toolbar.md +86 -0
  288. package/skills/frontend/astro/assets/configuration/editor-setup.md +166 -0
  289. package/skills/frontend/astro/assets/configuration/environment-variables.md +352 -0
  290. package/skills/frontend/astro/assets/configuration/typescript.md +379 -0
  291. package/skills/frontend/astro/assets/configuration/working-with-integrations.md +606 -0
  292. package/skills/frontend/astro/assets/reference/adapter-reference.md +1242 -0
  293. package/skills/frontend/astro/assets/reference/cli-reference.md +575 -0
  294. package/skills/frontend/astro/assets/reference/configuration-reference.md +3144 -0
  295. package/skills/frontend/astro/assets/reference/content-loader-reference.md +1682 -0
  296. package/skills/frontend/astro/assets/reference/directives-reference.md +324 -0
  297. package/skills/frontend/astro/assets/reference/image-service-reference.md +346 -0
  298. package/skills/frontend/astro/assets/reference/integrations-reference.md +2813 -0
  299. package/skills/frontend/astro/assets/reference/modules/astro-actions.md +604 -0
  300. package/skills/frontend/astro/assets/reference/modules/astro-app.md +460 -0
  301. package/skills/frontend/astro/assets/reference/modules/astro-assets.md +1657 -0
  302. package/skills/frontend/astro/assets/reference/modules/astro-config.md +395 -0
  303. package/skills/frontend/astro/assets/reference/modules/astro-content.md +720 -0
  304. package/skills/frontend/astro/assets/reference/modules/astro-env.md +46 -0
  305. package/skills/frontend/astro/assets/reference/modules/astro-fetch.md +346 -0
  306. package/skills/frontend/astro/assets/reference/modules/astro-hono.md +37 -0
  307. package/skills/frontend/astro/assets/reference/modules/astro-i18n.md +462 -0
  308. package/skills/frontend/astro/assets/reference/modules/astro-middleware.md +292 -0
  309. package/skills/frontend/astro/assets/reference/modules/astro-static-paths.md +74 -0
  310. package/skills/frontend/astro/assets/reference/modules/astro-transitions.md +595 -0
  311. package/skills/frontend/astro/assets/reference/modules/astro-zod.md +120 -0
  312. package/skills/frontend/astro/assets/reference/session-driver-reference.md +205 -0
  313. package/skills/frontend/astro/assets/routing-and-navigation/endpoints.md +251 -0
  314. package/skills/frontend/astro/assets/routing-and-navigation/internationalization.md +374 -0
  315. package/skills/frontend/astro/assets/routing-and-navigation/middleware.md +288 -0
  316. package/skills/frontend/astro/assets/routing-and-navigation/pages.md +205 -0
  317. package/skills/frontend/astro/assets/routing-and-navigation/prefetch.md +273 -0
  318. package/skills/frontend/astro/assets/routing-and-navigation/routing.md +760 -0
  319. package/skills/frontend/astro/assets/routing-and-navigation/view-transitions.md +792 -0
  320. package/skills/frontend/astro/assets/server-rendering/actions.md +770 -0
  321. package/skills/frontend/astro/assets/server-rendering/caching.md +255 -0
  322. package/skills/frontend/astro/assets/server-rendering/on-demand-rendering.md +289 -0
  323. package/skills/frontend/astro/assets/server-rendering/server-islands.md +126 -0
  324. package/skills/frontend/astro/assets/server-rendering/sessions.md +270 -0
  325. package/skills/frontend/astro/assets/start-a-new-project/develop-and-build.md +147 -0
  326. package/skills/frontend/astro/assets/start-a-new-project/installation.md +342 -0
  327. package/skills/frontend/astro/assets/start-a-new-project/project-structure.md +137 -0
  328. package/skills/frontend/astro/assets/upgrade-and-troubleshooting/testing.md +412 -0
  329. package/skills/frontend/astro/assets/upgrade-and-troubleshooting/troubleshooting.md +229 -0
  330. package/skills/frontend/astro/assets/upgrade-and-troubleshooting/upgrade-astro.md +205 -0
  331. package/skills/frontend/astro/assets/welcome/courses.md +46 -0
  332. package/skills/frontend/astro/assets/welcome/islands-architecture.md +135 -0
  333. package/skills/frontend/astro/assets/welcome/why-astro.md +90 -0
  334. package/skills/frontend/astro/evals/evals.json +66 -0
  335. package/skills/frontend/astro/references/contentCollections.md +164 -0
  336. package/skills/frontend/astro/references/islandsArchitecture.md +128 -0
  337. package/skills/frontend/astro/references/serverIslandsAndActions.md +187 -0
  338. package/skills/frontend/astro/scripts/auditAstroProduction.py +78 -0
  339. package/skills/frontend/generativeUi/SKILL.md +128 -0
  340. package/skills/frontend/generativeUi/evals/generativeUiVerification.json +14 -0
  341. package/skills/frontend/generativeUi/references/apiReference.md +3 -0
  342. package/skills/frontend/generativeUi/references/clientToolComponentMapping.md +8 -0
  343. package/skills/frontend/generativeUi/references/dataStreamProtocol.md +10 -0
  344. package/skills/frontend/generativeUi/scripts/generateUiComponentStub.py +46 -0
  345. package/skills/frontend/nextjs/SKILL.md +138 -0
  346. package/skills/frontend/nextjs/assets/README.md +67 -0
  347. package/skills/frontend/nextjs/assets/api-reference/cli/create-next-app.md +210 -0
  348. package/skills/frontend/nextjs/assets/api-reference/cli/next.md +484 -0
  349. package/skills/frontend/nextjs/assets/api-reference/components/font.md +952 -0
  350. package/skills/frontend/nextjs/assets/api-reference/components/form.md +387 -0
  351. package/skills/frontend/nextjs/assets/api-reference/components/image.md +1372 -0
  352. package/skills/frontend/nextjs/assets/api-reference/components/link.md +954 -0
  353. package/skills/frontend/nextjs/assets/api-reference/components/script.md +421 -0
  354. package/skills/frontend/nextjs/assets/api-reference/directives/use-cache-private.md +211 -0
  355. package/skills/frontend/nextjs/assets/api-reference/directives/use-cache-remote.md +652 -0
  356. package/skills/frontend/nextjs/assets/api-reference/directives/use-cache.md +848 -0
  357. package/skills/frontend/nextjs/assets/api-reference/directives/use-client.md +149 -0
  358. package/skills/frontend/nextjs/assets/api-reference/directives/use-server.md +234 -0
  359. package/skills/frontend/nextjs/assets/api-reference/edge-runtime.md +188 -0
  360. package/skills/frontend/nextjs/assets/api-reference/file-conventions/default.md +80 -0
  361. package/skills/frontend/nextjs/assets/api-reference/file-conventions/dynamic-routes.md +417 -0
  362. package/skills/frontend/nextjs/assets/api-reference/file-conventions/error.md +361 -0
  363. package/skills/frontend/nextjs/assets/api-reference/file-conventions/forbidden.md +75 -0
  364. package/skills/frontend/nextjs/assets/api-reference/file-conventions/instrumentation-client.md +308 -0
  365. package/skills/frontend/nextjs/assets/api-reference/file-conventions/instrumentation.md +177 -0
  366. package/skills/frontend/nextjs/assets/api-reference/file-conventions/intercepting-routes.md +78 -0
  367. package/skills/frontend/nextjs/assets/api-reference/file-conventions/layout.md +803 -0
  368. package/skills/frontend/nextjs/assets/api-reference/file-conventions/loading.md +209 -0
  369. package/skills/frontend/nextjs/assets/api-reference/file-conventions/mdx-components.md +84 -0
  370. package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/app-icons.md +302 -0
  371. package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/manifest.md +90 -0
  372. package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/opengraph-image.md +580 -0
  373. package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/robots.md +234 -0
  374. package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/sitemap.md +459 -0
  375. package/skills/frontend/nextjs/assets/api-reference/file-conventions/not-found.md +278 -0
  376. package/skills/frontend/nextjs/assets/api-reference/file-conventions/page.md +283 -0
  377. package/skills/frontend/nextjs/assets/api-reference/file-conventions/parallel-routes.md +517 -0
  378. package/skills/frontend/nextjs/assets/api-reference/file-conventions/proxy.md +857 -0
  379. package/skills/frontend/nextjs/assets/api-reference/file-conventions/public-folder.md +47 -0
  380. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-groups.md +40 -0
  381. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/dynamicParams.md +40 -0
  382. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/ensureStatic.md +195 -0
  383. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/instant.md +204 -0
  384. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/maxDuration.md +42 -0
  385. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/preferredRegion.md +55 -0
  386. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/prefetch.md +113 -0
  387. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/runtime.md +43 -0
  388. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route.md +772 -0
  389. package/skills/frontend/nextjs/assets/api-reference/file-conventions/src-folder.md +42 -0
  390. package/skills/frontend/nextjs/assets/api-reference/file-conventions/template.md +174 -0
  391. package/skills/frontend/nextjs/assets/api-reference/file-conventions/unauthorized.md +143 -0
  392. package/skills/frontend/nextjs/assets/api-reference/functions/after.md +332 -0
  393. package/skills/frontend/nextjs/assets/api-reference/functions/cacheLife.md +642 -0
  394. package/skills/frontend/nextjs/assets/api-reference/functions/cacheTag.md +272 -0
  395. package/skills/frontend/nextjs/assets/api-reference/functions/catchError.md +267 -0
  396. package/skills/frontend/nextjs/assets/api-reference/functions/connection.md +114 -0
  397. package/skills/frontend/nextjs/assets/api-reference/functions/cookies.md +349 -0
  398. package/skills/frontend/nextjs/assets/api-reference/functions/draft-mode.md +173 -0
  399. package/skills/frontend/nextjs/assets/api-reference/functions/fetch.md +141 -0
  400. package/skills/frontend/nextjs/assets/api-reference/functions/forbidden.md +327 -0
  401. package/skills/frontend/nextjs/assets/api-reference/functions/generate-image-metadata.md +311 -0
  402. package/skills/frontend/nextjs/assets/api-reference/functions/generate-metadata.md +1510 -0
  403. package/skills/frontend/nextjs/assets/api-reference/functions/generate-sitemaps.md +102 -0
  404. package/skills/frontend/nextjs/assets/api-reference/functions/generate-static-params.md +606 -0
  405. package/skills/frontend/nextjs/assets/api-reference/functions/generate-viewport.md +347 -0
  406. package/skills/frontend/nextjs/assets/api-reference/functions/headers.md +92 -0
  407. package/skills/frontend/nextjs/assets/api-reference/functions/image-response.md +225 -0
  408. package/skills/frontend/nextjs/assets/api-reference/functions/io.md +131 -0
  409. package/skills/frontend/nextjs/assets/api-reference/functions/navigation.md +220 -0
  410. package/skills/frontend/nextjs/assets/api-reference/functions/next-request.md +116 -0
  411. package/skills/frontend/nextjs/assets/api-reference/functions/next-response.md +219 -0
  412. package/skills/frontend/nextjs/assets/api-reference/functions/next-root-params.md +479 -0
  413. package/skills/frontend/nextjs/assets/api-reference/functions/not-found.md +269 -0
  414. package/skills/frontend/nextjs/assets/api-reference/functions/permanentRedirect.md +92 -0
  415. package/skills/frontend/nextjs/assets/api-reference/functions/prefetch.md +202 -0
  416. package/skills/frontend/nextjs/assets/api-reference/functions/redirect.md +255 -0
  417. package/skills/frontend/nextjs/assets/api-reference/functions/refresh.md +91 -0
  418. package/skills/frontend/nextjs/assets/api-reference/functions/revalidatePath.md +248 -0
  419. package/skills/frontend/nextjs/assets/api-reference/functions/revalidateTag.md +175 -0
  420. package/skills/frontend/nextjs/assets/api-reference/functions/unauthorized.md +389 -0
  421. package/skills/frontend/nextjs/assets/api-reference/functions/unstable_cache.md +131 -0
  422. package/skills/frontend/nextjs/assets/api-reference/functions/unstable_noStore.md +61 -0
  423. package/skills/frontend/nextjs/assets/api-reference/functions/unstable_rethrow.md +79 -0
  424. package/skills/frontend/nextjs/assets/api-reference/functions/updateTag.md +173 -0
  425. package/skills/frontend/nextjs/assets/api-reference/functions/use-link-status.md +268 -0
  426. package/skills/frontend/nextjs/assets/api-reference/functions/use-offline.md +222 -0
  427. package/skills/frontend/nextjs/assets/api-reference/functions/use-params.md +102 -0
  428. package/skills/frontend/nextjs/assets/api-reference/functions/use-pathname.md +189 -0
  429. package/skills/frontend/nextjs/assets/api-reference/functions/use-report-web-vitals.md +175 -0
  430. package/skills/frontend/nextjs/assets/api-reference/functions/use-router.md +214 -0
  431. package/skills/frontend/nextjs/assets/api-reference/functions/use-search-params.md +416 -0
  432. package/skills/frontend/nextjs/assets/api-reference/functions/use-selected-layout-segment.md +214 -0
  433. package/skills/frontend/nextjs/assets/api-reference/functions/use-selected-layout-segments.md +116 -0
  434. package/skills/frontend/nextjs/assets/api-reference/functions/use-server-inserted-html.md +145 -0
  435. package/skills/frontend/nextjs/assets/api-reference/functions/userAgent.md +95 -0
  436. package/skills/frontend/nextjs/assets/api-reference/turbopack.md +552 -0
  437. package/skills/frontend/nextjs/assets/architecture/accessibility.md +47 -0
  438. package/skills/frontend/nextjs/assets/architecture/fast-refresh.md +122 -0
  439. package/skills/frontend/nextjs/assets/architecture/nextjs-compiler.md +376 -0
  440. package/skills/frontend/nextjs/assets/architecture/supported-browsers.md +146 -0
  441. package/skills/frontend/nextjs/assets/community/contribution-guide.md +459 -0
  442. package/skills/frontend/nextjs/assets/community/rspack.md +25 -0
  443. package/skills/frontend/nextjs/assets/getting-started/caching.md +626 -0
  444. package/skills/frontend/nextjs/assets/getting-started/css.md +336 -0
  445. package/skills/frontend/nextjs/assets/getting-started/deploying.md +115 -0
  446. package/skills/frontend/nextjs/assets/getting-started/error-handling.md +485 -0
  447. package/skills/frontend/nextjs/assets/getting-started/fetching-data.md +743 -0
  448. package/skills/frontend/nextjs/assets/getting-started/fonts.md +232 -0
  449. package/skills/frontend/nextjs/assets/getting-started/images.md +272 -0
  450. package/skills/frontend/nextjs/assets/getting-started/installation.md +446 -0
  451. package/skills/frontend/nextjs/assets/getting-started/layouts-and-pages.md +386 -0
  452. package/skills/frontend/nextjs/assets/getting-started/linking-and-navigating.md +475 -0
  453. package/skills/frontend/nextjs/assets/getting-started/metadata-and-og-images.md +370 -0
  454. package/skills/frontend/nextjs/assets/getting-started/mutating-data.md +679 -0
  455. package/skills/frontend/nextjs/assets/getting-started/project-structure.md +290 -0
  456. package/skills/frontend/nextjs/assets/getting-started/proxy.md +107 -0
  457. package/skills/frontend/nextjs/assets/getting-started/revalidating.md +241 -0
  458. package/skills/frontend/nextjs/assets/getting-started/route-handlers.md +233 -0
  459. package/skills/frontend/nextjs/assets/getting-started/server-and-client-components.md +683 -0
  460. package/skills/frontend/nextjs/assets/getting-started/upgrading.md +137 -0
  461. package/skills/frontend/nextjs/assets/glossary.md +315 -0
  462. package/skills/frontend/nextjs/evals/nextjsVerification.json +14 -0
  463. package/skills/frontend/nextjs/references/apiReference.md +3 -0
  464. package/skills/frontend/nextjs/references/dataAccessLayer.md +39 -0
  465. package/skills/frontend/nextjs/references/nextjsFeatureMap.md +276 -0
  466. package/skills/frontend/nextjs/references/productionChecklist.md +49 -0
  467. package/skills/frontend/nextjs/references/securityHeadersCsp.md +44 -0
  468. package/skills/frontend/nextjs/scripts/auditProductionReadiness.py +85 -0
  469. package/skills/frontend/shadcn-ui/SKILL.md +102 -0
  470. package/skills/frontend/shadcn-ui/assets/README.md +82 -0
  471. package/skills/frontend/shadcn-ui/assets/advanced/javascript.md +44 -0
  472. package/skills/frontend/shadcn-ui/assets/advanced/monorepo.md +254 -0
  473. package/skills/frontend/shadcn-ui/assets/advanced/react-19.md +166 -0
  474. package/skills/frontend/shadcn-ui/assets/advanced/tailwind-v4.md +333 -0
  475. package/skills/frontend/shadcn-ui/assets/ai-elements/chain-of-thought.md +519 -0
  476. package/skills/frontend/shadcn-ui/assets/ai-elements/chat.md +581 -0
  477. package/skills/frontend/shadcn-ui/assets/ai-elements/checkpoint.md +243 -0
  478. package/skills/frontend/shadcn-ui/assets/ai-elements/confirmation.md +382 -0
  479. package/skills/frontend/shadcn-ui/assets/ai-elements/context.md +188 -0
  480. package/skills/frontend/shadcn-ui/assets/ai-elements/file-tree.md +248 -0
  481. package/skills/frontend/shadcn-ui/assets/ai-elements/index.md +307 -0
  482. package/skills/frontend/shadcn-ui/assets/ai-elements/inline-citation.md +219 -0
  483. package/skills/frontend/shadcn-ui/assets/ai-elements/message.md +298 -0
  484. package/skills/frontend/shadcn-ui/assets/ai-elements/model-selector.md +368 -0
  485. package/skills/frontend/shadcn-ui/assets/ai-elements/plan.md +398 -0
  486. package/skills/frontend/shadcn-ui/assets/ai-elements/prompt-input.md +403 -0
  487. package/skills/frontend/shadcn-ui/assets/ai-elements/queue.md +517 -0
  488. package/skills/frontend/shadcn-ui/assets/ai-elements/reasoning.md +349 -0
  489. package/skills/frontend/shadcn-ui/assets/ai-elements/sources.md +303 -0
  490. package/skills/frontend/shadcn-ui/assets/ai-elements/stack-trace.md +514 -0
  491. package/skills/frontend/shadcn-ui/assets/ai-elements/subagent.md +551 -0
  492. package/skills/frontend/shadcn-ui/assets/ai-elements/suggestion.md +246 -0
  493. package/skills/frontend/shadcn-ui/assets/ai-elements/task.md +380 -0
  494. package/skills/frontend/shadcn-ui/assets/ai-elements/terminal.md +463 -0
  495. package/skills/frontend/shadcn-ui/assets/ai-elements/test-results.md +641 -0
  496. package/skills/frontend/shadcn-ui/assets/ai-elements/tool.md +915 -0
  497. package/skills/frontend/shadcn-ui/assets/components/accordion.md +490 -0
  498. package/skills/frontend/shadcn-ui/assets/components/alert-dialog.md +520 -0
  499. package/skills/frontend/shadcn-ui/assets/components/alert.md +351 -0
  500. package/skills/frontend/shadcn-ui/assets/components/aspect-ratio.md +206 -0
  501. package/skills/frontend/shadcn-ui/assets/components/attachment.md +715 -0
  502. package/skills/frontend/shadcn-ui/assets/components/avatar.md +581 -0
  503. package/skills/frontend/shadcn-ui/assets/components/badge.md +276 -0
  504. package/skills/frontend/shadcn-ui/assets/components/breadcrumb.md +556 -0
  505. package/skills/frontend/shadcn-ui/assets/components/bubble.md +706 -0
  506. package/skills/frontend/shadcn-ui/assets/components/button-group.md +969 -0
  507. package/skills/frontend/shadcn-ui/assets/components/button.md +523 -0
  508. package/skills/frontend/shadcn-ui/assets/components/calendar.md +959 -0
  509. package/skills/frontend/shadcn-ui/assets/components/card.md +684 -0
  510. package/skills/frontend/shadcn-ui/assets/components/carousel.md +643 -0
  511. package/skills/frontend/shadcn-ui/assets/components/chart.md +1295 -0
  512. package/skills/frontend/shadcn-ui/assets/components/checkbox.md +553 -0
  513. package/skills/frontend/shadcn-ui/assets/components/code-block.md +2041 -0
  514. package/skills/frontend/shadcn-ui/assets/components/collapsible.md +504 -0
  515. package/skills/frontend/shadcn-ui/assets/components/combobox.md +1102 -0
  516. package/skills/frontend/shadcn-ui/assets/components/command.md +682 -0
  517. package/skills/frontend/shadcn-ui/assets/components/context-menu.md +949 -0
  518. package/skills/frontend/shadcn-ui/assets/components/data-table.md +1667 -0
  519. package/skills/frontend/shadcn-ui/assets/components/date-picker.md +698 -0
  520. package/skills/frontend/shadcn-ui/assets/components/dialog.md +454 -0
  521. package/skills/frontend/shadcn-ui/assets/components/direction.md +205 -0
  522. package/skills/frontend/shadcn-ui/assets/components/drawer.md +806 -0
  523. package/skills/frontend/shadcn-ui/assets/components/dropdown-menu.md +1315 -0
  524. package/skills/frontend/shadcn-ui/assets/components/empty.md +562 -0
  525. package/skills/frontend/shadcn-ui/assets/components/field.md +1321 -0
  526. package/skills/frontend/shadcn-ui/assets/components/hover-card.md +342 -0
  527. package/skills/frontend/shadcn-ui/assets/components/index.md +82 -0
  528. package/skills/frontend/shadcn-ui/assets/components/input-group.md +980 -0
  529. package/skills/frontend/shadcn-ui/assets/components/input-otp.md +551 -0
  530. package/skills/frontend/shadcn-ui/assets/components/input.md +555 -0
  531. package/skills/frontend/shadcn-ui/assets/components/item.md +937 -0
  532. package/skills/frontend/shadcn-ui/assets/components/kbd.md +290 -0
  533. package/skills/frontend/shadcn-ui/assets/components/label.md +327 -0
  534. package/skills/frontend/shadcn-ui/assets/components/marker.md +445 -0
  535. package/skills/frontend/shadcn-ui/assets/components/menubar.md +804 -0
  536. package/skills/frontend/shadcn-ui/assets/components/message-scroller.md +2770 -0
  537. package/skills/frontend/shadcn-ui/assets/components/message.md +618 -0
  538. package/skills/frontend/shadcn-ui/assets/components/native-select.md +321 -0
  539. package/skills/frontend/shadcn-ui/assets/components/navigation-menu.md +568 -0
  540. package/skills/frontend/shadcn-ui/assets/components/pagination.md +425 -0
  541. package/skills/frontend/shadcn-ui/assets/components/popover.md +402 -0
  542. package/skills/frontend/shadcn-ui/assets/components/progress.md +240 -0
  543. package/skills/frontend/shadcn-ui/assets/components/questionnaire.md +2055 -0
  544. package/skills/frontend/shadcn-ui/assets/components/radio-group.md +440 -0
  545. package/skills/frontend/shadcn-ui/assets/components/resizable.md +302 -0
  546. package/skills/frontend/shadcn-ui/assets/components/scroll-area.md +226 -0
  547. package/skills/frontend/shadcn-ui/assets/components/select.md +647 -0
  548. package/skills/frontend/shadcn-ui/assets/components/separator.md +235 -0
  549. package/skills/frontend/shadcn-ui/assets/components/sheet.md +354 -0
  550. package/skills/frontend/shadcn-ui/assets/components/sidebar.md +1156 -0
  551. package/skills/frontend/shadcn-ui/assets/components/skeleton.md +217 -0
  552. package/skills/frontend/shadcn-ui/assets/components/slider.md +253 -0
  553. package/skills/frontend/shadcn-ui/assets/components/spinner.md +352 -0
  554. package/skills/frontend/shadcn-ui/assets/components/switch.md +296 -0
  555. package/skills/frontend/shadcn-ui/assets/components/table.md +572 -0
  556. package/skills/frontend/shadcn-ui/assets/components/tabs.md +425 -0
  557. package/skills/frontend/shadcn-ui/assets/components/textarea.md +218 -0
  558. package/skills/frontend/shadcn-ui/assets/components/toast.md +260 -0
  559. package/skills/frontend/shadcn-ui/assets/components/toggle-group.md +419 -0
  560. package/skills/frontend/shadcn-ui/assets/components/toggle.md +220 -0
  561. package/skills/frontend/shadcn-ui/assets/components/tooltip.md +332 -0
  562. package/skills/frontend/shadcn-ui/assets/components/trace.md +1890 -0
  563. package/skills/frontend/shadcn-ui/assets/components/typography.md +561 -0
  564. package/skills/frontend/shadcn-ui/assets/dark-mode/next.md +108 -0
  565. package/skills/frontend/shadcn-ui/assets/dark-mode/overview.md +75 -0
  566. package/skills/frontend/shadcn-ui/assets/dark-mode/vite.md +144 -0
  567. package/skills/frontend/shadcn-ui/assets/forms/next.md +716 -0
  568. package/skills/frontend/shadcn-ui/assets/forms/overview.md +60 -0
  569. package/skills/frontend/shadcn-ui/assets/forms/react-hook-form.md +2055 -0
  570. package/skills/frontend/shadcn-ui/assets/forms/tanstack-form.md +2236 -0
  571. package/skills/frontend/shadcn-ui/assets/installation/astro.md +252 -0
  572. package/skills/frontend/shadcn-ui/assets/installation/manual.md +255 -0
  573. package/skills/frontend/shadcn-ui/assets/installation/next.md +256 -0
  574. package/skills/frontend/shadcn-ui/assets/installation/react-router.md +226 -0
  575. package/skills/frontend/shadcn-ui/assets/installation/remix.md +52 -0
  576. package/skills/frontend/shadcn-ui/assets/installation/vite.md +314 -0
  577. package/skills/frontend/shadcn-ui/assets/mcp/mcp.md +338 -0
  578. package/skills/frontend/shadcn-ui/assets/overview/changelog.md +6 -0
  579. package/skills/frontend/shadcn-ui/assets/overview/cli.md +738 -0
  580. package/skills/frontend/shadcn-ui/assets/overview/components-json.md +379 -0
  581. package/skills/frontend/shadcn-ui/assets/overview/directory.md +74 -0
  582. package/skills/frontend/shadcn-ui/assets/overview/introduction.md +77 -0
  583. package/skills/frontend/shadcn-ui/assets/overview/skills.md +71 -0
  584. package/skills/frontend/shadcn-ui/assets/overview/theming.md +304 -0
  585. package/skills/frontend/shadcn-ui/assets/overview/typeset.md +242 -0
  586. package/skills/frontend/shadcn-ui/assets/registry/getting-started.md +648 -0
  587. package/skills/frontend/shadcn-ui/assets/registry/overview.md +90 -0
  588. package/skills/frontend/shadcn-ui/assets/registry/registry-item-json.md +483 -0
  589. package/skills/frontend/shadcn-ui/assets/registry/registry-json.md +178 -0
  590. package/skills/frontend/shadcn-ui/evals/componentVerification.json +19 -0
  591. package/skills/frontend/shadcn-ui/references/aiComponentsCatalog.md +51 -0
  592. package/skills/frontend/shadcn-ui/references/apiReference.md +3 -0
  593. package/skills/frontend/shadcn-ui/references/blocksCatalog.md +32 -0
  594. package/skills/frontend/shadcn-ui/references/cliCommands.md +47 -0
  595. package/skills/frontend/shadcn-ui/references/componentMarkdownSources.md +48 -0
  596. package/skills/frontend/shadcn-ui/scripts/fetchComponentDocs.py +43 -0
  597. package/skills/frontend/tsxReactStandard/SKILL.md +150 -0
  598. package/skills/frontend/tsxReactStandard/evals/tsxVerification.json +14 -0
  599. package/skills/frontend/tsxReactStandard/references/apiReference.md +3 -0
  600. package/skills/frontend/tsxReactStandard/references/discriminatedUnions.md +31 -0
  601. package/skills/frontend/tsxReactStandard/references/tsconfigStrict.md +36 -0
  602. package/skills/frontend/tsxReactStandard/scripts/validateTsxTypes.py +44 -0
  603. package/skills/gitVersionControl/gitWorkflow/SKILL.md +128 -0
  604. package/skills/gitVersionControl/gitWorkflow/assets/README.md +23 -0
  605. package/skills/gitVersionControl/gitWorkflow/assets/cli/gh-environment.md +87 -0
  606. package/skills/gitVersionControl/gitWorkflow/assets/cli/gh-formatting.md +156 -0
  607. package/skills/gitVersionControl/gitWorkflow/assets/cli/gh-reference.md +2363 -0
  608. package/skills/gitVersionControl/gitWorkflow/assets/using-git/about-git.md +156 -0
  609. package/skills/gitVersionControl/gitWorkflow/assets/using-git/about-remote-repositories.md +65 -0
  610. package/skills/gitVersionControl/gitWorkflow/assets/using-git/associating-text-editors-with-git.md +93 -0
  611. package/skills/gitVersionControl/gitWorkflow/assets/using-git/caching-your-github-credentials.md +115 -0
  612. package/skills/gitVersionControl/gitWorkflow/assets/using-git/getting-changes-from-a-remote-repository.md +76 -0
  613. package/skills/gitVersionControl/gitWorkflow/assets/using-git/ignoring-files.md +51 -0
  614. package/skills/gitVersionControl/gitWorkflow/assets/using-git/managing-remote-repositories.md +231 -0
  615. package/skills/gitVersionControl/gitWorkflow/assets/using-git/pushing-commits-to-a-remote-repository.md +119 -0
  616. package/skills/gitVersionControl/gitWorkflow/evals/evalGitWorkflow.py +43 -0
  617. package/skills/gitVersionControl/gitWorkflow/references/apiReference.md +3 -0
  618. package/skills/gitVersionControl/gitWorkflow/references/branchingModels.md +32 -0
  619. package/skills/gitVersionControl/gitWorkflow/scripts/diagnoseGitGraph.py +68 -0
  620. package/skills/github/assets/README.md +39 -0
  621. package/skills/github/assets/cli/gh-environment.md +87 -0
  622. package/skills/github/assets/cli/gh-formatting.md +156 -0
  623. package/skills/github/assets/cli/gh-reference.md +2363 -0
  624. package/skills/github/assets/docs-api/github-docs-api.md +60 -0
  625. package/skills/github/assets/rest-api/actions-secrets.md +1272 -0
  626. package/skills/github/assets/rest-api/actions-variables.md +1247 -0
  627. package/skills/github/assets/rest-api/actions-workflow-runs.md +1697 -0
  628. package/skills/github/assets/rest-api/actions-workflows.md +348 -0
  629. package/skills/github/assets/rest-api/authenticating.md +174 -0
  630. package/skills/github/assets/rest-api/branches.md +727 -0
  631. package/skills/github/assets/rest-api/checks-runs.md +1013 -0
  632. package/skills/github/assets/rest-api/checks-suites.md +1142 -0
  633. package/skills/github/assets/rest-api/code-scanning.md +2957 -0
  634. package/skills/github/assets/rest-api/collaborators.md +547 -0
  635. package/skills/github/assets/rest-api/commits.md +957 -0
  636. package/skills/github/assets/rest-api/dependabot-alerts.md +895 -0
  637. package/skills/github/assets/rest-api/orgs.md +1172 -0
  638. package/skills/github/assets/rest-api/overview.md +875 -0
  639. package/skills/github/assets/rest-api/pull-reviews.md +722 -0
  640. package/skills/github/assets/rest-api/pulls.md +1605 -0
  641. package/skills/github/assets/rest-api/quickstart.md +344 -0
  642. package/skills/github/assets/rest-api/releases.md +650 -0
  643. package/skills/github/assets/rest-api/repos.md +2957 -0
  644. package/skills/github/assets/rest-api/rules.md +1507 -0
  645. package/skills/github/assets/rest-api/secret-scanning.md +947 -0
  646. package/skills/github/assets/rest-api/teams.md +1690 -0
  647. package/skills/github/githubAction/SKILL.md +159 -0
  648. package/skills/github/githubAction/assets/README.md +38 -0
  649. package/skills/github/githubAction/assets/reference/contexts.md +918 -0
  650. package/skills/github/githubAction/assets/reference/dependency-caching.md +393 -0
  651. package/skills/github/githubAction/assets/reference/events-that-trigger-workflows.md +1348 -0
  652. package/skills/github/githubAction/assets/reference/expressions.md +441 -0
  653. package/skills/github/githubAction/assets/reference/metadata-syntax.md +803 -0
  654. package/skills/github/githubAction/assets/reference/variables.md +149 -0
  655. package/skills/github/githubAction/assets/reference/workflow-cancellation.md +22 -0
  656. package/skills/github/githubAction/assets/reference/workflow-commands.md +1056 -0
  657. package/skills/github/githubAction/assets/reference/workflow-syntax.md +1721 -0
  658. package/skills/github/githubAction/assets/rest-api/secrets.md +1272 -0
  659. package/skills/github/githubAction/assets/rest-api/workflow-runs.md +1697 -0
  660. package/skills/github/githubAction/assets/rest-api/workflows.md +348 -0
  661. package/skills/github/githubAction/assets/starter-workflows/automation/stale.yml +27 -0
  662. package/skills/github/githubAction/assets/starter-workflows/ci/blank.yml +36 -0
  663. package/skills/github/githubAction/assets/starter-workflows/ci/docker-image.yml +18 -0
  664. package/skills/github/githubAction/assets/starter-workflows/ci/go.yml +28 -0
  665. package/skills/github/githubAction/assets/starter-workflows/ci/maven.yml +35 -0
  666. package/skills/github/githubAction/assets/starter-workflows/ci/node.js.yml +31 -0
  667. package/skills/github/githubAction/assets/starter-workflows/ci/python-app.yml +39 -0
  668. package/skills/github/githubAction/assets/starter-workflows/ci/rust.yml +22 -0
  669. package/skills/github/githubAction/assets/starter-workflows/code-scanning/codeql.yml +97 -0
  670. package/skills/github/githubAction/evals/actionVerification.json +14 -0
  671. package/skills/github/githubAction/references/apiReference.md +3 -0
  672. package/skills/github/githubAction/references/workflowPatterns.md +81 -0
  673. package/skills/github/githubAction/scripts/validateWorkflowYaml.py +53 -0
  674. package/skills/github/githubQuality/SKILL.md +136 -0
  675. package/skills/github/githubQuality/assets/README.md +24 -0
  676. package/skills/github/githubQuality/assets/pull-requests/about-code-owners.md +178 -0
  677. package/skills/github/githubQuality/assets/pull-requests/about-merge-methods.md +48 -0
  678. package/skills/github/githubQuality/assets/pull-requests/creating-a-pull-request.md +170 -0
  679. package/skills/github/githubQuality/assets/pull-requests/giving-reviews.md +48 -0
  680. package/skills/github/githubQuality/assets/pull-requests/managing-a-merge-queue.md +134 -0
  681. package/skills/github/githubQuality/assets/pull-requests/merging-a-pull-request.md +101 -0
  682. package/skills/github/githubQuality/assets/pull-requests/resolving-reviews.md +59 -0
  683. package/skills/github/githubQuality/assets/pull-requests/status-checks.md +135 -0
  684. package/skills/github/githubQuality/assets/rest-api/checks-runs.md +1013 -0
  685. package/skills/github/githubQuality/assets/rest-api/checks-suites.md +1142 -0
  686. package/skills/github/githubQuality/assets/rest-api/commits.md +957 -0
  687. package/skills/github/githubQuality/assets/rest-api/pulls.md +1605 -0
  688. package/skills/github/githubQuality/assets/rest-api/reviews.md +722 -0
  689. package/skills/github/githubQuality/evals/qualityVerification.json +14 -0
  690. package/skills/github/githubQuality/references/apiReference.md +3 -0
  691. package/skills/github/githubQuality/references/codeownersExample.md +26 -0
  692. package/skills/github/githubQuality/references/prTemplate.md +20 -0
  693. package/skills/github/githubQuality/scripts/auditPrQuality.py +52 -0
  694. package/skills/github/githubSecurity/SKILL.md +170 -0
  695. package/skills/github/githubSecurity/assets/README.md +32 -0
  696. package/skills/github/githubSecurity/assets/code-scanning/code-scanning-alerts.md +133 -0
  697. package/skills/github/githubSecurity/assets/code-scanning/code-scanning.md +67 -0
  698. package/skills/github/githubSecurity/assets/code-scanning/codeql-code-scanning.md +79 -0
  699. package/skills/github/githubSecurity/assets/code-scanning/configure-code-scanning.md +121 -0
  700. package/skills/github/githubSecurity/assets/dependabot/about-the-dependabot-yml-file.md +74 -0
  701. package/skills/github/githubSecurity/assets/dependabot/dependabot-alerts.md +133 -0
  702. package/skills/github/githubSecurity/assets/dependabot/dependabot-security-updates.md +95 -0
  703. package/skills/github/githubSecurity/assets/dependabot/dependabot-version-updates.md +80 -0
  704. package/skills/github/githubSecurity/assets/rest-api/code-scanning.md +2957 -0
  705. package/skills/github/githubSecurity/assets/rest-api/dependabot-alerts.md +895 -0
  706. package/skills/github/githubSecurity/assets/rest-api/secret-scanning.md +947 -0
  707. package/skills/github/githubSecurity/assets/secret-scanning/enable-secret-scanning.md +59 -0
  708. package/skills/github/githubSecurity/assets/secret-scanning/secret-scanning.md +105 -0
  709. package/skills/github/githubSecurity/assets/security-advisories/github-advisory-database.md +148 -0
  710. package/skills/github/githubSecurity/evals/securityVerification.json +14 -0
  711. package/skills/github/githubSecurity/references/apiReference.md +3 -0
  712. package/skills/github/githubSecurity/references/codeqlAnalysis.yml +42 -0
  713. package/skills/github/githubSecurity/references/dependabotConfig.yml +27 -0
  714. package/skills/github/githubSecurity/scripts/auditRepoSecurity.py +47 -0
  715. package/skills/github/githubSetup/SKILL.md +137 -0
  716. package/skills/github/githubSetup/assets/README.md +40 -0
  717. package/skills/github/githubSetup/assets/branches/about-protected-branches.md +198 -0
  718. package/skills/github/githubSetup/assets/branches/changing-the-default-branch.md +49 -0
  719. package/skills/github/githubSetup/assets/branches/deleting-and-restoring-branches.md +44 -0
  720. package/skills/github/githubSetup/assets/branches/managing-a-branch-protection-rule.md +115 -0
  721. package/skills/github/githubSetup/assets/branches/renaming-a-branch.md +74 -0
  722. package/skills/github/githubSetup/assets/branches/viewing-branches-in-your-repository.md +30 -0
  723. package/skills/github/githubSetup/assets/repositories/about-repositories.md +127 -0
  724. package/skills/github/githubSetup/assets/repositories/cloning-a-repository.md +114 -0
  725. package/skills/github/githubSetup/assets/repositories/creating-a-new-repository.md +82 -0
  726. package/skills/github/githubSetup/assets/repositories/creating-a-repository-from-a-template.md +51 -0
  727. package/skills/github/githubSetup/assets/repositories/deleting-a-repository.md +34 -0
  728. package/skills/github/githubSetup/assets/repositories/managing-teams-and-people-with-access.md +69 -0
  729. package/skills/github/githubSetup/assets/repositories/renaming-a-repository.md +47 -0
  730. package/skills/github/githubSetup/assets/repositories/restoring-a-deleted-repository.md +61 -0
  731. package/skills/github/githubSetup/assets/repositories/setting-repository-visibility.md +137 -0
  732. package/skills/github/githubSetup/assets/rest-api/branches.md +727 -0
  733. package/skills/github/githubSetup/assets/rest-api/quickstart.md +344 -0
  734. package/skills/github/githubSetup/assets/rest-api/repos.md +2957 -0
  735. package/skills/github/githubSetup/assets/rulesets/about-rulesets.md +72 -0
  736. package/skills/github/githubSetup/assets/rulesets/available-rules-for-rulesets.md +383 -0
  737. package/skills/github/githubSetup/assets/rulesets/converting-branch-protections-to-rulesets.md +92 -0
  738. package/skills/github/githubSetup/assets/rulesets/creating-rulesets-for-a-repository.md +108 -0
  739. package/skills/github/githubSetup/assets/rulesets/managing-rulesets-for-a-repository.md +149 -0
  740. package/skills/github/githubSetup/assets/rulesets/troubleshooting-rules.md +122 -0
  741. package/skills/github/githubSetup/evals/setupVerification.json +14 -0
  742. package/skills/github/githubSetup/references/apiReference.md +3 -0
  743. package/skills/github/githubSetup/references/repoSettingsBlueprint.md +13 -0
  744. package/skills/github/githubSetup/references/rulesetTemplates.json +42 -0
  745. package/skills/github/githubSetup/scripts/configureRepoBaseline.py +46 -0
  746. package/skills/github/githubTeam/SKILL.md +115 -0
  747. package/skills/github/githubTeam/assets/README.md +21 -0
  748. package/skills/github/githubTeam/assets/organizations/about-organizations.md +69 -0
  749. package/skills/github/githubTeam/assets/organizations/repository-roles-for-an-organization.md +94 -0
  750. package/skills/github/githubTeam/assets/rest-api/collaborators.md +547 -0
  751. package/skills/github/githubTeam/assets/rest-api/orgs.md +1172 -0
  752. package/skills/github/githubTeam/assets/rest-api/teams.md +1690 -0
  753. package/skills/github/githubTeam/assets/teams/about-teams.md +82 -0
  754. package/skills/github/githubTeam/assets/teams/adding-members-to-a-team.md +55 -0
  755. package/skills/github/githubTeam/evals/teamVerification.json +14 -0
  756. package/skills/github/githubTeam/references/apiReference.md +3 -0
  757. package/skills/github/githubTeam/references/permissionMatrix.md +17 -0
  758. package/skills/github/githubTeam/references/reviewAssignment.md +17 -0
  759. package/skills/github/githubTeam/scripts/manageTeamSync.py +31 -0
  760. package/skills/securityQa/llmSecurityRedteaming/SKILL.md +86 -0
  761. package/skills/securityQa/llmSecurityRedteaming/evals/securityRedteamVerification.json +14 -0
  762. package/skills/securityQa/llmSecurityRedteaming/references/apiReference.md +3 -0
  763. package/skills/securityQa/llmSecurityRedteaming/references/jailbreakTaxonomy.md +6 -0
  764. package/skills/securityQa/llmSecurityRedteaming/references/owaspLlmTopTen.md +12 -0
  765. package/skills/securityQa/llmSecurityRedteaming/scripts/testPromptInjection.py +34 -0
  766. package/skills/softwareDevelopment/requirementsEngineering/SKILL.md +110 -0
  767. package/skills/softwareDevelopment/requirementsEngineering/evals/evalRequirements.py +33 -0
  768. package/skills/softwareDevelopment/requirementsEngineering/references/apiReference.md +3 -0
  769. package/skills/softwareDevelopment/requirementsEngineering/references/requirementsAnalysisModels.md +34 -0
  770. package/skills/softwareDevelopment/requirementsEngineering/scripts/validateUserStories.py +49 -0
  771. package/skills/testing/testDrivenDevelopment/SKILL.md +122 -0
  772. package/skills/testing/testDrivenDevelopment/evals/evalTdd.py +25 -0
  773. package/skills/testing/testDrivenDevelopment/references/apiReference.md +3 -0
  774. package/skills/testing/testDrivenDevelopment/references/testPyramidDoubles.md +35 -0
  775. package/skills/testing/testDrivenDevelopment/scripts/auditTestPyramid.py +58 -0
@@ -0,0 +1,1605 @@
1
+ # REST API endpoints for pull requests
2
+
3
+ Use the REST API to interact with pull requests.
4
+
5
+ ## About pull requests
6
+
7
+ You can list, view, edit, create, and merge pull requests using the REST API. For information about how to interact with comments on a pull request, see [REST API endpoints for issue comments](/en/rest/issues/comments).
8
+
9
+ Pull requests are a type of issue. Any actions that are available in both pull requests and issues, like managing assignees, labels, and milestones, are handled by the REST API to manage issues. To perform these actions on pull requests, you must use the issues API endpoints (for example, `/repos/{owner}/{repo}/issues/{issue_number}`), not the pull requests endpoints. For more information, see [REST API endpoints for issues](/en/rest/issues).
10
+
11
+ ### Link Relations
12
+
13
+ Pull requests have these possible link relations:
14
+
15
+ * `self`: The API location of this pull request
16
+ * `html`: The HTML location of this pull request
17
+ * `issue`: The API location of this pull request's [issue](/en/rest/issues)
18
+ * `comments`: The API location of this pull request's [issue comments](/en/rest/issues/comments)
19
+ * `review_comments`: The API location of this pull request's [review comments](/en/rest/pulls/comments)
20
+ * `review_comment`: The [URL template](/en/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to construct the API location for a [review comment](/en/rest/pulls/comments) in this pull request's repository
21
+ * `commits`: The API location of this pull request's [commits](#list-commits-on-a-pull-request)
22
+ * `statuses`: The API location of this pull request's [commit statuses](/en/rest/commits#commit-statuses), which are the statuses of its `head` branch
23
+
24
+ > [!NOTE]
25
+ > Most endpoints use `Authorization: Bearer <YOUR-TOKEN>` and `Accept: application/vnd.github+json` headers, plus `X-GitHub-Api-Version: 2026-03-10`. Curl examples below omit these standard headers for brevity.
26
+
27
+ ## List pull requests
28
+
29
+ ```
30
+ GET /repos/{owner}/{repo}/pulls
31
+ ```
32
+
33
+ Lists pull requests in a specified repository.
34
+ Draft pull requests are available in public repositories with GitHub
35
+ Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing
36
+ plans, and in public and private repositories with GitHub Team and GitHub Enterprise
37
+ Cloud. For more information, see GitHub's products
38
+ in the GitHub Help documentation.
39
+ This endpoint supports the following custom media types. For more information, see "Media types."
40
+
41
+ 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.
42
+ application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body\_text.
43
+ application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body\_html.
44
+ application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body\_text, and body\_html.
45
+
46
+ ### Parameters
47
+
48
+ #### Headers
49
+
50
+ * **`accept`** (string)
51
+ Setting to `application/vnd.github+json` is recommended.
52
+
53
+ #### Path and query parameters
54
+
55
+ * **`owner`** (string) (required)
56
+ The account owner of the repository. The name is not case sensitive.
57
+
58
+ * **`repo`** (string) (required)
59
+ The name of the repository without the .git extension. The name is not case sensitive.
60
+
61
+ * **`state`** (string)
62
+ Either open, closed, or all to filter by state.
63
+ Default: `open`
64
+ Can be one of: `open`, `closed`, `all`
65
+
66
+ * **`head`** (string)
67
+ 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.
68
+
69
+ * **`base`** (string)
70
+ Filter pulls by base branch name. Example: gh-pages.
71
+
72
+ * **`sort`** (string)
73
+ 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.
74
+ Default: `created`
75
+ Can be one of: `created`, `updated`, `popularity`, `long-running`
76
+
77
+ * **`direction`** (string)
78
+ The direction of the sort. Default: desc when sort is created or sort is not specified, otherwise asc.
79
+ Can be one of: `asc`, `desc`
80
+
81
+ * **`per_page`** (integer)
82
+ The number of results per page (max 100). For more information, see "Using pagination in the REST API."
83
+ Default: `30`
84
+
85
+ * **`page`** (integer)
86
+ The page number of the results to fetch. For more information, see "Using pagination in the REST API."
87
+ Default: `1`
88
+
89
+ ### HTTP response status codes
90
+
91
+ * **200** - OK
92
+
93
+ * **304** - Not modified
94
+
95
+ * **422** - Validation failed, or the endpoint has been spammed.
96
+
97
+ ### Code examples
98
+
99
+ #### Example
100
+
101
+ **Request:**
102
+
103
+ ```curl
104
+ curl -L \
105
+ -X GET \
106
+ https://api.github.com/repos/OWNER/REPO/pulls
107
+ ```
108
+
109
+ **Response schema (Status: 200):**
110
+
111
+ Array of `Pull Request Simple`:
112
+
113
+ * `url`: required, string, format: uri
114
+ * `id`: required, integer, format: int64
115
+ * `node_id`: required, string
116
+ * `html_url`: required, string, format: uri
117
+ * `diff_url`: required, string, format: uri
118
+ * `patch_url`: required, string, format: uri
119
+ * `issue_url`: required, string, format: uri
120
+ * `commits_url`: required, string, format: uri
121
+ * `review_comments_url`: required, string, format: uri
122
+ * `review_comment_url`: required, string
123
+ * `comments_url`: required, string, format: uri
124
+ * `statuses_url`: required, string, format: uri
125
+ * `number`: required, integer
126
+ * `state`: required, string
127
+ * `locked`: required, boolean
128
+ * `title`: required, string
129
+ * `user`: required, any of:
130
+ * **null**
131
+ * **Simple User**
132
+ * `name`: string or null
133
+ * `email`: string or null
134
+ * `login`: required, string
135
+ * `id`: required, integer, format: int64
136
+ * `node_id`: required, string
137
+ * `avatar_url`: required, string, format: uri
138
+ * `gravatar_id`: required, string or null
139
+ * `url`: required, string, format: uri
140
+ * `html_url`: required, string, format: uri
141
+ * `followers_url`: required, string, format: uri
142
+ * `following_url`: required, string
143
+ * `gists_url`: required, string
144
+ * `starred_url`: required, string
145
+ * `subscriptions_url`: required, string, format: uri
146
+ * `organizations_url`: required, string, format: uri
147
+ * `repos_url`: required, string, format: uri
148
+ * `events_url`: required, string
149
+ * `received_events_url`: required, string, format: uri
150
+ * `type`: required, string
151
+ * `site_admin`: required, boolean
152
+ * `starred_at`: string
153
+ * `user_view_type`: string
154
+ * `body`: required, string or null
155
+ * `labels`: required, array of objects:
156
+ * `id`: required, integer, format: int64
157
+ * `node_id`: required, string
158
+ * `url`: required, string
159
+ * `name`: required, string
160
+ * `description`: required, string
161
+ * `color`: required, string
162
+ * `default`: required, boolean
163
+ * `archived_by`: required, all of:
164
+ * **Simple User** (see above)
165
+ * `milestone`: required, any of:
166
+ * **null**
167
+ * **Milestone**
168
+ * `url`: required, string, format: uri
169
+ * `html_url`: required, string, format: uri
170
+ * `labels_url`: required, string, format: uri
171
+ * `id`: required, integer
172
+ * `node_id`: required, string
173
+ * `number`: required, integer
174
+ * `state`: required, string, enum: `open`, `closed`, default: `"open"`
175
+ * `title`: required, string
176
+ * `description`: required, string or null
177
+ * `creator`: required, any of:
178
+ * **null**
179
+ * **Simple User** (see above)
180
+ * `open_issues`: required, integer
181
+ * `closed_issues`: required, integer
182
+ * `created_at`: required, string, format: date-time
183
+ * `updated_at`: required, string, format: date-time
184
+ * `closed_at`: required, string or null, format: date-time
185
+ * `due_on`: required, string or null, format: date-time
186
+ * `active_lock_reason`: string or null
187
+ * `created_at`: required, string, format: date-time
188
+ * `updated_at`: required, string, format: date-time
189
+ * `closed_at`: required, string or null, format: date-time
190
+ * `merged_at`: required, string or null, format: date-time
191
+ * `assignees`: array of `Simple User` (see above)
192
+ * `requested_reviewers`: array of `Simple User` (see above)
193
+ * `requested_teams`: array of `Team`:
194
+ * `id`: required, integer
195
+ * `node_id`: required, string
196
+ * `name`: required, string
197
+ * `slug`: required, string
198
+ * `description`: required, string or null
199
+ * `privacy`: string
200
+ * `notification_setting`: string
201
+ * `permission`: required, string
202
+ * `permissions`: object:
203
+ * `pull`: required, boolean
204
+ * `triage`: required, boolean
205
+ * `push`: required, boolean
206
+ * `maintain`: required, boolean
207
+ * `admin`: required, boolean
208
+ * `url`: required, string, format: uri
209
+ * `html_url`: required, string, format: uri
210
+ * `members_url`: required, string
211
+ * `repositories_url`: required, string, format: uri
212
+ * `type`: required, string, enum: `enterprise`, `organization`
213
+ * `access_source`: string, enum: `direct`, `organization`, `enterprise`
214
+ * `organization_id`: integer
215
+ * `enterprise_id`: integer
216
+ * `parent`: required, any of:
217
+ * **null**
218
+ * **Team Simple**
219
+ * `id`: required, integer
220
+ * `node_id`: required, string
221
+ * `url`: required, string, format: uri
222
+ * `members_url`: required, string
223
+ * `name`: required, string
224
+ * `description`: required, string or null
225
+ * `permission`: required, string
226
+ * `privacy`: string
227
+ * `notification_setting`: string
228
+ * `html_url`: required, string, format: uri
229
+ * `repositories_url`: required, string, format: uri
230
+ * `slug`: required, string
231
+ * `ldap_dn`: string
232
+ * `type`: required, string, enum: `enterprise`, `organization`
233
+ * `organization_id`: integer
234
+ * `enterprise_id`: integer
235
+ * `head`: required, object:
236
+ * `label`: required, string
237
+ * `ref`: required, string
238
+ * `repo`: required, `Repository`:
239
+ * `id`: required, integer, format: int64
240
+ * `node_id`: required, string
241
+ * `name`: required, string
242
+ * `full_name`: required, string
243
+ * `license`: required, any of:
244
+ * **null**
245
+ * **License Simple**
246
+ * `key`: required, string
247
+ * `name`: required, string
248
+ * `url`: required, string or null, format: uri
249
+ * `spdx_id`: required, string or null
250
+ * `node_id`: required, string
251
+ * `html_url`: string, format: uri
252
+ * `forks`: required, integer
253
+ * `permissions`: object:
254
+ * `admin`: required, boolean
255
+ * `pull`: required, boolean
256
+ * `triage`: boolean
257
+ * `push`: required, boolean
258
+ * `maintain`: boolean
259
+ * `owner`: required, `Simple User` (see above)
260
+ * `private`: required, boolean, default: `false`
261
+ * `html_url`: required, string, format: uri
262
+ * `description`: required, string or null
263
+ * `fork`: required, boolean
264
+ * `url`: required, string, format: uri
265
+ * `archive_url`: required, string
266
+ * `assignees_url`: required, string
267
+ * `blobs_url`: required, string
268
+ * `branches_url`: required, string
269
+ * `collaborators_url`: required, string
270
+ * `comments_url`: required, string
271
+ * `commits_url`: required, string
272
+ * `compare_url`: required, string
273
+ * `contents_url`: required, string
274
+ * `contributors_url`: required, string, format: uri
275
+ * `deployments_url`: required, string, format: uri
276
+ * `downloads_url`: required, string, format: uri
277
+ * `events_url`: required, string, format: uri
278
+ * `forks_url`: required, string, format: uri
279
+ * `git_commits_url`: required, string
280
+ * `git_refs_url`: required, string
281
+ * `git_tags_url`: required, string
282
+ * `git_url`: required, string
283
+ * `issue_comment_url`: required, string
284
+ * `issue_events_url`: required, string
285
+ * `issues_url`: required, string
286
+ * `keys_url`: required, string
287
+ * `labels_url`: required, string
288
+ * `languages_url`: required, string, format: uri
289
+ * `merges_url`: required, string, format: uri
290
+ * `milestones_url`: required, string
291
+ * `notifications_url`: required, string
292
+ * `pulls_url`: required, string
293
+ * `releases_url`: required, string
294
+ * `ssh_url`: required, string
295
+ * `stargazers_url`: required, string, format: uri
296
+ * `statuses_url`: required, string
297
+ * `subscribers_url`: required, string, format: uri
298
+ * `subscription_url`: required, string, format: uri
299
+ * `tags_url`: required, string, format: uri
300
+ * `teams_url`: required, string, format: uri
301
+ * `trees_url`: required, string
302
+ * `clone_url`: required, string
303
+ * `mirror_url`: required, string or null, format: uri
304
+ * `hooks_url`: required, string, format: uri
305
+ * `svn_url`: required, string, format: uri
306
+ * `homepage`: required, string or null, format: uri
307
+ * `language`: required, string or null
308
+ * `forks_count`: required, integer
309
+ * `stargazers_count`: required, integer
310
+ * `watchers_count`: required, integer
311
+ * `size`: required, integer
312
+ * `default_branch`: required, string
313
+ * `open_issues_count`: required, integer
314
+ * `is_template`: boolean, default: `false`
315
+ * `topics`: array of string
316
+ * `has_issues`: required, boolean, default: `true`
317
+ * `has_projects`: required, boolean, default: `true`
318
+ * `has_wiki`: required, boolean, default: `true`
319
+ * `has_pages`: required, boolean
320
+ * `has_discussions`: boolean, default: `false`
321
+ * `has_pull_requests`: boolean, default: `true`
322
+ * `pull_request_creation_policy`: string, enum: `all`, `collaborators_only`
323
+ * `archived`: required, boolean, default: `false`
324
+ * `disabled`: required, boolean
325
+ * `visibility`: string, default: `"public"`
326
+ * `pushed_at`: required, string or null, format: date-time
327
+ * `created_at`: required, string or null, format: date-time
328
+ * `updated_at`: required, string or null, format: date-time
329
+ * `allow_rebase_merge`: boolean, default: `true`
330
+ * `temp_clone_token`: string
331
+ * `allow_squash_merge`: boolean, default: `true`
332
+ * `allow_auto_merge`: boolean, default: `false`
333
+ * `delete_branch_on_merge`: boolean, default: `false`
334
+ * `allow_update_branch`: boolean, default: `false`
335
+ * `squash_merge_commit_title`: string, enum: `PR_TITLE`, `COMMIT_OR_PR_TITLE`
336
+ * `squash_merge_commit_message`: string, enum: `PR_BODY`, `COMMIT_MESSAGES`, `BLANK`
337
+ * `merge_commit_title`: string, enum: `PR_TITLE`, `MERGE_MESSAGE`
338
+ * `merge_commit_message`: string, enum: `PR_BODY`, `PR_TITLE`, `BLANK`
339
+ * `allow_merge_commit`: boolean, default: `true`
340
+ * `allow_forking`: boolean
341
+ * `web_commit_signoff_required`: boolean, default: `false`
342
+ * `open_issues`: required, integer
343
+ * `watchers`: required, integer
344
+ * `starred_at`: string
345
+ * `anonymous_access_enabled`: boolean
346
+ * `code_search_index_status`: object:
347
+ * `lexical_search_ok`: boolean
348
+ * `lexical_commit_sha`: string
349
+ * `sha`: required, string
350
+ * `user`: required, any of:
351
+ * **null**
352
+ * **Simple User** (see above)
353
+ * `base`: required, object:
354
+ * `label`: required, string
355
+ * `ref`: required, string
356
+ * `repo`: required, `Repository` (see above)
357
+ * `sha`: required, string
358
+ * `user`: required, any of:
359
+ * **null**
360
+ * **Simple User** (see above)
361
+ * `_links`: required, object:
362
+ * `comments`: required, `Link`:
363
+ * `href`: required, string
364
+ * `commits`: required, `Link` (see above)
365
+ * `statuses`: required, `Link` (see above)
366
+ * `html`: required, `Link` (see above)
367
+ * `issue`: required, `Link` (see above)
368
+ * `review_comments`: required, `Link` (see above)
369
+ * `review_comment`: required, `Link` (see above)
370
+ * `self`: required, `Link` (see above)
371
+ * `author_association`: required, string, enum: `COLLABORATOR`, `CONTRIBUTOR`, `FIRST_TIMER`, `FIRST_TIME_CONTRIBUTOR`, `MANNEQUIN`, `MEMBER`, `NONE`, `OWNER`
372
+ * `auto_merge`: required, `Auto merge`:
373
+ * `enabled_by`: required, `Simple User` (see above)
374
+ * `merge_method`: required, string, enum: `merge`, `squash`, `rebase`
375
+ * `commit_title`: required, string
376
+ * `commit_message`: required, string
377
+ * `stack`: `Pull Request Stack`:
378
+ * `base`: required, object:
379
+ * `ref`: required, string
380
+ * `sha`: required, string
381
+ * `size`: integer
382
+ * `position`: integer
383
+ * `id`: integer
384
+ * `number`: integer
385
+ * `draft`: boolean
386
+
387
+ ## Create a pull request
388
+
389
+ ```
390
+ POST /repos/{owner}/{repo}/pulls
391
+ ```
392
+
393
+ 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 in the GitHub Help documentation.
394
+ To 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.
395
+ This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."
396
+ This endpoint supports the following custom media types. For more information, see "Media types."
397
+
398
+ 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.
399
+ application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body\_text.
400
+ application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body\_html.
401
+ application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body\_text, and body\_html.
402
+
403
+ ### Parameters
404
+
405
+ #### Headers
406
+
407
+ * **`accept`** (string)
408
+ Setting to `application/vnd.github+json` is recommended.
409
+
410
+ #### Path and query parameters
411
+
412
+ * **`owner`** (string) (required)
413
+ The account owner of the repository. The name is not case sensitive.
414
+
415
+ * **`repo`** (string) (required)
416
+ The name of the repository without the .git extension. The name is not case sensitive.
417
+
418
+ #### Body parameters
419
+
420
+ * **`title`** (string)
421
+ The title of the new pull request. Required unless issue is specified.
422
+
423
+ * **`head`** (string) (required)
424
+ 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.
425
+
426
+ * **`head_repo`** (string)
427
+ 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.
428
+
429
+ * **`base`** (string) (required)
430
+ 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.
431
+
432
+ * **`body`** (string)
433
+ The contents of the pull request.
434
+
435
+ * **`maintainer_can_modify`** (boolean)
436
+ Indicates whether maintainers can modify the pull request.
437
+
438
+ * **`draft`** (boolean)
439
+ Indicates whether the pull request is a draft. See "Draft Pull Requests" in the GitHub Help documentation to learn more.
440
+
441
+ * **`issue`** (integer)
442
+ 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.
443
+
444
+ ### HTTP response status codes
445
+
446
+ * **201** - Created
447
+
448
+ * **403** - Forbidden
449
+
450
+ * **422** - Validation failed, or the endpoint has been spammed.
451
+
452
+ ### Code examples
453
+
454
+ #### Example
455
+
456
+ **Request:**
457
+
458
+ ```curl
459
+ curl -L \
460
+ -X POST \
461
+ https://api.github.com/repos/OWNER/REPO/pulls \
462
+ -d '{
463
+ "title": "Amazing new feature",
464
+ "body": "Please pull these awesome changes in!",
465
+ "head": "octocat:new-feature",
466
+ "base": "master"
467
+ }'
468
+ ```
469
+
470
+ **Response schema (Status: 201):**
471
+
472
+ * `url`: required, string, format: uri
473
+ * `id`: required, integer, format: int64
474
+ * `node_id`: required, string
475
+ * `html_url`: required, string, format: uri
476
+ * `diff_url`: required, string, format: uri
477
+ * `patch_url`: required, string, format: uri
478
+ * `issue_url`: required, string, format: uri
479
+ * `commits_url`: required, string, format: uri
480
+ * `review_comments_url`: required, string, format: uri
481
+ * `review_comment_url`: required, string
482
+ * `comments_url`: required, string, format: uri
483
+ * `statuses_url`: required, string, format: uri
484
+ * `number`: required, integer
485
+ * `state`: required, string, enum: `open`, `closed`
486
+ * `locked`: required, boolean
487
+ * `title`: required, string
488
+ * `user`: required, `Simple User`:
489
+ * `name`: string or null
490
+ * `email`: string or null
491
+ * `login`: required, string
492
+ * `id`: required, integer, format: int64
493
+ * `node_id`: required, string
494
+ * `avatar_url`: required, string, format: uri
495
+ * `gravatar_id`: required, string or null
496
+ * `url`: required, string, format: uri
497
+ * `html_url`: required, string, format: uri
498
+ * `followers_url`: required, string, format: uri
499
+ * `following_url`: required, string
500
+ * `gists_url`: required, string
501
+ * `starred_url`: required, string
502
+ * `subscriptions_url`: required, string, format: uri
503
+ * `organizations_url`: required, string, format: uri
504
+ * `repos_url`: required, string, format: uri
505
+ * `events_url`: required, string
506
+ * `received_events_url`: required, string, format: uri
507
+ * `type`: required, string
508
+ * `site_admin`: required, boolean
509
+ * `starred_at`: string
510
+ * `user_view_type`: string
511
+ * `body`: required, string or null
512
+ * `labels`: required, array of objects:
513
+ * `id`: required, integer, format: int64
514
+ * `node_id`: required, string
515
+ * `url`: required, string
516
+ * `name`: required, string
517
+ * `description`: required, string or null
518
+ * `color`: required, string
519
+ * `default`: required, boolean
520
+ * `archived_by`: required, all of:
521
+ * **Simple User** (see above)
522
+ * `milestone`: required, any of:
523
+ * **null**
524
+ * **Milestone**
525
+ * `url`: required, string, format: uri
526
+ * `html_url`: required, string, format: uri
527
+ * `labels_url`: required, string, format: uri
528
+ * `id`: required, integer
529
+ * `node_id`: required, string
530
+ * `number`: required, integer
531
+ * `state`: required, string, enum: `open`, `closed`, default: `"open"`
532
+ * `title`: required, string
533
+ * `description`: required, string or null
534
+ * `creator`: required, any of:
535
+ * **null**
536
+ * **Simple User** (see above)
537
+ * `open_issues`: required, integer
538
+ * `closed_issues`: required, integer
539
+ * `created_at`: required, string, format: date-time
540
+ * `updated_at`: required, string, format: date-time
541
+ * `closed_at`: required, string or null, format: date-time
542
+ * `due_on`: required, string or null, format: date-time
543
+ * `active_lock_reason`: string or null
544
+ * `created_at`: required, string, format: date-time
545
+ * `updated_at`: required, string, format: date-time
546
+ * `closed_at`: required, string or null, format: date-time
547
+ * `merged_at`: required, string or null, format: date-time
548
+ * `assignees`: array of `Simple User` (see above)
549
+ * `requested_reviewers`: array of `Simple User` (see above)
550
+ * `requested_teams`: array of `Team Simple`:
551
+ * `id`: required, integer
552
+ * `node_id`: required, string
553
+ * `url`: required, string, format: uri
554
+ * `members_url`: required, string
555
+ * `name`: required, string
556
+ * `description`: required, string or null
557
+ * `permission`: required, string
558
+ * `privacy`: string
559
+ * `notification_setting`: string
560
+ * `html_url`: required, string, format: uri
561
+ * `repositories_url`: required, string, format: uri
562
+ * `slug`: required, string
563
+ * `ldap_dn`: string
564
+ * `type`: required, string, enum: `enterprise`, `organization`
565
+ * `organization_id`: integer
566
+ * `enterprise_id`: integer
567
+ * `head`: required, object:
568
+ * `label`: required, string
569
+ * `ref`: required, string
570
+ * `repo`: required, `Repository`:
571
+ * `id`: required, integer, format: int64
572
+ * `node_id`: required, string
573
+ * `name`: required, string
574
+ * `full_name`: required, string
575
+ * `license`: required, any of:
576
+ * **null**
577
+ * **License Simple**
578
+ * `key`: required, string
579
+ * `name`: required, string
580
+ * `url`: required, string or null, format: uri
581
+ * `spdx_id`: required, string or null
582
+ * `node_id`: required, string
583
+ * `html_url`: string, format: uri
584
+ * `forks`: required, integer
585
+ * `permissions`: object:
586
+ * `admin`: required, boolean
587
+ * `pull`: required, boolean
588
+ * `triage`: boolean
589
+ * `push`: required, boolean
590
+ * `maintain`: boolean
591
+ * `owner`: required, `Simple User` (see above)
592
+ * `private`: required, boolean, default: `false`
593
+ * `html_url`: required, string, format: uri
594
+ * `description`: required, string or null
595
+ * `fork`: required, boolean
596
+ * `url`: required, string, format: uri
597
+ * `archive_url`: required, string
598
+ * `assignees_url`: required, string
599
+ * `blobs_url`: required, string
600
+ * `branches_url`: required, string
601
+ * `collaborators_url`: required, string
602
+ * `comments_url`: required, string
603
+ * `commits_url`: required, string
604
+ * `compare_url`: required, string
605
+ * `contents_url`: required, string
606
+ * `contributors_url`: required, string, format: uri
607
+ * `deployments_url`: required, string, format: uri
608
+ * `downloads_url`: required, string, format: uri
609
+ * `events_url`: required, string, format: uri
610
+ * `forks_url`: required, string, format: uri
611
+ * `git_commits_url`: required, string
612
+ * `git_refs_url`: required, string
613
+ * `git_tags_url`: required, string
614
+ * `git_url`: required, string
615
+ * `issue_comment_url`: required, string
616
+ * `issue_events_url`: required, string
617
+ * `issues_url`: required, string
618
+ * `keys_url`: required, string
619
+ * `labels_url`: required, string
620
+ * `languages_url`: required, string, format: uri
621
+ * `merges_url`: required, string, format: uri
622
+ * `milestones_url`: required, string
623
+ * `notifications_url`: required, string
624
+ * `pulls_url`: required, string
625
+ * `releases_url`: required, string
626
+ * `ssh_url`: required, string
627
+ * `stargazers_url`: required, string, format: uri
628
+ * `statuses_url`: required, string
629
+ * `subscribers_url`: required, string, format: uri
630
+ * `subscription_url`: required, string, format: uri
631
+ * `tags_url`: required, string, format: uri
632
+ * `teams_url`: required, string, format: uri
633
+ * `trees_url`: required, string
634
+ * `clone_url`: required, string
635
+ * `mirror_url`: required, string or null, format: uri
636
+ * `hooks_url`: required, string, format: uri
637
+ * `svn_url`: required, string, format: uri
638
+ * `homepage`: required, string or null, format: uri
639
+ * `language`: required, string or null
640
+ * `forks_count`: required, integer
641
+ * `stargazers_count`: required, integer
642
+ * `watchers_count`: required, integer
643
+ * `size`: required, integer
644
+ * `default_branch`: required, string
645
+ * `open_issues_count`: required, integer
646
+ * `is_template`: boolean, default: `false`
647
+ * `topics`: array of string
648
+ * `has_issues`: required, boolean, default: `true`
649
+ * `has_projects`: required, boolean, default: `true`
650
+ * `has_wiki`: required, boolean, default: `true`
651
+ * `has_pages`: required, boolean
652
+ * `has_discussions`: boolean, default: `false`
653
+ * `has_pull_requests`: boolean, default: `true`
654
+ * `pull_request_creation_policy`: string, enum: `all`, `collaborators_only`
655
+ * `archived`: required, boolean, default: `false`
656
+ * `disabled`: required, boolean
657
+ * `visibility`: string, default: `"public"`
658
+ * `pushed_at`: required, string or null, format: date-time
659
+ * `created_at`: required, string or null, format: date-time
660
+ * `updated_at`: required, string or null, format: date-time
661
+ * `allow_rebase_merge`: boolean, default: `true`
662
+ * `temp_clone_token`: string
663
+ * `allow_squash_merge`: boolean, default: `true`
664
+ * `allow_auto_merge`: boolean, default: `false`
665
+ * `delete_branch_on_merge`: boolean, default: `false`
666
+ * `allow_update_branch`: boolean, default: `false`
667
+ * `squash_merge_commit_title`: string, enum: `PR_TITLE`, `COMMIT_OR_PR_TITLE`
668
+ * `squash_merge_commit_message`: string, enum: `PR_BODY`, `COMMIT_MESSAGES`, `BLANK`
669
+ * `merge_commit_title`: string, enum: `PR_TITLE`, `MERGE_MESSAGE`
670
+ * `merge_commit_message`: string, enum: `PR_BODY`, `PR_TITLE`, `BLANK`
671
+ * `allow_merge_commit`: boolean, default: `true`
672
+ * `allow_forking`: boolean
673
+ * `web_commit_signoff_required`: boolean, default: `false`
674
+ * `open_issues`: required, integer
675
+ * `watchers`: required, integer
676
+ * `starred_at`: string
677
+ * `anonymous_access_enabled`: boolean
678
+ * `code_search_index_status`: object:
679
+ * `lexical_search_ok`: boolean
680
+ * `lexical_commit_sha`: string
681
+ * `sha`: required, string
682
+ * `user`: required, `Simple User` (see above)
683
+ * `base`: required, object:
684
+ * `label`: required, string
685
+ * `ref`: required, string
686
+ * `repo`: required, `Repository` (see above)
687
+ * `sha`: required, string
688
+ * `user`: required, `Simple User` (see above)
689
+ * `_links`: required, object:
690
+ * `comments`: required, `Link`:
691
+ * `href`: required, string
692
+ * `commits`: required, `Link` (see above)
693
+ * `statuses`: required, `Link` (see above)
694
+ * `html`: required, `Link` (see above)
695
+ * `issue`: required, `Link` (see above)
696
+ * `review_comments`: required, `Link` (see above)
697
+ * `review_comment`: required, `Link` (see above)
698
+ * `self`: required, `Link` (see above)
699
+ * `author_association`: required, string, enum: `COLLABORATOR`, `CONTRIBUTOR`, `FIRST_TIMER`, `FIRST_TIME_CONTRIBUTOR`, `MANNEQUIN`, `MEMBER`, `NONE`, `OWNER`
700
+ * `auto_merge`: required, `Auto merge`:
701
+ * `enabled_by`: required, `Simple User` (see above)
702
+ * `merge_method`: required, string, enum: `merge`, `squash`, `rebase`
703
+ * `commit_title`: required, string
704
+ * `commit_message`: required, string
705
+ * `stack`: `Pull Request Stack`:
706
+ * `base`: required, object:
707
+ * `ref`: required, string
708
+ * `sha`: required, string
709
+ * `size`: integer
710
+ * `position`: integer
711
+ * `id`: integer
712
+ * `number`: integer
713
+ * `draft`: boolean
714
+ * `merged`: required, boolean
715
+ * `mergeable`: required, boolean or null
716
+ * `rebaseable`: boolean or null
717
+ * `mergeable_state`: required, string
718
+ * `merged_by`: required, any of:
719
+ * **null**
720
+ * **Simple User** (see above)
721
+ * `comments`: required, integer
722
+ * `review_comments`: required, integer
723
+ * `maintainer_can_modify`: required, boolean
724
+ * `commits`: required, integer
725
+ * `additions`: required, integer
726
+ * `deletions`: required, integer
727
+ * `changed_files`: required, integer
728
+
729
+ ## Get a pull request
730
+
731
+ ```
732
+ GET /repos/{owner}/{repo}/pulls/{pull_number}
733
+ ```
734
+
735
+ 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 in the GitHub Help documentation.
736
+ Lists details of a pull request by providing its number.
737
+ When you get, create, or edit 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".
738
+ The 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.
739
+ The 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:
740
+
741
+ If merged as a merge commit, merge\_commit\_sha represents the SHA of the merge commit.
742
+ If merged via a squash, merge\_commit\_sha represents the SHA of the squashed commit on the base branch.
743
+ If rebased, merge\_commit\_sha represents the commit that the base branch was updated to.
744
+
745
+ Pass the appropriate media type to fetch diff and patch formats.
746
+ This endpoint supports the following custom media types. For more information, see "Media types."
747
+
748
+ 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.
749
+ application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body\_text.
750
+ application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body\_html.
751
+ application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body\_text, and body\_html.
752
+ application/vnd.github.diff: For more information, see "git-diff" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
753
+
754
+ ### Parameters
755
+
756
+ #### Headers
757
+
758
+ * **`accept`** (string)
759
+ Setting to `application/vnd.github+json` is recommended.
760
+
761
+ #### Path and query parameters
762
+
763
+ * **`owner`** (string) (required)
764
+ The account owner of the repository. The name is not case sensitive.
765
+
766
+ * **`repo`** (string) (required)
767
+ The name of the repository without the .git extension. The name is not case sensitive.
768
+
769
+ * **`pull_number`** (integer) (required)
770
+ The number that identifies the pull request.
771
+
772
+ ### HTTP response status codes
773
+
774
+ * **200** - Pass the appropriate media type to fetch diff and patch formats.
775
+
776
+ * **304** - Not modified
777
+
778
+ * **404** - Resource not found
779
+
780
+ * **406** - Unacceptable
781
+
782
+ * **422** - Validation failed, or the endpoint has been spammed.
783
+
784
+ * **500** - Internal Error
785
+
786
+ * **503** - Service unavailable
787
+
788
+ ### Code examples
789
+
790
+ #### Example
791
+
792
+ **Request:**
793
+
794
+ ```curl
795
+ curl -L \
796
+ -X GET \
797
+ https://api.github.com/repos/OWNER/REPO/pulls/PULL_NUMBER
798
+ ```
799
+
800
+ **Response schema (Status: 200):**
801
+
802
+ Same response schema as [Create a pull request](#create-a-pull-request).
803
+
804
+ ## Update a pull request
805
+
806
+ ```
807
+ PATCH /repos/{owner}/{repo}/pulls/{pull_number}
808
+ ```
809
+
810
+ 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 in the GitHub Help documentation.
811
+ To 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.
812
+ This endpoint supports the following custom media types. For more information, see "Media types."
813
+
814
+ 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.
815
+ application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body\_text.
816
+ application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body\_html.
817
+ application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body\_text, and body\_html.
818
+
819
+ ### Parameters
820
+
821
+ #### Headers
822
+
823
+ * **`accept`** (string)
824
+ Setting to `application/vnd.github+json` is recommended.
825
+
826
+ #### Path and query parameters
827
+
828
+ * **`owner`** (string) (required)
829
+ The account owner of the repository. The name is not case sensitive.
830
+
831
+ * **`repo`** (string) (required)
832
+ The name of the repository without the .git extension. The name is not case sensitive.
833
+
834
+ * **`pull_number`** (integer) (required)
835
+ The number that identifies the pull request.
836
+
837
+ #### Body parameters
838
+
839
+ * **`title`** (string)
840
+ The title of the pull request.
841
+
842
+ * **`body`** (string)
843
+ The contents of the pull request.
844
+
845
+ * **`state`** (string)
846
+ State of this Pull Request. Either open or closed.
847
+ Can be one of: `open`, `closed`
848
+
849
+ * **`base`** (string)
850
+ 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.
851
+
852
+ * **`maintainer_can_modify`** (boolean)
853
+ Indicates whether maintainers can modify the pull request.
854
+
855
+ ### HTTP response status codes
856
+
857
+ * **200** - OK
858
+
859
+ * **403** - Forbidden
860
+
861
+ * **422** - Validation failed, or the endpoint has been spammed.
862
+
863
+ ### Code examples
864
+
865
+ #### Example
866
+
867
+ **Request:**
868
+
869
+ ```curl
870
+ curl -L \
871
+ -X PATCH \
872
+ https://api.github.com/repos/OWNER/REPO/pulls/PULL_NUMBER \
873
+ -d '{
874
+ "title": "new title",
875
+ "body": "updated body",
876
+ "state": "open",
877
+ "base": "master"
878
+ }'
879
+ ```
880
+
881
+ **Response schema (Status: 200):**
882
+
883
+ Same response schema as [Create a pull request](#create-a-pull-request).
884
+
885
+ ## List commits on a pull request
886
+
887
+ ```
888
+ GET /repos/{owner}/{repo}/pulls/{pull_number}/commits
889
+ ```
890
+
891
+ Lists a maximum of 250 commits for a pull request. To receive a complete
892
+ commit list for pull requests with more than 250 commits, use the List commits
893
+ endpoint.
894
+ This endpoint supports the following custom media types. For more information, see "Media types."
895
+
896
+ 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.
897
+ application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body\_text.
898
+ application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body\_html.
899
+ application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body\_text, and body\_html.
900
+
901
+ ### Parameters
902
+
903
+ #### Headers
904
+
905
+ * **`accept`** (string)
906
+ Setting to `application/vnd.github+json` is recommended.
907
+
908
+ #### Path and query parameters
909
+
910
+ * **`owner`** (string) (required)
911
+ The account owner of the repository. The name is not case sensitive.
912
+
913
+ * **`repo`** (string) (required)
914
+ The name of the repository without the .git extension. The name is not case sensitive.
915
+
916
+ * **`pull_number`** (integer) (required)
917
+ The number that identifies the pull request.
918
+
919
+ * **`per_page`** (integer)
920
+ The number of results per page (max 100). For more information, see "Using pagination in the REST API."
921
+ Default: `30`
922
+
923
+ * **`page`** (integer)
924
+ The page number of the results to fetch. For more information, see "Using pagination in the REST API."
925
+ Default: `1`
926
+
927
+ ### HTTP response status codes
928
+
929
+ * **200** - OK
930
+
931
+ ### Code examples
932
+
933
+ #### Example
934
+
935
+ **Request:**
936
+
937
+ ```curl
938
+ curl -L \
939
+ -X GET \
940
+ https://api.github.com/repos/OWNER/REPO/pulls/PULL_NUMBER/commits
941
+ ```
942
+
943
+ **Response schema (Status: 200):**
944
+
945
+ Array of `Commit`:
946
+
947
+ * `url`: required, string, format: uri
948
+ * `sha`: required, string
949
+ * `node_id`: required, string
950
+ * `html_url`: required, string, format: uri
951
+ * `comments_url`: required, string, format: uri
952
+ * `commit`: required, object:
953
+ * `url`: required, string, format: uri
954
+ * `author`: required, any of:
955
+ * **null**
956
+ * **Git User**
957
+ * `name`: string
958
+ * `email`: string
959
+ * `date`: string, format: date-time
960
+ * `committer`: required, any of:
961
+ * **null**
962
+ * **Git User** (see above)
963
+ * `message`: required, string
964
+ * `comment_count`: required, integer
965
+ * `tree`: required, object:
966
+ * `sha`: required, string
967
+ * `url`: required, string, format: uri
968
+ * `verification`: `Verification`:
969
+ * `verified`: required, boolean
970
+ * `reason`: required, string
971
+ * `payload`: required, string or null
972
+ * `signature`: required, string or null
973
+ * `verified_at`: required, string or null
974
+ * `author`: required, one of:
975
+ * **Simple User**
976
+ * `name`: string or null
977
+ * `email`: string or null
978
+ * `login`: required, string
979
+ * `id`: required, integer, format: int64
980
+ * `node_id`: required, string
981
+ * `avatar_url`: required, string, format: uri
982
+ * `gravatar_id`: required, string or null
983
+ * `url`: required, string, format: uri
984
+ * `html_url`: required, string, format: uri
985
+ * `followers_url`: required, string, format: uri
986
+ * `following_url`: required, string
987
+ * `gists_url`: required, string
988
+ * `starred_url`: required, string
989
+ * `subscriptions_url`: required, string, format: uri
990
+ * `organizations_url`: required, string, format: uri
991
+ * `repos_url`: required, string, format: uri
992
+ * `events_url`: required, string
993
+ * `received_events_url`: required, string, format: uri
994
+ * `type`: required, string
995
+ * `site_admin`: required, boolean
996
+ * `starred_at`: string
997
+ * `user_view_type`: string
998
+ * **Empty Object**
999
+ * `committer`: required, one of:
1000
+ * **Simple User** (see above)
1001
+ * **Empty Object** (see above)
1002
+ * `parents`: required, array of objects:
1003
+ * `sha`: required, string
1004
+ * `url`: required, string, format: uri
1005
+ * `html_url`: string, format: uri
1006
+ * `stats`: object:
1007
+ * `additions`: integer
1008
+ * `deletions`: integer
1009
+ * `total`: integer
1010
+ * `files`: array of `Diff Entry`:
1011
+ * `sha`: required, string or null
1012
+ * `filename`: required, string
1013
+ * `status`: required, string, enum: `added`, `removed`, `modified`, `renamed`, `copied`, `changed`, `unchanged`
1014
+ * `additions`: required, integer
1015
+ * `deletions`: required, integer
1016
+ * `changes`: required, integer
1017
+ * `blob_url`: required, string, format: uri
1018
+ * `raw_url`: required, string, format: uri
1019
+ * `contents_url`: required, string, format: uri
1020
+ * `patch`: string
1021
+ * `previous_filename`: string
1022
+
1023
+ ## List pull requests files
1024
+
1025
+ ```
1026
+ GET /repos/{owner}/{repo}/pulls/{pull_number}/files
1027
+ ```
1028
+
1029
+ Lists the files in a specified pull request.
1030
+ Note
1031
+
1032
+ Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
1033
+
1034
+ This endpoint supports the following custom media types. For more information, see "Media types."
1035
+
1036
+ 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.
1037
+ application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body\_text.
1038
+ application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body\_html.
1039
+ application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body\_text, and body\_html.
1040
+
1041
+ ### Parameters
1042
+
1043
+ #### Headers
1044
+
1045
+ * **`accept`** (string)
1046
+ Setting to `application/vnd.github+json` is recommended.
1047
+
1048
+ #### Path and query parameters
1049
+
1050
+ * **`owner`** (string) (required)
1051
+ The account owner of the repository. The name is not case sensitive.
1052
+
1053
+ * **`repo`** (string) (required)
1054
+ The name of the repository without the .git extension. The name is not case sensitive.
1055
+
1056
+ * **`pull_number`** (integer) (required)
1057
+ The number that identifies the pull request.
1058
+
1059
+ * **`per_page`** (integer)
1060
+ The number of results per page (max 100). For more information, see "Using pagination in the REST API."
1061
+ Default: `30`
1062
+
1063
+ * **`page`** (integer)
1064
+ The page number of the results to fetch. For more information, see "Using pagination in the REST API."
1065
+ Default: `1`
1066
+
1067
+ ### HTTP response status codes
1068
+
1069
+ * **200** - OK
1070
+
1071
+ * **422** - Validation failed, or the endpoint has been spammed.
1072
+
1073
+ * **500** - Internal Error
1074
+
1075
+ * **503** - Service unavailable
1076
+
1077
+ ### Code examples
1078
+
1079
+ #### Example
1080
+
1081
+ **Request:**
1082
+
1083
+ ```curl
1084
+ curl -L \
1085
+ -X GET \
1086
+ https://api.github.com/repos/OWNER/REPO/pulls/PULL_NUMBER/files
1087
+ ```
1088
+
1089
+ **Response schema (Status: 200):**
1090
+
1091
+ Array of `Diff Entry`:
1092
+
1093
+ * `sha`: required, string or null
1094
+ * `filename`: required, string
1095
+ * `status`: required, string, enum: `added`, `removed`, `modified`, `renamed`, `copied`, `changed`, `unchanged`
1096
+ * `additions`: required, integer
1097
+ * `deletions`: required, integer
1098
+ * `changes`: required, integer
1099
+ * `blob_url`: required, string, format: uri
1100
+ * `raw_url`: required, string, format: uri
1101
+ * `contents_url`: required, string, format: uri
1102
+ * `patch`: string
1103
+ * `previous_filename`: string
1104
+
1105
+ ## Check if a pull request has been merged
1106
+
1107
+ ```
1108
+ GET /repos/{owner}/{repo}/pulls/{pull_number}/merge
1109
+ ```
1110
+
1111
+ 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.
1112
+
1113
+ ### Parameters
1114
+
1115
+ #### Headers
1116
+
1117
+ * **`accept`** (string)
1118
+ Setting to `application/vnd.github+json` is recommended.
1119
+
1120
+ #### Path and query parameters
1121
+
1122
+ * **`owner`** (string) (required)
1123
+ The account owner of the repository. The name is not case sensitive.
1124
+
1125
+ * **`repo`** (string) (required)
1126
+ The name of the repository without the .git extension. The name is not case sensitive.
1127
+
1128
+ * **`pull_number`** (integer) (required)
1129
+ The number that identifies the pull request.
1130
+
1131
+ ### HTTP response status codes
1132
+
1133
+ * **204** - Response if pull request has been merged
1134
+
1135
+ * **404** - Not Found if pull request has not been merged
1136
+
1137
+ ### Code examples
1138
+
1139
+ #### Example
1140
+
1141
+ **Request:**
1142
+
1143
+ ```curl
1144
+ curl -L \
1145
+ -X GET \
1146
+ https://api.github.com/repos/OWNER/REPO/pulls/PULL_NUMBER/merge
1147
+ ```
1148
+
1149
+ **Response schema (Status: 204):**
1150
+
1151
+ ## Merge a pull request
1152
+
1153
+ ```
1154
+ PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge
1155
+ ```
1156
+
1157
+ Note
1158
+
1159
+ We recommend using the asynchronous merge API instead. This endpoint does not support stacked pull requests or merging with a merge queue.
1160
+
1161
+ Merges a pull request into the base branch.
1162
+ This endpoint triggers notifications.
1163
+ Creating content too quickly using this endpoint may result in secondary rate limiting.
1164
+ For more information, see "Rate limits for the API" and "Best practices for using the REST API."
1165
+
1166
+ ### Parameters
1167
+
1168
+ #### Headers
1169
+
1170
+ * **`accept`** (string)
1171
+ Setting to `application/vnd.github+json` is recommended.
1172
+
1173
+ #### Path and query parameters
1174
+
1175
+ * **`owner`** (string) (required)
1176
+ The account owner of the repository. The name is not case sensitive.
1177
+
1178
+ * **`repo`** (string) (required)
1179
+ The name of the repository without the .git extension. The name is not case sensitive.
1180
+
1181
+ * **`pull_number`** (integer) (required)
1182
+ The number that identifies the pull request.
1183
+
1184
+ #### Body parameters
1185
+
1186
+ * **`commit_title`** (string)
1187
+ Title for the automatic commit message.
1188
+
1189
+ * **`commit_message`** (string)
1190
+ Extra detail to append to automatic commit message.
1191
+
1192
+ * **`sha`** (string)
1193
+ SHA that pull request head must match to allow merge.
1194
+
1195
+ * **`merge_method`** (string)
1196
+ The merge method to use.
1197
+ Can be one of: `merge`, `squash`, `rebase`
1198
+
1199
+ ### HTTP response status codes
1200
+
1201
+ * **200** - if merge was successful
1202
+
1203
+ * **403** - Forbidden
1204
+
1205
+ * **404** - Resource not found
1206
+
1207
+ * **405** - Method Not Allowed if merge cannot be performed
1208
+
1209
+ * **409** - Conflict if sha was provided and pull request head did not match
1210
+
1211
+ * **422** - Validation failed, or the endpoint has been spammed.
1212
+
1213
+ ### Code examples
1214
+
1215
+ #### Example
1216
+
1217
+ **Request:**
1218
+
1219
+ ```curl
1220
+ curl -L \
1221
+ -X PUT \
1222
+ https://api.github.com/repos/OWNER/REPO/pulls/PULL_NUMBER/merge \
1223
+ -d '{
1224
+ "commit_title": "Expand enum",
1225
+ "commit_message": "Add a new value to the merge_method enum"
1226
+ }'
1227
+ ```
1228
+
1229
+ **Response schema (Status: 200):**
1230
+
1231
+ * `sha`: required, string
1232
+ * `merged`: required, boolean
1233
+ * `message`: required, string
1234
+
1235
+ ## Merge a pull request asynchronously
1236
+
1237
+ ```
1238
+ PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge-async
1239
+ ```
1240
+
1241
+ Merges a pull request into the base branch in the background or adds it to a merge queue. Background processing allows certain types of errors to be retried and reduces the risk of timeouts for complex merges.
1242
+ This is the required API for merging stacked pull requests. For a stacked pull request, the operation includes all open downstack pull requests.
1243
+ A new asynchronous merge request returns a 202 response with a UUID that can be used to fetch the result of the merge. If another asynchronous merge request is already pending for this pull request, a 409 response returns that request's UUID and merge options instead.
1244
+ If the pull request is already merged or already in a merge queue, a 200 response is returned immediately. A merged result includes the merge commit OID. An enqueued result means the pull request was added to the merge queue, not that it has merged.
1245
+ If the pull request cannot be merged (e.g. because it is closed, or still a draft) this result will be returned immediately with a 400 response status. Branch protection rules and repository rules are not run at this stage, only basic pull request state checks are performed.
1246
+
1247
+ ### Parameters
1248
+
1249
+ #### Headers
1250
+
1251
+ * **`accept`** (string)
1252
+ Setting to `application/vnd.github+json` is recommended.
1253
+
1254
+ #### Path and query parameters
1255
+
1256
+ * **`owner`** (string) (required)
1257
+ The account owner of the repository. The name is not case sensitive.
1258
+
1259
+ * **`repo`** (string) (required)
1260
+ The name of the repository without the .git extension. The name is not case sensitive.
1261
+
1262
+ * **`pull_number`** (integer) (required)
1263
+ The number that identifies the pull request.
1264
+
1265
+ #### Body parameters
1266
+
1267
+ * **`commit_title`** (string)
1268
+ Title for the automatic commit message. Only supported for direct merges.
1269
+
1270
+ * **`commit_message`** (string)
1271
+ Extra detail to append to automatic commit message. Only supported for direct merges.
1272
+
1273
+ * **`sha`** (string)
1274
+ SHA that pull request head must match to allow merge. If not provided, the current head of the PR at the time of the request will be used; if the PR is pushed in between the merge being requested and being executed, the merge will be cancelled.
1275
+
1276
+ * **`merge_method`** (string)
1277
+ The merge method to use for a direct merge. Only supported for direct merges.
1278
+ Can be one of: `merge`, `squash`, `rebase`
1279
+
1280
+ * **`merge_action`** (string)
1281
+ The action that will be taken to merge the pull request. direct\_merge merges the pull request directly without using a merge queue; merge\_queue adds the pull request to a merge queue; default uses a merge queue if one is configured for the target branch, or merges directly otherwise. If omitted, defaults to default.
1282
+ Can be one of: `default`, `direct_merge`, `merge_queue`
1283
+
1284
+ * **`bypass_rules`** (boolean)
1285
+ Whether to bypass repository rules that the authenticated actor is permitted to bypass.
1286
+ Default: `false`
1287
+
1288
+ ### HTTP response status codes
1289
+
1290
+ * **200** - if the pull request was already merged, or is already in a merge queue
1291
+
1292
+ * **202** - if the merge request was accepted and will run in the background
1293
+
1294
+ * **400** - if the pull request is not ready to be merged, e.g. because it is closed
1295
+
1296
+ * **403** - Forbidden
1297
+
1298
+ * **404** - Resource not found
1299
+
1300
+ * **409** - if there is an existing merge request already enqueued for this pull request
1301
+
1302
+ * **422** - Validation failed, or the endpoint has been spammed.
1303
+
1304
+ ### Code examples
1305
+
1306
+ #### Direct merge example 1: Status Code 200
1307
+
1308
+ **Request:**
1309
+
1310
+ ```curl
1311
+ curl -L \
1312
+ -X PUT \
1313
+ https://api.github.com/repos/OWNER/REPO/pulls/PULL_NUMBER/merge-async \
1314
+ -d '{
1315
+ "commit_title": "Fix race condition",
1316
+ "commit_message": "Avoids a race by trying to read the file and handling the exception if it does not exist.",
1317
+ "sha": "6358cd125586d9def8c3e5943f23506202da81cc",
1318
+ "merge_method": "squash",
1319
+ "merge_action": "direct_merge"
1320
+ }'
1321
+ ```
1322
+
1323
+ **Response schema (Status: 200):**
1324
+
1325
+ * `status`: required, string, enum: `pending`, `merged`, `enqueued`, `failed`
1326
+ * `details`: required, any of:
1327
+ * **object**
1328
+ * `message`: required, string
1329
+ * `uuid`: required, string
1330
+ * `merge_method`: required, string, enum: `default`, `merge`, `squash`, `rebase`
1331
+ * `merge_action`: required, string, enum: `default`, `merge_queue`, `direct_merge`
1332
+ * `expected_head_sha`: required, string
1333
+ * `bypass_rules`: boolean, default: `false`
1334
+ * **object**
1335
+ * `message`: required, string
1336
+ * **object**
1337
+ * `message`: required, string
1338
+ * **object**
1339
+ * `message`: required, string
1340
+ * `sha`: required, string
1341
+
1342
+ #### Merge queue example 2: Status Code 200
1343
+
1344
+ **Request:**
1345
+
1346
+ ```curl
1347
+ curl -L \
1348
+ -X PUT \
1349
+ https://api.github.com/repos/OWNER/REPO/pulls/PULL_NUMBER/merge-async \
1350
+ -d '{
1351
+ "sha": "6358cd125586d9def8c3e5943f23506202da81cc",
1352
+ "merge_action": "merge_queue"
1353
+ }'
1354
+ ```
1355
+
1356
+ **Response schema (Status: 200):**
1357
+
1358
+ * `status`: required, string, enum: `pending`, `merged`, `enqueued`, `failed`
1359
+ * `details`: required, any of:
1360
+ * **object**
1361
+ * `message`: required, string
1362
+ * `uuid`: required, string
1363
+ * `merge_method`: required, string, enum: `default`, `merge`, `squash`, `rebase`
1364
+ * `merge_action`: required, string, enum: `default`, `merge_queue`, `direct_merge`
1365
+ * `expected_head_sha`: required, string
1366
+ * `bypass_rules`: boolean, default: `false`
1367
+ * **object**
1368
+ * `message`: required, string
1369
+ * **object**
1370
+ * `message`: required, string
1371
+ * **object**
1372
+ * `message`: required, string
1373
+ * `sha`: required, string
1374
+
1375
+ #### Direct merge example 3: Status Code 202
1376
+
1377
+ **Request:**
1378
+
1379
+ ```curl
1380
+ curl -L \
1381
+ -X PUT \
1382
+ https://api.github.com/repos/OWNER/REPO/pulls/PULL_NUMBER/merge-async \
1383
+ -d '{
1384
+ "commit_title": "Fix race condition",
1385
+ "commit_message": "Avoids a race by trying to read the file and handling the exception if it does not exist.",
1386
+ "sha": "6358cd125586d9def8c3e5943f23506202da81cc",
1387
+ "merge_method": "squash",
1388
+ "merge_action": "direct_merge"
1389
+ }'
1390
+ ```
1391
+
1392
+ **Response schema (Status: 202):**
1393
+
1394
+ * `status`: required, string, enum: `pending`, `merged`, `enqueued`, `failed`
1395
+ * `details`: required, any of:
1396
+ * **object**
1397
+ * `message`: required, string
1398
+ * `uuid`: required, string
1399
+ * `merge_method`: required, string, enum: `default`, `merge`, `squash`, `rebase`
1400
+ * `merge_action`: required, string, enum: `default`, `merge_queue`, `direct_merge`
1401
+ * `expected_head_sha`: required, string
1402
+ * `bypass_rules`: boolean, default: `false`
1403
+ * **object**
1404
+ * `message`: required, string
1405
+ * **object**
1406
+ * `message`: required, string
1407
+ * **object**
1408
+ * `message`: required, string
1409
+ * `sha`: required, string
1410
+
1411
+ #### Merge queue example 4: Status Code 202
1412
+
1413
+ **Request:**
1414
+
1415
+ ```curl
1416
+ curl -L \
1417
+ -X PUT \
1418
+ https://api.github.com/repos/OWNER/REPO/pulls/PULL_NUMBER/merge-async \
1419
+ -d '{
1420
+ "sha": "6358cd125586d9def8c3e5943f23506202da81cc",
1421
+ "merge_action": "merge_queue"
1422
+ }'
1423
+ ```
1424
+
1425
+ **Response schema (Status: 202):**
1426
+
1427
+ * `status`: required, string, enum: `pending`, `merged`, `enqueued`, `failed`
1428
+ * `details`: required, any of:
1429
+ * **object**
1430
+ * `message`: required, string
1431
+ * `uuid`: required, string
1432
+ * `merge_method`: required, string, enum: `default`, `merge`, `squash`, `rebase`
1433
+ * `merge_action`: required, string, enum: `default`, `merge_queue`, `direct_merge`
1434
+ * `expected_head_sha`: required, string
1435
+ * `bypass_rules`: boolean, default: `false`
1436
+ * **object**
1437
+ * `message`: required, string
1438
+ * **object**
1439
+ * `message`: required, string
1440
+ * **object**
1441
+ * `message`: required, string
1442
+ * `sha`: required, string
1443
+
1444
+ ## Get the result of an asynchronous merge
1445
+
1446
+ ```
1447
+ GET /repos/{owner}/{repo}/pulls/{pull_number}/merge-async/{uuid}
1448
+ ```
1449
+
1450
+ Fetches the current result of an asynchronous merge request, identified by the UUID that was returned when the merge was requested.
1451
+ While the request's status is pending, the response includes the UUID, merge method, merge action, and expected head SHA of the request. Once the asynchronous request completes, its status is one of:
1452
+
1453
+ merged: The pull request was merged into the base branch. The response includes the merge commit OID.
1454
+ enqueued: The pull request was added to a merge queue.
1455
+ failed: The request failed. The response includes a message describing the failure.
1456
+
1457
+ An enqueued result is final for the merge queue requests and does not mean the pull request has merged. This result does not change when the merge queue later merges the pull request. To get the eventual merge status, check if a pull request has been merged.
1458
+ The result of an asynchronous merge request is retained for 24 hours after its most recent update. After this window the request expires and this endpoint returns a 404 response for its UUID.
1459
+
1460
+ ### Parameters
1461
+
1462
+ #### Headers
1463
+
1464
+ * **`accept`** (string)
1465
+ Setting to `application/vnd.github+json` is recommended.
1466
+
1467
+ #### Path and query parameters
1468
+
1469
+ * **`owner`** (string) (required)
1470
+ The account owner of the repository. The name is not case sensitive.
1471
+
1472
+ * **`repo`** (string) (required)
1473
+ The name of the repository without the .git extension. The name is not case sensitive.
1474
+
1475
+ * **`pull_number`** (integer) (required)
1476
+ The number that identifies the pull request.
1477
+
1478
+ * **`uuid`** (string) (required)
1479
+ The UUID of the asynchronous merge request, as returned when the merge was requested.
1480
+
1481
+ ### HTTP response status codes
1482
+
1483
+ * **200** - the current result of the asynchronous merge request
1484
+
1485
+ * **403** - Forbidden
1486
+
1487
+ * **404** - Resource not found
1488
+
1489
+ ### Code examples
1490
+
1491
+ #### Example 1: Status Code 200
1492
+
1493
+ **Request:**
1494
+
1495
+ ```curl
1496
+ curl -L \
1497
+ -X GET \
1498
+ https://api.github.com/repos/OWNER/REPO/pulls/PULL_NUMBER/merge-async/UUID
1499
+ ```
1500
+
1501
+ **Response schema (Status: 200):**
1502
+
1503
+ Same response schema as [Merge a pull request asynchronously](#merge-a-pull-request-asynchronously).
1504
+
1505
+ #### Example 2: Status Code 200
1506
+
1507
+ **Request:**
1508
+
1509
+ ```curl
1510
+ curl -L \
1511
+ -X GET \
1512
+ https://api.github.com/repos/OWNER/REPO/pulls/PULL_NUMBER/merge-async/UUID
1513
+ ```
1514
+
1515
+ **Response schema (Status: 200):**
1516
+
1517
+ Same response schema as [Merge a pull request asynchronously](#merge-a-pull-request-asynchronously).
1518
+
1519
+ #### Example 3: Status Code 200
1520
+
1521
+ **Request:**
1522
+
1523
+ ```curl
1524
+ curl -L \
1525
+ -X GET \
1526
+ https://api.github.com/repos/OWNER/REPO/pulls/PULL_NUMBER/merge-async/UUID
1527
+ ```
1528
+
1529
+ **Response schema (Status: 200):**
1530
+
1531
+ Same response schema as [Merge a pull request asynchronously](#merge-a-pull-request-asynchronously).
1532
+
1533
+ #### Example 4: Status Code 200
1534
+
1535
+ **Request:**
1536
+
1537
+ ```curl
1538
+ curl -L \
1539
+ -X GET \
1540
+ https://api.github.com/repos/OWNER/REPO/pulls/PULL_NUMBER/merge-async/UUID
1541
+ ```
1542
+
1543
+ **Response schema (Status: 200):**
1544
+
1545
+ Same response schema as [Merge a pull request asynchronously](#merge-a-pull-request-asynchronously).
1546
+
1547
+ ## Update a pull request branch
1548
+
1549
+ ```
1550
+ PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch
1551
+ ```
1552
+
1553
+ Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.
1554
+ Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository.
1555
+
1556
+ ### Parameters
1557
+
1558
+ #### Headers
1559
+
1560
+ * **`accept`** (string)
1561
+ Setting to `application/vnd.github+json` is recommended.
1562
+
1563
+ #### Path and query parameters
1564
+
1565
+ * **`owner`** (string) (required)
1566
+ The account owner of the repository. The name is not case sensitive.
1567
+
1568
+ * **`repo`** (string) (required)
1569
+ The name of the repository without the .git extension. The name is not case sensitive.
1570
+
1571
+ * **`pull_number`** (integer) (required)
1572
+ The number that identifies the pull request.
1573
+
1574
+ #### Body parameters
1575
+
1576
+ * **`expected_head_sha`** (string)
1577
+ The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the "List commits" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.
1578
+
1579
+ ### HTTP response status codes
1580
+
1581
+ * **202** - Accepted
1582
+
1583
+ * **403** - Forbidden
1584
+
1585
+ * **422** - Validation failed, or the endpoint has been spammed.
1586
+
1587
+ ### Code examples
1588
+
1589
+ #### Example
1590
+
1591
+ **Request:**
1592
+
1593
+ ```curl
1594
+ curl -L \
1595
+ -X PUT \
1596
+ https://api.github.com/repos/OWNER/REPO/pulls/PULL_NUMBER/update-branch \
1597
+ -d '{
1598
+ "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
1599
+ }'
1600
+ ```
1601
+
1602
+ **Response schema (Status: 202):**
1603
+
1604
+ * `message`: string
1605
+ * `url`: string