Octokit (internals)¶
This part of the documentation covers all the octokit APIs.
RestRequest API¶
RestRequest is for all the Octokit APIs that require a REST interface with GitHub.
- class ghastoolkit.RestRequest(repository: Repository | None = None, retries: Retry | None = None)¶
- get(path: str, parameters: dict = {}, expected: int | None = 200, authenticated: bool = False, display_errors: bool = True, error_handler: Callable[[int, dict], Any] | None = None) dict | list[dict]¶
Get Request.
Limits requests based on token
- static restGet(url: str, authenticated: bool = False)¶
Get Request Wrapper.
GraphQLRequest API¶
GraphQLRequest is for all the Octokit APIs that require a GraphQL interface with GitHub.
- class ghastoolkit.GraphQLRequest(repository: Repository | None = None)¶
- query(name: str, options: dict[str, Any] = {}) dict¶
Run a GraphQL query.
https://docs.github.com/en/enterprise-cloud@latest/graphql/overview/about-the-graphql-api https://docs.github.com/en/enterprise-cloud@latest/graphql/overview/rate-limits-and-node-limits-for-the-graphql-api#primary-rate-limit
