UNPKG

github

Version:
1,464 lines (1,379 loc) 271 kB
{ "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, "documentation": "https://developer.github.com/v3", "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", "X-Poll-Interval", "X-GitHub-Request-Id", "Retry-After", "Link", "Location", "Last-Modified", "Etag", "Status" ], "request-headers": [ "Authorization", "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'" }, "owner": { "type": "String", "required": true, "validation": "", "invalidmsg": "", "description": "" }, "username": { "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." }, "installation_id": { "type": "String", "required": true, "validation": "", "invalidmsg": "", "description": "" }, "repository_id": { "type": "String", "required": true, "validation": "", "invalidmsg": "", "description": "" }, "commit_id": { "type": "String", "required": true, "validation": "", "invalidmsg": "Sha of the commit to comment on.", "description": "Sha of the commit to comment on." }, "client_id": { "type": "String", "required": false, "validation": "", "invalidmsg": "", "description": "The 20 character OAuth app client key for which to create the token." }, "column_id": { "type": "String", "required": true, "validation": "", "invalidmsg": "", "description": "" }, "project_id": { "type": "String", "required": true, "validation": "", "invalidmsg": "", "description": "" }, "repo_id": { "type": "String", "required": true, "validation": "", "invalidmsg": "", "description": "" }, "invitation_id": { "type": "String", "required": true, "validation": "", "invalidmsg": "", "description": "" }, "ref": { "type": "String", "required": true, "allow-empty": 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": "" }, "issue_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": "", "enum": ["asc", "desc"], "default": "desc" }, "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|all)$", "invalidmsg": "open, closed, all, default: open", "description": "", "enum": ["open", "closed", "all"], "default": "open" }, "color": { "type": "String", "required": true, "validation": "", "invalidmsg": "6 character hex code, without a leading #.", "description": "6 character hex code, without a leading #." }, "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." }, "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.", "default": "false" }, "has_issues": { "type": "Boolean", "required": false, "validation": "", "invalidmsg": "", "description": "True to enable issues for this repository, false to disable them. Default is true.", "default": "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.", "default": "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": "true" }, "default_branch": { "type": "String", "required": false, "validation": "", "invalidmsg": "", "description": "Updates the default branch for this repository." }, "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.", "default": "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", "default": "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." }, "license_template": { "type": "String", "required": false, "validation": "", "invalidmsg": "", "description": "Desired LICENSE template to apply. Use the name of the template without the extension. For example, \"mit\" or \"mozilla\"." }, "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", "enum": ["asc", "desc"], "default": "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" }, "privacy": { "type": "String", "required": false, "validation": "^(secret|closed)$", "invalidmsg": "secret, closed, default: secret", "description": "The level of privacy this team should have.", "enum": ["secret", "closed"], "default": "secret" }, "fingerprint": { "type": "String", "required": false, "validation": "", "invalidmsg": "", "description": "A unique string to distinguish an authorization from others created for the same client ID and user." }, "access_token": { "type": "String", "required": true, "validation": "", "invalidmsg": "", "description": "OAuth token" } }, "acceptTree": { "application/vnd.github.cloak-preview+json": [ "/search/commits" ], "application/vnd.github.ant-man-preview+json": [ "/repos/:owner/:repo/deployments", "/repos/:owner/:repo/deployments/:id/statuses" ], "application/vnd.github.cryptographer-preview": [ "/user/gpg_keys", "/user/gpg_keys/:id" ], "application/vnd.github.barred-rock-preview": [ "/repos/:owner/:repo/import/authors", "/repos/:owner/:repo/import/authors/:author_id", "/:owner/:name/import/lfs", "/:owner/:name/import/large_files", "/repos/:owner/:repo/import" ], "application/vnd.github.machine-man-preview": [ "/integration/installations", "/installations/:installation_id/access_tokens", "/integration/identity/user", "/installation/repositories", "/installations/:installation_id/repositories/:repository_id" ], "application/vnd.github.drax-preview+json": [ "/licenses", "/licenses/:license", "/repos/:owner/:repo", "/repos/:owner/:repo/license" ], "application/vnd.github.wyandotte-preview+json": [ "/orgs/:org/migrations", "/orgs/:org/migrations/:id", "/orgs/:org/migrations/:id/archive", "/orgs/:org/migrations/:id/repos/:repo_name/lock" ], "application/vnd.github.korra-preview+json": [ "/orgs/:org", "/orgs/:org/invitations", "/orgs/:org/outside_collaborators", "/orgs/:org/outside_collaborator/:username", "/orgs/:org/teams", "/repos/:owner/:repo/collaborators", "/repos/:owner/:repo/collaborators/:username/permission", "/teams/:id/invitations" ], "application/vnd.github.mister-fantastic-preview+json": [ "/repos/:owner/:repo/pages", "/repos/:owner/:repo/pages/builds", "/repos/:owner/:repo/pages/builds/latest", "/repos/:owner/:repo/pages/builds/:id" ], "application/vnd.github.eye-scream-preview": [ "/admin/pre-receive-environments/:id", "/admin/pre_receive_environments", "/admin/pre-receive-environments/:id/downloads/latest", "/admin/pre_receive_environments/:id/downloads", "/admin/pre-receive-hooks/:id", "/admin/pre-receive-hooks" ], "application/vnd.github.inertia-preview+json": [ "/repos/:owner/:repo/projects", "/orgs/:org/projects", "/projects/:id", "/projects/columns/:column_id/cards", "/projects/columns/cards/:id", "/projects/columns/cards/:id/moves", "/projects/:project_id/columns", "/projects/columns/:id", "/projects/columns/:id/moves" ], "application/vnd.github.loki-preview+json": [ "/repos/:owner/:repo/branches", "/repos/:owner/:repo/branches/:branch", "/repos/:owner/:repo/branches/:branch/protection", "/repos/:owner/:repo/branches/:branch/protection/required_status_checks", "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts", "/repos/:owner/:repo/branches/:branch/protection/restrictions", "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams", "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" ], "application/vnd.github.polaris-preview": [ "/repos/:owner/:repo/pulls/:number/merge" ], "application/vnd.github.squirrel-girl-preview": [ "/repos/:owner/:repo/comments/:id/reactions", "/repos/:owner/:repo/issues/:number/reactions", "/repos/:owner/:repo/issues/comments/:id/reactions", "/repos/:owner/:repo/pulls/comments/:id/reactions", "/reactions/:id", "/repos/:owner/:repo/pulls/:number/comments", "/repos/:owner/:repo/pulls/comments", "/repos/:owner/:repo/pulls/comments/:id" ], "application/vnd.github.mockingbird-preview": [ "/repos/:owner/:repo/issues/:issue_number/timeline" ], "application/vnd.github.black-cat-preview+json": [ "/repos/:owner/:repo/pulls/:number/reviews", "/repos/:owner/:repo/pulls/:number/reviews/:id", "/repos/:owner/:repo/pulls/:number/reviews/:id/comments", "/repos/:owner/:repo/pulls/:number/reviews/:id/events", "/repos/:owner/:repo/pulls/:number/reviews/:id/dismissals", "/repos/:owner/:repo/pulls/:number/requested_reviewers" ] } }, "authorization": { "get-grants": { "url": "/applications/grants", "method": "GET", "params": { "$page": null, "$per_page": null }, "description": "List your grants." }, "get-grant": { "url": "/applications/grants/:id", "method": "GET", "params": { "$id": null, "$page": null, "$per_page": null }, "description": "Get a single grant." }, "delete-grant": { "url": "/applications/grants/:id", "method": "DELETE", "params": { "$id": null }, "description": "Delete a grant." }, "get-all": { "url": "/authorizations", "method": "GET", "params": { "$page": null, "$per_page": null }, "description": "List your authorizations." }, "get": { "url": "/authorizations/:id", "method": "GET", "params": { "$id": null }, "description": "Get a single authorization." }, "create": { "url": "/authorizations", "method": "POST", "params": { "$scopes": null, "$note": null, "$note_url": null, "$client_id": null, "client_secret": { "type": "String", "required": false, "validation": "", "invalidmsg": "", "description": "The 40 character OAuth app client secret for which to create the token." }, "$fingerprint": null }, "description": "Create a new authorization." }, "get-or-create-authorization-for-app": { "url": "/authorizations/clients/:client_id", "method": "PUT", "params": { "$client_id": null, "client_secret": { "type": "String", "required": true, "validation": "", "invalidmsg": "", "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL." }, "$scopes": null, "$note": null, "$note_url": null, "$fingerprint": null }, "description": "Get or create an authorization for a specific app." }, "get-or-create-authorization-for-app-and-fingerprint": { "url": "/authorizations/clients/:client_id/:fingerprint", "method": "PUT", "params": { "$client_id": null, "$fingerprint": null, "client_secret": { "type": "String", "required": true, "validation": "", "invalidmsg": "", "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL." }, "$scopes": null, "$note": null, "$note_url": null }, "description": "Get or create an authorization for a specific app and fingerprint." }, "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, "$fingerprint": null }, "description": "Update an existing authorization." }, "delete": { "url": "/authorizations/:id", "method": "DELETE", "params": { "$id": null }, "description": "Delete an authorization." }, "check": { "url": "/applications/:client_id/tokens/:access_token", "method": "GET", "params": { "$client_id": null, "$access_token": null }, "description": "Check an authorization" }, "reset": { "url": "/applications/:client_id/tokens/:access_token", "method": "POST", "params": { "$client_id": null, "$access_token": null }, "description": "Reset an authorization" }, "revoke": { "url": "/applications/:client_id/tokens/:access_token", "method": "DELETE", "params": { "$client_id": null, "$access_token": null }, "description": "Revoke an authorization for an application" } }, "activity": { "get-events": { "url": "/events", "method": "GET", "params": { "$page": null, "$per_page": null }, "description": "List public events" }, "get-events-for-repo": { "url": "/repos/:owner/:repo/events", "method": "GET", "params": { "$owner": null, "$repo": null, "$page": null, "$per_page": null }, "description": "List repository events" }, "get-events-for-repo-issues": { "url": "/repos/:owner/:repo/issues/events", "method": "GET", "params": { "$owner": null, "$repo": null, "$page": null, "$per_page": null }, "description": "List issue events for a repository" }, "get-events-for-repo-network": { "url": "/networks/:owner/:repo/events", "method": "GET", "params": { "$owner": null, "$repo": null, "$page": null, "$per_page": null }, "description": "List public events for a network of repositories" }, "get-events-for-org": { "url": "/orgs/:org/events", "method": "GET", "params": { "$org": null, "$page": null, "$per_page": null }, "description": "List public events for an organization" }, "get-events-received": { "url": "/users/:username/received_events", "method": "GET", "params": { "$username": null, "$page": null, "$per_page": null }, "description": "List events that a user has received" }, "get-events-received-public": { "url": "/users/:username/received_events/public", "method": "GET", "params": { "$username": null, "$page": null, "$per_page": null }, "description": "List public events that a user has received" }, "get-events-for-user": { "url": "/users/:username/events", "method": "GET", "params": { "$username": null, "$page": null, "$per_page": null }, "description": "List events performed by a user" }, "get-events-for-user-public": { "url": "/users/:username/events/public", "method": "GET", "params": { "$username": null, "$page": null, "$per_page": null }, "description": "List public events performed by a user" }, "get-events-for-user-org": { "url": "/users/:username/events/orgs/:org", "method": "GET", "params": { "$username": null, "$org": null, "$page": null, "$per_page": null }, "description": "List events for a user's organization" }, "get-feeds": { "url": "/feeds", "method": "GET", "params": {}, "description": "Get all feeds available for the authenticated user." }, "get-notifications": { "url": "/notifications", "method": "GET", "params": { "all": { "type": "Boolean", "required": false, "validation": "", "invalidmsg": "", "description": "If true, show notifications marked as read. Default: false", "default": "false" }, "participating": { "type": "Boolean", "required": false, "validation": "", "invalidmsg": "", "description": "If true, only shows notifications in which the user is directly participating or mentioned. Default: false", "default": "false" }, "$since": null, "before": { "type": "String", "required": false, "validation": "", "invalidmsg": "", "description": "Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ." } }, "description": "Get all notifications for the current user, grouped by repository." }, "get-notifications-for-user": { "url": "/repos/:owner/:repo/notifications", "method": "GET", "params": { "$owner": null, "$repo": null, "all": { "type": "Boolean", "required": false, "validation": "", "invalidmsg": "", "description": "If true, show notifications marked as read. Default: false", "default": "false" }, "participating": { "type": "Boolean", "required": false, "validation": "", "invalidmsg": "", "description": "If true, only shows notifications in which the user is directly participating or mentioned. Default: false", "default": "false" }, "$since": null, "before": { "type": "String", "required": false, "validation": "", "invalidmsg": "", "description": "Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ." } }, "description": "Get all notifications for the given user." }, "mark-notifications-as-read": { "url": "/notifications", "method": "PUT", "params": { "last_read_at": { "type": "String", "required": false, "validation": "", "invalidmsg": "", "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: Time.now", "default": "Time.now" } }, "description": "Mark notifications as read for authenticated user." }, "mark-notifications-as-read-for-repo": { "url": "/repos/:owner/:repo/notifications", "method": "PUT", "params": { "$owner": null, "$repo": null, "last_read_at": { "type": "String", "required": false, "validation": "", "invalidmsg": "", "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: Time.now", "default": "Time.now" } }, "description": "Mark notifications in a repo as read." }, "get-notification-thread": { "url": "/notifications/threads/:id", "method": "GET", "params": { "$id": null }, "description": "View a single notification thread." }, "mark-notification-thread-as-read": { "url": "/notifications/threads/:id", "method": "PATCH", "params": { "$id": null }, "description": "Mark a notification thread as read." }, "check-notification-thread-subscription": { "url": "/notifications/threads/:id/subscription", "method": "GET", "params": { "$id": null }, "description": "Check to see if the current user is subscribed to a thread." }, "set-notification-thread-subscription": { "url": "/notifications/threads/:id/subscription", "method": "PUT", "params": { "$id": null, "subscribed": { "type": "Boolean", "required": false, "validation": "", "invalidmsg": "", "description": "Determines if notifications should be received from this thread" }, "ignored": { "type": "Boolean", "required": false, "validation": "", "invalidmsg": "", "description": "Determines if all notifications should be blocked from this thread" } }, "description": "This lets you subscribe or unsubscribe from a conversation. Unsubscribing from a conversation mutes all future notifications (until you comment or get @mentioned once more)." }, "delete-notification-thread-subscription": { "url": "/notifications/threads/:id/subscription", "method": "DELETE", "params": { "$id": null }, "description": "Delete a notification thread subscription." }, "get-stargazers-for-repo": { "url": "/repos/:owner/:repo/stargazers", "method": "GET", "params": { "$owner": null, "$repo": null, "$page": null, "$per_page": null }, "description": "List Stargazers" }, "get-starred-repos-for-user": { "url": "/users/:username/starred", "method": "GET", "params": { "$username": null, "sort": { "type": "String", "required": false, "validation": "^(created|updated)$", "invalidmsg": "created or updated (when it was last pushed to); default: created.", "description": "", "enum": ["created", "updated"], "default": "created" }, "$direction": null, "$page": null, "$per_page": null }, "description": "List repositories being starred by a user" }, "get-starred-repos": { "url": "/user/starred", "method": "GET", "params": { "sort": { "type": "String", "required": false, "validation": "^(created|updated)$", "invalidmsg": "created or updated (when it was last pushed to); default: created.", "description": "", "enum": ["created", "updated"], "default": "created" }, "$direction": null, "$page": null, "$per_page": null }, "description": "List repositories being starred by the authenticated user" }, "check-starring-repo": { "url": "/user/starred/:owner/:repo", "method": "GET", "params": { "$owner": null, "$repo": null, "$page": null, "$per_page": null }, "description": "Check if you are starring a repository" }, "star-repo": { "url": "/user/starred/:owner/:repo", "method": "PUT", "params": { "$owner": null, "$repo": null }, "description": "Star a repository" }, "unstar-repo": { "url": "/user/starred/:owner/:repo", "method": "DELETE", "params": { "$owner": null, "$repo": null }, "description": "Unstar a repository" }, "get-watchers-for-repo": { "url": "/repos/:owner/:repo/subscribers", "method": "GET", "params": { "$owner": null, "$repo": null, "$page": null, "$per_page": null }, "description": "Get watchers for repository." }, "get-watched-repos-for-user": { "url": "/users/:username/subscriptions", "method": "GET", "params": { "$username": null, "$page": null, "$per_page": null }, "description": "List repositories being watched by a user." }, "get-watched-repos": { "url": "/user/subscriptions", "method": "GET", "params": { "$page": null, "$per_page": null }, "description": "List repositories being watched by the authenticated user." }, "get-repo-subscription": { "url": "/repos/:owner/:repo/subscription", "method": "GET", "params": { "$owner": null, "$repo": null, "$page": null, "$per_page": null }, "description": "Get a Repository Subscription." }, "set-repo-subscription": { "url": "/repos/:owner/:repo/subscription", "method": "PUT", "params": { "$owner": null, "$repo": null, "subscribed": { "type": "Boolean", "required": false, "validation": "", "invalidmsg": "", "description": "Determines if notifications should be received from this repository." }, "ignored": { "type": "Boolean", "required": false, "validation": "", "invalidmsg": "", "description": "Determines if all notifications should be blocked from this repository." } }, "description": "Set a Repository Subscription" }, "unwatch-repo": { "url": "/repos/:owner/:repo/subscription", "method": "DELETE", "params": { "$owner": null, "$repo": null }, "description": "Unwatch a repository." } }, "gists": { "get-for-user": { "url": "/users/:username/gists", "method": "GET", "params": { "$username": null, "$since": null, "$page": null, "$per_page": null }, "description": "List a user's gists" }, "get-all": { "url": "/gists", "method": "GET", "params": { "$since": null, "$page": null, "$per_page": null }, "description": "List the authenticated user's gists or if called anonymously, this will return all public gists" }, "get-public": { "url": "/gists/public", "method": "GET", "params": { "$since": null }, "description": "List all public gists" }, "get-starred": { "url": "/gists/starred", "method": "GET", "params": { "$since": null }, "description": "List the authenticated user's starred gists" }, "get": { "url": "/gists/:id", "method": "GET", "params": { "$id": null }, "description": "Get a single gist" }, "get-revision": { "url": "/gists/:id/:sha", "method": "GET", "params": { "$id": null, "$sha": null }, "description": "Get a specific revision of a gist" }, "create": { "url": "/gists", "method": "POST", "params": { "$files": null, "$description": null, "public": { "type": "Boolean", "required": true, "validation": "", "invalidmsg": "", "description": "" } }, "description": "Create a gist" }, "edit": { "url": "/gists/:id", "method": "PATCH", "params": { "$id": null, "$description": null, "$files": null, "content": { "type": "String", "required": false, "validation": "", "invalidmsg": "", "description": "Updated file contents." }, "filename": { "type": "String", "required": false, "validation": "", "invalidmsg": "", "description": "New name for this file." } }, "description": "Edit a gist" }, "get-commits": { "url": "/gists/:id/commits", "method": "GET", "params": { "$id": null }, "description": "List gist commits" }, "star": { "url": "/gists/:id/star", "method": "PUT", "params": { "$id": null }, "description": "Star a gist" }, "unstar": { "url": "/gists/:id/star", "method": "DELETE", "params": { "$id": null }, "description": "Unstar a gist" }, "check-star": { "url": "/gists/:id/star", "method": "GET", "params": { "$id": null }, "description": "Check if a gist is starred" }, "fork": { "url": "/gists/:id/forks", "method": "POST", "params": { "$id": null }, "description": "Fork a gist" }, "get-forks": { "url": "/gists/:id/forks", "method": "GET", "params": { "$id": null, "$page": null, "$per_page": null }, "description": "List gist forks" }, "delete": { "url": "/gists/:id", "method": "DELETE", "params": { "$id": null }, "description": "Delete a gist" }, "get-comments": { "url": "/gists/:gist_id/comments", "method": "GET", "params": { "$gist_id": null }, "description": "List comments on a gist" }, "get-comment": { "url": "/gists/:gist_id/comments/:id", "method": "GET", "params": { "$gist_id": null, "$id": null }, "description": "Get a single comment" }, "create-comment": { "url": "/gists/:gist_id/comments", "method": "POST", "params": { "$gist_id": null, "$body": null }, "description": "Create a comment" }, "edit-comment": { "url": "/gists/:gist_id/comments/:id", "method": "PATCH", "params": { "$gist_id": null, "$id": null, "$body": null }, "description": "Edit a comment" }, "delete-comment": { "url": "/gists/:gist_id/comments/:id", "method": "DELETE", "params": { "$gist_id": null, "$id": null }, "description": "Delete a comment" } }, "gitdata": { "get-blob": { "url": "/repos/:owner/:repo/git/blobs/:sha", "method": "GET", "params": { "$owner": null, "$repo": null, "$sha": null, "$page": null, "$per_page": null }, "description": "Get a Blob" }, "create-blob": { "url": "/repos/:owner/:repo/git/blobs", "method": "POST", "params": { "$owner": null, "$repo": null, "content": { "type": "String", "required": true, "allow-empty": true, "validation": "", "invalidmsg": "", "description": "" }, "encoding": { "type": "String", "required": true, "validation": "", "invalidmsg": "", "description": "" } }, "description": "Create a Blob" }, "get-commit": { "url": "/repos/:owner/:repo/git/commits/:sha", "method": "GET", "params": { "$owner": null, "$repo": null, "$sha": null }, "description": "Get a Commit" }, "create-commit": { "url": "/repos/:owner/:repo/git/commits", "method": "POST", "params": { "$owner": null, "$repo": null, "message": { "type": "String", "required": true, "validation": "", "invalidmsg": "", "description": "String of the commit message" }, "tree": { "type": "String",