GhEx.Search (gh_ex v0.3.1)

Copy Markdown View Source

Convenience functions for the GitHub Search REST API.

Each function takes the search query (the q parameter) and returns the same {:ok, body, meta} / {:error, reason} shape as GhEx.REST. Pass params: [sort: ..., order: ..., per_page: ...] for the other search options; q is merged in.

Summary

Functions

code(client, query, opts \\ [])

@spec code(GhEx.Client.t(), String.t(), keyword()) :: GhEx.REST.result()

Searches code.

commits(client, query, opts \\ [])

@spec commits(GhEx.Client.t(), String.t(), keyword()) :: GhEx.REST.result()

Searches commits.

issues_and_pull_requests(client, query, opts \\ [])

@spec issues_and_pull_requests(GhEx.Client.t(), String.t(), keyword()) ::
  GhEx.REST.result()

Searches issues and pull requests.

repositories(client, query, opts \\ [])

@spec repositories(GhEx.Client.t(), String.t(), keyword()) :: GhEx.REST.result()

Searches repositories.

users(client, query, opts \\ [])

@spec users(GhEx.Client.t(), String.t(), keyword()) :: GhEx.REST.result()

Searches users.