UNPKG

swgg-github-users

Version:

this zero-dependency package will provide a (nodejs-compatible) swagger-client for github-users's web-apis, with a working web-demo

1,082 lines 395 kB
{ "basePath": "/", "definitions": { "_2Fuser_20PATCH.body": { "properties": { "bio": { "default": "There once...", "type": "string", "x-swgg-descriptionLineList": [ "The new short biography of the user." ] }, "blog": { "default": "https://github.com/blog", "type": "string", "x-swgg-descriptionLineList": [ "The new blog URL of the user." ] }, "company": { "default": "GitHub", "type": "string", "x-swgg-descriptionLineList": [ "The new company of the user." ] }, "email": { "default": "octocat@github.com", "type": "string", "x-swgg-descriptionLineList": [ "The publicly visible email address of the user." ] }, "hireable": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "The new hiring availability of the user." ] }, "location": { "default": "San Francisco", "type": "string", "x-swgg-descriptionLineList": [ "The new location of the user." ] }, "name": { "default": "monalisa octocat", "type": "string", "x-swgg-descriptionLineList": [ "The new name of the user." ] } }, "x-swgg-tags0": "github-users" }, "_2Fuser_2Femail_2Fvisibility_20PATCH.body": { "properties": { "email": { "default": "octocat@github.com", "type": "string", "x-swgg-descriptionLineList": [ "**Required**. Specify the primary email address that needs a visibility change." ] }, "visibility": { "default": "public", "type": "string", "x-swgg-descriptionLineList": [ "**Required**. Use ```public``` to enable an authenticated user to view the specified email address, or use ```private``` so this primary email address cannot be seen publicly." ] } }, "required": [ "email", "visibility" ], "x-swgg-tags0": "github-users" }, "_2Fuser_2Fgpg_keys_20POST.body": { "properties": { "armored_public_key": { "default": "-----BEGIN PGP PUBLIC KEY BLOCK-----\n...\n-----END PGP PUBLIC KEY BLOCK-----", "type": "string" } }, "x-swgg-tags0": "github-users" }, "_2Fuser_2Fkeys_20POST.body": { "properties": { "key": { "default": "ssh-rsa AAA...", "type": "string" }, "title": { "default": "octocat@octomac", "type": "string" } }, "x-swgg-tags0": "github-users" } }, "info": { "title": "swgg-github-users", "version": "2018.4.21", "x-swgg-description": "this zero-dependency package will provide a (nodejs-compatible) swagger-client for github-users's web-apis, with a working web-demo", "x-swgg-homepage": "https://github.com/kaizhu256/node-swgg-github-users" }, "parameters": { "github-all.key": { "default": "xxxxxxxx", "in": "query", "name": "access_token", "type": "string", "x-swgg-apiKey": true, "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/#authentication", "", "OAuth2 token (sent as a parameter)" ] }, "github-all.user-agent": { "default": "Awesome-Octocat-App", "in": "header", "name": "user-agent", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/index.html#user-agent-required", "", "All API requests MUST include a valid ```User-Agent``` header. Requests with no ```User-Agent``` header will be rejected. We request that you use your GitHub username, or the name of your application, for the ```User-Agent``` header value. This allows us to contact you if there are problems." ] } }, "paths": { "/user": { "get": { "operationId": "_2Fuser_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hagar-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.hagar-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "[Users](https://developer.github.com/v3/users/#get-the-authenticated-user) - Get the authenticated user" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Users](https://developer.github.com/v3/users/#get-the-authenticated-user) - Get the authenticated user", "x-swgg-tags0": "github-users" }, "patch": { "operationId": "_2Fuser_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hagar-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.hagar-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Fuser_20PATCH.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "[Users](https://developer.github.com/v3/users/#update-the-authenticated-user) - Update the authenticated user" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Users](https://developer.github.com/v3/users/#update-the-authenticated-user) - Update the authenticated user", "x-swgg-tags0": "github-users" } }, "/user/blocks": { "get": { "operationId": "_2Fuser_2Fblocks_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.giant-sentry-fist-preview+json" ], "enum": [ "application/vnd.github.giant-sentry-fist-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "[Block Another User](https://developer.github.com/v3/users/blocking/#list-blocked-users) - List blocked users", "", "List the users you've blocked on your personal account." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Block Another User](https://developer.github.com/v3/users/blocking/#list-blocked-users) - List blocked users", "x-swgg-tags0": "github-users" } }, "/user/blocks/{username}": { "delete": { "operationId": "_2Fuser_2Fblocks_2F_7Busername_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.giant-sentry-fist-preview+json" ], "enum": [ "application/vnd.github.giant-sentry-fist-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "username", "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "[Block Another User](https://developer.github.com/v3/users/blocking/#unblock-a-user) - Unblock a user" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Block Another User](https://developer.github.com/v3/users/blocking/#unblock-a-user) - Unblock a user", "x-swgg-tags0": "github-users" }, "get": { "operationId": "_2Fuser_2Fblocks_2F_7Busername_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.giant-sentry-fist-preview+json" ], "enum": [ "application/vnd.github.giant-sentry-fist-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "username", "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "[Block Another User](https://developer.github.com/v3/users/blocking/#check-whether-youve-blocked-a-user) - Check whether you've blocked a user" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Block Another User](https://developer.github.com/v3/users/blocking/#check-whether-youve-blocked-a-user) - Check whether you've blocked a user", "x-swgg-tags0": "github-users" }, "put": { "operationId": "_2Fuser_2Fblocks_2F_7Busername_7D_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.giant-sentry-fist-preview+json" ], "enum": [ "application/vnd.github.giant-sentry-fist-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "username", "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "[Block Another User](https://developer.github.com/v3/users/blocking/#block-a-user) - Block a user" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Block Another User](https://developer.github.com/v3/users/blocking/#block-a-user) - Block a user", "x-swgg-tags0": "github-users" } }, "/user/email/visibility": { "patch": { "operationId": "_2Fuser_2Femail_2Fvisibility_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Fuser_2Femail_2Fvisibility_20PATCH.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "[User Emails](https://developer.github.com/v3/users/emails/#toggle-primary-email-visibility) - Toggle primary email visibility", "", "Sets the visibility for your primary email addresses." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[User Emails](https://developer.github.com/v3/users/emails/#toggle-primary-email-visibility) - Toggle primary email visibility", "x-swgg-tags0": "github-users" } }, "/user/emails": { "delete": { "operationId": "_2Fuser_2Femails_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "[User Emails](https://developer.github.com/v3/users/emails/#delete-email-addresses) - Delete email address(es)" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[User Emails](https://developer.github.com/v3/users/emails/#delete-email-addresses) - Delete email address(es)", "x-swgg-tags0": "github-users" }, "get": { "operationId": "_2Fuser_2Femails_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "[User Emails](https://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user) - List email addresses for a user", "", "Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the ```user:email``` scope." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[User Emails](https://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user) - List email addresses for a user", "x-swgg-tags0": "github-users" }, "post": { "operationId": "_2Fuser_2Femails_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "[User Emails](https://developer.github.com/v3/users/emails/#add-email-addresses) - Add email address(es)" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[User Emails](https://developer.github.com/v3/users/emails/#add-email-addresses) - Add email address(es)", "x-swgg-tags0": "github-users" } }, "/user/following/{username}": { "delete": { "operationId": "_2Fuser_2Ffollowing_2F_7Busername_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "username", "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "[User Followers](https://developer.github.com/v3/users/followers/#unfollow-a-user) - Unfollow a user" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[User Followers](https://developer.github.com/v3/users/followers/#unfollow-a-user) - Unfollow a user", "x-swgg-tags0": "github-users" }, "get": { "operationId": "_2Fuser_2Ffollowing_2F_7Busername_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "username", "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "[User Followers](https://developer.github.com/v3/users/followers/#check-if-you-are-following-a-user) - Check if you are following a user" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[User Followers](https://developer.github.com/v3/users/followers/#check-if-you-are-following-a-user) - Check if you are following a user", "x-swgg-tags0": "github-users" }, "put": { "operationId": "_2Fuser_2Ffollowing_2F_7Busername_7D_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "username", "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "[User Followers](https://developer.github.com/v3/users/followers/#follow-a-user) - Follow a user" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[User Followers](https://developer.github.com/v3/users/followers/#follow-a-user) - Follow a user", "x-swgg-tags0": "github-users" } }, "/user/gpg_keys": { "get": { "operationId": "_2Fuser_2Fgpg_keys_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "[User GPG Keys](https://developer.github.com/v3/users/gpg_keys/#list-your-gpg-keys) - List your GPG keys" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[User GPG Keys](https://developer.github.com/v3/users/gpg_keys/#list-your-gpg-keys) - List your GPG keys", "x-swgg-tags0": "github-users" }, "post": { "operationId": "_2Fuser_2Fgpg_keys_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Fuser_2Fgpg_keys_20POST.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "[User GPG Keys](https://developer.github.com/v3/users/gpg_keys/#create-a-gpg-key) - Create a GPG key", "", "Creates a GPG key. Requires that you are authenticated via Basic Auth, or OAuth with at least ```write:gpg_key``` [scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/)." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[User GPG Keys](https://developer.github.com/v3/users/gpg_keys/#create-a-gpg-key) - Create a GPG key", "x-swgg-tags0": "github-users" } }, "/user/gpg_keys/{id}": { "delete": { "operationId": "_2Fuser_2Fgpg_keys_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "[User GPG Keys](https://developer.github.com/v3/users/gpg_keys/#delete-a-gpg-key) - Delete a GPG key", "", "Removes a GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least ```admin:gpg_key``` [scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/)." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[User GPG Keys](https://developer.github.com/v3/users/gpg_keys/#delete-a-gpg-key) - Delete a GPG key", "x-swgg-tags0": "github-users" }, "get": { "operationId": "_2Fuser_2Fgpg_keys_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "[User GPG Keys](https://developer.github.com/v3/users/gpg_keys/#get-a-single-gpg-key) - Get a single GPG key", "", "View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least ```read:gpg_key``` [scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/)." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[User GPG Keys](https://developer.github.com/v3/users/gpg_keys/#get-a-single-gpg-key) - Get a single GPG key", "x-swgg-tags0": "github-users" } }, "/user/keys": { "get": { "operationId": "_2Fuser_2Fkeys_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "[User Public Keys](https://developer.github.com/v3/users/keys/#list-your-public-keys) - List your public keys" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg