bower
Version:
The browser package manager
1,603 lines (1,520 loc) • 123 kB
JSON
{
"defines": {
"constants": {
"name": "Github",
"description": "A Node.JS module, which provides an object oriented wrapper for the GitHub v3 API.",
"protocol": "https",
"host": "api.github.com",
"port": 443,
"dateFormat": "YYYY-MM-DDTHH:MM:SSZ",
"requestFormat": "json",
"requestMedia": "application/vnd.github.v3+json"
},
"response-headers": [
"X-RateLimit-Limit",
"X-RateLimit-Remaining",
"X-RateLimit-Reset",
"X-Oauth-Scopes",
"Link",
"Location",
"Last-Modified",
"Etag",
"Status"
],
"request-headers": [
"If-Modified-Since",
"If-None-Match",
"Cookie",
"User-Agent",
"Accept",
"X-GitHub-OTP"
],
"params": {
"files": {
"type": "Json",
"required": true,
"validation": "",
"invalidmsg": "",
"description": "Files that make up this gist. The key of which should be a required string filename and the value another required hash with parameters: 'content'"
},
"user": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": ""
},
"org": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": ""
},
"repo": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": ""
},
"branch": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": ""
},
"sha": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": ""
},
"description": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": ""
},
"id": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": ""
},
"gist_id": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": "Id (SHA1 hash) of the gist."
},
"ref": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": "String of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected."
},
"number": {
"type": "Number",
"required": true,
"validation": "^[0-9]+$",
"invalidmsg": "",
"description": ""
},
"name": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": ""
},
"direction": {
"type": "String",
"required": false,
"validation": "^(asc|desc)$",
"invalidmsg": "asc or desc, default: desc.",
"description": ""
},
"since": {
"type": "Date",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ"
},
"until": {
"type": "Date",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ"
},
"state": {
"type": "String",
"required": false,
"validation": "^(open|closed)$",
"invalidmsg": "open, closed, default: open",
"description": ""
},
"color": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "6 character hex code, without a leading #.",
"description": "6 character hex code, without a leading #."
},
"permission": {
"type": "String",
"required": false,
"validation": "^(pull|push|admin)$",
"invalidmsg": "",
"description": "`pull` - team members can pull, but not push or administer this repositories (Default), `push` - team members can pull and push, but not administer this repositores, `admin` - team members can pull, push and administer these repositories."
},
"base": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": "The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo."
},
"head": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": "The branch (or git ref) where your changes are implemented."
},
"commit_id": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "Sha of the commit to comment on.",
"description": "Sha of the commit to comment on."
},
"line": {
"type": "Number",
"required": true,
"validation": "",
"invalidmsg": "Line index in the diff to comment on.",
"description": "Line index in the diff to comment on."
},
"path": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "Relative path of the file to comment on.",
"description": "Relative path of the file to comment on."
},
"position": {
"type": "Number",
"required": true,
"validation": "",
"invalidmsg": "Column index in the diff to comment on.",
"description": "Column index in the diff to comment on."
},
"body": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": ""
},
"homepage": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": ""
},
"private": {
"type": "Boolean",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "True to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account. Default is false."
},
"has_issues": {
"type": "Boolean",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "True to enable issues for this repository, false to disable them. Default is true."
},
"has_wiki": {
"type": "Boolean",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "True to enable the wiki for this repository, false to disable it. Default is true."
},
"has_downloads": {
"type": "Boolean",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "True to enable downloads for this repository, false to disable them. Default is true."
},
"default_branch": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "Updates the default branch for this repository."
},
"collabuser": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": ""
},
"title": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": ""
},
"key": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": ""
},
"page": {
"type": "Number",
"required": false,
"validation": "^[0-9]+$",
"invalidmsg": "",
"description": "Page number of the results to fetch."
},
"per_page": {
"type": "Number",
"required": false,
"validation": "^[0-9]+$",
"invalidmsg": "",
"description": "A custom page size up to 100. Default is 30."
},
"scopes": {
"type": "Array",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "A list of scopes that this authorization is in."
},
"note": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "A note to remind you what the OAuth token is for."
},
"note_url": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "A URL to remind you what app the OAuth token is for."
},
"auto_init": {
"type": "Boolean",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "True to create an initial commit with empty README. Default is false"
},
"gitignore_template": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "Desired language or platform .gitignore template to apply. Ignored if auto_init parameter is not provided."
},
"content": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": ""
},
"message": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": ""
},
"order": {
"type": "String",
"required": false,
"validation": "^(asc|desc)$",
"invalidmsg": "The sort order if sort parameter is provided. One of asc or desc. Default: desc",
"description": "asc or desc"
},
"q": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": "Search Term",
"combined": true
},
"data": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": "Raw data to send as the body of the request"
}
}
},
"gists": {
"get-all": {
"url": "/gists",
"method": "GET",
"params": {
"$page": null,
"$per_page": null,
"$since": null
}
},
"get-from-user": {
"url": "/users/:user/gists",
"method": "GET",
"params": {
"$user": null,
"$page": null,
"$per_page": null,
"$since": null
}
},
"create": {
"url": "/gists",
"method": "POST",
"params": {
"$description": null,
"public": {
"type": "Boolean",
"required": true,
"validation": "",
"invalidmsg": "",
"description": ""
},
"$files": null
}
},
"edit": {
"url": "/gists/:id",
"method": "PATCH",
"params": {
"$id": null,
"$description": null,
"$files": null
}
},
"public": {
"url": "/gists/public",
"method": "GET",
"params": {
"$since": null
}
},
"starred": {
"url": "/gists/starred",
"method": "GET",
"params": {
"$since": null
}
},
"get": {
"url": "/gists/:id",
"method": "GET",
"params": {
"$id": null
}
},
"star": {
"url": "/gists/:id/star",
"method": "PUT",
"params": {
"$id": null
}
},
"delete-star": {
"url": "/gists/:id/star",
"method": "DELETE",
"params": {
"$id": null
}
},
"check-star": {
"url": "/gists/:id/star",
"method": "GET",
"params": {
"$id": null
}
},
"fork": {
"url": "/gists/:id/fork",
"method": "POST",
"params": {
"$id": null
}
},
"delete": {
"url": "/gists/:id",
"method": "DELETE",
"params": {
"$id": null
}
},
"get-comments": {
"url": "/gists/:gist_id/comments",
"method": "GET",
"params": {
"$gist_id": null
}
},
"get-comment": {
"url": "/gists/:gist_id/comments/:id",
"method": "GET",
"params": {
"$gist_id": null,
"$id": null
}
},
"create-comment": {
"url": "/gists/:gist_id/comments",
"method": "POST",
"params": {
"$gist_id": null,
"$body": null
}
},
"edit-comment": {
"url": "/gists/:gist_id/comments/:id",
"method": "PATCH",
"params": {
"$gist_id": null,
"$id": null,
"$body": null
}
},
"delete-comment": {
"url": "/gists/:gist_id/comments/:id",
"method": "DELETE",
"params": {
"$gist_id": null,
"$id": null
}
}
},
"gitdata": {
"get-blob": {
"url": "/repos/:user/:repo/git/blobs/:sha",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"$sha": null,
"$page": null,
"$per_page": null
}
},
"create-blob": {
"url": "/repos/:user/:repo/git/blobs",
"method": "POST",
"params": {
"$user": null,
"$repo": null,
"content": {
"type": "String",
"required": true,
"allow-empty": true,
"validation": "",
"invalidmsg": "",
"description": ""
},
"encoding": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": ""
}
}
},
"get-commit": {
"url": "/repos/:user/:repo/git/commits/:sha",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"$sha": null
}
},
"create-commit": {
"url": "/repos/:user/:repo/git/commits",
"method": "POST",
"params": {
"$user": null,
"$repo": null,
"message": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": "String of the commit message"
},
"tree": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": "String of the SHA of the tree object this commit points to"
},
"parents": {
"type": "Array",
"required": true,
"validation": "",
"invalidmsg": "",
"description": "Array of the SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided, for a merge commit, an array of more than one should be provided."
},
"author": {
"type": "Json",
"required": false,
"validation": "",
"invalidmsg": "",
"description": ""
},
"committer": {
"type": "Json",
"required": false,
"validation": "",
"invalidmsg": "",
"description": ""
}
}
},
"get-reference": {
"url": "/repos/:user/:repo/git/refs/:ref",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"$ref": null
}
},
"get-all-references": {
"url": "/repos/:user/:repo/git/refs",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"$page": null,
"$per_page": null
}
},
"create-reference": {
"url": "/repos/:user/:repo/git/refs",
"method": "POST",
"params": {
"$user": null,
"$repo": null,
"$ref": null,
"$sha": null
}
},
"update-reference": {
"url": "/repos/:user/:repo/git/refs/:ref",
"method": "PATCH",
"params": {
"$user": null,
"$repo": null,
"$ref": null,
"$sha": null,
"force": {
"type": "Boolean",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "Boolean indicating whether to force the update or to make sure the update is a fast-forward update. The default is false, so leaving this out or setting it to false will make sure you’re not overwriting work."
}
}
},
"delete-reference": {
"url": "/repos/:user/:repo/git/refs/:ref",
"method": "DELETE",
"params": {
"$user": null,
"$repo": null,
"$ref": null
}
},
"get-tag": {
"url": "/repos/:user/:repo/git/tags/:sha",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"$sha": null
}
},
"create-tag": {
"url": "/repos/:user/:repo/git/tags",
"method": "POST",
"params": {
"$user": null,
"$repo": null,
"tag": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": "String of the tag"
},
"message": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": "String of the tag message"
},
"object": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": "String of the SHA of the git object this is tagging"
},
"type": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": "String of the type of the object we’re tagging. Normally this is a commit but it can also be a tree or a blob."
},
"tagger": {
"type": "Json",
"required": true,
"validation": "",
"invalidmsg": "",
"description": "JSON object that contains the following keys: `name` - String of the name of the author of the tag, `email` - String of the email of the author of the tag, `date` - Timestamp of when this object was tagged"
}
}
},
"get-tree": {
"url": "/repos/:user/:repo/git/trees/:sha",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"$sha": null,
"recursive": {
"type": "Boolean",
"required": false,
"validation": "",
"invalidmsg": "",
"description": ""
}
}
},
"create-tree": {
"url": "/repos/:user/:repo/git/trees",
"method": "POST",
"params": {
"$user": null,
"$repo": null,
"tree": {
"type": "Json",
"required": true,
"validation": "",
"invalidmsg": "",
"description": "Array of Hash objects (of path, mode, type and sha) specifying a tree structure"
},
"base_tree": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "String of the SHA1 of the tree you want to update with new data"
}
}
}
},
"issues": {
"get-all": {
"url": "/issues",
"method": "GET",
"params": {
"filter": {
"type": "String",
"required": false,
"validation": "^(all|assigned|created|mentioned|subscribed)$",
"invalidmsg": "",
"description": ""
},
"state": {
"type": "String",
"required": false,
"validation": "^(open|closed|all)$",
"invalidmsg": "open, closed, all, default: open",
"description": "open, closed, or all"
},
"labels": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "String list of comma separated Label names. Example: bug,ui,@high"
},
"sort": {
"type": "String",
"required": false,
"validation": "^(created|updated|comments)$",
"invalidmsg": "created, updated, comments, default: created.",
"description": ""
},
"$direction": null,
"$since": null,
"$page": null,
"$per_page": null
}
},
"repo-issues": {
"url": "/repos/:user/:repo/issues",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"milestone": {
"type": "String",
"required": false,
"validation": "^([0-9]+|none|\\*)$",
"invalidmsg": "",
"description": ""
},
"state": {
"type": "String",
"required": false,
"validation": "^(open|closed|all)$",
"invalidmsg": "open, closed, all, default: open",
"description": "open, closed, or all"
},
"assignee": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "String User login, `none` for Issues with no assigned User. `*` for Issues with any assigned User."
},
"creator": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "The user that created the issue."
},
"mentioned": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "String User login."
},
"labels": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "String list of comma separated Label names. Example: bug,ui,@high"
},
"sort": {
"type": "String",
"required": false,
"validation": "^(created|updated|comments)$",
"invalidmsg": "created, updated, comments, default: created.",
"description": ""
},
"$direction": null,
"$since": null,
"$page": null,
"$per_page": null
}
},
"get-repo-issue": {
"url": "/repos/:user/:repo/issues/:number",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"$number": null
}
},
"create": {
"url": "/repos/:user/:repo/issues",
"method": "POST",
"params": {
"$user": null,
"$repo": null,
"title": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": ""
},
"body": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": ""
},
"assignee": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "Login for the user that this issue should be assigned to."
},
"milestone": {
"type": "Number",
"required": false,
"validation": "^[0-9]+$",
"invalidmsg": "",
"description": "Milestone to associate this issue with."
},
"labels": {
"type": "Json",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "Array of strings - Labels to associate with this issue."
}
}
},
"edit": {
"url": "/repos/:user/:repo/issues/:number",
"method": "PATCH",
"params": {
"$user": null,
"$repo": null,
"$number": null,
"title": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": ""
},
"body": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": ""
},
"assignee": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "Login for the user that this issue should be assigned to."
},
"milestone": {
"type": "Number",
"required": false,
"validation": "^[0-9]+$",
"invalidmsg": "",
"description": "Milestone to associate this issue with."
},
"labels": {
"type": "Json",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "Array of strings - Labels to associate with this issue."
},
"state": {
"type": "String",
"required": false,
"validation": "^(open|closed)$",
"invalidmsg": "open, closed, default: open",
"description": "open or closed"
}
}
},
"repo-comments": {
"url": "/repos/:user/:repo/issues/comments",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"sort": {
"type": "String",
"required": false,
"validation": "^(created|updated)$",
"invalidmsg": "created, updated, default: created.",
"description": ""
},
"$direction": null,
"$since": null,
"$page": null,
"$per_page": null
}
},
"get-comments": {
"url": "/repos/:user/:repo/issues/:number/comments",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"$number": null,
"$page": null,
"$per_page": null
}
},
"get-comment": {
"url": "/repos/:user/:repo/issues/comments/:id",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"$id": null
}
},
"create-comment": {
"url": "/repos/:user/:repo/issues/:number/comments",
"method": "POST",
"params": {
"$user": null,
"$repo": null,
"$number": null,
"body": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": ""
}
}
},
"edit-comment": {
"url": "/repos/:user/:repo/issues/comments/:id",
"method": "PATCH",
"params": {
"$user": null,
"$repo": null,
"$id": null,
"body": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": ""
}
}
},
"delete-comment": {
"url": "/repos/:user/:repo/issues/comments/:id",
"method": "DELETE",
"params": {
"$user": null,
"$repo": null,
"$id": null
}
},
"get-events": {
"url": "/repos/:user/:repo/issues/:number/events",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"$number": null,
"$page": null,
"$per_page": null
}
},
"get-repo-events": {
"url": "/repos/:user/:repo/issues/events",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"$page": null,
"$per_page": null
}
},
"get-event": {
"url": "/repos/:user/:repo/issues/events/:id",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"$id": null
}
},
"get-labels": {
"url": "/repos/:user/:repo/labels",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"$page": null,
"$per_page": null
}
},
"get-label": {
"url": "/repos/:user/:repo/labels/:name",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"$name": null
}
},
"create-label": {
"url": "/repos/:user/:repo/labels",
"method": "POST",
"params": {
"$user": null,
"$repo": null,
"$name": null,
"$color": null
}
},
"update-label": {
"url": "/repos/:user/:repo/labels/:name",
"method": "POST",
"params": {
"$user": null,
"$repo": null,
"$name": null,
"$color": null
}
},
"delete-label": {
"url": "/repos/:user/:repo/labels/:name",
"method": "DELETE",
"params": {
"$user": null,
"$repo": null,
"$name": null
}
},
"get-issue-labels": {
"url": "/repos/:user/:repo/issues/:number/labels",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"$number": null
}
},
"get-all-milestones": {
"url": "/repos/:user/:repo/milestones",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"$state": null,
"sort": {
"type": "String",
"required": false,
"validation": "^(due_date|completeness)$",
"invalidmsg": "due_date, completeness, default: due_date",
"description": "due_date, completeness, default: due_date"
},
"$page": null,
"$per_page": null
}
},
"get-milestone": {
"url": "/repos/:user/:repo/milestones/:number",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"$number": null
}
},
"create-milestone": {
"url": "/repos/:user/:repo/milestones",
"method": "POST",
"params": {
"$user": null,
"$repo": null,
"title": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": ""
},
"$state": null,
"$description": null,
"due_on": {
"type": "Date",
"required": false,
"validation": "",
"invalidmsg": "Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ",
"description": "Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ"
}
}
},
"update-milestone": {
"url": "/repos/:user/:repo/milestones/:number",
"method": "PATCH",
"params": {
"$user": null,
"$repo": null,
"$number": null,
"title": {
"type": "String",
"required": true,
"validation": "",
"invalidmsg": "",
"description": ""
},
"$state": null,
"$description": null,
"due_on": {
"type": "Date",
"required": false,
"validation": "",
"invalidmsg": "Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ",
"description": "Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ"
}
}
},
"delete-milestone": {
"url": "/repos/:user/:repo/milestones/:number",
"method": "DELETE",
"params": {
"$user": null,
"$repo": null,
"$number": null
}
}
},
"authorization": {
"get-all": {
"url": "/authorizations",
"method": "GET",
"params": {
"$page": null,
"$per_page": null
}
},
"get": {
"url": "/authorizations/:id",
"method": "GET",
"params": {
"$id": null
}
},
"create": {
"url": "/authorizations",
"method": "POST",
"params": {
"$scopes": null,
"$note": null,
"$note_url": null
}
},
"update": {
"url": "/authorizations/:id",
"method": "PATCH",
"params": {
"$id": null,
"$scopes": null,
"add_scopes": {
"type": "Array",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "A list of scopes to add to this authorization."
},
"remove_scopes": {
"type": "Array",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "A list of scopes to remove from this authorization."
},
"$note": null,
"$note_url": null
}
},
"delete": {
"url": "/authorizations/:id",
"method": "DELETE",
"params": {
"$id": null
}
}
},
"orgs": {
"get-from-user": {
"url": "/users/:user/orgs",
"method": "GET",
"params": {
"$user": null,
"$page": null,
"$per_page": null
}
},
"get": {
"url": "/orgs/:org",
"method": "GET",
"params": {
"$org": null,
"$page": null,
"$per_page": null
}
},
"update": {
"url": "/orgs/:org",
"method": "PATCH",
"params": {
"$org": null,
"billing_email": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "Billing email address. This address is not publicized."
},
"company": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": ""
},
"email": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "Publicly visible email address."
},
"location": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": ""
},
"name": {
"type": "String",
"required": false,
"validation": "",
"invalidmsg": "",
"description": ""
}
}
},
"get-members": {
"url": "/orgs/:org/members",
"method": "GET",
"params": {
"$org": null,
"$page": null,
"$per_page": null,
"filter": {
"type": "String",
"required": false,
"validation": "^(all|2fa_disabled)$",
"invalidmsg": "all, 2fa_disabled, default: all",
"description": ""
}
}
},
"get-member": {
"url": "/orgs/:org/members/:user",
"method": "GET",
"params": {
"$org": null,
"$user": null
}
},
"remove-member": {
"url": "/orgs/:org/members/:user",
"method": "DELETE",
"params": {
"$org": null,
"$user": null
}
},
"get-public-members": {
"url": "/orgs/:org/public_members",
"method": "GET",
"params": {
"$org": null
}
},
"get-public-member": {
"url": "/orgs/:org/public_members/:user",
"method": "GET",
"params": {
"$org": null,
"$user": null
}
},
"publicize-membership": {
"url": "/orgs/:org/public_members/:user",
"method": "PUT",
"params": {
"$org": null,
"$user": null
}
},
"conceal-membership": {
"url": "/orgs/:org/public_members/:user",
"method": "DELETE",
"params": {
"$org": null,
"$user": null
}
},
"get-teams": {
"url": "/orgs/:org/teams",
"method": "GET",
"params": {
"$org": null,
"$page": null,
"$per_page": null
}
},
"get-team": {
"url": "/teams/:id",
"method": "GET",
"params": {
"$id": null
}
},
"create-team": {
"url": "/orgs/:org/teams",
"method": "POST",
"params": {
"$org": null,
"$name": null,
"repo_names": {
"type": "Array",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "Array of strings"
},
"$permission": null
}
},
"update-team": {
"url": "/teams/:id",
"method": "PATCH",
"params": {
"$id": null,
"$name": null,
"$permission": null
}
},
"delete-team": {
"url": "/teams/:id",
"method": "DELETE",
"params": {
"$id": null
}
},
"get-team-members": {
"url": "/teams/:id/members",
"method": "GET",
"params": {
"$id": null,
"$page": null,
"$per_page": null
}
},
"get-team-member": {
"url": "/teams/:id/members/:user",
"method": "GET",
"params": {
"$id": null,
"$user": null
}
},
"add-team-member": {
"url": "/teams/:id/members/:user",
"method": "PUT",
"params": {
"$id": null,
"$user": null
}
},
"delete-team-member": {
"url": "/teams/:id/members/:user",
"method": "DELETE",
"params": {
"$id": null,
"$user": null
}
},
"add-team-membership": {
"url": "/teams/:id/memberships/:user",
"method": "PUT",
"params": {
"$id": null,
"$user": null
}
},
"get-team-repos": {
"url": "/teams/:id/repos",
"method": "GET",
"params": {
"$id": null,
"$page": null,
"$per_page": null
}
},
"get-team-repo": {
"url": "/teams/:id/repos/:user/:repo",
"method": "GET",
"params": {
"$id": null,
"$user": null,
"$repo": null
}
},
"add-team-repo": {
"url": "/teams/:id/repos/:user/:repo",
"method": "PUT",
"params": {
"$id": null,
"$user": null,
"$repo": null
}
},
"delete-team-repo": {
"url": "/teams/:id/repos/:user/:repo",
"method": "DELETE",
"params": {
"$id": null,
"$user": null,
"$repo": null
}
}
},
"statuses": {
"get": {
"url": "/repos/:user/:repo/commits/:sha/statuses",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"$sha": null
}
},
"get-combined": {
"url": "/repos/:user/:repo/commits/:sha/status",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"$sha": null
}
},
"create": {
"url": "/repos/:user/:repo/statuses/:sha",
"method": "POST",
"params": {
"$user": null,
"$repo": null,
"$sha": nul