module Octokit
Overview
Crystal toolkit for the GitHub API.
Note: All examples contained herein assume that @client
is an instantiated
Octokit::Client
with a valid user configured.
Defined in:
octokit.croctokit/authentication.cr
octokit/client.cr
octokit/client/authorizations.cr
octokit/client/issues.cr
octokit/client/markdown.cr
octokit/client/organizations.cr
octokit/client/pub_sub_hubbub.cr
octokit/client/rate_limit.cr
octokit/client/releases.cr
octokit/client/repositories.cr
octokit/client/say.cr
octokit/client/search.cr
octokit/client/statuses.cr
octokit/client/users.cr
octokit/configurable.cr
octokit/connection.cr
octokit/default.cr
octokit/error.cr
octokit/helpers.cr
octokit/models/activity.cr
octokit/models/activity_notifications.cr
octokit/models/activity_star.cr
octokit/models/activity_watching.cr
octokit/models/admin.cr
octokit/models/admin_stats.cr
octokit/models/apps.cr
octokit/models/apps_marketplace.cr
octokit/models/authorizations.cr
octokit/models/checks.cr
octokit/models/commits.cr
octokit/models/event.cr
octokit/models/event_types.cr
octokit/models/gists.cr
octokit/models/git_blobs.cr
octokit/models/git_refs.cr
octokit/models/git_tags.cr
octokit/models/git_trees.cr
octokit/models/github.cr
octokit/models/gitignore.cr
octokit/models/interactions.cr
octokit/models/issue_comments.cr
octokit/models/issue_events.cr
octokit/models/issue_labels.cr
octokit/models/issue_milestones.cr
octokit/models/issue_timeline.cr
octokit/models/issues.cr
octokit/models/licenses.cr
octokit/models/migration_source_import.cr
octokit/models/migration_user.cr
octokit/models/migrations.cr
octokit/models/misc.cr
octokit/models/oauth.cr
octokit/models/org_members.cr
octokit/models/org_outside_collaborators.cr
octokit/models/orgs.cr
octokit/models/projects.cr
octokit/models/pull_comments.cr
octokit/models/pull_reviewers.cr
octokit/models/pull_reviews.cr
octokit/models/pulls.cr
octokit/models/reactions.cr
octokit/models/repo_branches.cr
octokit/models/repo_collaborators.cr
octokit/models/repo_comments.cr
octokit/models/repo_commits.cr
octokit/models/repo_community_health.cr
octokit/models/repo_contents.cr
octokit/models/repo_deployments.cr
octokit/models/repo_forks.cr
octokit/models/repo_hooks.cr
octokit/models/repo_invitations.cr
octokit/models/repo_merging.cr
octokit/models/repo_pages.cr
octokit/models/repo_prereceive_hooks.cr
octokit/models/repo_projects.cr
octokit/models/repo_releases.cr
octokit/models/repo_stats.cr
octokit/models/repo_statuses.cr
octokit/models/repo_traffic.cr
octokit/models/repos.cr
octokit/models/search.cr
octokit/models/team_discussion_comments.cr
octokit/models/team_discussions.cr
octokit/models/team_members.cr
octokit/models/teams.cr
octokit/models/user_administration.cr
octokit/models/user_emails.cr
octokit/models/user_gpg_keys.cr
octokit/models/user_keys.cr
octokit/models/users.cr
octokit/preview.cr
octokit/rate_limit.cr
octokit/response/raise_error.cr
octokit/version.cr
octokit/warnable.cr
Constant Summary
-
VERSION =
"0.1.0"
Class Method Summary
-
.client(login = nil, password = nil, *, access_token = nil, bearer_token = nil, client_id = nil, client_secret = nil)
API client based on configuration options in
Configurable
-
.enterprise_admin_client
EnterpriseAdminClient client based on configuration options in
Configurable
-
.enterprise_management_console_client
EnterpriseManagementConsoleClient client based on configuration options in
Configurable
Macro Summary
-
initializer_for(properties)
writes basic initializer from properti maps used by JSON.mapping if a
mustbe
field is present for the value, the initializer will set the instance variable to the given value - initializer_for(**properties)
- rest_model(fields)
- rest_model(**fields)
Class Method Detail
API client based on configuration options in Configurable
EnterpriseAdminClient client based on configuration options in Configurable
EnterpriseManagementConsoleClient client based on configuration options in Configurable
Macro Detail
writes basic initializer from properti maps used by JSON.mapping
if a mustbe
field is present for the value, the initializer will set the
instance variable to the given value