@itentialopensource/adapter-github

{ "openapi": "3.0.0", "info": { "title": "GitHub", "description": "Powerful collaboration, code review, and code management for open source and private projects.\n", "contact": {}, "version": "v3" }, "servers": [ { "url": "https://api.github.com/", "variables": {} }, { "url": "https://github.com/login/oauth", "variables": {} } ], "paths": { "/emojis": { "get": { "summary": "Emojis_GET", "description": "Lists all the emojis available to use on GitHub.", "operationId": "Emojis_GET", "parameters": [ { "name": "Accept", "in": "header", "description": "Is used to set specified media type.", "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-GitHub-Request-Id": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Limit": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Remaining": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Reset": { "content": { "text/plain": { "schema": { "type": "string" } } } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n" } }, "deprecated": false } }, "/events": { "get": { "summary": "Events_GET", "description": "List public events.", "operationId": "Events_GET", "parameters": [ { "name": "Accept", "in": "header", "description": "Is used to set specified media type.", "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-GitHub-Request-Id": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Limit": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Remaining": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Reset": { "content": { "text/plain": { "schema": { "type": "string" } } } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/event" }, "description": "OK" } } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n" } }, "deprecated": false } }, "/feeds": { "get": { "summary": "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", "operationId": "Feeds_GET", "parameters": [ { "name": "Accept", "in": "header", "description": "Is used to set specified media type.", "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-GitHub-Request-Id": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Limit": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Remaining": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Reset": { "content": { "text/plain": { "schema": { "type": "string" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/feeds" } } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n" } }, "deprecated": false } }, "/gists": { "get": { "summary": "Gists_GET", "description": "List the authenticated user's gists or if called anonymously, this will\nreturn all public gists.\n", "operationId": "Gists_GET", "parameters": [ { "name": "since", "in": "query", "description": "Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.\nOnly gists updated at or after this time are returned.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Is used to set specified media type.", "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-GitHub-Request-Id": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Limit": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Remaining": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Reset": { "content": { "text/plain": { "schema": { "type": "string" } } } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/gist1" }, "description": "OK" } } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n" } }, "deprecated": false }, "post": { "summary": "Gists_POST", "description": "Create a gist.", "operationId": "Gists_POST", "parameters": [ { "name": "Accept", "in": "header", "description": "Is used to set specified media type.", "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postGist" } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-GitHub-Request-Id": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Limit": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Remaining": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Reset": { "content": { "text/plain": { "schema": { "type": "string" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gist" } } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n" } }, "deprecated": false } }, "/gists/public": { "get": { "summary": "GistsPublic_GET", "description": "List all public gists.", "operationId": "GistsPublic_GET", "parameters": [ { "name": "since", "in": "query", "description": "Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.\nOnly gists updated at or after this time are returned.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Is used to set specified media type.", "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-GitHub-Request-Id": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Limit": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Remaining": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Reset": { "content": { "text/plain": { "schema": { "type": "string" } } } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/gist1" }, "description": "OK" } } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n" } }, "deprecated": false } }, "/gists/starred": { "get": { "summary": "GistsStarred_GET", "description": "List the authenticated user's starred gists.", "operationId": "GistsStarred_GET", "parameters": [ { "name": "since", "in": "query", "description": "Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.\nOnly gists updated at or after this time are returned.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Is used to set specified media type.", "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-GitHub-Request-Id": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Limit": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Remaining": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Reset": { "content": { "text/plain": { "schema": { "type": "string" } } } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/gist1" }, "description": "OK" } } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n" } }, "deprecated": false } }, "/gists/{id}": { "delete": { "summary": "GistsById_DELETE", "description": "Delete a gist.", "operationId": "GistsById_DELETE", "parameters": [ { "name": "id", "in": "path", "description": "Id of gist.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept", "in": "header", "description": "Is used to set specified media type.", "style": "simple", "schema": { "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", "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-GitHub-Request-Id": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Limit": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Remaining": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Reset": { "content": { "text/plain": { "schema": { "type": "string" } } } } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n" } }, "deprecated": false }, "get": { "summary": "GistsById_GET", "description": "Get a single gist.", "operationId": "GistsById_GET", "parameters": [ { "name": "id", "in": "path", "description": "Id of gist.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept", "in": "header", "description": "Is used to set specified media type.", "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-GitHub-Request-Id": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Limit": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Remaining": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Reset": { "content": { "text/plain": { "schema": { "type": "string" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gist" } } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n" } }, "deprecated": false }, "patch": { "summary": "GistsById_PATCH", "description": "Edit a gist.", "operationId": "GistsById_PATCH", "parameters": [ { "name": "id", "in": "path", "description": "Id of gist.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept", "in": "header", "description": "Is used to set specified media type.", "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patchGist" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-GitHub-Request-Id": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Limit": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Remaining": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Reset": { "content": { "text/plain": { "schema": { "type": "string" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gist" } } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n" } }, "deprecated": false } }, "/gists/{id}/comments": { "get": { "summary": "GistsCommentsById_GET", "description": "List comments on a gist.", "operationId": "GistsCommentsById_GET", "parameters": [ { "name": "id", "in": "path", "description": "Id of gist.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept", "in": "header", "description": "Is used to set specified media type.", "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-GitHub-Request-Id": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Limit": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Remaining": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Reset": { "content": { "text/plain": { "schema": { "type": "string" } } } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/comments2" }, "description": "OK" } } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n" } }, "deprecated": false }, "post": { "summary": "GistsCommentsById_POST", "description": "Create a commen", "operationId": "GistsCommentsById_POST", "parameters": [ { "name": "id", "in": "path", "description": "Id of gist.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept", "in": "header", "description": "Is used to set specified media type.", "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/commentBody" } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-GitHub-Request-Id": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Limit": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Remaining": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Reset": { "content": { "text/plain": { "schema": { "type": "string" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n" } }, "deprecated": false } }, "/gists/{id}/comments/{commentId}": { "delete": { "summary": "GistsCommentsByIdAndCommentId_DELETE", "description": "Delete a comment.", "operationId": "GistsCommentsByIdAndCommentId_DELETE", "parameters": [ { "name": "id", "in": "path", "description": "Id of gist.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "commentId", "in": "path", "description": "Id of comment.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept", "in": "header", "description": "Is used to set specified media type.", "style": "simple", "schema": { "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", "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-GitHub-Request-Id": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Limit": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Remaining": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Reset": { "content": { "text/plain": { "schema": { "type": "string" } } } } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n" } }, "deprecated": false }, "get": { "summary": "GistsCommentsByIdAndCommentId_GET", "description": "Get a single comment.", "operationId": "GistsCommentsByIdAndCommentId_GET", "parameters": [ { "name": "id", "in": "path", "description": "Id of gist.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "commentId", "in": "path", "description": "Id of comment.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept", "in": "header", "description": "Is used to set specified media type.", "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-GitHub-Request-Id": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Limit": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Remaining": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Reset": { "content": { "text/plain": { "schema": { "type": "string" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n" } }, "deprecated": false }, "patch": { "summary": "GistsCommentsByIdAndCommentId_PATCH", "description": "Edit a comment.", "operationId": "GistsCommentsByIdAndCommentId_PATCH", "parameters": [ { "name": "id", "in": "path", "description": "Id of gist.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "commentId", "in": "path", "description": "Id of comment.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept", "in": "header", "description": "Is used to set specified media type.", "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-GitHub-Request-Id": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Limit": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Remaining": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Reset": { "content": { "text/plain": { "schema": { "type": "string" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n" } }, "deprecated": false } }, "/gists/{id}/forks": { "post": { "summary": "GistsForksById_POST", "description": "Fork a gist.", "operationId": "GistsForksById_POST", "parameters": [ { "name": "id", "in": "path", "description": "Id of gist.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept", "in": "header", "description": "Is used to set specified media type.", "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Exists.", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-GitHub-Request-Id": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Limit": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Remaining": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Reset": { "content": { "text/plain": { "schema": { "type": "string" } } } } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n" }, "404": { "description": "Not exists." } }, "deprecated": false } }, "/gists/{id}/star": { "delete": { "summary": "GistsStarById_DELETE", "description": "Unstar a gist.", "operationId": "GistsStarById_DELETE", "parameters": [ { "name": "id", "in": "path", "description": "Id of gist.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept", "in": "header", "description": "Is used to set specified media type.", "style": "simple", "schema": { "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", "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-GitHub-Request-Id": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Limit": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Remaining": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Reset": { "content": { "text/plain": { "schema": { "type": "string" } } } } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n" } }, "deprecated": false }, "get": { "summary": "GistsStarById_GET", "description": "Check if a gist is starred.", "operationId": "GistsStarById_GET", "parameters": [ { "name": "id", "in": "path", "description": "Id of gist.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept", "in": "header", "description": "Is used to set specified media type.", "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Exists.", "headers": { "X-GitHub-Media-Type": { "description": "You can check the current version of media type in responses.\n", "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-GitHub-Request-Id": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Limit": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Remaining": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "X-RateLimit-Reset": { "content": { "text/plain": { "schema": { "type": "string" } } } } } }, "403": { "description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n" }, "404": { "description": "No