github-v3-rest-api_skill

Overview

This skill provides reference documentation and operation-level details for GitHub's v3 REST API. It maps resources, operations, and schemas so you can discover endpoints, request/response shapes, and usage patterns quickly. Use it to look up endpoints, required parameters, and schema definitions when integrating with GitHub programmatically.

How this skill works

The skill organizes the API docs into resource indexes, individual operation files, and schema groups. Start by locating a resource index, open the operation file for endpoint signatures and examples, and consult schema files for payload structure and field types. The documentation uses the base URL https://api.github.com and enumerates available resources and their operation counts.

When to use it

• Building or debugging integrations that call GitHub v3 REST endpoints
• Looking up exact request parameters, headers, or response fields
• Exploring available repository, issue, pull request, and Actions endpoints
• Checking rate limit endpoints and API metadata
• Finding schema definitions for request and response payloads

Best practices

• Locate the resource index first to narrow available operations before opening detailed operation files
• Always confirm required authentication and scopes for an endpoint before calling it
• Refer to schema files for exact field names, types, and nested objects to avoid malformed payloads
• Check the rate-limit resource before bulk operations to avoid throttling
• Prefer documented endpoints over undocumented behavior; use ETags and conditional requests where supported

Example use cases

• Create, update, or list repositories and repository settings using the repos resource
• Automate Actions workflows, runs, and artifacts via the actions endpoints
• Manage organization teams, members, and permissions through orgs and teams resources
• List and manage issues and pull requests using issues and pulls endpoints
• Query code scanning, secret scanning, and dependency alerts via specialized security resources