Guides
Audience: Developers integrating with the GitHub Issues REST API (portfolio subset)
Scope: Task-based documentation that complements the rendered OpenAPI reference docs. These guides are designed to be readable on GitHub and easy to link from a docs site.
Start here
- Quickstart Open guide
- Pagination And Filters Open guide
- Errors And Troubleshooting Open guide
- Support Checklist Open guide
- Glossary Open guide
Release notes and migration
What these guides add (beyond the OpenAPI spec)
- Fast onboarding path (quickstart)
- Evidence-backed notes on defaults, caps, and invalid inputs
- Troubleshooting patterns with saved examples
- A reproducible support/reporting checklist
Known limitations (by design)
- This is not a full GitHub REST API specification. It covers only endpoints and behaviors verified in the included test suite and evidence artifacts.
- Evidence reflects observations during 2025-12-10 to 2026-01-06 (ET); GitHub behavior may change over time.
- Authentication is documented at a practical level (Bearer token), but token scope and org policy outcomes are environment-specific.
- Rate limiting is referenced via headers, but rate-limit behavior is not exhaustively tested in this portfolio scope.
Related links
- Guide index
- Glossary
- OpenAPI spec
- Test suite
- Evidence package
- Evidence matrix
- Traceability map
- Evidence manifest
Generated from
guides/ into docs\guides/.