Files
PyGithub/codegen/JsonDescriptionOfGithubApiV3/description.human_readable.json
T

1852 lines
76 KiB
JSON

{
"classes": [
{
"name": "Plan",
"attributes": [
{ "name": "collaborators", "type": "integer" },
{ "name": "private_repos", "type": "integer" },
{ "name": "name", "type": "string" },
{ "name": "space", "type": "integer" }
]
},
{
"name": "AuthenticatedUser",
"url": [
{ "type": "constant", "value": "https://api.github.com/user" }
],
"edit": {
"optionalParameters": [
{ "name": "name", "type": "string" },
{ "name": "email", "type": "string" },
{ "name": "blog", "type": "string" },
{ "name": "company", "type": "string" },
{ "name": "location", "type": "string" },
{ "name": "hireable", "type": "bool" },
{ "name": "bio", "type": "string" }
]
},
"attributes": [
{ "name": "avatar_url", "type": "string" },
{ "name": "bio", "type": "string" },
{ "name": "blog", "type": "string" },
{ "name": "collaborators", "type": "integer" },
{ "name": "company", "type": "string" },
{ "name": "created_at", "type": "string" },
{ "name": "disk_usage", "type": "integer" },
{ "name": "email", "type": "string" },
{ "name": "followers", "type": "integer" },
{ "name": "following", "type": "integer" },
{ "name": "gravatar_id", "type": "string" },
{ "name": "hireable", "type": "bool" },
{ "name": "html_url", "type": "string" },
{ "name": "id", "type": "integer" },
{ "name": "location", "type": "string" },
{ "name": "login", "type": "string" },
{ "name": "name", "type": "string" },
{ "name": "owned_private_repos", "type": "integer" },
{ "name": "plan", "type": "Plan" },
{ "name": "private_gists", "type": "integer" },
{ "name": "public_gists", "type": "integer" },
{ "name": "public_repos", "type": "integer" },
{ "name": "total_private_repos", "type": "integer" },
{ "name": "type", "type": "string" },
{ "name": "url", "type": "string" }
],
"collections": [
{
"name": "authorizations",
"singularName": "authorization",
"type": "Authorization",
"url": [
{ "type": "constant", "value": "https://api.github.com/authorizations" }
],
"createElement": {
"optionalParameters": [
{ "name": "scopes", "type": "list:string" },
{ "name": "note", "type": "string" },
{ "name": "note_url", "type": "string" }
]
},
"getElement": {
"parameter": { "name": "id", "type": "integer" }
},
"getList": true
},
{
"name": "events",
"singularName": "event",
"type": "Event",
"getList": true,
"url": [ { "type": "constant", "value": "https://api.github.com/events" } ]
},
{
"name": "issues",
"singularName": "issue",
"type": "Issue",
"getList": true,
"url": [ { "type": "constant", "value": "https://api.github.com/issues" } ]
},
{
"name": "keys",
"singularName": "key",
"type": "UserKey",
"url": [ { "type": "constant", "value": "https://api.github.com/user/keys" } ],
"getList": true,
"getElement": {
"parameter": { "name": "id", "type": "integer" }
},
"createElement": {
"mandatoryParameters": [
{ "name": "title", "type": "string" },
{ "name": "key", "type": "string" }
]
}
},
{
"name": "repos",
"singularName": "repo",
"type": "Repository",
"getList": {
"optionalParameters": [
{ "name": "type", "type": "string" },
{ "name": "sort", "type": "string" },
{ "name": "direction", "type": "string" }
]
},
"getElement": {
"parameter": { "name": "name", "type": "string" },
"url": [
{ "type": "constant", "value": "https://api.github.com/repos/" },
{ "type": "attribute", "value": [ "login" ] },
{ "type": "constant", "value": "/" },
{ "type": "argument", "value": [ "name" ] }
]
},
"createElement": {
"mandatoryParameters": [
{ "name": "name", "type": "string" }
],
"optionalParameters": [
{ "name": "description", "type": "string" },
{ "name": "homepage", "type": "string" },
{ "name": "private", "type": "bool" },
{ "name": "has_issues", "type": "bool" },
{ "name": "has_wiki", "type": "bool" },
{ "name": "has_downloads", "type": "bool" }
]
}
},
{
"name": "emails",
"singularName": "email",
"type": "string",
"getList": true,
"addSeveralElements": true,
"removeSeveralElements": true
},
{
"name": "watched",
"singularName": "watched",
"type": "Repository",
"getList": true,
"hasElement": true,
"addElement": true,
"removeElement": true
},
{
"name": "following",
"singularName": "following",
"type": "NamedUser",
"getList": true,
"removeElement": true,
"hasElement": true,
"addElement": true
},
{
"name": "followers",
"singularName": "follower",
"type": "NamedUser",
"getList": true
},
{
"name": "orgs",
"singularName": "org",
"type": "Organization",
"getList": true
},
{
"name": "gists",
"singularName": "gist",
"type": "Gist",
"getList": true,
"createElement": {
"mandatoryParameters": [
{ "name": "public", "type": "bool" },
{ "name": "files", "type": "dict:string-InputFileContent" }
],
"optionalParameters": [
{ "name": "description", "type": "string" }
]
},
"url": [
{ "type": "constant", "value": "https://api.github.com/gists" }
]
}
],
"additionalMethods": [
{
"name": [ "create", "fork" ],
"group": "forking",
"type": "Repository",
"mandatoryParameters": [
{ "name": "repo", "type": "Repository" }
],
"request": {
"verb": "POST",
"url": [
{ "type": "constant", "value": "https://api.github.com/repos/" },
{ "type": "argument", "value": [ "repo", "owner", "login" ] },
{ "type": "constant", "value": "/" },
{ "type": "argument", "value": [ "repo", "name" ] },
{ "type": "constant", "value": "/forks" }
],
"information": "status"
}
},
{
"name": [ "get", "organization", "events" ],
"group": "events",
"type": "list:Event",
"mandatoryParameters": [
{ "name": "org", "type": "Organization" }
],
"request": {
"verb": "GET",
"url": [
{ "type": "constant", "value": "https://api.github.com/users/" },
{ "type": "attribute", "value": [ "login" ] },
{ "type": "constant", "value": "/events/orgs/" },
{ "type": "argument", "value": [ "org", "login" ] }
],
"information": "status"
}
},
{
"name": [ "get", "starred", "gists" ],
"group": "gists",
"type": "list:Gist",
"request": {
"verb": "GET",
"url": [
{ "type": "constant", "value": "https://api.github.com/gists/starred" }
],
"information": "status"
}
}
]
},
{
"name": "AuthorizationApplication",
"attributes": [
{ "name": "url", "type": "string" },
{ "name": "name", "type": "string" }
]
},
{
"name": "Authorization",
"edit": {
"optionalParameters": [
{ "name": "scopes", "type": "list:string" },
{ "name": "add_scopes", "type": "list:string" },
{ "name": "remove_scopes", "type": "list:string" },
{ "name": "note", "type": "string" },
{ "name": "note_url", "type": "string" }
]
},
"delete": true,
"attributes": [
{ "name": "app", "type": "AuthorizationApplication" },
{ "name": "created_at", "type": "string" },
{ "name": "id", "type": "integer" },
{ "name": "note_url", "type": "string" },
{ "name": "note", "type": "string" },
{ "name": "scopes", "type": "list:string" },
{ "name": "token", "type": "string" },
{ "name": "updated_at", "type": "string" },
{ "name": "url", "type": "string" }
]
},
{
"name": "Branch",
"attributes": [
{ "name": "name", "type": "string" },
{ "name": "commit", "type": "Commit" }
]
},
{
"name": "CommitStats",
"attributes": [
{ "name": "deletions", "type": "integer" },
{ "name": "additions", "type": "integer" },
{ "name": "total", "type": "integer" }
]
},
{
"name": "File",
"attributes": [
{ "name": "additions", "type": "integer" },
{ "name": "blob_url", "type": "string" },
{ "name": "changes", "type": "integer" },
{ "name": "deletions", "type": "integer" },
{ "name": "filename", "type": "string" },
{ "name": "patch", "type": "string" },
{ "name": "raw_url", "type": "string" },
{ "name": "sha", "type": "string" },
{ "name": "status", "type": "string" }
]
},
{
"name": "Commit",
"attributes": [
{ "name": "files", "type": "list:File" },
{ "name": "parents", "type": "list:Commit" },
{ "name": "sha", "type": "string" },
{ "name": "stats", "type": "CommitStats" },
{ "name": "url", "type": "string" },
{ "name": "author", "type": "NamedUser" },
{ "name": "committer", "type": "NamedUser" },
{ "name": "commit", "type": "GitCommit" }
],
"collections": [
{
"name": "comments",
"singularName": "comment",
"type": "CommitComment",
"getList": true,
"createElement": {
"mandatoryParameters": [
{ "name": "body", "type": "string" }
],
"optionalParameters": [
{ "name": "line", "type": "integer" },
{ "name": "path", "type": "string" },
{ "name": "position", "type": "integer" }
]
}
}
]
},
{
"name": "CommitComment",
"edit": {
"mandatoryParameters": [
{ "name": "body", "type": "string" }
]
},
"delete": true,
"attributes": [
{ "name": "body", "type": "string" },
{ "name": "commit_id", "type": "string" },
{ "name": "created_at", "type": "string" },
{ "name": "html_url", "type": "string" },
{ "name": "id", "type": "integer" },
{ "name": "line", "type": "integer" },
{ "name": "path", "type": "string" },
{ "name": "position", "type": "integer" },
{ "name": "updated_at", "type": "string" },
{ "name": "url", "type": "string" },
{ "name": "user", "type": "NamedUser" }
]
},
{
"name": "Download",
"delete": true,
"attributes": [
{ "name": "accesskeyid", "type": "string" },
{ "name": "acl", "type": "string" },
{ "name": "bucket", "type": "string" },
{ "name": "content_type", "type": "string" },
{ "name": "created_at", "type": "string" },
{ "name": "description", "type": "string" },
{ "name": "download_count", "type": "integer" },
{ "name": "expirationdate", "type": "string" },
{ "name": "html_url", "type": "string" },
{ "name": "id", "type": "integer" },
{ "name": "mime_type", "type": "string" },
{ "name": "name", "type": "string" },
{ "name": "path", "type": "string" },
{ "name": "policy", "type": "string" },
{ "name": "prefix", "type": "string" },
{ "name": "redirect", "type": "bool" },
{ "name": "s3_url", "type": "string" },
{ "name": "signature", "type": "string" },
{ "name": "size", "type": "integer" },
{ "name": "url", "type": "string" }
]
},
{
"name": "Event",
"attributes": [
{ "name": "actor", "type": "NamedUser" },
{ "name": "created_at", "type": "string" },
{ "name": "id", "type": "string" },
{ "name": "payload", "type": "dict" },
{ "name": "public", "type": "bool" },
{ "name": "type", "type": "string" },
{ "name": "org", "type": "Organization" },
{ "name": "repo", "type": "Repository" }
]
},
{
"name": "GistHistoryState",
"attributes": [
{ "name": "change_status", "type": "CommitStats" },
{ "name": "committed_at", "type": "string" },
{ "name": "url", "type": "string" },
{ "name": "user", "type": "NamedUser" },
{ "name": "version", "type": "string" }
]
},
{
"name": "GistFile",
"attributes": [
{ "name": "size", "type": "integer" },
{ "name": "filename", "type": "string" },
{ "name": "raw_url", "type": "string" },
{ "name": "language", "type": "string" },
{ "name": "content", "type": "string" }
]
},
{
"name": "Gist",
"edit": {
"optionalParameters": [
{ "name": "description", "type": "string" },
{ "name": "files", "type": "dict:string-InputFileContent" }
]
},
"delete": true,
"attributes": [
{ "name": "comments", "type": "integer" },
{ "name": "created_at", "type": "string" },
{ "name": "description", "type": "string" },
{ "name": "files", "type": "dict:string-GistFile" },
{ "name": "fork_of", "type": "Gist" },
{ "name": "forks", "type": "list:Gist" },
{ "name": "git_pull_url", "type": "string" },
{ "name": "git_push_url", "type": "string" },
{ "name": "history", "type": "list:GistHistoryState" },
{ "name": "html_url", "type": "string" },
{ "name": "id", "type": "string" },
{ "name": "public", "type": "bool" },
{ "name": "updated_at", "type": "string" },
{ "name": "url", "type": "string" },
{ "name": "user", "type": "NamedUser" }
],
"collections": [
{
"name": "comments",
"singularName": "comment",
"type": "GistComment",
"getList": true,
"getElement": {
"parameter": { "name": "id", "type": "integer" },
"url": [
{ "type": "constant", "value": "https://api.github.com/gists/comments/" },
{ "type": "argument", "value": [ "id" ] }
]
},
"createElement": {
"mandatoryParameters": [
{ "name": "body", "type": "string" }
]
}
}
],
"additionalMethods": [
{
"name": [ "is", "starred" ],
"group": "starring",
"type": "bool",
"request": {
"verb": "GET",
"url": [
{ "type": "attribute", "value": [ "url" ] },
{ "type": "constant", "value": "/star" }
],
"information": "status"
}
},
{
"name": [ "reset", "starred" ],
"group": "starring",
"type": "void",
"request": {
"verb": "DELETE",
"url": [
{ "type": "attribute", "value": [ "url" ] },
{ "type": "constant", "value": "/star" }
],
"information": "status"
}
},
{
"name": [ "set", "starred" ],
"group": "starring",
"type": "void",
"request": {
"verb": "PUT",
"url": [
{ "type": "attribute", "value": [ "url" ] },
{ "type": "constant", "value": "/star" }
],
"information": "status"
}
},
{
"name": [ "create", "fork" ],
"group": "forking",
"type": "Gist",
"request": {
"verb": "POST",
"url": [
{ "type": "attribute", "value": [ "url" ] },
{ "type": "constant", "value": "/fork" }
],
"information": "status"
}
}
]
},
{
"name": "GistComment",
"edit": {
"mandatoryParameters": [
{ "name": "body", "type": "string" }
]
},
"delete": true,
"attributes": [
{ "name": "body", "type": "string" },
{ "name": "created_at", "type": "string" },
{ "name": "id", "type": "integer" },
{ "name": "updated_at", "type": "string" },
{ "name": "url", "type": "string" },
{ "name": "user", "type": "NamedUser" }
]
},
{
"name": "GitBlob",
"attributes": [
{ "name": "content", "type": "string" },
{ "name": "encoding", "type": "string" },
{ "name": "sha", "type": "string" },
{ "name": "size", "type": "integer" },
{ "name": "url", "type": "string" }
]
},
{
"name": "GitCommit",
"attributes": [
{ "name": "author", "type": "GitAuthor" },
{ "name": "committer", "type": "GitAuthor" },
{ "name": "message", "type": "string" },
{ "name": "parents", "type": "list:GitCommit" },
{ "name": "sha", "type": "string" },
{ "name": "url", "type": "string" },
{ "name": "tree", "type": "GitTree" }
]
},
{
"name": "GitObject",
"isCompletable": false,
"attributes": [
{ "name": "sha", "type": "string" },
{ "name": "type", "type": "string" },
{ "name": "url", "type": "string" }
]
},
{
"name": "GitRef",
"edit": {
"mandatoryParameters": [
{ "name": "sha", "type": "string" }
],
"optionalParameters": [
{ "name": "force", "type": "bool" }
]
},
"delete": true,
"attributes": [
{ "name": "object", "type": "GitObject" },
{ "name": "ref", "type": "string" },
{ "name": "url", "type": "string" }
]
},
{
"name": "GitTag",
"attributes": [
{ "name": "message", "type": "string" },
{ "name": "object", "type": "GitObject" },
{ "name": "sha", "type": "string" },
{ "name": "tag", "type": "string" },
{ "name": "tagger", "type": "GitAuthor" },
{ "name": "url", "type": "string" }
]
},
{
"name": "GitTreeElement",
"isCompletable": false,
"attributes": [
{ "name": "mode", "type": "string" },
{ "name": "path", "type": "string" },
{ "name": "sha", "type": "string" },
{ "name": "size", "type": "integer" },
{ "name": "type", "type": "string" },
{ "name": "url", "type": "string" }
]
},
{
"name": "GitTree",
"attributes": [
{ "name": "sha", "type": "string" },
{ "name": "tree", "type": "list:GitTreeElement" },
{ "name": "url", "type": "string" }
]
},
{
"name": "GitAuthor",
"attributes": [
{ "name": "date", "type": "string" },
{ "name": "email", "type": "string" },
{ "name": "name", "type": "string" }
]
},
{
"name": "HookResponse",
"attributes": [
{ "name": "status", "type": "string" },
{ "name": "message", "type": "string" },
{ "name": "code", "type": "integer" }
]
},
{
"name": "Hook",
"edit": {
"mandatoryParameters": [
{ "name": "name", "type": "string" },
{ "name": "config", "type": "dict" }
],
"optionalParameters": [
{ "name": "events", "type": "list:string" },
{ "name": "add_events", "type": "list:string" },
{ "name": "remove_events", "type": "list:string" },
{ "name": "active", "type": "bool" }
]
},
"delete": true,
"attributes": [
{ "name": "active", "type": "bool" },
{ "name": "config", "type": "dict" },
{ "name": "created_at", "type": "string" },
{ "name": "events", "type": "list:string" },
{ "name": "id", "type": "integer" },
{ "name": "last_response", "type": "HookResponse" },
{ "name": "name", "type": "string" },
{ "name": "updated_at", "type": "string" },
{ "name": "url", "type": "string" }
],
"additionalMethods": [
{
"name": [ "test" ],
"group": "testing",
"type": "void",
"request": {
"verb": "POST",
"url": [
{ "type": "attribute", "value": [ "url" ] },
{ "type": "constant", "value": "/test" }
],
"information": "status"
}
}
]
},
{
"name": "IssuePullRequest",
"attributes": [
{ "name": "diff_url", "type": "string" },
{ "name": "patch_url", "type": "string" },
{ "name": "html_url", "type": "string" }
]
},
{
"name": "Issue",
"edit": {
"optionalParameters": [
{ "name": "title", "type": "string" },
{ "name": "body", "type": "string" },
{ "name": "assignee", "type": "string" },
{ "name": "state", "type": "string" },
{ "name": "milestone", "type": "integer" },
{ "name": "labels", "type": "list:string" }
]
},
"attributes": [
{ "name": "assignee", "type": "NamedUser" },
{ "name": "body", "type": "string" },
{ "name": "closed_at", "type": "string" },
{ "name": "closed_by", "type": "NamedUser" },
{ "name": "comments", "type": "integer" },
{ "name": "created_at", "type": "string" },
{ "name": "html_url", "type": "string" },
{ "name": "id", "type": "integer" },
{ "name": "labels", "type": "list:Label" },
{ "name": "milestone", "type": "Milestone" },
{ "name": "number", "type": "integer" },
{ "name": "pull_request", "type": "IssuePullRequest" },
{ "name": "repository", "type": "Repository" },
{ "name": "state", "type": "string" },
{ "name": "title", "type": "string" },
{ "name": "updated_at", "type": "string" },
{ "name": "url", "type": "string" },
{ "name": "user", "type": "NamedUser" }
],
"collections": [
{
"name": "comments",
"singularName": "comment",
"type": "IssueComment",
"getList": true,
"getElement": {
"parameter": { "name": "id", "type": "integer" },
"request": {
"url": [
{
"type": "parentUrl",
"value": [
{ "type": "attribute", "value": [ "url" ] }
]
},
{ "type": "constant", "value": "/comments" },
{ "type": "constant", "value": "/" },
{ "type": "argument", "value": [ "id" ] }
]
}
},
"createElement": {
"mandatoryParameters": [
{ "name": "body", "type": "string" }
]
}
},
{
"name": "events",
"singularName": "event",
"type": "IssueEvent",
"getList": true
},
{
"name": "labels",
"singularName": "label",
"type": "Label",
"getList": true,
"addSeveralElements": true,
"removeElement": true,
"setList": true,
"deleteList": true
}
]
},
{
"name": "IssueComment",
"edit": {
"mandatoryParameters": [
{ "name": "body", "type": "string" }
]
},
"delete": true,
"attributes": [
{ "name": "body", "type": "string" },
{ "name": "created_at", "type": "string" },
{ "name": "id", "type": "integer" },
{ "name": "updated_at", "type": "string" },
{ "name": "url", "type": "string" },
{ "name": "user", "type": "NamedUser" }
]
},
{
"name": "IssueEvent",
"attributes": [
{ "name": "commit_id", "type": "string" },
{ "name": "created_at", "type": "string" },
{ "name": "event", "type": "string" },
{ "name": "id", "type": "integer" },
{ "name": "issue", "type": "Issue" },
{ "name": "url", "type": "string" },
{ "name": "actor", "type": "NamedUser" }
]
},
{
"name": "Label",
"edit": {
"mandatoryParameters": [
{ "name": "name", "type": "string" },
{ "name": "color", "type": "string" }
]
},
"delete": true,
"attributes": [
{ "name": "color", "type": "string" },
{ "name": "name", "type": "string" },
{ "name": "url", "type": "string" }
],
"identity": [
{
"type": "urlquote",
"value": [
{ "type": "attribute", "value": [ "name" ] }
]
}
]
},
{
"name": "Milestone",
"edit": {
"mandatoryParameters": [
{ "name": "title", "type": "string" }
],
"optionalParameters": [
{ "name": "state", "type": "string" },
{ "name": "description", "type": "string" },
{ "name": "due_on", "type": "string" }
]
},
"delete": true,
"attributes": [
{ "name": "closed_issues", "type": "integer" },
{ "name": "created_at", "type": "string" },
{ "name": "description", "type": "string" },
{ "name": "due_on", "type": "string" },
{ "name": "id", "type": "integer" },
{ "name": "number", "type": "integer" },
{ "name": "open_issues", "type": "integer" },
{ "name": "state", "type": "string" },
{ "name": "title", "type": "string" },
{ "name": "url", "type": "string" },
{ "name": "creator", "type": "NamedUser" }
],
"collections": [
{
"name": "labels",
"singularName": "label",
"type": "Label",
"getList": true
}
]
},
{
"name": "NamedUser",
"attributes": [
{ "name": "avatar_url", "type": "string" },
{ "name": "bio", "type": "string" },
{ "name": "blog", "type": "string" },
{ "name": "collaborators", "type": "integer" },
{ "name": "company", "type": "string" },
{ "name": "contributions", "type": "integer" },
{ "name": "created_at", "type": "string" },
{ "name": "disk_usage", "type": "integer" },
{ "name": "email", "type": "string" },
{ "name": "followers", "type": "integer" },
{ "name": "following", "type": "integer" },
{ "name": "gravatar_id", "type": "string" },
{ "name": "hireable", "type": "bool" },
{ "name": "html_url", "type": "string" },
{ "name": "id", "type": "integer" },
{ "name": "location", "type": "string" },
{ "name": "login", "type": "string" },
{ "name": "name", "type": "string" },
{ "name": "owned_private_repos", "type": "integer" },
{ "name": "plan", "type": "Plan" },
{ "name": "private_gists", "type": "integer" },
{ "name": "public_gists", "type": "integer" },
{ "name": "public_repos", "type": "integer" },
{ "name": "total_private_repos", "type": "integer" },
{ "name": "type", "type": "string" },
{ "name": "url", "type": "string" }
],
"identity": [ { "type": "attribute", "value": [ "login" ] } ],
"collections": [
{
"name": "events",
"singularName": "event",
"type": "Event",
"getList": true
},
{
"name": "followers",
"singularName": "follower",
"type": "NamedUser",
"getList": true
},
{
"name": "following",
"singularName": "following",
"type": "NamedUser",
"getList": true
},
{
"name": "repos",
"singularName": "repo",
"type": "Repository",
"getList": {
"optionalParameters": [
{ "name": "type", "type": "string" }
]
},
"getElement": {
"parameter": { "name": "name", "type": "string" },
"url": [
{ "type": "constant", "value": "https://api.github.com/repos/" },
{ "type": "attribute", "value": [ "login" ] },
{ "type": "constant", "value": "/" },
{ "type": "argument", "value": [ "name" ] }
]
}
},
{
"name": "watched",
"singularName": "watched",
"type": "Repository",
"getList": true
},
{
"name": "orgs",
"singularName": "org",
"type": "Organization",
"getList": true
},
{
"name": "gists",
"singularName": "gist",
"type": "Gist",
"getList": true,
"createElement": {
"mandatoryParameters": [
{ "name": "public", "type": "bool" },
{ "name": "files", "type": "dict:string-InputFileContent" }
],
"optionalParameters": [
{ "name": "description", "type": "string" }
]
}
}
],
"additionalMethods": [
{
"name": [ "get", "public", "events" ],
"group": "events",
"type": "list:Event",
"request": {
"verb": "GET",
"url": [
{ "type": "attribute", "value": [ "url" ] },
{ "type": "constant", "value": "/events/public" }
]
}
},
{
"name": [ "get", "received", "events" ],
"group": "events",
"type": "list:Event",
"request": {
"verb": "GET",
"url": [
{ "type": "attribute", "value": [ "url" ] },
{ "type": "constant", "value": "/received_events" }
]
}
},
{
"name": [ "get", "public", "received", "events" ],
"group": "events",
"type": "list:Event",
"request": {
"verb": "GET",
"url": [
{ "type": "attribute", "value": [ "url" ] },
{ "type": "constant", "value": "/received_events/public" }
]
}
}
]
},
{
"name": "Organization",
"edit": {
"optionalParameters": [
{ "name": "billing_email", "type": "string" },
{ "name": "blog", "type": "string" },
{ "name": "company", "type": "string" },
{ "name": "email", "type": "string" },
{ "name": "location", "type": "string" },
{ "name": "name", "type": "string" }
]
},
"attributes": [
{ "name": "avatar_url", "type": "string" },
{ "name": "billing_email", "type": "string" },
{ "name": "blog", "type": "string" },
{ "name": "collaborators", "type": "integer" },
{ "name": "company", "type": "string" },
{ "name": "created_at", "type": "string" },
{ "name": "disk_usage", "type": "integer" },
{ "name": "email", "type": "string" },
{ "name": "followers", "type": "integer" },
{ "name": "following", "type": "integer" },
{ "name": "gravatar_id", "type": "string" },
{ "name": "html_url", "type": "string" },
{ "name": "id", "type": "integer" },
{ "name": "location", "type": "string" },
{ "name": "login", "type": "string" },
{ "name": "name", "type": "string" },
{ "name": "owned_private_repos", "type": "integer" },
{ "name": "plan", "type": "Plan" },
{ "name": "private_gists", "type": "integer" },
{ "name": "public_gists", "type": "integer" },
{ "name": "public_repos", "type": "integer" },
{ "name": "total_private_repos", "type": "integer" },
{ "name": "type", "type": "string" },
{ "name": "url", "type": "string" }
],
"collections": [
{
"name": "events",
"singularName": "event",
"type": "Event",
"getList": true
},
{
"name": "members",
"singularName": "member",
"type": "NamedUser",
"getList": true,
"hasElement": true,
"removeElement": true
},
{
"name": "public_members",
"singularName": "public_member",
"type": "NamedUser",
"getList": true,
"hasElement": true,
"addElement": true,
"removeElement": true
},
{
"name": "repos",
"singularName": "repo",
"type": "Repository",
"getList": {
"optionalParameters": [
{ "name": "type", "type": "string" }
]
},
"getElement": {
"parameter": { "name": "name", "type": "string" },
"url": [
{ "type": "constant", "value": "https://api.github.com/repos/" },
{ "type": "attribute", "value": [ "login" ] },
{ "type": "constant", "value": "/" },
{ "type": "argument", "value": [ "name" ] }
]
},
"createElement": {
"mandatoryParameters": [
{ "name": "name", "type": "string" }
],
"optionalParameters": [
{ "name": "description", "type": "string" },
{ "name": "homepage", "type": "string" },
{ "name": "private", "type": "bool" },
{ "name": "has_issues", "type": "bool" },
{ "name": "has_wiki", "type": "bool" },
{ "name": "has_downloads", "type": "bool" },
{ "name": "team_id", "type": "integer" }
]
}
},
{
"name": "teams",
"singularName": "team",
"type": "Team",
"getList": true,
"createElement": {
"mandatoryParameters": [
{ "name": "name", "type": "string" }
],
"optionalParameters": [
{ "name": "repo_names", "type": "list:string" },
{ "name": "permission", "type": "string" }
]
},
"getElement": {
"parameter": { "name": "id", "type": "integer" },
"url" : [
{ "type": "constant", "value": "https://api.github.com/teams/" },
{ "type": "argument", "value": [ "id" ] }
]
}
}
],
"additionalMethods": [
{
"name": [ "create", "fork" ],
"group": "forking",
"type": "Repository",
"mandatoryParameters": [
{ "name": "repo", "type": "Repository" }
],
"request": {
"verb": "POST",
"url": [
{ "type": "constant", "value": "https://api.github.com/repos/" },
{ "type": "argument", "value": [ "repo", "owner", "login" ] },
{ "type": "constant", "value": "/" },
{ "type": "argument", "value": [ "repo", "name" ] },
{ "type": "constant", "value": "/forks" }
],
"urlParameters": [
{ "name": "org", "value": [ { "type": "attribute", "value": [ "login" ] } ] }
],
"information": "status"
}
}
]
},
{
"name": "PullRequestMergeStatus",
"attributes": [
{ "name": "sha", "type": "string" },
{ "name": "merged", "type": "bool" },
{ "name": "message", "type": "string" }
]
},
{
"name": "PullRequestPart",
"attributes": [
{ "name": "label", "type": "string" },
{ "name": "ref", "type": "string" },
{ "name": "sha", "type": "string" },
{ "name": "user", "type": "NamedUser" },
{ "name": "repo", "type": "Repository" }
]
},
{
"name": "PullRequest",
"edit": {
"optionalParameters": [
{ "name": "title", "type": "string" },
{ "name": "body", "type": "string" },
{ "name": "state", "type": "string" }
]
},
"attributes": [
{ "name": "additions", "type": "integer" },
{ "name": "base", "type": "PullRequestPart" },
{ "name": "body", "type": "string" },
{ "name": "changed_files", "type": "integer" },
{ "name": "closed_at", "type": "string" },
{ "name": "comments", "type": "integer" },
{ "name": "commits", "type": "integer" },
{ "name": "created_at", "type": "string" },
{ "name": "deletions", "type": "integer" },
{ "name": "diff_url", "type": "string" },
{ "name": "head", "type": "PullRequestPart" },
{ "name": "html_url", "type": "string" },
{ "name": "id", "type": "integer" },
{ "name": "issue_url", "type": "string" },
{ "name": "mergeable", "type": "bool" },
{ "name": "merged_at", "type": "string" },
{ "name": "merged_by", "type": "NamedUser" },
{ "name": "merged", "type": "bool" },
{ "name": "number", "type": "integer" },
{ "name": "patch_url", "type": "string" },
{ "name": "review_comments", "type": "integer" },
{ "name": "state", "type": "string" },
{ "name": "title", "type": "string" },
{ "name": "updated_at", "type": "string" },
{ "name": "url", "type": "string" },
{ "name": "user", "type": "NamedUser" }
],
"collections": [
{
"name": "comments",
"singularName": "comment",
"type": "PullRequestComment",
"getList": true,
"getElement": {
"parameter": { "name": "id", "type": "integer" },
"request": {
"url": [
{
"type": "parentUrl",
"value": [
{ "type": "attribute", "value": [ "url" ] }
]
},
{ "type": "constant", "value": "/comments" },
{ "type": "constant", "value": "/" },
{ "type": "argument", "value": [ "id" ] }
]
}
},
"createElement": {
"mandatoryParameters": [
{ "name": "body", "type": "string" },
{ "name": "commit_id", "type": "string" },
{ "name": "path", "type": "string" },
{ "name": "position", "type": "integer" }
]
}
},
{
"name": "commits",
"singularName": "commit",
"type": "Commit",
"getList": true
},
{
"name": "files",
"singularName": "file",
"type": "File",
"getList": true
}
],
"additionalMethods": [
{
"name": [ "is", "merged" ],
"type": "bool",
"group": "merging",
"request": {
"verb": "GET",
"url": [
{ "type": "attribute", "value": [ "url" ] },
{ "type": "constant", "value": "/merge" }
],
"information": "status"
}
},
{
"name": [ "merge" ],
"type": "PullRequestMergeStatus",
"group": "merging",
"optionalParameters": [
{ "name": "commit_message", "type": "string" }
],
"request": {
"verb": "PUT",
"url": [
{ "type": "attribute", "value": [ "url" ] },
{ "type": "constant", "value": "/merge" }
],
"information": "status",
"postParameters": true
}
}
]
},
{
"name": "PullRequestComment",
"edit": {
"mandatoryParameters": [
{ "name": "body", "type": "string" }
]
},
"delete": true,
"attributes": [
{ "name": "body", "type": "string" },
{ "name": "commit_id", "type": "string" },
{ "name": "created_at", "type": "string" },
{ "name": "id", "type": "integer" },
{ "name": "path", "type": "string" },
{ "name": "position", "type": "integer" },
{ "name": "original_position", "type": "integer" },
{ "name": "original_commit_id", "type": "string" },
{ "name": "updated_at", "type": "string" },
{ "name": "url", "type": "string" },
{ "name": "user", "type": "NamedUser" }
]
},
{
"name": "Permissions",
"attributes": [
{ "name": "admin", "type": "bool" },
{ "name": "pull", "type": "bool" },
{ "name": "push", "type": "bool" }
]
},
{
"name": "Comparison",
"attributes": [
{ "name": "url", "type": "string" },
{ "name": "html_url", "type": "string" },
{ "name": "permalink_url", "type": "string" },
{ "name": "diff_url", "type": "string" },
{ "name": "patch_url", "type": "string" },
{ "name": "base_commit", "type": "Commit" },
{ "name": "status", "type": "string" },
{ "name": "ahead_by", "type": "integer" },
{ "name": "behind_by", "type": "integer" },
{ "name": "total_commits", "type": "integer" },
{ "name": "commits", "type": "list:Commit" },
{ "name": "files", "type": "list:File" }
]
},
{
"name": "Repository",
"identity": [
{ "type": "attribute", "value": [ "owner", "login" ] },
{ "type": "constant", "value": "/" },
{ "type": "attribute", "value": [ "name" ] }
],
"edit": {
"mandatoryParameters": [
{ "name": "name", "type": "string" }
],
"optionalParameters": [
{ "name": "description", "type": "string" },
{ "name": "homepage", "type": "string" },
{ "name": "public", "type": "bool" },
{ "name": "has_issues", "type": "bool" },
{ "name": "has_wiki", "type": "bool" },
{ "name": "has_downloads", "type": "bool" }
]
},
"attributes": [
{ "name": "clone_url", "type": "string" },
{ "name": "created_at", "type": "string" },
{ "name": "description", "type": "string" },
{ "name": "fork", "type": "bool" },
{ "name": "forks", "type": "integer" },
{ "name": "full_name", "type": "string" },
{ "name": "git_url", "type": "string" },
{ "name": "has_downloads", "type": "bool" },
{ "name": "has_issues", "type": "bool" },
{ "name": "has_wiki", "type": "bool" },
{ "name": "homepage", "type": "string" },
{ "name": "html_url", "type": "string" },
{ "name": "id", "type": "integer" },
{ "name": "language", "type": "string" },
{ "name": "master_branch", "type": "string" },
{ "name": "name", "type": "string" },
{ "name": "open_issues", "type": "integer" },
{ "name": "organization", "type": "Organization" },
{ "name": "owner", "type": "NamedUser" },
{ "name": "parent", "type": "Repository" },
{ "name": "permissions", "type": "Permissions" },
{ "name": "private", "type": "bool" },
{ "name": "pushed_at", "type": "string" },
{ "name": "size", "type": "integer" },
{ "name": "source", "type": "Repository" },
{ "name": "ssh_url", "type": "string" },
{ "name": "svn_url", "type": "string" },
{ "name": "updated_at", "type": "string" },
{ "name": "url", "type": "string" },
{ "name": "watchers", "type": "integer" }
],
"collections": [
{
"name": "branches",
"singularName": "branch",
"type": "Branch",
"getList": true
},
{
"name": "collaborators",
"singularName": "collaborator",
"type": "NamedUser",
"getList": true,
"hasElement": true,
"addElement": true,
"removeElement": true
},
{
"name": "comments",
"singularName": "comment",
"type": "CommitComment",
"getList": true,
"getElement": {
"parameter": { "name": "id", "type": "integer" }
}
},
{
"name": "commits",
"singularName": "commit",
"type": "Commit",
"getList": {
"optionalParameters": [
{ "name": "sha", "type": "string" },
{ "name": "path", "type": "string" }
]
},
"getElement": {
"parameter": { "name": "sha", "type": "string" }
}
},
{
"name": "contributors",
"singularName": "contributor",
"type": "NamedUser",
"getList": true
},
{
"name": "downloads",
"singularName": "download",
"type": "Download",
"getList": true,
"getElement": {
"parameter": { "name": "id", "type": "integer" }
},
"createElement": {
"mandatoryParameters": [
{ "name": "name", "type": "string" },
{ "name": "size", "type": "integer" }
],
"optionalParameters": [
{ "name": "description", "type": "string" },
{ "name": "content_type", "type": "string" }
]
}
},
{
"name": "events",
"singularName": "event",
"type": "Event",
"getList": true
},
{
"name": "forks",
"singularName": "fork",
"type": "Repository",
"getList": true
},
{
"name": "git_blobs",
"singularName": "git_blob",
"type": "GitBlob",
"getElement": {
"parameter": { "name": "sha", "type": "string" }
},
"createElement": {
"mandatoryParameters": [
{ "name": "content", "type": "string" },
{ "name": "encoding", "type": "string" }
]
},
"url": [
{ "type": "attribute", "value": [ "url" ] },
{ "type": "constant", "value": "/git/blobs" }
]
},
{
"name": "git_commits",
"singularName": "git_commit",
"type": "GitCommit",
"getElement": {
"parameter": { "name": "sha", "type": "string" }
},
"createElement": {
"mandatoryParameters": [
{ "name": "message", "type": "string" },
{ "name": "tree", "type": "string" },
{ "name": "parents", "type": "list:GitCommit" }
],
"optionalParameters": [
{ "name": "author", "type": "InputGitAuthor" },
{ "name": "committer", "type": "InputGitAuthor" }
]
},
"url": [
{ "type": "attribute", "value": [ "url" ] },
{ "type": "constant", "value": "/git/commits" }
]
},
{
"name": "git_refs",
"singularName": "git_ref",
"type": "GitRef",
"getList": true,
"createElement": {
"mandatoryParameters": [
{ "name": "ref", "type": "string" },
{ "name": "sha", "type": "string" }
]
},
"getElement": {
"parameter": { "name": "ref", "type": "string" },
"request": {
"url": [
{ "type": "attribute", "value": [ "url" ] },
{ "type": "constant", "value": "/git/" },
{ "type": "argument", "value": [ "ref" ] }
]
}
},
"url": [
{ "type": "attribute", "value": [ "url" ] },
{ "type": "constant", "value": "/git/refs" }
]
},
{
"name": "git_tags",
"singularName": "git_tag",
"type": "GitTag",
"createElement": {
"mandatoryParameters": [
{ "name": "tag", "type": "string" },
{ "name": "message", "type": "string" },
{ "name": "object", "type": "string" },
{ "name": "type", "type": "string" }
],
"optionalParameters": [
{ "name": "tagger", "type": "InputGitAuthor" }
]
},
"getElement": {
"parameter": { "name": "sha", "type": "string" }
},
"url": [
{ "type": "attribute", "value": [ "url" ] },
{ "type": "constant", "value": "/git/tags" }
]
},
{
"name": "git_trees",
"singularName": "git_tree",
"type": "GitTree",
"createElement": {
"mandatoryParameters": [
{ "name": "tree", "type": "list:InputGitTreeElement" }
],
"optionalParameters": [
{ "name": "base_tree", "type": "string" }
]
},
"getElement": {
"parameter": { "name": "sha", "type": "string" },
"optionalParameters": [
{ "name": "recursive", "type": "bool" }
]
},
"url": [
{ "type": "attribute", "value": [ "url" ] },
{ "type": "constant", "value": "/git/trees" }
]
},
{
"name": "hooks",
"singularName": "hook",
"type": "Hook",
"getList": true,
"createElement": {
"mandatoryParameters": [
{ "name": "name", "type": "string" },
{ "name": "config", "type": "dict" }
],
"optionalParameters": [
{ "name": "events", "type": "list:string" },
{ "name": "active", "type": "bool" }
]
},
"getElement": {
"parameter": { "name": "id", "type": "integer" }
}
},
{
"name": "issues",
"singularName": "issue",
"type": "Issue",
"getList": {
"optionalParameters": [
{ "name": "milestone", "type": "integer" },
{ "name": "state", "type": "string" },
{ "name": "assignee", "type": "string" },
{ "name": "mentioned", "type": "string" },
{ "name": "labels", "type": "string" },
{ "name": "sort", "type": "string" },
{ "name": "direction", "type": "string" },
{ "name": "since", "type": "string" }
]
},
"createElement": {
"mandatoryParameters": [
{ "name": "title", "type": "string" }
],
"optionalParameters": [
{ "name": "body", "type": "string" },
{ "name": "assignee", "type": "string" },
{ "name": "milestone", "type": "integer" },
{ "name": "labels", "type": "list:string" }
]
},
"getElement": {
"parameter": { "name": "number", "type": "integer" }
}
},
{
"name": "issues_events",
"singularName": "issues_event",
"type": "IssueEvent",
"getList": true,
"getElement": {
"parameter": { "name": "id", "type": "integer" }
},
"url": [
{ "type": "attribute", "value": [ "url" ] },
{ "type": "constant", "value": "/issues/events" }
]
},
{
"name": "keys",
"singularName": "key",
"type": "RepositoryKey",
"getList": true,
"createElement": {
"mandatoryParameters": [
{ "name": "title", "type": "string" },
{ "name": "key", "type": "string" }
]
},
"getElement": {
"parameter": { "name": "id", "type": "integer" }
}
},
{
"name": "labels",
"singularName": "label",
"type": "Label",
"getList": true,
"createElement": {
"mandatoryParameters": [
{ "name": "name", "type": "string" },
{ "name": "color", "type": "string" }
]
},
"getElement": {
"parameter": { "name": "name", "type": "string" },
"request": {
"url": [
{ "type": "attribute", "value": [ "url" ] },
{ "type": "constant", "value": "/labels/" },
{
"type": "urlquote",
"value": [
{ "type": "argument", "value": [ "name" ] }
]
}
]
}
}
},
{
"name": "milestones",
"singularName": "milestone",
"type": "Milestone",
"getList": {
"optionalParameters": [
{ "name": "state", "type": "string" },
{ "name": "sort", "type": "string" },
{ "name": "direction", "type": "string" }
]
},
"createElement": {
"mandatoryParameters": [
{ "name": "title", "type": "string" }
],
"optionalParameters": [
{ "name": "state", "type": "string" },
{ "name": "description", "type": "string" },
{ "name": "due_on", "type": "string" }
]
},
"getElement": {
"parameter": { "name": "number", "type": "integer" }
}
},
{
"name": "pulls",
"singularName": "pull",
"type": "PullRequest",
"getList": {
"optionalParameters": [
{ "name": "state", "type": "string" }
]
},
"getElement": {
"parameter": { "name": "number", "type": "integer" }
},
"createElement": {
"optionalParameters": [
{ "name": "title", "type": "string" },
{ "name": "body", "type": "string" },
{ "name": "issue", "type": "integer" },
{ "name": "base", "type": "string" },
{ "name": "head", "type": "string" }
]
}
},
{
"name": "tags",
"singularName": "tag",
"type": "Tag",
"getList": true
},
{
"name": "teams",
"singularName": "team",
"type": "Team",
"getList": true
},
{
"name": "watchers",
"singularName": "watcher",
"type": "NamedUser",
"getList": true
}
],
"additionalMethods": [
{
"name": [ "get", "network", "events" ],
"type": "list:Event",
"group": "events",
"request": {
"verb": "GET",
"url": [
{ "type": "constant", "value": "https://api.github.com/networks/" },
{ "type": "attribute", "value": [ "owner", "login" ] },
{ "type": "constant", "value": "/" },
{ "type": "attribute", "value": [ "name" ] },
{ "type": "constant", "value": "/events" }
]
}
},
{
"name": [ "get", "languages" ],
"type": "dict:string-integer",
"group": "languages",
"request": {
"verb": "GET",
"url": [
{ "type": "attribute", "value": [ "url" ] },
{ "type": "constant", "value": "/languages" }
]
}
},
{
"name": [ "compare" ],
"type": "Comparison",
"group": "Comparison",
"mandatoryParameters": [
{ "name": "base", "type": "string" },
{ "name": "head", "type": "string" }
],
"request": {
"verb": "GET",
"url": [
{ "type": "attribute", "value": [ "url" ] },
{ "type": "constant", "value": "/compare/" },
{ "type": "argument", "value": [ "base" ] },
{ "type": "constant", "value": "..." },
{ "type": "argument", "value": [ "head" ] }
]
}
}
]
},
{
"name": "RepositoryKey",
"edit": {
"optionalParameters": [
{ "name": "title", "type": "string" },
{ "name": "key", "type": "string" }
]
},
"delete": true,
"attributes": [
{ "name": "id", "type": "integer" },
{ "name": "key", "type": "string" },
{ "name": "title", "type": "string" },
{ "name": "url", "type": "string" },
{ "name": "verified", "type": "bool" }
]
},
{
"name": "Tag",
"attributes": [
{ "name": "name", "type": "string" },
{ "name": "tarball_url", "type": "string" },
{ "name": "zipball_url", "type": "string" },
{ "name": "commit", "type": "Commit" }
]
},
{
"name": "Team",
"edit": {
"mandatoryParameters": [
{ "name": "name", "type": "string" }
],
"optionalParameters": [
{ "name": "permission", "type": "string" }
]
},
"delete": true,
"attributes": [
{ "name": "id", "type": "integer" },
{ "name": "members_count", "type": "integer" },
{ "name": "name", "type": "string" },
{ "name": "permission", "type": "string" },
{ "name": "repos_count", "type": "integer" },
{ "name": "url", "type": "string" }
],
"collections": [
{
"name": "members",
"singularName": "member",
"type": "NamedUser",
"getList": true,
"addElement": true,
"hasElement": true,
"removeElement": true
},
{
"name": "repos",
"singularName": "repo",
"type": "Repository",
"getList": true,
"addElement": true,
"hasElement": true,
"removeElement": true
}
]
},
{
"name": "UserKey",
"edit": {
"optionalParameters": [
{ "name": "title", "type": "string" },
{ "name": "key", "type": "string" }
]
},
"delete": true,
"attributes": [
{ "name": "id", "type": "integer" },
{ "name": "key", "type": "string" },
{ "name": "title", "type": "string" },
{ "name": "url", "type": "string" },
{ "name": "verified", "type": "bool" }
]
}
]
}