API Reference gh_ex v#0.3.2

A Req-based client for the GitHub REST and GraphQL APIs.

Convenience functions for the GitHub Actions REST API (workflows and runs).

GitHub App authentication.

Credential handling.

Convenience functions for the GitHub Checks REST API.

The client struct: credentials, endpoints, and per-request Req options.

Convenience functions for the GitHub repository Contents REST API (reading and writing files).

A normalized API error.

Convenience functions for the GitHub Gists REST API.

Generic GraphQL access. This is the whole GraphQL API: any query or mutation, including the corners REST cannot reach, such as Projects v2 and Discussions.

Metadata accompanying a successful GraphQL response.

Convenience functions for the GitHub Issues REST API.

Mints the short-lived JWT a GitHub App presents to authenticate as itself.

Convenience functions for the GitHub Organizations REST API.

REST pagination via the Link header.

Convenience functions for the GitHub Pull Requests REST API.

Generic REST access. Any GitHub REST path is reachable through get/3, post/3, patch/3, put/3, and delete/3.

Metadata accompanying a successful REST response.

Rate-limit headers and an opt-in retry for GitHub's rate limits.

Convenience functions for the GitHub Releases REST API.

Convenience functions for the GitHub Repositories REST API.

Builds the Req request shared by every API call.

Convenience functions for the GitHub Search REST API.

Convenience functions for the GitHub commit statuses REST API.

Convenience functions for the GitHub Teams REST API.

Behaviour for caching minted installation access tokens.

Default GhEx.TokenCache: an ETS table owned by a GenServer.

An opaque, redacting cached installation access token and its expiry.

Convenience functions for the GitHub Users REST API.

Helpers for receiving GitHub webhooks: verify the delivery signature and decode the payload.