UNPKG

@itentialopensource/adapter-github

Version:

This adapter integrates with system described as: github.

1,646 lines (1,645 loc) 699 kB
{ "swagger": "2.0", "schemes": [ "https" ], "host": "api.github.com", "basePath": "/", "info": { "description": "Powerful collaboration, code review, and code management for open source and private projects.\n", "termsOfService": "https://help.github.com/articles/github-terms-of-service/#b-api-terms", "title": "GitHub", "version": "v3", "x-apisguru-categories": [ "collaboration", "developer_tools" ], "x-logo": { "url": "https://twitter.com/github/profile_image?size=original" }, "x-origin": [ { "format": "swagger", "url": "https://raw.githubusercontent.com/APIs-guru/unofficial_openapi_specs/master/github.com/v3/swagger.yaml", "version": "2.0" } ], "x-providerName": "github.com", "x-unofficialSpec": true }, "externalDocs": { "url": "https://developer.github.com/v3/" }, "consumes": [ "application/json" ], "produces": [ "application/json" ], "securityDefinitions": { "oauth_2_0": { "authorizationUrl": "https://github.com/login/oauth/authorize", "description": "OAuth2 is a protocol that lets external apps request authorization to private\ndetails in a user's GitHub account without getting their password. This is\npreferred over Basic Authentication because tokens can be limited to specific\ntypes of data, and can be revoked by users at any time.\n", "flow": "accessCode", "scopes": { "admin:org": "", "admin:org_hook": "", "admin:public_key": "", "admin:repo_hook": "", "delete_repo": "", "gist": "", "notifications": "", "public_repo": "", "read:org": "", "read:public_key": "", "read:repo_hook": "", "repo": "", "repo:status": "", "repo_deployment": "", "user": "", "user:email": "", "user:follow": "", "write:org": "", "write:public_key": "", "write:repo_hook": "" }, "tokenUrl": "https://github.com/login/oauth/access_token", "type": "oauth2" } }, "paths": { "/emojis": { "get": { "description": "Lists all the emojis available to use on GitHub.", "parameters": [ { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } }, "schema": { "$ref": "#/definitions/emojis" } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } } }, "/events": { "get": { "description": "List public events.", "parameters": [ { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } }, "schema": { "$ref": "#/definitions/events" } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } } }, "/feeds": { "get": { "description": "List Feeds.\nGitHub provides several timeline resources in Atom format. The Feeds API\n lists all the feeds available to the authenticating user.\n", "parameters": [ { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } }, "schema": { "$ref": "#/definitions/feeds" } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } } }, "/gists": { "get": { "description": "List the authenticated user's gists or if called anonymously, this will\nreturn all public gists.\n", "parameters": [ { "description": "Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.\nOnly gists updated at or after this time are returned.\n", "in": "query", "name": "since", "type": "string" }, { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } }, "schema": { "$ref": "#/definitions/gists" } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } }, "post": { "description": "Create a gist.", "parameters": [ { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/postGist" } } ], "responses": { "201": { "description": "Created", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } }, "schema": { "$ref": "#/definitions/gist" } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } } }, "/gists/public": { "get": { "description": "List all public gists.", "parameters": [ { "description": "Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.\nOnly gists updated at or after this time are returned.\n", "in": "query", "name": "since", "type": "string" }, { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } }, "schema": { "$ref": "#/definitions/gists" } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } } }, "/gists/starred": { "get": { "description": "List the authenticated user's starred gists.", "parameters": [ { "description": "Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.\nOnly gists updated at or after this time are returned.\n", "in": "query", "name": "since", "type": "string" }, { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } }, "schema": { "$ref": "#/definitions/gists" } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } } }, "/gists/{id}": { "delete": { "description": "Delete a gist.", "parameters": [ { "description": "Id of gist.", "in": "path", "name": "id", "required": true, "type": "integer" }, { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" } ], "responses": { "204": { "description": "No content.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } }, "get": { "description": "Get a single gist.", "parameters": [ { "description": "Id of gist.", "in": "path", "name": "id", "required": true, "type": "integer" }, { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } }, "schema": { "$ref": "#/definitions/gist" } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } }, "patch": { "description": "Edit a gist.", "parameters": [ { "description": "Id of gist.", "in": "path", "name": "id", "required": true, "type": "integer" }, { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/patchGist" } } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } }, "schema": { "$ref": "#/definitions/gist" } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } } }, "/gists/{id}/comments": { "get": { "description": "List comments on a gist.", "parameters": [ { "description": "Id of gist.", "in": "path", "name": "id", "required": true, "type": "integer" }, { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } }, "schema": { "$ref": "#/definitions/comments" } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } }, "post": { "description": "Create a commen", "parameters": [ { "description": "Id of gist.", "in": "path", "name": "id", "required": true, "type": "integer" }, { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/commentBody" } } ], "responses": { "201": { "description": "Created", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } }, "schema": { "$ref": "#/definitions/comment" } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } } }, "/gists/{id}/comments/{commentId}": { "delete": { "description": "Delete a comment.", "parameters": [ { "description": "Id of gist.", "in": "path", "name": "id", "required": true, "type": "integer" }, { "description": "Id of comment.", "in": "path", "name": "commentId", "required": true, "type": "integer" }, { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" } ], "responses": { "204": { "description": "No content.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } }, "get": { "description": "Get a single comment.", "parameters": [ { "description": "Id of gist.", "in": "path", "name": "id", "required": true, "type": "integer" }, { "description": "Id of comment.", "in": "path", "name": "commentId", "required": true, "type": "integer" }, { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } }, "schema": { "$ref": "#/definitions/comment" } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } }, "patch": { "description": "Edit a comment.", "parameters": [ { "description": "Id of gist.", "in": "path", "name": "id", "required": true, "type": "integer" }, { "description": "Id of comment.", "in": "path", "name": "commentId", "required": true, "type": "integer" }, { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/comment" } } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } }, "schema": { "$ref": "#/definitions/comment" } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } } }, "/gists/{id}/forks": { "post": { "description": "Fork a gist.", "parameters": [ { "description": "Id of gist.", "in": "path", "name": "id", "required": true, "type": "integer" }, { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" } ], "responses": { "204": { "description": "Exists.", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } }, "404": { "description": "Not exists.", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } } }, "/gists/{id}/star": { "delete": { "description": "Unstar a gist.", "parameters": [ { "description": "Id of gist.", "in": "path", "name": "id", "required": true, "type": "integer" }, { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" } ], "responses": { "204": { "description": "Item removed.", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } }, "get": { "description": "Check if a gist is starred.", "parameters": [ { "description": "Id of gist.", "in": "path", "name": "id", "required": true, "type": "integer" }, { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" } ], "responses": { "204": { "description": "Exists.", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } }, "404": { "description": "Not exists.", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } }, "put": { "description": "Star a gist.", "parameters": [ { "description": "Id of gist.", "in": "path", "name": "id", "required": true, "type": "integer" }, { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" } ], "responses": { "204": { "description": "Starred.", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } } }, "/gitignore/templates": { "get": { "description": "Listing available templates.\nList all templates available to pass as an option when creating a repository.\n", "parameters": [ { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } }, "schema": { "$ref": "#/definitions/gitignore" } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } } }, "/gitignore/templates/{language}": { "get": { "description": "Get a single template.", "parameters": [ { "in": "path", "name": "language", "required": true, "type": "string" }, { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } }, "schema": { "$ref": "#/definitions/gitignore-lang" } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } } }, "/issues": { "get": { "description": "List issues.\nList all issues across all the authenticated user's visible repositories.\n", "parameters": [ { "default": "all", "description": "Issues assigned to you / created by you / mentioning you / you're\nsubscribed to updates for / All issues the authenticated user can see\n", "enum": [ "assigned", "created", "mentioned", "subscribed", "all" ], "in": "query", "name": "filter", "required": true, "type": "string" }, { "default": "open", "enum": [ "open", "closed" ], "in": "query", "name": "state", "required": true, "type": "string" }, { "description": "String list of comma separated Label names. Example - bug,ui,@high.", "in": "query", "name": "labels", "required": true, "type": "string" }, { "default": "created", "enum": [ "created", "updated", "comments" ], "in": "query", "name": "sort", "required": true, "type": "string" }, { "default": "desc", "enum": [ "asc", "desc" ], "in": "query", "name": "direction", "required": true, "type": "string" }, { "description": "Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.\nOnly issues updated at or after this time are returned.\n", "in": "query", "name": "since", "type": "string" }, { "description": "Is used to set specified media type.", "in": "header", "name": "Accept", "type": "string" } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } }, "schema": { "$ref": "#/definitions/issues" } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "type": "string" }, "X-GitHub-Request-Id": { "type": "integer" }, "X-RateLimit-Limit": { "type": "integer" }, "X-RateLimit-Remaining": { "type": "integer" }, "X-RateLimit-Reset": { "type": "integer" } } } } } }, "/legacy/issues/search/{owner}/{repository}/{state}/{keyword}": { "get": { "deprecated": true, "description": "Find issues by state and keyword.", "parameters": [ { "description": "The search term.", "in": "path", "name": "keyword", "required": true, "type": "string" }, { "description": "Indicates the state of the issues to return. Can be either open or closed.", "enum": [ "open", "closed" ], "in": "path", "name": "state", "required": true, "type": "string" }, {