Resources Enums Models Clients

Github 0.3.60

History | Watch

See https://developer.github.com/v3/

Resources

blob

Operations

Method and Path Description
GET /repos/:owner/:repo/git/blobs/:sha
POST /repos/:owner/:repo/git/blobs

commit

Operations

Method and Path Description
GET /repos/:owner/:repo/git/commits/:sha
POST /repos/:owner/:repo/git/commits

contents

Operations

Method and Path Description
GET /repos/:owner/:repo/readme
GET /repos/:owner/:repo/contents/:path

hook

Operations

Method and Path Description
GET /repos/:owner/:repo/hooks
GET /repos/:owner/:repo/hooks/:id
POST /repos/:owner/:repo/hooks
DELETE /repos/:owner/:repo/hooks/:id

pull_request

Operations

Method and Path Description
POST /repos/:owner/:repo/pulls
GET /repos/:owner/:repo/pulls

ref

Operations

Method and Path Description
GET /repos/:owner/:repo/git/refs
GET /repos/:owner/:repo/git/refs/:ref
POST /repos/:owner/:repo/git/refs
PUT /repos/:owner/:repo/git/refs/:ref

repository

Operations

Method and Path Description
GET /user/repos
GET /users/:username/repos

List public repositories for the specified user.
GET /orgs/:org/repos

List repositories for the specified org.

tag

Operations

Method and Path Description
GET /repos/:owner/:repo/tags
GET /repos/:owner/:repo/tags/:sha
POST /repos/:owner/:repo/git/tags

tree

Operations

Method and Path Description
POST /repos/:owner/:repo/git/trees

user

Operations

Method and Path Description
GET /user
GET /user/orgs

user_email

Operations

Method and Path Description
GET /user/emails

Headers

No headers

Imports

No imports

Enums

contents_type

Name Value Description
file file
dir dir
symlink symlink
submodule submodule

encoding

Name Value Description
base64 base64
utf-8 utf-8

hook_event

Name Value Description
push push
pull_request pull_request

node_type

Name Value Description
blob blob
tree tree
commit commit

owner_type

Name Value Description
User User

visibility

Name Value Description
all all
public public
private private

Interfaces

No interfaces

Models

blob

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
content string Yes -

encoding encoding Yes -

url string Yes -

sha string Yes -

size long Yes -

blob_created

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
url string Yes -

sha string Yes -

blob_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
content string Yes -

encoding encoding Yes utf-8

commit

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
sha string Yes -

Example: c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc
url string Yes -

Example: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc
html_url string Yes -

author person Yes -

committer person Yes -

tree tree_summary Yes -

message string Yes -

parents [commit_summary] Yes -

commit_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
message string Yes -

tree string Yes -

parents [string] Yes -

author person Yes -

committer person Yes -

commit_response

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
sha string Yes -

url string Yes -

author person Yes -

committer person Yes -

message string Yes -

tree tree_summary Yes -

parents [tree_summary] Yes -

commit_summary

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
sha string Yes -

Example: c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc
url string Yes -

Example: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc

contents

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
type contents_type Yes -

encoding encoding Yes -

size long Yes -

name string Yes -

path string Yes -

content string No -

If file, then present
sha string Yes -

url string Yes -

git_url string Yes -

html_url string Yes -

download_url string Yes -

create_tree_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
base_tree string Yes -

tree [tree_form] Yes -

create_tree_response

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
sha string Yes -

url string Yes -

tree_result tree Yes -

error

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
resource string Yes -

Example: Issue
field string Yes -

Example: title
code string Yes -

Example: missing_field

github_object

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
type string Yes -

Example: commit
sha string Yes -

url string Yes -

hook

Example Json: Minimal | Full

Interfaces: None

See https://developer.github.com/v3/repos/hooks/#create-a-hook

Field Type Required? Default Description
id long Yes -

url string Yes -

test_url string Yes -

ping_url string Yes -

name string Yes -

events [hook_event] Yes -

active boolean Yes -

config hook_config Yes -

updated_at date-time-iso8601 Yes -

created_at date-time-iso8601 Yes -

hook_config

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
url string No -

content_type string No -

Example: json or form

hook_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
name string Yes -

Example: web
config hook_config Yes -

events [hook_event] Yes -

active boolean Yes -

node

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
path string Yes -

mode string Yes -

100644 file (blob), 100755 executable (blob), 040000 subdirectory (tree), 160000 submodule (commit)
type node_type Yes -

size long Yes -

sha string Yes -

url string Yes -

node_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
path string Yes -

mode string Yes -

100644 file (blob), 100755 executable (blob), 040000 subdirectory (tree), 160000 submodule (commit)
type node_type Yes -

sha string Yes -

person

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
name string Yes -

email string Yes -

date date-time-iso8601 Yes -

pull_request

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
id long Yes -

url string Yes -

number long Yes -

html_url string Yes -

head pull_request_head Yes -

pull_request_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
title string Yes -

head string Yes -

base string Yes -

body string No -

pull_request_head

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
ref string Yes -

ref

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
ref string Yes -

Example: refs/heads/featureA or refs/heads/main
url string Yes -

object github_object Yes -

ref_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
ref string Yes -

Example: refs/heads/featureA or refs/heads/main
sha string Yes -

Example: 940bd336248efae0f9ee5bc7b2d5c985887b16ac

ref_update_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
sha string Yes -

Example: 940bd336248efae0f9ee5bc7b2d5c985887b16ac

repository

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
id long Yes -

owner user Yes -

name string Yes -

full_name string Yes -

private boolean Yes -

description string No -

url string Yes -

html_url string Yes -

default_branch string Yes -

tag

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
tag string Yes -

Example: v0.0.1
sha string Yes -

Example: 940bd336248efae0f9ee5bc7b2d5c985887b16ac
url string Yes -

Example: https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac
message string Yes -

Example: initial version
tagger tagger Yes -

object github_object Yes -

tag_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
tag string Yes -

Example: v0.0.1
message string Yes -

object string Yes -

The SHA of the git object this is tagging

Example: 940bd336248efae0f9ee5bc7b2d5c985887b16ac
type string Yes commit

tagger tagger Yes -

tag_summary

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
name string Yes -

Example: v0.1
commit commit_summary Yes -

tagger

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
name string Yes -

email string Yes -

date date-time-iso8601 Yes -

tree

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
sha string Yes -

url string Yes -

truncated boolean Yes -

tree [node] Yes -

tree_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
path string Yes -

mode string Yes -

100644 file (blob), 100755 executable (blob), 040000 subdirectory (tree), 160000 submodule (commit)
type node_type Yes -

sha string No -

content string No -

tree_result

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
path string Yes -

mode string Yes -

100644 file (blob), 100755 executable (blob), 040000 subdirectory (tree), 160000 submodule (commit)
type node_type Yes -

size long Yes -

sha string Yes -

url string Yes -

tree_summary

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
url string Yes -

sha string Yes -

unprocessable_entity

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
message string Yes -

Example: Validation Failed
errors [error] No -

user

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
id long Yes -

login string Yes -

name string No -

email string No -

avatar_url string No -

gravatar_id string No -

url string Yes -

html_url string Yes -

type owner_type Yes -

user_email

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
email string Yes -

verified boolean Yes -

primary boolean Yes -

user_org

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
login string Yes -

Unions

No unions

Annotations

No annotations