openapi-to-graphql-lxwang2
Version:
Generates a GraphQL schema for a given OpenAPI Specification (OAS)
1,749 lines (1,748 loc) • 667 kB
JSON
{
"swagger": "2.0",
"schemes": ["https"],
"host": "api.github.com",
"basePath": "/",
"x-hasEquivalentPaths": true,
"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": "http://assets-cdn.github.com/images/modules/logos_page/GitHub-Mark.png"
},
"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": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/emojis"
}
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
}
},
"/events": {
"get": {
"description": "List public events.",
"parameters": [
{
"description": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/events"
}
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
}
},
"/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": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/feeds"
}
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
}
},
"/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": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/gists"
}
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
},
"post": {
"description": "Create a gist.",
"parameters": [
{
"description": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
},
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/postGist"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/gist"
}
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
}
},
"/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": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/gists"
}
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
}
},
"/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": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/gists"
}
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
}
},
"/gists/{id}": {
"delete": {
"description": "Delete a gist.",
"parameters": [
{
"description": "Id of gist.",
"in": "path",
"name": "id",
"required": true,
"type": "integer"
},
{
"description": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"204": {
"description": "No content.\n"
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
},
"get": {
"description": "Get a single gist.",
"parameters": [
{
"description": "Id of gist.",
"in": "path",
"name": "id",
"required": true,
"type": "integer"
},
{
"description": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/gist"
}
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
},
"patch": {
"description": "Edit a gist.",
"parameters": [
{
"description": "Id of gist.",
"in": "path",
"name": "id",
"required": true,
"type": "integer"
},
{
"description": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
},
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/patchGist"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/gist"
}
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
}
},
"/gists/{id}/comments": {
"get": {
"description": "List comments on a gist.",
"parameters": [
{
"description": "Id of gist.",
"in": "path",
"name": "id",
"required": true,
"type": "integer"
},
{
"description": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/comments"
}
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
},
"post": {
"description": "Create a commen",
"parameters": [
{
"description": "Id of gist.",
"in": "path",
"name": "id",
"required": true,
"type": "integer"
},
{
"description": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
},
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commentBody"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/comment"
}
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
}
},
"/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": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"204": {
"description": "No content.\n"
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
},
"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": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/comment"
}
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
},
"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": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
},
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/comment"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/comment"
}
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
}
},
"/gists/{id}/forks": {
"post": {
"description": "Fork a gist.",
"parameters": [
{
"description": "Id of gist.",
"in": "path",
"name": "id",
"required": true,
"type": "integer"
},
{
"description": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"204": {
"description": "Exists."
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
},
"404": {
"description": "Not exists."
}
}
}
},
"/gists/{id}/star": {
"delete": {
"description": "Unstar a gist.",
"parameters": [
{
"description": "Id of gist.",
"in": "path",
"name": "id",
"required": true,
"type": "integer"
},
{
"description": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"204": {
"description": "Item removed."
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
},
"get": {
"description": "Check if a gist is starred.",
"parameters": [
{
"description": "Id of gist.",
"in": "path",
"name": "id",
"required": true,
"type": "integer"
},
{
"description": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"204": {
"description": "Exists."
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
},
"404": {
"description": "Not exists."
}
}
},
"put": {
"description": "Star a gist.",
"parameters": [
{
"description": "Id of gist.",
"in": "path",
"name": "id",
"required": true,
"type": "integer"
},
{
"description": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"204": {
"description": "Starred."
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
}
},
"/gitignore/templates": {
"get": {
"description": "Listing available templates.\nList all templates available to pass as an option when creating a repository.\n",
"parameters": [
{
"description": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/gitignore"
}
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
}
},
"/gitignore/templates/{language}": {
"get": {
"description": "Get a single template.",
"parameters": [
{
"in": "path",
"name": "language",
"required": true,
"type": "string"
},
{
"description": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/gitignore-lang"
}
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
}
},
"/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": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/issues"
}
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
}
},
"/legacy/issues/search/{owner}/{repository}/{state}/{keyword}": {
"get": {
"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"
},
{
"in": "path",
"name": "owner",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "repository",
"required": true,
"type": "string"
},
{
"description": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/search-issues-by-keyword"
}
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
}
},
"/legacy/repos/search/{keyword}": {
"get": {
"description": "Find repositories by keyword. Note, this legacy method does not follow the v3 pagination pattern. This method returns up to 100 results per page and pages can be fetched using the start_page parameter.",
"parameters": [
{
"description": "The search term",
"in": "path",
"name": "keyword",
"required": true,
"type": "string"
},
{
"default": "desc",
"description": "The sort field. if sort param is provided. Can be either asc or desc.",
"enum": ["desc", "asc"],
"in": "query",
"name": "order",
"type": "string"
},
{
"description": "Filter results by language",
"in": "query",
"name": "language",
"type": "string"
},
{
"description": "The page number to fetch",
"in": "query",
"name": "start_page",
"type": "string"
},
{
"description": "The sort field. One of stars, forks, or updated. Default: results are sorted by best match.",
"enum": ["updated", "stars", "forks"],
"in": "query",
"name": "sort",
"type": "string"
},
{
"description": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/search-repositories-by-keyword"
}
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
}
},
"/legacy/user/email/{email}": {
"get": {
"description": "This API call is added for compatibility reasons only.",
"parameters": [
{
"description": "The email address",
"in": "path",
"name": "email",
"required": true,
"type": "string"
},
{
"description": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/search-user-by-email"
}
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
}
},
"/legacy/user/search/{keyword}": {
"get": {
"description": "Find users by keyword.",
"parameters": [
{
"description": "The search term",
"in": "path",
"name": "keyword",
"required": true,
"type": "string"
},
{
"default": "desc",
"description": "The sort field. if sort param is provided. Can be either asc or desc.",
"enum": ["desc", "asc"],
"in": "query",
"name": "order",
"type": "string"
},
{
"description": "The page number to fetch",
"in": "query",
"name": "start_page",
"type": "string"
},
{
"description": "The sort field. One of stars, forks, or updated. Default: results are sorted by best match.",
"enum": ["updated", "stars", "forks"],
"in": "query",
"name": "sort",
"type": "string"
},
{
"description": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/search-users-by-keyword"
}
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
}
},
"/markdown": {
"post": {
"description": "Render an arbitrary Markdown document",
"parameters": [
{
"description": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
},
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/markdown"
}
}
],
"produces": ["text/html"],
"responses": {
"200": {
"description": "OK"
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
}
},
"/markdown/raw": {
"post": {
"consumes": ["text/plain"],
"description": "Render a Markdown document in raw mode",
"parameters": [
{
"description": "You can check the current version of media type in responses.\n",
"in": "header",
"name": "X-GitHub-Media-Type",
"type": "string"
},
{
"description": "Is used to set specified media type.",
"in": "header",
"name": "Accept",
"type": "string"
},
{
"in": "header",
"name": "X-RateLimit-Limit",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Remaining",
"type": "integer"
},
{
"in": "header",
"name": "X-RateLimit-Reset",
"type": "integer"
},
{
"in": "header",
"name": "X-GitHub-Request-Id",
"type": "integer"
}
],
"produces": ["text/html"],
"responses": {
"200": {
"description": "OK"
},
"403": {
"description": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting\nfor details.\n"
}
}
}
},
"/meta": {
"get": {
"description": "This gives some information about GitHub.com, the service.",
"parameters": [
{
"description": "You can check the current version of media type in responses.\n",