Github 0.0.2

Resources

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

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.

user

Operations

Method and Path Description
GET /user

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

hook_event

Name Value Description
push push

pull_request pull_request

owner_type

Name Value Description
User User

visibility

Name Value Description
all all

public public

private private

Models

contents

Example Json: Minimal | Full
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 -

hook

Example Json: Minimal | Full

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
Field Type Required? Default Description
url string No -

content_type string No -

Example: json or form

repository

Example Json: Minimal | Full
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 -

user

Example Json: Minimal | Full
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
Field Type Required? Default Description
email string Yes -

verified boolean Yes -

primary boolean Yes -

Unions

No unions

Annotations

No annotations