SQLite format 3 @ � � � .zp
� � ��
�
� 9 �
� � �
^ �+
QQ�Atablesemantic_endpoints_vector_chunks00semantic_endpoints_vector_chunks00
CREATE TABLE "semantic_endpoints_vector_chunks00"(rowid PRIMARY KEY,vectors BLOB NOT NULL)c wQ indexsqlite_autoindex_semantic_endpoints_vector_chunks00_1semantic_endpoints_vector_chunks00 �N??�+tablesemantic_endpoints_rowidssemantic_endpoints_rowidsCREATE TABLE "semantic_endpoints_rowids"(rowid INTEGER PRIMARY KEY AUTOINCREMENT,id TEXT UNIQUE NOT NULL,chunk_id INTEGER,chunk_offset INTEGER)Q e? indexsqlite_autoindex_semantic_endpoints_rowids_1semantic_endpoints_rowids P++Ytablesqlite_sequencesqlite_sequenceCREATE TABLE sqlite_sequence(name,seq)�U??�9tablesemantic_endpoints_chunkssemantic_endpoints_chunksCREATE TABLE "semantic_endpoints_chunks"(chunk_id INTEGER PRIMARY KEY AUTOINCREMENT,size INTEGER NOT NULL,validity BLOB NOT NULL,rowids BLOB NOT NULL)�;;� tablesemantic_endpoints_infosemantic_endpoints_infoCREATE TABLE "semantic_endpoints_info" (key text primary key, value any)Ma; indexsqlite_autoindex_semantic_endpoints_info_1semantic_endpoints_info�!11�otablesemantic_endpointssemantic_endpointsCREATE VIRTUAL TABLE semantic_endpoints USING vec0(
operation_id TEXT PRIMARY KEY,
embedding FLOAT[768]
)�8 �?tableendpointsendpointsCREATE TABLE endpoints (
operation_id TEXT PRIMARY KEY,
path TEXT NOT NULL,
method TEXT NOT NULL,
summary TEXT,
description TEXT,
input_schema TEXT NOT NULL,
output_schema TEXT NOT NULL,
auth_scheme_ref TEXT
)1E indexsqlite_autoindex_endpoints_1endpoints � ��������������������������~ytoje`ZTNHB<60*$ ���������������������|vpjd^XRLF@:4.("
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
z
t
n
h
b
\
V
P
J
D
>
8
2
,
&
� � � � � � � � � � � � � � � � � � � � � ~ x r l f ` Z T N H B < 6 0 * $ � � � � � � � � � � � � � � � � � � � � � | v p j d ^ X R L F @ : 4 . ( " �D W%5
�'�3/enterprise-admin/list-global-webhooks/admin/hooksGETList global webhooks{"parameters":[{"description":"This API is under preview and subject to change.","in":"header","name":"accept","required":true,"schema":{"default":"application/vnd.github.superpro-preview+json","type":"string"},"style":"simple"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/global-hook-items"}},"schema":{"items":{"$ref":"#/components/schemas/global-hook"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�F +�U�_/meta/root/GETGitHub API RootGet Hypermedia links to resources accessible in GitHub's REST API{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"properties":{"authorizations_url":{"format":"uri-template","type":"string"},"code_search_url":{"format":"uri-template","type":"string"},"commit_search_url":{"format":"uri-template","type":"string"},"current_user_authorizations_html_url":{"format":"uri-template","type":"string"},"current_user_repositories_url":{"format":"uri-template","type":"string"},"current_user_url":{"format":"uri-template","type":"string"},"emails_url":{"format":"uri-template","type":"string"},"emojis_url":{"format":"uri-template","type":"string"},"events_url":{"format":"uri-template","type":"string"},"feeds_url":{"format":"uri-template","type":"string"},"followers_url":{"format":"uri-template","type":"string"},"following_url":{"format":"uri-template","type":"string"},"gists_url":{"format":"uri-template","type":"string"},"hub_url":{"format":"uri-template","type":"string"},"issue_search_url":{"format":"uri-template","type":"string"},"issues_url":{"format":"uri-template","type":"string"},"keys_url":{"format":"uri-template","type":"string"},"label_search_url":{"format":"uri-template","type":"string"},"notifications_url":{"format":"uri-template","type":"string"},"organization_repositories_url":{"format":"uri-template","type":"string"},"organization_teams_url":{"format":"uri-template","type":"string"},"organization_url":{"format":"uri-template","type":"string"},"public_gists_url":{"format":"uri-template","type":"string"},"rate_limit_url":{"for �� ��} ��w ��s ��n �j �e �` �_ ��] �Y �U �S �Q �O �K �F �C �@ �> �< �: �7 �6 �5 ��3 ߄1 ބ/ ݄- ܄* ۄ( ڄ% ل# ! ք Մ Ԅ ӄ ҄ ф Є τ ΄ ̈́ ̄
˄ ʄ Ʉ ȃ ǃ{ ƃy Ńu ăp Ãn k ��h ��c ��` ��] ��Z ��X ��W ��T ��P ��O ��M ��I ��C ��A ��= ��9 ��5 ��1 ��- ��) ��% ��! �� �� �� �� �� �� �� �� �� �� �� �� �� ��} ��{ ��z ��y ��u ��r ��q ��p ��m ��k ��j ��i ��h ��g ��d ��b ��a ��` ��] ��\ ��Y ��T ��R ��P �O ~�N }�L |�I {�G z�E x�D u�B t�@ s�> r�< q�: p�8 o�5 n�2 l�/ k�+ j�) i�% g�" f� e� d� c� b� a� `� _� ^� \� [�{ Z�w Y�t X�q W�n V�j U�f T�d S�c R�` Q�] P�\ O�[ N�X M�V L�T K�Q J�N I�K H�I G�F D�D C�? B�; A�7 @�4 ?�0 >�. =�+ <�& :�# 9� 8� 7� 6� 5� 3�
2� 1� 0� /{ .x -v ,p +j *e )a (] %X $T #P "L !@ < : 9 7 4 1 . , * ' $
l ��W��x� � ���[ -
����
8
�
: �]
�K
� � o��
�~W v����Z
�.
��@
n ��� �P� � eH
� x
� � B�
o�C_����q�1 E�
enterprise-admin/set-self-hosted-runners-in-group-for-enterpriseWF�enterprise-admin/list-self-hosted-runners-in-group-for-enterpriseVQ�%enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterpriseUN� enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterpriseTN� enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterpriseSO�!enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterpriseRD� enterprise-admin/update-self-hosted-runner-group-for-enterpriseQE�
enterprise-admin/delete-self-hosted-runner-group-from-enterprisePA�enterprise-admin/get-self-hosted-runner-group-for-enterpriseOD� enterprise-admin/create-self-hosted-runner-group-for-enterpriseNC� enterprise-admin/list-self-hosted-runner-groups-for-enterpriseM#Kenterprise-admin/get-user-statsL#Kenterprise-admin/get-repo-statsK+[enterprise-admin/get-pull-request-statsJ$Menterprise-admin/get-pages-statsI"Ienterprise-admin/get-org-statsH(Uenterprise-admin/get-milestone-statsG$Menterprise-admin/get-issue-statsF$Menterprise-admin/get-hooks-statsEA�enterprise-admin/get-all-stats (GET /enterprise/stats/gists)D&Qenterprise-admin/get-comment-statsC"Ienterprise-admin/get-all-statsB,]enterprise-admin/get-license-informationA!emojis/get@%Ocodes-of-conduct/get-conduct-code?-_codes-of-conduct/get-all-codes-of-conduct>-_oauth-authorizations/update-authorization=-_oauth-authorizations/delete-authorization<*Yoauth-authorizations/get-authorization;M� oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint:<}oauth-authorizations/get-or-create-authorization-for-app9-_oauth-authorizations/create-authorization8,]oauth-authorizations/list-authorizations7-apps/get-by-slug6-_apps/revoke-authorization-for-application5 =apps/reset-authorization4 =apps/check-authorization3-apps/reset-token2/apps/delete-token1-apps/check-token0%Oapps/revoke-grant-for-application/ ?apps/delete-authorization.%Ooauth-authorizations/delete-grant-"Ioauth-authorizations/get-grant,$Moauth-authorizations/list-grants+ Capps/unsuspend-installation* ?apps/suspend-installation))Wapps/create-installation-access-token( =apps/delete-installation'7apps/get-installation&;apps/list-installations% ?apps/create-from-manifest$9apps/get-authenticated#6qenterprise-admin/delete-impersonation-o-auth-token"6qenterprise-admin/create-impersonation-o-auth-token!-_enterprise-admin/update-username-for-user Eenterprise-admin/delete-user Eenterprise-admin/create-user 1genterprise-admin/delete-personal-access-token 0eenterprise-admin/list-personal-access-tokens ,]enterprise-admin/update-pre-receive-hook,]enterprise-admin/delete-pre-receive-hook)Wenterprise-admin/get-pre-receive-hook,]enterprise-admin/create-pre-receive-hook+[enterprise-admin/list-pre-receive-hooksE�
enterprise-admin/get-download-status-for-pre-receive-environment;{enterprise-admin/start-pre-receive-environment-download3kenterprise-admin/update-pre-receive-environment3kenterprise-admin/delete-pre-receive-environment0eenterprise-admin/get-pre-receive-environment3kenterprise-admin/create-pre-receive-environment2ienterprise-admin/list-pre-receive-environments$Menterprise-admin/update-org-name Centerprise-admin/create-org/centerprise-admin/sync-ldap-mapping-for-user
1genterprise-admin/update-ldap-mapping-for-user /centerprise-admin/sync-ldap-mapping-for-team 1genterprise-admin/update-ldap-mapping-for-team
&Qenterprise-admin/delete-public-key %Oenterprise-admin/list-p 'O�!enter '0ee 'O�!enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterpriseR E%licenses/get{ ?repo � ;teams/list-child-legacyA � ;repos/list-contributorsl m Areactions/delete-for-issue� & =apps/check-authorization3.
� ���� 5CREATE_VERSION_PATCH 5 CREATE_VERSION_MINOR5CREATE_VERSION_MAJOR)CREATE_VERSIONv0.1.9
� ���� 5CREATE_VERSION_PATCH5CREATE_VERSION_MINOR5CREATE_VERSION_MAJOR) CREATE_VERSION
� �� �D W%5
�'�3/enterprise-admin/list-global-webhooks/admin/hooksGETList global webhooks{"parameters":[{"description":"This API is under preview and subject to change.","in":"header","name":"accept","required":true,"schema":{"default":"application/vnd.github.superpro-preview+json","type":"string"},"style":"simple"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/global-hook-items"}},"schema":{"items":{"$ref":"#/components/schemas/global-hook"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�F +�U�_/meta/root/GETGitHub API RootGet Hypermedia links to resources accessible in GitHub's REST API{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"properties":{"authorizations_url":{"format":"uri-template","type":"string"},"code_search_url":{"format":"uri-template","type":"string"},"commit_search_url":{"format":"uri-template","type":"string"},"current_user_authorizations_html_url":{"format":"uri-template","type":"string"},"current_user_repositories_url":{"format":"uri-template","type":"string"},"current_user_url":{"format":"uri-template","type":"string"},"emails_url":{"format":"uri-template","type":"string"},"emojis_url":{"format":"uri-template","type":"string"},"events_url":{"format":"uri-template","type":"string"},"feeds_url":{"format":"uri-template","type":"string"},"followers_url":{"format":"uri-template","type":"string"},"following_url":{"format":"uri-template","type":"string"},"gists_url":{"format":"uri-template","type":"string"},"hub_url":{"format":"uri-template","type":"string"},"issue_search_url":{"format":"uri-template","type":"string"},"issues_url":{"format":"uri-template","type":"string"},"keys_url":{"format":"uri-template","type":"string"},"label_search_url":{"format":"uri-template","type":"string"},"notifications_url":{"format":"uri-template","type":"string"},"organization_repositories_url":{"format":"uri-template","type":"string"},"organization_teams_url":{"format":"uri-template","type":"string"},"organization_url":{"format":"uri-template","type":"string"},"public_gists_url":{"format":"uri-template","type":"string"},"rate_limit_url":{"format":"uri-template","type":"string"},"repository_search_url":{"format":"uri-template","type":"string"},"repository_url":{"format":"uri-template","type":"string"},"starred_gists_url":{"format":"uri-template","type":"string"},"starred_url":{"format":"uri-template","type":"string"},"topic_search_url":{"format":"uri-template","type":"string"},"user_organizations_url":{"format":"uri-template","type":"string"},"user_repositories_url":{"format":"uri-template","type":"string"},"user_search_url":{"format":"uri-template","type":"string"},"user_url":{"format":"uri-template","type":"string"}},"required":["current_user_url","current_user_authorizations_html_url","authorizations_url","code_search_url","commit_search_url","emails_url","emojis_url","events_url","feeds_url","followers_url","following_url","gists_url","hub_url","issue_search_url","issues_url","keys_url","label_search_url","notifications_url","organization_url","organization_repositories_url","organization_teams_url","public_gists_url","rate_limit_url","repository_url","repository_search_url","current_user_repositories_url","starred_url","starred_gists_url","user_url","user_organizations_url","user_repositories_url","user_search_url"],"type":"object"}}},"description":"Response"}}GitHubBearerToken
� ��� �:
Y9;
�UQ/enterprise-admin/delete-global-webhook/admin/hooks/{hook_id}DELETEDelete a global webhook{"parameters":[{"description":"This API is under preview and subject to change.","in":"header","name":"accept","required":true,"schema":{"default":"application/vnd.github.superpro-preview+json","type":"string"},"style":"simple"},{"$ref":"#/components/parameters/hook-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�L S95
�U�/enterprise-admin/get-global-webhook/admin/hooks/{hook_id}GETGet a global webhook{"parameters":[{"description":"This API is under preview and subject to change.","in":"header","name":"accept","required":true,"schema":{"default":"application/vnd.github.superpro-preview+json","type":"string"},"style":"simple"},{"$ref":"#/components/parameters/hook-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/global-hook"}},"schema":{"$ref":"#/components/schemas/global-hook"}}},"description":"Response"}}GitHubBearerToken�( Y%;
��/enterprise-admin/create-global-webhook/admin/hooksPOSTCreate a global webhook{"parameters":[{"description":"This API is under preview and subject to change.","in":"header","name":"accept","required":true,"schema":{"default":"application/vnd.github.superpro-preview+json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":{"config":{"content_type":"json","secret":"secret","url":"https://example.com/webhook"},"events":["organization","user"],"name":"web"},"schema":{"properties":{"active":{"default":true,"description":"Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.","type":"boolean"},"config":{"description":"Key/value pairs to provide settings for this webhook.","properties":{"content_type":{"description":"The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.","type":"string"},"insecure_ssl":{"description":"Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**","type":"string"},"secret":{"description":"If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads/#delivery-headers) header.","type":"string"},"url":{"description":"The URL to which the payloads will be delivered.","type":"string"}},"required":["url"],"type":"object"},"events":{"description":"The [events](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.","items":{"type":"string"},"type":"array"},"name":{"description":"Must be passed as \"web\".","type":"string"}},"required":["name","config"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/global-hook"}},"schema":{"$ref":"#/components/schemas/global-hook"}}},"description":"Response"}}GitHubBearerToken
� ��j � �[
Q73
�)Q/enterprise-admin/delete-public-key/admin/keys/{key_ids}DELETEDelete a public key{"parameters":[{"$ref":"#/components/parameters/key-ids"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�0 O#-
�u�O/enterprise-admin/list-public-keys/admin/keysGETList public keys{"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/direction"},{"in":"query","name":"sort","schema":{"default":"created","enum":["created","updated","accessed"],"type":"string"},"style":"form"},{"description":"Only show public keys accessed after the given time.","in":"query","name":"since","schema":{"type":"string"},"style":"form"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/enterprise-public-key-items"}},"schema":{"items":{"$ref":"#/components/schemas/public-key-full"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�; UE7�
�UQ/enterprise-admin/ping-global-webhook/admin/hooks/{hook_id}/pingsPOSTPing a global webhookThis will trigger a [ping event](https://docs.github.com/enterprise-server@2.22/webhooks/#ping-event) to be sent to the webhook.{"parameters":[{"description":"This API is under preview and subject to change.","in":"header","name":"accept","required":true,"schema":{"default":"application/vnd.github.superpro-preview+json","type":"string"},"style":"simple"},{"$ref":"#/components/parameters/hook-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�" Y9;�e��
/enterprise-admin/update-global-webhook/admin/hooks/{hook_id}PATCHUpdate a global webhookParameters that are not provided will be overwritten with the default value or removed if no default exists.{"parameters":[{"description":"This API is under preview and subject to change.","in":"header","name":"accept","required":true,"schema":{"default":"application/vnd.github.superpro-preview+json","type":"string"},"style":"simple"},{"$ref":"#/components/parameters/hook-id"}],"requestBody":{"content":{"application/json":{"example":{"config":{"url":"https://example.com/webhook"},"events":["organization"]},"schema":{"properties":{"active":{"default":true,"description":"Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.","type":"boolean"},"config":{"description":"Key/value pairs to provide settings for this webhook.","properties":{"content_type":{"description":"The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.","type":"string"},"insecure_ssl":{"description":"Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**","type":"string"},"secret":{"description":"If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads/#delivery-headers) header.","type":"string"},"url":{"description":"The URL to which the payloads will be delivered.","type":"string"}},"required":["url"],"type":"object"},"events":{"description":"The [events](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.","items":{"type":"string"},"type":"array"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/global-hook-2"}},"schema":{"$ref":"#/components/schemas/global-hook-2"}}},"description":"Response"}}GitHubBearerToken
�
���� � � C59
�a�%/enterprise-admin/create-org/admin/organizationsPOSTCreate an organization{"parameters":[],"requestBody":{"content":{"application/json":{"example":{"admin":"monalisaoctocat","login":"github","profile_name":"GitHub, Inc."},"schema":{"properties":{"admin":{"description":"The login of the user who will manage this organization.","type":"string"},"login":{"description":"The organization's username.","type":"string"},"profile_name":{"description":"The organization's display name.","type":"string"}},"required":["login","admin"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/organization-simple"}},"schema":{"$ref":"#/components/schemas/organization-simple"}}},"description":"Response"}}GitHubBearerToken�5
cOE�{�+�Y/enterprise-admin/sync-ldap-mapping-for-user/admin/ldap/users/{username}/syncPOSTSync LDAP mapping for a userNote that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready.{"parameters":[{"$ref":"#/components/parameters/username"}],"requestBody":null}{"201":{"content":{"application/json":{"example":{"status":"queued"},"schema":{"properties":{"status":{"type":"string"}},"type":"object"}}},"description":"Response"}}GitHubBearerToken�g gUI
�+� /enterprise-admin/update-ldap-mapping-for-user/admin/ldap/users/{username}/mappingPATCHUpdate LDAP mapping for a user{"parameters":[{"$ref":"#/components/parameters/username"}],"requestBody":{"content":{"application/json":{"example":{"ldap_dn":"uid=asdf,ou=users,dc=github,dc=com"},"schema":{"properties":{"ldap_dn":{"description":"The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.","type":"string"}},"required":["ldap_dn"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/ldap-mapping-user"}},"schema":{"$ref":"#/components/schemas/ldap-mapping-user"}}},"description":"Response"}}GitHubBearerToken�3 cME�{�)�Y/enterprise-admin/sync-ldap-mapping-for-team/admin/ldap/teams/{team_id}/syncPOSTSync LDAP mapping for a teamNote that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready.{"parameters":[{"$ref":"#/components/parameters/team-id"}],"requestBody":null}{"201":{"content":{"application/json":{"example":{"status":"queued"},"schema":{"properties":{"status":{"type":"string"}},"type":"object"}}},"description":"Response"}}GitHubBearerToken�
gSI�7�;� /enterprise-admin/update-ldap-mapping-for-team/admin/ldap/teams/{team_id}/mappingPATCHUpdate LDAP mapping for a teamUpdates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://help.github.com/enterprise/admin/guides/user-management/using-ldap/#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@2.22/rest/reference/teams/#create-a-team) endpoint to create a team with LDAP mapping.
If you pass the `hellcat-preview` media type, you can also update the LDAP mapping of a child team.{"parameters":[{"$ref":"#/components/parameters/team-id"}],"requestBody":{"content":{"application/json":{"example":{"ldap_dn":"cn=Enterprise Ops,ou=teams,dc=github,dc=com"},"schema":{"properties":{"ldap_dn":{"description":"The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.","type":"string"}},"required":["ldap_dn"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/ldap-mapping-team"}},"schema":{"$ref":"#/components/schemas/ldap-mapping-team"}}},"description":"Response"}}GitHubBearerToken
6
-
�i�6 �S
k�M��O�/enterprise-admin/delete-pre-receive-environment/admin/pre-receive-environments/{pre_receive_environment_id}DELETEDelete a pre-receive environmentIf you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response.
The possible error messages are:
* _Cannot modify or delete the default environment_
* _Cannot delete environment that has hooks_
* _Cannot delete environment when download is in progress_{"parameters":[{"$ref":"#/components/parameters/pre-receive-environment-id"}],"requestBody":null}{"204":{"description":"Response"},"422":{"content":{"application/json":{"examples":{"client-errors":{"value":{"errors":[{"code":"custom","message":"Cannot modify or delete the default environment","resource":"PreReceiveEnvironment"}],"message":"Validation Failed"}}},"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"},"resource":{"type":"string"}},"type":"object"},"type":"array"},"message":{"type":"string"}},"type":"object"}}},"description":"Client Errors"}}GitHubBearerToken�Z e�G
�O�5/enterprise-admin/get-pre-receive-environment/admin/pre-receive-environments/{pre_receive_environment_id}GETGet a pre-receive environment{"parameters":[{"$ref":"#/components/parameters/pre-receive-environment-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pre-receive-environment"}},"schema":{"$ref":"#/components/schemas/pre-receive-environment"}}},"description":"Response"}}GitHubBearerToken� kKM
��5/enterprise-admin/create-pre-receive-environment/admin/pre-receive-environmentsPOSTCreate a pre-receive environment{"parameters":[],"requestBody":{"content":{"application/json":{"example":{"image_url":"https://my_file_server/path/to/devtools_env.tar.gz","name":"DevTools Hook Env"},"schema":{"properties":{"image_url":{"description":"URL from which to download a tarball of this environment.","type":"string"},"name":{"description":"The new pre-receive environment's name.","type":"string"}},"required":["name","image_url"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pre-receive-environment"}},"schema":{"$ref":"#/components/schemas/pre-receive-environment"}}},"description":"Response"}}GitHubBearerToken� iKG
�S�s/enterprise-admin/list-pre-receive-environments/admin/pre-receive-environmentsGETList pre-receive environments{"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/direction"},{"in":"query","name":"sort","schema":{"default":"created","enum":["created","updated","name"],"type":"string"},"style":"form"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pre-receive-environment-items"}},"schema":{"items":{"$ref":"#/components/schemas/pre-receive-environment"},"type":"array"}}},"description":"Response"}}GitHubBearerToken�P MAC
�W�w/enterprise-admin/update-org-name/admin/organizations/{org}PATCHUpdate an organization name{"parameters":[{"$ref":"#/components/parameters/org"}],"requestBody":{"content":{"application/json":{"example":{"login":"the-new-octocats"},"schema":{"properties":{"login":{"description":"The organization's new name.","type":"string"}},"required":["login"],"type":"object"}}},"required":true}}{"202":{"content":{"application/json":{"example":{"message":"Job queued to rename organization. It may take a few minutes to complete.","url":"https://<hostname>/api/v3/organizations/1"},"schema":{"properties":{"message":{"type":"string"},"url":{"type":"string"}},"type":"object"}}},"description":"Response"}}GitHubBearerToken
�
��� �x�
�'w� �O�u/enterprise-admin/get-download-status-for-pre-receive-environment/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latestGETGet the download status for a pre-receive environmentIn addition to seeing the download status at the "[Get a pre-receive environment](#get-a-pre-receive-environment)" endpoint, there is also this separate endpoint for just the download status.{"parameters":[{"$ref":"#/components/parameters/pre-receive-environment-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pre-receive-environment-download-status"}},"schema":{"$ref":"#/components/schemas/pre-receive-environment-download-status"}}},"description":"Response"}}GitHubBearerToken�U
{�]�i�O� /enterprise-admin/start-pre-receive-environment-download/admin/pre-receive-environments/{pre_receive_environment_id}/downloadsPOSTStart a pre-receive environment downloadTriggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment.
If a download cannot be triggered, you will receive a `422 Unprocessable Entity` response.
The possible error messages are:
* _Cannot modify or delete the default environment_
* _Can not start a new download when a download is in progress_{"parameters":[{"$ref":"#/components/parameters/pre-receive-environment-id"}],"requestBody":null}{"202":{"content":{"application/json":{"examples":{"default-response":{"$ref":"#/components/examples/pre-receive-environment-download-status-default-response"}},"schema":{"$ref":"#/components/schemas/pre-receive-environment-download-status"}}},"description":"Response"},"422":{"content":{"application/json":{"examples":{"client-errors":{"value":{"errors":[{"code":"custom","message":"Can not start a new download when a download is in progress","resource":"PreReceiveEnvironment"}],"message":"Validation Failed"}}},"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"},"resource":{"type":"string"}},"type":"object"},"type":"array"},"message":{"type":"string"}},"type":"object"}}},"description":"Client Errors"}}GitHubBearerToken�x
k�M�5�S�3/enterprise-admin/update-pre-receive-environment/admin/pre-receive-environments/{pre_receive_environment_id}PATCHUpdate a pre-receive environmentYou cannot modify the default environment. If you attempt to modify the default environment, you will receive a `422 Unprocessable Entity` response.{"parameters":[{"$ref":"#/components/parameters/pre-receive-environment-id"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"image_url":{"description":"URL from which to download a tarball of this environment.","type":"string"},"name":{"description":"This pre-receive environment's new name.","type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default-response":{"$ref":"#/components/examples/pre-receive-environment-default-response"}},"schema":{"$ref":"#/components/schemas/pre-receive-environment"}}},"description":"Response"},"422":{"content":{"application/json":{"examples":{"client-errors":{"value":{"errors":[{"code":"custom","message":"Cannot modify or delete the default environment","resource":"PreReceiveEnvironment"}],"message":"Validation Failed"}}},"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"},"resource":{"type":"string"}},"type":"object"},"type":"array"},"message":{"type":"string"}},"type":"object"}}},"description":"Client Errors"}}GitHubBearerToken
)
�� ) �G ]i?
�k� /enterprise-admin/update-pre-receive-hook/admin/pre-receive-hooks/{pre_receive_hook_id}PATCHUpdate a pre-receive hook{"parameters":[{"$ref":"#/components/parameters/pre-receive-hook-id"}],"requestBody":{"content":{"application/json":{"example":{"allow_downstream_configuration":true,"environment":{"id":1},"name":"Check Commits"},"schema":{"properties":{"allow_downstream_configuration":{"description":"Whether enforcement can be overridden at the org or repo level.","type":"boolean"},"enforcement":{"description":"The state of enforcement for this hook.","type":"string"},"environment":{"additionalProperties":true,"description":"The pre-receive environment where the script is executed.","type":"object"},"name":{"description":"The name of the hook.","type":"string"},"script":{"description":"The script that the hook runs.","type":"string"},"script_repository":{"additionalProperties":true,"description":"The GitHub repository where the script is kept.","type":"object"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pre-receive-hook-2"}},"schema":{"$ref":"#/components/schemas/pre-receive-hook"}}},"description":"Response"}}GitHubBearerToken�
]i?
�AQ/enterprise-admin/delete-pre-receive-hook/admin/pre-receive-hooks/{pre_receive_hook_id}DELETEDelete a pre-receive hook{"parameters":[{"$ref":"#/components/parameters/pre-receive-hook-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�( Wi9
�A�/enterprise-admin/get-pre-receive-hook/admin/pre-receive-hooks/{pre_receive_hook_id}GETGet a pre-receive hook{"parameters":[{"$ref":"#/components/parameters/pre-receive-hook-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pre-receive-hook"}},"schema":{"$ref":"#/components/schemas/pre-receive-hook"}}},"description":"Response"}}GitHubBearerToken�Y ]=?
�A�/enterprise-admin/create-pre-receive-hook/admin/pre-receive-hooksPOSTCreate a pre-receive hook{"parameters":[],"requestBody":{"content":{"application/json":{"example":{"allow_downstream_configuration":false,"enforcement":"disabled","environment":{"id":2},"name":"Check Commits","script":"scripts/commit_check.sh","script_repository":{"full_name":"DevIT/hooks"}},"schema":{"properties":{"allow_downstream_configuration":{"description":"Whether enforcement can be overridden at the org or repo level. default: `false`","type":"boolean"},"enforcement":{"description":"The state of enforcement for this hook. default: `disabled`","type":"string"},"environment":{"additionalProperties":true,"description":"The pre-receive environment where the script is executed.","type":"object"},"name":{"description":"The name of the hook.","type":"string"},"script":{"description":"The script that the hook runs.","type":"string"},"script_repository":{"additionalProperties":true,"description":"The GitHub repository where the script is kept.","type":"object"}},"required":["name","script","script_repository","environment"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pre-receive-hook"}},"schema":{"$ref":"#/components/schemas/pre-receive-hook"}}},"description":"Response"}}GitHubBearerToken�t [=9
�C�W/enterprise-admin/list-pre-receive-hooks/admin/pre-receive-hooksGETList pre-receive hooks{"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/direction"},{"description":"One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.","in":"query","name":"sort","schema":{"default":"created","enum":["created","updated","name"],"type":"string"},"style":"form"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pre-receive-hook-items"}},"schema":{"items":{"$ref":"#/components/schemas/pre-receive-hook"},"type":"array"}}},"description":"Response"}}GitHubBearerToken
�
� ��� � �D _;I
�U�O/enterprise-admin/update-username-for-user/admin/users/{username}PATCHUpdate the username for a user{"parameters":[{"$ref":"#/components/parameters/username"}],"requestBody":{"content":{"application/json":{"example":{"login":"thenewmonalisa"},"schema":{"properties":{"login":{"description":"The user's new username.","type":"string"}},"required":["login"],"type":"object"}}},"required":true}}{"202":{"content":{"application/json":{"example":{"message":"Job queued to rename user. It may take a few minutes to complete.","url":"https://api.github.com/user/1"},"schema":{"properties":{"message":{"type":"string"},"url":{"type":"string"}},"type":"object"}}},"description":"Response"}}GitHubBearerToken�q E;'�I�+Q/enterprise-admin/delete-user/admin/users/{username}DELETEDelete a userDeleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#suspend-a-user) is often a better option.
You can delete any user account except your own.{"parameters":[{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�* E%'�o�[�/enterprise-admin/create-user/admin/usersPOSTCreate a userIf an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#update-ldap-mapping-for-a-user) for the user.
The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `"octo_cat"` as the login, a user named `"octo-cat"` will be created.
If the login name or email address is already associated with an account, the server will return a `422` response.{"parameters":[],"requestBody":{"content":{"application/json":{"example":{"email":"octocat@github.com","login":"monalisa"},"schema":{"properties":{"email":{"description":"**Required for built-in authentication.** The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the [GitHub authentication guide](https://help.github.com/enterprise/2.18/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/).","type":"string"},"login":{"description":"The user's username.","type":"string"}},"required":["login"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/simple-user"}},"schema":{"$ref":"#/components/schemas/simple-user"}}},"description":"Response"}}GitHubBearerToken�j g=I�u�+Q/enterprise-admin/delete-personal-access-token/admin/tokens/{token_id}DELETEDelete a personal access tokenDeletes a personal access token. Returns a `403 - Forbidden` status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error.{"parameters":[{"$ref":"#/components/parameters/token-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�D e'C��{�;/enterprise-admin/list-personal-access-tokens/admin/tokensGETList personal access tokensLists personal access tokens for all users, including admin users.{"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authorization-items"}},"schema":{"items":{"$ref":"#/components/schemas/authorization"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
p
5 %�p � $ ?OS� �/�//apps/create-from-manifest/app-manifests/{code}/conversionsPOSTCreate a GitHub App from a manifestUse this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.{"parameters":[{"in":"path","name":"code","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object"}}}}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/integration-from-manifest"}},"schema":{"allOf":[{"$ref":"#/components/schemas/integration"},{"additionalProperties":true,"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"pem":{"type":"string"},"webhook_secret":{"nullable":true,"type":"string"}},"required":["client_id","client_secret","webhook_secret","pem"],"type":"object"}]}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed_simple"}}GitHubBearerToken�# 9?�KU�/apps/get-authenticated/appGETGet the authenticated appReturns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-server@2.22/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint.
You must use a [JWT](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/integration"}},"schema":{"$ref":"#/components/schemas/integration"}}},"description":"Response"}}GitHubBearerToken�
"
qYS
�+Q/enterprise-admin/delete-impersonation-o-auth-token/admin/users/{username}/authorizationsDELETEDelete an impersonation OAuth token{"parameters":[{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�H! qYS
�g�
/enterprise-admin/create-impersonation-o-auth-token/admin/users/{username}/authorizationsPOSTCreate an impersonation OAuth token{"parameters":[{"$ref":"#/components/parameters/username"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"scopes":{"description":"A list of [scopes](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).","items":{"type":"string"},"type":"array"}},"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authorization"}},"schema":{"$ref":"#/components/schemas/authorization"}}},"description":"Response"}}GitHubBearerToken
( (U( �*' =Um�o�9�5/apps/delete-installation/app/installations/{installation_id}DELETEDelete an installation for the authenticated appUninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-server@2.22/rest/reference/apps/#suspend-an-app-installation)" endpoint.
You must use a [JWT](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.{"parameters":[{"$ref":"#/components/parameters/installation-id"}],"requestBody":null}{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�P& 7Ug�q�9�/apps/get-installation/app/installations/{installation_id}GETGet an installation for the authenticated appEnables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (`target_type`) will be either an organization or a user account, depending which account the repository belongs to.
You must use a [JWT](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.{"parameters":[{"$ref":"#/components/parameters/installation-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/base-installation-ghes-2"}},"schema":{"$ref":"#/components/schemas/installation-ghes-2"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"415":{"$ref":"#/components/responses/preview_header_missing"}}GitHubBearerToken�U% ;1e��c�i/apps/list-installations/app/installationsGETList installations for the authenticated appYou must use a [JWT](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
The permissions the installation has are included under the `permissions` key.{"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/since"},{"in":"query","name":"outdated","schema":{"type":"string"},"style":"form"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/base-installation-items-ghes-2"}},"schema":{"items":{"$ref":"#/components/schemas/installation-ghes-2"},"type":"array"}}},"description":"The permissions the installation has are included under the `permissions` key.","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
"6 �* CiG�Y�9�5/apps/unsuspend-installation/app/installations/{installation_id}/suspendedDELETEUnsuspend an app installationRemoves a GitHub App installation suspension.
You must use a [JWT](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.{"parameters":[{"$ref":"#/components/parameters/installation-id"}],"requestBody":null}{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�i) ?iC��9�5/apps/suspend-installation/app/installations/{installation_id}/suspendedPUTSuspend an app installationSuspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.
You must use a [JWT](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.{"parameters":[{"$ref":"#/components/parameters/installation-id"}],"requestBody":null}{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�[( Wqi��'�[/apps/create-installation-access-token/app/installations/{installation_id}/access_tokensPOSTCreate an installation access token for an appCreates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.
You must use a [JWT](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.{"parameters":[{"$ref":"#/components/parameters/installation-id"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"permissions":{"$ref":"#/components/schemas/app-permissions"},"repositories":{"description":"List of repository names that the token should have access to","items":{"example":"rails","type":"string"},"type":"array"},"repository_ids":{"description":"List of repository IDs that the token should have access to","example":[1],"items":{"type":"integer"},"type":"array"}},"type":"object"}}}}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/installation-token"}},"schema":{"$ref":"#/components/schemas/installation-token"}}},"description":"Response"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"415":{"$ref":"#/components/responses/preview_header_missing"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
D �&, IK1��+�k/oauth-authorizations/get-grant/applications/grants/{grant_id}GETGet a single grant**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).{"parameters":[{"$ref":"#/components/parameters/grant-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/application-grant"}},"schema":{"$ref":"#/components/schemas/application-grant"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken�9+ M5-�]�w�}/oauth-authorizations/list-grants/applications/grantsGETList your grants**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.22/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).
You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`.{"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"description":"The client ID of your GitHub app.","in":"query","name":"client_id","schema":{"type":"string"},"style":"form"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/application-grant-items"}},"schema":{"items":{"$ref":"#/components/schemas/application-grant"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
�
?� �. ?KC���E/apps/delete-authorization/applications/{client_id}/grantDELETEDelete an app authorizationOAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.22/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.
Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).{"parameters":[{"$ref":"#/components/parameters/client-id"}],"requestBody":{"content":{"application/json":{"example":{"access_token":"e72e16c7e42f292c6912e7710c838347ae178b4a"},"schema":{"properties":{"access_token":{"description":"The OAuth access token used to authenticate to the GitHub API.","type":"string"}},"required":["access_token"],"type":"object"}}},"required":true}}{"204":{"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�>- OK)�w�+� /oauth-authorizations/delete-grant/applications/grants/{grant_id}DELETEDelete a grant**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.22/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).
Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).{"parameters":[{"$ref":"#/components/parameters/grant-id"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken
� �7� �1 /K3�A��E/apps/delete-token/applications/{client_id}/tokenDELETEDelete an app tokenOAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.22/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.{"parameters":[{"$ref":"#/components/parameters/client-id"}],"requestBody":{"content":{"application/json":{"example":{"access_token":"e72e16c7e42f292c6912e7710c838347ae178b4a"},"schema":{"properties":{"access_token":{"description":"The OAuth access token used to authenticate to the GitHub API.","type":"string"}},"required":["access_token"],"type":"object"}}},"required":true}}{"204":{"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�?0 -K'�%�M�y/apps/check-token/applications/{client_id}/tokenPOSTCheck a tokenOAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.22/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.{"parameters":[{"$ref":"#/components/parameters/client-id"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"access_token":{"description":"The access_token of the OAuth application.","type":"string"}},"required":["access_token"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authorization-with-user"}},"schema":{"$ref":"#/components/schemas/authorization"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�/ OkO�+�
Q/apps/revoke-grant-for-application/applications/{client_id}/grants/{access_token}DELETERevoke a grant for an application**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).
OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.22/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.
Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under "Authorized OAuth Apps" on GitHub Enterprise Server](https://github.com/settings/applications#authorized).{"parameters":[{"$ref":"#/components/parameters/client-id"},{"$ref":"#/components/parameters/access-token"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken
� w� � �U4 =k9�'�
�!/apps/reset-authorization/applications/{client_id}/tokens/{access_token}POSTReset an authorization**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).
OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.22/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.{"parameters":[{"$ref":"#/components/parameters/client-id"},{"$ref":"#/components/parameters/access-token"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authorization-with-user"}},"schema":{"$ref":"#/components/schemas/authorization"}}},"description":"Response"}}GitHubBearerToken�3 =k9�=�
�/apps/check-authorization/applications/{client_id}/tokens/{access_token}GETCheck an authorization**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).
OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.22/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.{"parameters":[{"$ref":"#/components/parameters/client-id"},{"$ref":"#/components/parameters/access-token"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authorization-with-user"}},"schema":{"$ref":"#/components/schemas/nullable-authorization"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�2 -K'��M�/apps/reset-token/applications/{client_id}/tokenPATCHReset a tokenOAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.22/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.{"parameters":[{"$ref":"#/components/parameters/client-id"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"access_token":{"description":"The access_token of the OAuth application.","type":"string"}},"required":["access_token"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authorization-with-user"}},"schema":{"$ref":"#/components/schemas/authorization"}}},"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� �> � �M7 ]+=��w�m/oauth-authorizations/list-authorizations/authorizationsGETList your authorizations**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).{"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"description":"The client ID of your GitHub app.","in":"query","name":"client_id","schema":{"type":"string"},"style":"form"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authorization-items"}},"schema":{"items":{"$ref":"#/components/schemas/authorization"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�6 --!�C�+�K/apps/get-by-slug/apps/{app_slug}GETGet an app**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).
If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.{"parameters":[{"$ref":"#/components/parameters/app-slug"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/integration"}},"schema":{"$ref":"#/components/schemas/integration"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"415":{"$ref":"#/components/responses/preview_header_missing"}}GitHubBearerToken�)5 _ka�S�
Q/apps/revoke-authorization-for-application/applications/{client_id}/tokens/{access_token}DELETERevoke an authorization for an application**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).
OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.22/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.{"parameters":[{"$ref":"#/components/parameters/client-id"},{"$ref":"#/components/parameters/access-token"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).
**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).
Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@2.22/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@2.22/rest/overview/other-authentication-methods#working-with-two-factor-authentication)."
To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.
You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://help.github.com/articles/creating-an-access-token-for-command-line-use).
Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://help.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on).{"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"properties":{"client_id":{"description":"The OAuth app client key for which to create the token.","maxLength":20,"type":"string"},"client_secret":{"description":"The OAuth app client secret for which to create the token.","maxLength":40,"type":"string"},"fingerprint":{"description":"A unique string to distinguish an authorization from others created for the same client ID and user.","type":"string"},"note":{"description":"A note to remind you what the OAuth token is for.","example":"Update all gems","type":"string"},"note_url":{"description":"A URL to remind you what app the OAuth token is for.","type":"string"},"scopes":{"description":"A list of scopes that this authorization is in.","example":["public_repo","user"],"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}}}}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authorization"}},"schema":{"$ref":"#/components/schemas/authorization"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/authorizations/1","schema":{"type":"string"},"style":"simple"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"410":{"$ref":"#/components/responses/gone"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� � �c9 }So�1�5�//oauth-authorizations/get-or-create-authorization-for-app/authorizations/clients/{client_id}PUTGet-or-create an authorization for a specific app**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.22/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).
**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecate �<8 _+A�1�m�/oauth-authorizations/create-authorization/authorizationsPOSTCreate a new authorization**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.22/developers/ d-passwords-and-authorizations-api).
Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@2.22/rest/overview/other-authentication-methods#working-with-two-factor-authentication)."
**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.22/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).{"parameters":[{"$ref":"#/components/parameters/client-id"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"client_secret":{"description":"The OAuth app client secret for which to create the token.","maxLength":40,"type":"string"},"fingerprint":{"description":"A unique string to distinguish an authorization from others created for the same client ID and user.","type":"string"},"note":{"description":"A note to remind you what the OAuth token is for.","example":"Update all gems","type":"string"},"note_url":{"description":"A URL to remind you what app the OAuth token is for.","type":"string"},"scopes":{"description":"A list of scopes that this authorization is in.","example":["public_repo","user"],"items":{"type":"string"},"nullable":true,"type":"array"}},"required":["client_secret"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"response-if-returning-an-existing-token":{"$ref":"#/components/examples/authorization-response-if-returning-an-existing-token-2"}},"schema":{"$ref":"#/components/schemas/authorization"}}},"description":"if returning an existing token","headers":{"Location":{"example":"https://api.github.com/authorizations/1","schema":{"type":"string"},"style":"simple"}}},"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authorization"}},"schema":{"$ref":"#/components/schemas/authorization"}}},"description":"**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).","headers":{"Location":{"example":"https://api.github.com/authorizations/1","schema":{"type":"string"},"style":"simple"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
j j �:� o��w�I�U/oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint/authorizations/clients/{client_id}/{fingerprint}PUTGet-or-create an authorization for a specific app and fingerprint**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.22/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).
**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).
This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@2.22/rest/overview/other-authentication-methods#working-with-two-factor-authentication)."{"parameters":[{"$ref":"#/components/parameters/client-id"},{"in":"path","name":"fingerprint","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"client_secret":{"description":"The OAuth app client secret for which to create the token.","maxLength":40,"type":"string"},"note":{"description":"A note to remind you what the OAuth token is for.","example":"Update all gems","type":"string"},"note_url":{"description":"A URL to remind you what app the OAuth token is for.","type":"string"},"scopes":{"description":"A list of scopes that this authorization is in.","example":["public_repo","user"],"items":{"type":"string"},"nullable":true,"type":"array"}},"required":["client_secret"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"response-if-returning-an-existing-token":{"$ref":"#/components/examples/authorization-response-if-returning-an-existing-token"}},"schema":{"$ref":"#/components/schemas/authorization"}}},"description":"if returning an existing token","headers":{"Location":{"example":"https://api.github.com/authorizations/1","schema":{"type":"string"},"style":"simple"}}},"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authorization-3"}},"schema":{"$ref":"#/components/schemas/authorization"}}},"description":"Response if returning a new token","headers":{"Location":{"example":"https://api.github.com/authorizations/1","schema":{"type":"string"},"style":"simple"}}},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
!
�! � < _Q;��;� /oauth-authorizations/delete-authorization/authorizations/{authorization_id}DELETEDelete an authorization**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).{"parameters":[{"$ref":"#/components/parameters/authorization-id"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken�;; YQA��;�_/oauth-authorizations/get-authorization/authorizations/{authorization_id}GETGet a single authorization**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).{"parameters":[{"$ref":"#/components/parameters/authorization-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authorization-2"}},"schema":{"$ref":"#/components/schemas/authorization"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken
� 'q] � �\@ !!�U�/emojis/get/emojisGETGet emojisLists all the emojis available to use on GitHub Enterprise Server.{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"additionalProperties":{"type":"string"},"type":"object"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"}}GitHubBearerToken�? O;7
��c/codes-of-conduct/get-conduct-code/codes_of_conduct/{key}GETGet a code of conduct{"parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/code-of-conduct"}},"schema":{"$ref":"#/components/schemas/code-of-conduct"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�3>
_/=
U�K/codes-of-conduct/get-all-codes-of-conduct/codes_of_conductGETGet all codes of conduct{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/code-of-conduct-simple-items"}},"schema":{"items":{"$ref":"#/components/schemas/code-of-conduct"},"type":"array"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"}}GitHubBearerToken�V= _QM�W�]�/oauth-authorizations/update-authorization/authorizations/{authorization_id}PATCHUpdate an existing authorization**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.22/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).
If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@2.22/rest/overview/other-authentication-methods#working-with-two-factor-authentication)."
You can only send one of these scope keys at a time.{"parameters":[{"$ref":"#/components/parameters/authorization-id"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"add_scopes":{"description":"A list of scopes to add to this authorization.","items":{"type":"string"},"type":"array"},"fingerprint":{"description":"A unique string to distinguish an authorization from others created for the same client ID and user.","type":"string"},"note":{"description":"A note to remind you what the OAuth token is for.","example":"Update all gems","type":"string"},"note_url":{"description":"A URL to remind you what app the OAuth token is for.","type":"string"},"remove_scopes":{"description":"A list of scopes to remove from this authorization.","items":{"type":"string"},"type":"array"},"scopes":{"description":"A list of scopes that this authorization is in.","example":["public_repo","user"],"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authorization-2"}},"schema":{"$ref":"#/components/schemas/authorization"}}},"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
�
L -
� ����sH) �L
K;5
U�/enterprise-admin/get-user-stats/enterprise/stats/usersGETGet users statistics{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/enterprise-user-overview"}}},"description":"Response"}}GitHubBearerToken� K
K;? U�#/enterprise-admin/get-repo-stats/enterprise/stats/reposGETGet repository statistics{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/enterprise-repository-overview"}}},"description":"Response"}}GitHubBearerToken�(J
[;C
U�'/enterprise-admin/get-pull-request-stats/enterprise/stats/pullsGETGet pull request statistics{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/enterprise-pull-request-overview"}}},"description":"Response"}}GitHubBearerToken�I
M;5
U�/enterprise-admin/get-pages-stats/enterprise/stats/pagesGETGet pages statistics{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/enterprise-page-overview"}}},"description":"Response"}}GitHubBearerToken� H
I9C
U�'/enterprise-admin/get-org-stats/enterprise/stats/orgsGETGet organization statistics{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/enterprise-organization-overview"}}},"description":"Response"}}GitHubBearerToken�$G
UE=
U�!/enterprise-admin/get-milestone-stats/enterprise/stats/milestonesGETGet milestone statistics{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/enterprise-milestone-overview"}}},"description":"Response"}}GitHubBearerToken�F
M=5
U�/enterprise-admin/get-issue-stats/enterprise/stats/issuesGETGet issue statistics{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/enterprise-issue-overview"}}},"description":"Response"}}GitHubBearerToken�E
M;5 U�/enterprise-admin/get-hooks-stats/enterprise/stats/hooksGETGet hooks statistics{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/enterprise-hook-overview"}}},"description":"Response"}}GitHubBearerToken�.D �;3
U�/enterprise-admin/get-all-stats (GET /enterprise/stats/gists)/enterprise/stats/gistsGETGet gist statistics{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/enterprise-gist-overview"}}},"description":"Response"}}GitHubBearerToken� C
QA9
U� /enterprise-admin/get-comment-stats/enterprise/stats/commentsGETGet comment statistics{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/enterprise-comment-overview"}}},"description":"Response"}}GitHubBearerToken�SB
I71
U�%/enterprise-admin/get-all-stats/enterprise/stats/allGETGet all statistics{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/enterprise-overview"}},"schema":{"$ref":"#/components/schemas/enterprise-overview"}}},"description":"Response"}}GitHubBearerToken�[A
]E;
U� /enterprise-admin/get-license-information/enterprise/settings/licenseGETGet license information{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/license-info"}},"schema":{"$ref":"#/components/schemas/license-info"}}},"description":"Response"}}GitHubBearerToken
� ���� �P
�
�u�A�Q/enterprise-admin/delete-self-hosted-runner-group-from-enterprise/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}DELETEDelete a self-hosted runner group from an enterpriseDeletes a self-hosted runner group for an enterprise.
You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/enterprise"},{"$ref":"#/components/parameters/runner-group-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�HO��m�M��7/enterprise-admin/get-self-hosted-runner-group-for-enterprise/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}GETGet a self-hosted runner group for an enterpriseGets a specific self-hosted runner group for an enterprise.
You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/enterprise"},{"$ref":"#/components/parameters/runner-group-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/runner-group-enterprise"}},"schema":{"$ref":"#/components/schemas/runner-groups-enterprise"}}},"description":"Response"}}GitHubBearerToken�pN
� ks�I��7/enterprise-admin/create-self-hosted-runner-group-for-enterprise/enterprises/{enterprise}/actions/runner-groupsPOSTCreate a self-hosted runner group for an enterpriseCreates a new self-hosted runner group for an enterprise.
You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/enterprise"}],"requestBody":{"content":{"application/json":{"example":{"name":"Expensive hardware runners","runners":[9,2],"selected_organization_ids":[32,91],"visibility":"selected"},"schema":{"properties":{"name":{"description":"Name of the runner group.","type":"string"},"runners":{"description":"List of runner IDs to add to the runner group.","items":{"description":"Unique identifier of the runner.","type":"integer"},"type":"array"},"selected_organization_ids":{"description":"List of organization IDs that can access the runner group.","items":{"description":"Unique identifier of the organization.","type":"integer"},"type":"array"},"visibility":{"description":"Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: `all` or `selected`","enum":["selected","all"],"type":"string"}},"required":["name"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/runner-group-enterprise"}},"schema":{"$ref":"#/components/schemas/runner-groups-enterprise"}}},"description":"Response"}}GitHubBearerToken�iM
� km�C�W�c/enterprise-admin/list-self-hosted-runner-groups-for-enterprise/enterprises/{enterprise}/actions/runner-groupsGETList self-hosted runner groups for an enterpriseLists all self-hosted runner groups for an enterprise.
You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/enterprise"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/runner-groups-enterprise"}},"schema":{"properties":{"runner_groups":{"items":{"$ref":"#/components/schemas/runner-groups-enterprise"},"type":"array"},"total_count":{"type":"number"}},"required":["total_count","runner_groups"],"type":"object"}}},"description":"Response"}}GitHubBearerToken
\u� �hT� �=��+�iQ/enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}PUTAdd organization access to a self-hosted runner group in an enterpriseAdds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)."
You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/enterprise"},{"$ref":"#/components/parameters/runner-group-id"},{"$ref":"#/components/parameters/org-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�oS� �+��'� Q/enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizationsPUTSet organization access for a self-hosted runner group in an enterpriseReplaces the list of organizations that have access to a self-hosted runner configured in an enterprise.
You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/enterprise"},{"$ref":"#/components/parameters/runner-group-id"}],"requestBody":{"content":{"application/json":{"example":{"selected_organization_ids":[32,91]},"schema":{"properties":{"selected_organization_ids":{"description":"List of organization IDs that can access the runner group.","items":{"description":"Unique identifier of the organization.","type":"integer"},"type":"array"}},"required":["selected_organization_ids"],"type":"object"}}},"required":true}}{"204":{"description":"Response"}}GitHubBearerToken�dR�!�+��[�=�Q/enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizationsGETList organization access to a self-hosted runner group in an enterpriseLists the organizations with access to a self-hosted runner group.
You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/enterprise"},{"$ref":"#/components/parameters/runner-group-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/organization-targets"}},"schema":{"properties":{"organizations":{"items":{"$ref":"#/components/schemas/organization-simple"},"type":"array"},"total_count":{"type":"number"}},"required":["total_count","organizations"],"type":"object"}}},"description":"Response"}}GitHubBearerToken�!Q� �s�}�y�E/enterprise-admin/update-self-hosted-runner-group-for-enterprise/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}PATCHUpdate a self-hosted runner group for an enterpriseUpdates the `name` and `visibility` of a self-hosted runner group in an enterprise.
You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/enterprise"},{"$ref":"#/components/parameters/runner-group-id"}],"requestBody":{"content":{"application/json":{"example":{"name":"Expensive hardware runners","visibility":"selected"},"schema":{"properties":{"name":{"description":"Name of the runner group.","type":"string"},"visibility":{"default":"all","description":"Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: `all` or `selected`","enum":["selected","all"],"type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/runner-group-update-enterprise"}},"schema":{"$ref":"#/components/schemas/runner-groups-enterprise"}}},"description":"Response"}}GitHubBearerToken
� �� � �jX
� �7w�g�oQ/enterprise-admin/add-self-hosted-runner-to-group-for-enterprise/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}PUTAdd a self-hosted runner to a group for an enterpriseAdds a self-hosted runner to a runner group configured in an enterprise.
You must authenticate using an access token with the `admin:enterprise`
scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/enterprise"},{"$ref":"#/components/parameters/runner-group-id"},{"$ref":"#/components/parameters/runner-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�oW
�
� u��wQ/enterprise-admin/set-self-hosted-runners-in-group-for-enterprise/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runnersPUTSet self-hosted runners in a group for an enterpriseReplaces the list of self-hosted runners that are part of an enterprise runner group.
You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/enterprise"},{"$ref":"#/components/parameters/runner-group-id"}],"requestBody":{"content":{"application/json":{"example":{"runners":[9,2]},"schema":{"properties":{"runners":{"description":"List of runner IDs to add to the runner group.","items":{"description":"Unique identifier of the runner.","type":"integer"},"type":"array"}},"required":["runners"],"type":"object"}}},"required":true}}{"204":{"description":"Response"}}GitHubBearerToken�uV�� w�c�=�//enterprise-admin/list-self-hosted-runners-in-group-for-enterprise/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runnersGETList self-hosted runners in a group for an enterpriseLists the self-hosted runners that are in a specific enterprise group.
You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/enterprise"},{"$ref":"#/components/parameters/runner-group-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/runner-paginated-no-labels"}},"schema":{"properties":{"runners":{"items":{"$ref":"#/components/schemas/runner-no-labels"},"type":"array"},"total_count":{"type":"number"}},"required":["total_count","runners"],"type":"object"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�vU�%�=� �5�iQ/enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}DELETERemove organization access to a self-hosted runner group in an enterpriseRemoves an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)."
You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/enterprise"},{"$ref":"#/components/parameters/runner-group-id"},{"$ref":"#/components/parameters/org-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken
� Z � ��]<���a7
�
�
�
�
P
� � � � S + � � � � q E
�
�
�
�
a
C
� � � d 4 ��lC#���g-���R+���qF9� �����gI �/@w���~X���&(Sactivity/list-repos-starred-by-user~)Uactivity/list-public-events-for-usern4kactivity/list-org-events-for-authenticated-userm0cactivity/list-events-for-authenticated-userl7qactivity/list-watched-repos-for-authenticated-userh0cactivity/unstar-repo-for-authenticated-userg._activity/star-repo-for-authenticated-userf9uactivity/check-repo-is-starred-by-authenticated-usere6oactivity/list-repos-starred-by-authenticated-userd9uapps/add-repo-to-installation-for-authenticated-userR&
apps/crea2gactivity/list-received-public-events-for-userz+Yactivity/list-received-events-for-usery apps/(Sactivity/list-repos-watched-by-user%Mactivity/set-thread-subscription �#Iactivity/set-repo-subscription!Eactivity/mark-thread-as-read �-]activity/mark-repo-notifications-as-read�(Sactivity/mark-notifications-as-read �$Kactivity/list-watchers-for-repo&Oactivity/list-stargazers-for-repo�<{activity/list-repo-notifications-for-authenticated-user� ?activity/list-repo-eventsu$Kactivity/list-public-org-events �0eactivity/list-public-events-for-repo-network Cactivity/list-public-events`7qactivity/list-notifications-for-authenticated-user �<{activity/get-thread-subscription-for-authenticated-user �3activity/get-thread �#Iactivity/get-repo-subscription1activity/get-feedsa(Sactivity/delete-thread-subscription �&Oactivity/delete-repo-subscription4kactions/update-self-hosted-runner-group-for-org �5mactions/set-self-hosted-runners-in-group-for-org �._actions/set-selected-repos-for-org-secret �@�actions/set-repo-access-to-self-hosted-runner-group-in-org �9uactions/remove-self-hosted-runner-from-group-for-org �1eactions/remove-selected-repo-from-org-secret �C�actions/remove-repo-access-to-self-hosted-runner-group-in-org � ;actions/re-run-workflow(Sactions/list-workflow-runs-for-repo Aactions/list-workflow-runs (Sactions/list-workflow-run-artifacts6oactions/list-self-hosted-runners-in-group-for-org �._actions/list-self-hosted-runners-for-repo-]actions/list-self-hosted-runners-for-org �3iactions/list-self-hosted-runner-groups-for-org �/aactions/list-selected-repos-for-org-secret �._actions/list-runner-applications-for-repo-]actions/list-runner-applications-for-org � Cactions/list-repo-workflows ?actions/list-repo-secretsA�actions/list-repo-access-to-self-hosted-runner-group-in-org � =actions/list-org-secrets �'Qactions/list-jobs-for-workflow-run$Kactions/list-artifacts-for-repo =actions/get-workflow-run
5actions/get-workflow1eactions/get-self-hosted-runner-group-for-org �,[actions/get-self-hosted-runner-for-repo
+Yactions/get-self-hosted-runner-for-org � ;actions/get-repo-secret Cactions/get-repo-public-key9actions/get-org-secret � Aactions/get-org-public-key �%Mactions/get-job-for-workflow-run5actions/get-artifact'Qactions/download-workflow-run-logs/aactions/download-job-logs-for-workflow-run ?actions/download-artifact%Mactions/delete-workflow-run-logs Cactions/delete-workflow-run5mactions/delete-self-hosted-runner-group-from-org �0cactions/delete-self-hosted-runner-from-repo /aactions/delete-self-hosted-runner-from-org � Aactions/delete-repo-secret ?actions/delete-org-secret � ;actions/delete-artifact%Mactions/create-workflow-dispatch 4kactions/create-self-hosted-runner-group-for-org �)Uactions/create-remove-token-for-repo (Sactions/create-remove-token-for-org �/aactions/create-registration-token-for-repo._actions/create-registration-token-for-org �)Uactions/create-or-update-repo-secret(Sactions/create-or-update-org-secret � Cactions/cancel-workflow-run4kactions/add-self-hosted-runner-to-group-for-org �,[actions/add-selected-repo-to-org-secret �@�actions/add-repo-access-to-self-hosted-runner-group-in-org �
A ] |X������lR3�V�����hB������qX= ����^>
�
�
�
�
? �� � � x D � � \ ;
�
�
s
F
� � x ?
���R ���m@���tA
���@ ��enterprise-admin/set-org-a/aenterprise-admin/remove-authorized-ssh-key �/aenterprise-admin/demote-site-administrator} enterprise-admin/l#Iapps/create-content-attachmenth-apps/check-token0 ?apps/delete-authorization.)Wapps/create-installation-access-token( ?apps/create-from-manifest$ Aapps/get-user-installationu>apps/remove-repo-from-installation-for-authenticated-userS8sapps/list-installation-repos-for-authenticated-userQ3iapps/list-installations-for-authenticated-userP6oenterprise-admin/create-enterprise-server-license ?apps/suspend-installation))Wapps/revoke-installation-access-tokenx%Oapps/revoke-grant-for-application/-_apps/revoke-authorization-for-application5-apps/reset-token2 =apps/reset-authorization4.aapps/list-repos-accessible-to-installationw;apps/list-installations% Aapps/get-repo-installation� ?apps/get-org-installation �7apps/get-installation&-apps/get-by-slug69apps/get-authenticated#/apps/delete-token1 =apps/delete-installation')Wenterprise-admin/list-global-webhooks#Kenterprise-admin/get-user-statsL"Genterprise-admin/get-settingsA�enterprise-admin/get-self-hosted-runner-group-for-enterpriseO:yenterprise-admin/get-self-hosted-runner-for-enterprise^#Kenterprise-admin/get-repo-statsK+[enterprise-admin/get-pull-request-statsJ3ienterprise-admin/get-pre-receive-hook-for-repo�2genterprise-admin/get-pre-receive-hook-for-org �)Wenterprise-admin/get-pre-receive-hook0eenterprise-admin/get-pre-receive-environment$Menterprise-admin/get-pages-statsI"Ienterprise-admin/get-org-statsH(Uenterprise-admin/get-milestone-statsG,[enterprise-admin/get-maintenance-status,]enterprise-admin/get-license-informationA$Menterprise-admin/get-issue-statsF$Menterprise-admin/get-hooks-statsE'Senterprise-admin/get-global-webhookE�
enterprise-admin/get-download-status-for-pre-receive-environment._enterprise-admin/get-configuration-status&Qenterprise-admin/get-comment-statsCA�enterprise-admin/get-all-stats (GET /enterprise/stats/gists)D"Ienterprise-admin/get-all-statsB1eenterprise-admin/get-all-authorized-ssh-keys 8senterprise-admin/enable-or-disable-maintenance-mode Eenterprise-admin/delete-user E�
enterprise-admin/delete-self-hosted-runner-group-from-enterpriseP?�enterprise-admin/delete-self-hosted-runner-from-enterprise_&Qenterprise-admin/delete-public-key ,]enterprise-admin/delete-pre-receive-hook3kenterprise-admin/delete-pre-receive-environment1genterprise-admin/delete-personal-access-token 6qenterprise-admin/delete-impersonation-o-auth-token"*Yenterprise-admin/delete-global-webhook Eenterprise-admin/create-user D� enterprise-admin/create-self-hosted-runner-group-for-enterpriseN7senterprise-admin/create-remove-token-for-enterprise]=enterprise-admin/create-registration-token-for-enterprise\,]enterprise-admin/create-pre-receive-hook3kenterprise-admin/create-pre-receive-environment Centerprise-admin/create-org6qenterprise-admin/create-impersonation-o-auth-token!*Yenterprise-admin/create-global-webhookD� enterprise-admin/add-self-hosted-runner-to-group-for-enterpriseXN� enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterpriseT,[enterprise-admin/add-authorized-ssh-key !emojis/get@%Ocodes-of-conduct/get-conduct-code?-_codes-of-conduct/get-all-codes-of-conduct> Acode-scanning/upload-sarifP Acode-scanning/update-alertN'Qcode-scanning/list-recent-analysesO'Qcode-scanning/list-alerts-for-repoL ;code-scanning/get-alertM'checks/updateE"Gchecks/set-suites-preferencesH9checks/rerequest-suiteK Achecks/list-suites-for-refd7checks/list-for-suiteJ3checks/list-for-refc ;checks/list-annotationsF-checks/get-suiteI!checks/getD3checks/create-suiteG'checks/createC Capps/unsuspend-installation*
;
U �W� ; �] sy[�w�/�-/enterprise-admin/create-remove-token-for-enterprise/enterprises/{enterprise}/actions/runners/remove-tokenPOSTCreate a remove token for an enterpriseReturns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.
You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
#### Example using remove token
To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this
endpoint.
```
./config.sh remove --token TOKEN
```{"parameters":[{"$ref":"#/components/parameters/enterprise"}],"requestBody":null}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authentication-token-2"}},"schema":{"$ref":"#/components/schemas/authentication-token"}}},"description":"Response"}}GitHubBearerToken�\
�g�e�/�)/enterprise-admin/create-registration-token-for-enterprise/enterprises/{enterprise}/actions/runners/registration-tokenPOSTCreate a registration token for an enterpriseReturns a token that you can pass to the `config` script. The token expires after one hour.
You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
#### Example using registration token
Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.
```
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN
```{"parameters":[{"$ref":"#/components/parameters/enterprise"}],"requestBody":null}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authentication-token"}},"schema":{"$ref":"#/components/schemas/authentication-token"}}},"description":"Response"}}GitHubBearerToken� [ }sa�g�/�_/enterprise-admin/list-runner-applications-for-enterprise/enterprises/{enterprise}/actions/runners/downloadsGETList runner applications for an enterpriseLists binaries for the runner application that you can download and run.
You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/enterprise"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/runner-application-items"}},"schema":{"items":{"$ref":"#/components/schemas/runner-application"},"type":"array"}}},"description":"Response"}}GitHubBearerToken�\Z }_a�M�W�e/enterprise-admin/list-self-hosted-runners-for-enterprise/enterprises/{enterprise}/actions/runnersGETList self-hosted runners for an enterpriseLists all self-hosted runners configured for an enterprise.
You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/enterprise"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/runner-paginated-no-labels"}},"schema":{"properties":{"runners":{"items":{"$ref":"#/components/schemas/runner-no-labels"},"type":"array"},"total_count":{"type":"number"}},"type":"object"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�(Y��7��G�oQ/enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}DELETERemove a self-hosted runner from a group for an enterpriseRemoves a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/enterprise"},{"$ref":"#/components/parameters/runner-group-id"},{"$ref":"#/components/parameters/runner-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken
u
`
�Qu �Ya 1 �U�i/activity/get-feeds/feedsGETGet feedsGitHub Enterprise Server provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:
* **Timeline**: The GitHub Enterprise Server global public timeline
* **User**: The public timeline for any user, using [URI template](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#hypermedia)
* **Current user public**: The public timeline for the authenticated user
* **Current user**: The private timeline for the authenticated user
* **Current user actor**: The private timeline for activity created by the authenticated user
* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.
* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.
**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@2.22/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/feed"}},"schema":{"$ref":"#/components/schemas/feed"}}},"description":"Response"}}GitHubBearerToken�` C1�O�{�i/activity/list-public-events/eventsGETList public eventsWe delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.{"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/event"},"type":"array"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"503":{"$ref":"#/components/responses/service_unavailable"}}GitHubBearerToken�o_ �wi�+� Q/enterprise-admin/delete-self-hosted-runner-from-enterprise/enterprises/{enterprise}/actions/runners/{runner_id}DELETEDelete a self-hosted runner from an enterpriseForces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/enterprise"},{"$ref":"#/components/parameters/runner-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken� ^ ywa�U� �/enterprise-admin/get-self-hosted-runner-for-enterprise/enterprises/{enterprise}/actions/runners/{runner_id}GETGet a self-hosted runner for an enterpriseGets a specific self-hosted runner configured in an enterprise.
You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/enterprise"},{"$ref":"#/components/parameters/runner-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/runner-no-labels"}},"schema":{"$ref":"#/components/schemas/runner-no-labels"}}},"description":"Response"}}GitHubBearerToken
c
,%9 c �Se 1)1e�M�y/gists/list-starred/gists/starredGETList starred gistsList the authenticated user's starred gists:{"parameters":[{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/base-gist-items"}},"schema":{"items":{"$ref":"#/components/schemas/base-gist"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken�id /'/�!�M�m/gists/list-public/gists/publicGETList public gistsList public gists sorted by most recently updated to least recently updated.
Note: With [pagination](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.{"parameters":[{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/base-gist-items"}},"schema":{"items":{"$ref":"#/components/schemas/base-gist"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�c %'��s�#/gists/create/gistsPOSTCreate a gistAllows you to add a new gist with one or more files.
**Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.{"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"description":"Description of the gist","example":"Example Ruby script","type":"string"},"files":{"additionalProperties":{"properties":{"content":{"description":"Content of the file","type":"string"}},"required":["content"],"type":"object"},"description":"Names and content for the files that make up the gist","example":{"hello.rb":{"content":"puts \"Hello, World!\""}},"type":"object"},"public":{"oneOf":[{"default":false,"description":"Flag indicating whether the gist is public","example":true,"type":"boolean"},{"default":"false","enum":["true","false"],"example":"true","type":"string"}]}},"required":["files"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/gist"}},"schema":{"$ref":"#/components/schemas/gist-simple"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/gists/aa5a315d61ae9438b18d","schema":{"type":"string"},"style":"simple"}}},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�Qb !W�Y�M�y/gists/list/gistsGETList gists for the authenticated userLists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:{"parameters":[{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/base-gist-items"}},"schema":{"items":{"$ref":"#/components/schemas/base-gist"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken
U �y�U �qj 5?7
�a�W/gists/create-comment/gists/{gist_id}/commentsPOSTCreate a gist comment{"parameters":[{"$ref":"#/components/parameters/gist-id"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"body":{"description":"The comment text.","example":"Body of the attachment","maxLength":65535,"type":"string"}},"required":["body"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/gist-comment"}},"schema":{"$ref":"#/components/schemas/gist-comment"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1","schema":{"type":"string"},"style":"simple"}}},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�-i 3?1
�Q�i/gists/list-comments/gists/{gist_id}/commentsGETList gist comments{"parameters":[{"$ref":"#/components/parameters/gist-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/gist-comment-items"}},"schema":{"items":{"$ref":"#/components/schemas/gist-comment"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�Gh %-'�a�o�O/gists/update/gists/{gist_id}PATCHUpdate a gistAllows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.{"parameters":[{"$ref":"#/components/parameters/gist-id"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"required":["description"]},{"required":["files"]}],"nullable":true,"properties":{"description":{"description":"Description of the gist","example":"Example Ruby script","type":"string"},"files":{"additionalProperties":{"anyOf":[{"required":["content"]},{"required":["filename"]},{"maxProperties":0,"type":"object"}],"nullable":true,"properties":{"content":{"description":"The new content of the file","type":"string"},"filename":{"description":"The new filename for the file","nullable":true,"type":"string"}},"type":"object"},"description":"Names of files to be updated","example":{"hello.rb":{"content":"blah","filename":"goodbye.rb"}},"type":"object"}},"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/gist"}},"schema":{"$ref":"#/components/schemas/gist-simple"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�Tg %-'
�)�/gists/delete/gists/{gist_id}DELETEDelete a gist{"parameters":[{"$ref":"#/components/parameters/gist-id"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�cf -!
�)�3/gists/get/gists/{gist_id}GETGet a gist{"parameters":[{"$ref":"#/components/parameters/gist-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/gist"}},"schema":{"$ref":"#/components/schemas/gist-simple"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden_gist"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
�
� W`� � �\p !9#w�)�)/gists/fork/gists/{gist_id}/forksPOSTFork a gist**Note**: This was previously `/gists/:gist_id/fork`.{"parameters":[{"$ref":"#/components/parameters/gist-id"}],"requestBody":null}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/base-gist"}},"schema":{"$ref":"#/components/schemas/base-gist"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/gists/aa5a315d61ae9438b18d","schema":{"type":"string"},"style":"simple"}}},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken� o -9+
�Q�a/gists/list-forks/gists/{gist_id}/forksGETList gist forks{"parameters":[{"$ref":"#/components/parameters/gist-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/gist-fork-items"}},"schema":{"items":{"$ref":"#/components/schemas/gist-simple"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�tn 1=/
�Q�}/gists/list-commits/gists/{gist_id}/commitsGETList gist commits{"parameters":[{"$ref":"#/components/parameters/gist-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/gist-commit-items"}},"schema":{"items":{"$ref":"#/components/schemas/gist-commit"},"type":"array"}}},"description":"Response","headers":{"Link":{"example":"<https://api.github.com/resource?page=2>; rel=\"next\"","schema":{"type":"string"},"style":"simple"}}},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�8m 5Y7
�=�m/gists/update-comment/gists/{gist_id}/comments/{comment_id}PATCHUpdate a gist comment{"parameters":[{"$ref":"#/components/parameters/gist-id"},{"$ref":"#/components/parameters/comment-id"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"body":{"description":"The comment text.","example":"Body of the attachment","maxLength":65535,"type":"string"}},"required":["body"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/gist-comment"}},"schema":{"$ref":"#/components/schemas/gist-comment"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�(l 5Y7
��/gists/delete-comment/gists/{gist_id}/comments/{comment_id}DELETEDelete a gist comment{"parameters":[{"$ref":"#/components/parameters/gist-id"},{"$ref":"#/components/parameters/comment-id"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�@k /Y1
��E/gists/get-comment/gists/{gist_id}/comments/{comment_id}GETGet a gist comment{"parameters":[{"$ref":"#/components/parameters/gist-id"},{"$ref":"#/components/parameters/comment-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/gist-comment"}},"schema":{"$ref":"#/components/schemas/gist-comment"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden_gist"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
7 �
�1�7 � v 9C=��� /gitignore/get-template/gitignore/templates/{name}GETGet a gitignore templateThe API also allows fetching the source of a single template.
Use the raw [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types/) to get the raw contents.{"parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/gitignore-template"}},"schema":{"$ref":"#/components/schemas/gitignore-template"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"}}GitHubBearerToken�Wu C5C�U�/gitignore/get-all-templates/gitignore/templatesGETGet all gitignore templatesList all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#create-a-repository-for-the-authenticated-user).{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"example":["Actionscript","Android","AppceleratorTitanium","Autotools","Bancha","C","C++"],"schema":{"items":{"type":"string"},"type":"array"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"}}GitHubBearerToken�Rt 193
�W�3/gists/get-revision/gists/{gist_id}/{sha}GETGet a gist revision{"parameters":[{"$ref":"#/components/parameters/gist-id"},{"in":"path","name":"sha","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/gist"}},"schema":{"$ref":"#/components/schemas/gist-simple"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�Ys %7'
�)�/gists/unstar/gists/{gist_id}/starDELETEUnstar a gist{"parameters":[{"$ref":"#/components/parameters/gist-id"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�8r !7#�W�)�/gists/star/gists/{gist_id}/starPUTStar a gistNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-verbs)."{"parameters":[{"$ref":"#/components/parameters/gist-id"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�`q 97A
�)�i/gists/check-is-starred/gists/{gist_id}/starGETCheck if a gist is starred{"parameters":[{"$ref":"#/components/parameters/gist-id"}],"requestBody":null}{"204":{"description":"Response if gist is starred"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object"}}},"description":"Not Found if gist is not starred"}}GitHubBearerToken
� n� �x
W3S�'UQ/apps/revoke-installation-access-token/installation/tokenDELETERevoke an installation access tokenRevokes the installation token you're using to authenticate as an installation and access this endpoint.
Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@2.22/rest/reference/apps#create-an-installation-access-token-for-an-app)" endpoint.
You must use an [installation access token](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.{"parameters":[],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�w aAu� �{�{/apps/list-repos-accessible-to-installation/installation/repositoriesGETList repositories accessible to the app installationList repositories that an app installation can access.
You must use an [installation access token](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.{"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/repository-paginated-2"}},"schema":{"properties":{"repositories":{"items":{"$ref":"#/components/schemas/repository"},"type":"array"},"repository_selection":{"example":"selected","type":"string"},"total_count":{"type":"integer"}},"required":["total_count","repositories"],"type":"object"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken
� �� � �{ %3'
� �'/licenses/get/licenses/{license}GETGet a license{"parameters":[{"in":"path","name":"license","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/license"}},"schema":{"$ref":"#/components/schemas/license"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�=z I I
��9/licenses/get-all-commonly-used/licensesGETGet all commonly used licenses{"parameters":[{"in":"query","name":"featured","schema":{"type":"boolean"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/license-simple-items"}},"schema":{"items":{"$ref":"#/components/schemas/license-simple"},"type":"array"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"}}GitHubBearerToken�y #i�'�]�q/issues/list/issuesGETList issues assigned to the authenticated userList issues assigned to the authenticated user across all visible repositories including owned repositories, member
repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not
necessarily assigned to you.
**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
request id, use the "[List pull requests](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#list-pull-requests)" endpoint.{"parameters":[{"description":"Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation","in":"query","name":"filter","schema":{"default":"assigned","enum":["assigned","created","mentioned","subscribed","repos","all"],"type":"string"},"style":"form"},{"description":"Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.","in":"query","name":"state","schema":{"default":"open","enum":["open","closed","all"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/labels"},{"description":"What to sort results by. Can be either `created`, `updated`, `comments`.","in":"query","name":"sort","schema":{"default":"created","enum":["created","updated","comments"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/since"},{"in":"query","name":"collab","schema":{"type":"boolean"},"style":"form"},{"in":"query","name":"orgs","schema":{"type":"boolean"},"style":"form"},{"in":"query","name":"owned","schema":{"type":"boolean"},"style":"form"},{"in":"query","name":"pulls","schema":{"type":"boolean"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/issue-with-repo-items"}},"schema":{"items":{"$ref":"#/components/schemas/issue"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
f ,��
�f� q)g�'�Q�a/activity/list-notifications-for-authenticated-user/notificationsGETList notifications for the authenticated userList all notifications for the current user, sorted by most recently updated.{"parameters":[{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/participating"},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/before"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/thread-items"}},"schema":{"items":{"$ref":"#/components/schemas/thread"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�@ eKm
� �I/activity/list-public-events-for-repo-network/networks/{owner}/{repo}/eventsGETList public events for a network of repositories{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/event"},"type":"array"}}},"description":"Response"},"301":{"$ref":"#/components/responses/moved_permanently"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�o~
g
U�s/meta/get/metaGETGet GitHub Enterprise Server meta information{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/api-overview"}},"schema":{"$ref":"#/components/schemas/api-overview"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"}}GitHubBearerToken�7} 3'Y�O��_/markdown/render-raw/markdown/rawPOSTRender a Markdown document in raw modeYou must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.{"parameters":[],"requestBody":{"content":{"text/plain":{"schema":{"type":"string"}},"text/x-markdown":{"schema":{"type":"string"}}}}}{"200":{"content":{"text/html":{"schema":{"type":"string"}}},"description":"Response","headers":{"X-CommonMarker-Version":{"$ref":"#/components/headers/x-common-marker-version"}}},"304":{"$ref":"#/components/responses/not_modified"}}GitHubBearerToken�| + A
�/�u/markdown/render/markdownPOSTRender a Markdown document{"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"properties":{"context":{"description":"The repository context to use when creating references in `gfm` mode.","type":"string"},"mode":{"default":"markdown","description":"The rendering mode.","enum":["markdown","gfm"],"example":"markdown","type":"string"},"text":{"description":"The Markdown text to render in HTML.","type":"string"}},"required":["text"],"type":"object"}}},"required":true}}{"200":{"content":{"text/html":{"schema":{"type":"string"}}},"description":"Response","headers":{"Content-Length":{"example":"279","schema":{"type":"string"},"style":"simple"},"Content-Type":{"$ref":"#/components/headers/content-type"},"X-CommonMarker-Version":{"$ref":"#/components/headers/x-common-marker-version"}}},"304":{"$ref":"#/components/responses/not_modified"}}GitHubBearerToken
��* �� {ku�3�-�s/activity/get-thread-subscription-for-authenticated-user/notifications/threads/{thread_id}/subscriptionGETGet a thread subscription for the authenticated userThis checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@2.22/rest/reference/activity#get-a-repository-subscription).
Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.{"parameters":[{"$ref":"#/components/parameters/thread-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/thread-subscription"}},"schema":{"$ref":"#/components/schemas/thread-subscription"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken�R� EQ7
�-�)/activity/mark-thread-as-read/notifications/threads/{thread_id}PATCHMark a thread as read{"parameters":[{"$ref":"#/components/parameters/thread-id"}],"requestBody":null}{"205":{"description":"Reset Content"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken� � 3Q%
�-�?/activity/get-thread/notifications/threads/{thread_id}GETGet a thread{"parameters":[{"$ref":"#/components/parameters/thread-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/thread"}},"schema":{"$ref":"#/components/schemas/thread"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken�o� S)A�m� �9/activity/mark-notifications-as-read/notificationsPUTMark notifications as readMarks all notifications as "read" removes it from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@2.22/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.{"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"properties":{"last_read_at":{"description":"Describes the last point that notifications were checked.","format":"date-time","type":"string"},"read":{"description":"Whether the notification has been read.","type":"boolean"}},"type":"object"}}}}}{"202":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Response"},"205":{"description":"Reset Content"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken
�
�(�� �>� )1�'��e/orgs/list/organizationsGETList organizationsLists all organizations, in the order that they were created on GitHub Enterprise Server.
**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations.{"parameters":[{"$ref":"#/components/parameters/since-org"},{"$ref":"#/components/parameters/per-page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/organization-simple-items"}},"schema":{"items":{"$ref":"#/components/schemas/organization-simple"},"type":"array"}}},"description":"Response","headers":{"Link":{"example":"<https://api.github.com/organizations?since=135>; rel=\"next\"","schema":{"type":"string"},"style":"simple"}}},"304":{"$ref":"#/components/responses/not_modified"}}GitHubBearerToken�j� - #E�U�]/meta/get-octocat/octocatGETGet OctocatGet the octocat as ASCII art{"parameters":[{"description":"The words to show in Octocat's speech bubble","in":"query","name":"s","schema":{"type":"string"},"style":"form"}],"requestBody":null}{"200":{"content":{"application/octocat-stream":{"schema":{"type":"string"}}},"description":"Response"}}GitHubBearerToken�X� SkE�i�-� /activity/delete-thread-subscription/notifications/threads/{thread_id}/subscriptionDELETEDelete a thread subscriptionMutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@2.22/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`.{"parameters":[{"$ref":"#/components/parameters/thread-id"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken�x� Mk?�y��s/activity/set-thread-subscription/notifications/threads/{thread_id}/subscriptionPUTSet a thread subscriptionIf you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.
You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.
Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@2.22/rest/reference/activity#delete-a-thread-subscription) endpoint.{"parameters":[{"$ref":"#/components/parameters/thread-id"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"ignored":{"default":false,"description":"Whether to block all notifications from a thread.","type":"boolean"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/thread-subscription"}},"schema":{"$ref":"#/components/schemas/thread-subscription"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken
� ,� �q�
##9�5�'�/orgs/update/orgs/{org}PATCHUpdate an organization**Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).
Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.{"parameters":[{"$ref":"#/components/parameters/org"}],"requestBody":{"content":{"application/json":{"example":{"billing_email":"mona@github.com","company":"GitHub","default_repository_permission":"read","description":"GitHub, the company.","email":"mona@github.com","location":"San Francisco","members_allowed_repository_creation_type":"all","members_can_create_repositories":true,"name":"github","twitter_username":"github"},"schema":{"properties":{"billing_email":{"description":"Billing email address. This address is not publicized.","type":"string"},"blog":{"example":"\"http://github.blog\"","type":"string"},"company":{"description":"The company name.","type":"string"},"default_repository_permission":{"default":"read","description":"Default permission level members have for organization repositories: \n\\* `read` - can pull, but not push to or administer this repository. \n\\* `write` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push, and administer this repository. \n\\* `none` - no permissions granted by default.","enum":["read","write","admin","none"],"type":"string"},"description":{"description":"The description of the company.","type":"string"},"email":{"description":"The publicly visible email address.","type":"string"},"has_organization_projects":{"description":"Toggles whether an organization can use organization projects.","type":"boolean"},"has_repository_projects":{"description":"Toggles whether repositories that belong to the organization can use repository projects.","type":"boolean"},"location":{"description":"The location.","type":"string"},"members_all 4�P� #3�e�!�5/orgs/get/orgs/{org}GETGet an organizationTo see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).
GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub Enterprise Server plan. See "[Authenticating with GitHub Apps](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below."{"parameters":[{"$ref":"#/components/parameters/org"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default-response":{"$ref":"#/components/examples/organization-full-default-response"}},"schema":{"$ref":"#/components/schemas/organization-full"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken owed_repository_creation_type":{"description":"Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n\\* `none` - only admin members can create repositories. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.","enum":["all","private","none"],"type":"string"},"members_can_create_internal_repositories":{"description":"Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: \n\\* `true` - all organization members can create internal repositories. \n\\* `false` - only organization owners can create internal repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.","type":"boolean"},"members_can_create_private_repositories":{"description":"Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: \n\\* `true` - all organization members can create private repositories. \n\\* `false` - only organization owners can create private repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.","type":"boolean"},"members_can_create_public_repositories":{"description":"Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: \n\\* `true` - all organization members can create public repositories. \n\\* `false` - only organization owners can create public repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.","type":"boolean"},"members_can_create_repositories":{"default":true,"description":"Toggles the ability of non-admin organization members to create repositories. Can be one of: \n\\* `true` - all organization members can create repositories. \n\\* `false` - only organization owners can create repositories. \nDefault: `true` \n**Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.","type":"boolean"},"name":{"description":"The shorthand name of the company.","type":"string"},"twitter_username":{"description":"The Twitter username of the company.","type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/organization-full"}},"schema":{"$ref":"#/components/schemas/organization-full"}}},"description":"Response"},"409":{"$ref":"#/components/responses/conflict"},"422":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/validation-error"},{"$ref":"#/components/schemas/validation-error-simple"}]}}},"description":"Validation failed"}}GitHubBearerToken
. �� . �n� msy�5�Q/actions/delete-self-hosted-runner-group-from-org/orgs/{org}/actions/runner-groups/{runner_group_id}DELETEDelete a self-hosted runner group from an organizationDeletes a self-hosted runner group for an organization.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/runner-group-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken��
esq�A�� /actions/get-self-hosted-runner-group-for-org/orgs/{org}/actions/runner-groups/{runner_group_id}GETGet a self-hosted runner group for an organizationGets a specific self-hosted runner group for an organization.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/runner-group-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/runner-group-item"}},"schema":{"$ref":"#/components/schemas/runner-groups-org"}}},"description":"Response"}}GitHubBearerToken�h� kOw��}�/actions/create-self-hosted-runner-group-for-org/orgs/{org}/actions/runner-groupsPOSTCreate a self-hosted runner group for an organizationThe self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
Creates a new self-hosted runner group for an organization.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"}],"requestBody":{"content":{"application/json":{"example":{"name":"Expensive hardware runners","runners":[9,2],"selected_repository_ids":[32,91],"visibility":"selected"},"schema":{"properties":{"name":{"description":"Name of the runner group.","type":"string"},"runners":{"description":"List of runner IDs to add to the runner group.","items":{"description":"Unique identifier of the runner.","type":"integer"},"type":"array"},"selected_repository_ids":{"description":"List of repository IDs that can access the runner group.","items":{"description":"Unique identifier of the repository.","type":"integer"},"type":"array"},"visibility":{"default":"all","description":"Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: `all`, `selected`, or `private`.","enum":["selected","all","private"],"type":"string"}},"required":["name"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/runner-group"}},"schema":{"$ref":"#/components/schemas/runner-groups-org"}}},"description":"Response"}}GitHubBearerToken�\� iOq�
�I�G/actions/list-self-hosted-runner-groups-for-org/orgs/{org}/actions/runner-groupsGETList self-hosted runner groups for an organizationLists all self-hosted runner groups configured in an organization and inherited from an enterprise.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/runner-groups-org"}},"schema":{"properties":{"runner_groups":{"items":{"$ref":"#/components/schemas/runner-groups-org"},"type":"array"},"total_count":{"type":"number"}},"required":["total_count","runner_groups"],"type":"object"}}},"description":"Response"}}GitHubBearerToken
� [�� �?���
��%�iQ/actions/set-repo-access-to-self-hosted-runner-group-in-org/orgs/{org}/actions/runner-groups/{runner_group_id}/repositoriesPUTSet repository access for a self-hosted runner group in an organizationReplaces the list of repositories that have access to a self-hosted runner group configured in an organization.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/runner-group-id"}],"requestBody":{"content":{"application/json":{"example":{"selected_repository_ids":[32,91]},"schema":{"properties":{"selected_repository_ids":{"description":"List of repository IDs that can access the runner group.","items":{"description":"Unique identifier of the repository.","type":"integer"},"type":"array"}},"required":["selected_repository_ids"],"type":"object"}}},"required":true}}{"204":{"description":"Response"}}GitHubBearerToken�H���
��c�/�[/actions/list-repo-access-to-self-hosted-runner-group-in-org/orgs/{org}/actions/runner-groups/{runner_group_id}/repositoriesGETList repository access to a self-hosted runner group in an organizationThe self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
Lists the repositories with access to a self-hosted runner group configured in an organization.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/runner-group-id"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/per-page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/minimal-repository-paginated"}},"schema":{"properties":{"repositories":{"items":{"$ref":"#/components/schemas/minimal-repository"},"type":"array"},"total_count":{"type":"number"}},"required":["total_count","repositories"],"type":"object"}}},"description":"Response"}}GitHubBearerToken�!� ksw�q�s�/actions/update-self-hosted-runner-group-for-org/orgs/{org}/actions/runner-groups/{runner_group_id}PATCHUpdate a self-hosted runner group for an organizationUpdates the `name` and `visibility` of a self-hosted runner group in an organization.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/runner-group-id"}],"requestBody":{"content":{"application/json":{"example":{"name":"Expensive hardware runners","visibility":"selected"},"schema":{"properties":{"name":{"description":"Name of the runner group.","type":"string"},"visibility":{"description":"Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: `all`, `selected`, or `private`.","enum":["selected","all","private"],"type":"string"}},"required":["name"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/runner-group"}},"schema":{"$ref":"#/components/schemas/runner-groups-org"}}},"description":"Response"}}GitHubBearerToken
D � X�D �E� m�y�u�iQ/actions/set-self-hosted-runners-in-group-for-org/orgs/{org}/actions/runner-groups/{runner_group_id}/runnersPUTSet self-hosted runners in a group for an organizationReplaces the list of self-hosted runners that are part of an organization runner group.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/runner-group-id"}],"requestBody":{"content":{"application/json":{"example":{"runners":[9,2]},"schema":{"properties":{"runners":{"description":"List of runner IDs to add to the runner group.","items":{"description":"Unique identifier of the runner.","type":"integer"},"type":"array"}},"required":["runners"],"type":"object"}}},"required":true}}{"204":{"description":"Response"}}GitHubBearerToken�G�
o�{�O�/�//actions/list-self-hosted-runners-in-group-for-org/orgs/{org}/actions/runner-groups/{runner_group_id}/runnersGETList self-hosted runners in a group for an organizationLists self-hosted runners that are in a specific organization group.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/runner-group-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/runner-paginated-no-labels"}},"schema":{"properties":{"runners":{"items":{"$ref":"#/components/schemas/runner-no-labels"},"type":"array"},"total_count":{"type":"number"}},"required":["total_count","runners"],"type":"object"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�W���-� �%�iQ/actions/remove-repo-access-to-self-hosted-runner-group-in-org/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}DELETERemove repository access to a self-hosted runner group in an organizationRemoves a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)."
You must authenticate using an access token with the `admin:org` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/runner-group-id"},{"$ref":"#/components/parameters/repository-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�I���-���iQ/actions/add-repo-access-to-self-hosted-runner-group-in-org/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}PUTAdd repository access to a self-hosted runner group in an organizationAdds a repository to the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)."
You must authenticate using an access token with the `admin:org` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/runner-group-id"},{"$ref":"#/components/parameters/repository-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken
� :�h �Q� _ik�1�!�)/actions/create-registration-token-for-org/orgs/{org}/actions/runners/registration-tokenPOSTCreate a registration token for an organizationReturns a token that you can pass to the `config` script. The token expires after one hour.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
#### Example using registration token
Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.
```
./config.sh --url https://github.com/octo-org --token TOKEN
```{"parameters":[{"$ref":"#/components/parameters/org"}],"requestBody":null}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authentication-token"}},"schema":{"$ref":"#/components/schemas/authentication-token"}}},"description":"Response"}}GitHubBearerToken�r� ]We�Y�!�_/actions/list-runner-applications-for-org/orgs/{org}/actions/runners/downloadsGETList runner applications for an organizationLists binaries for the runner application that you can download and run.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/runner-application-items"}},"schema":{"items":{"$ref":"#/components/schemas/runner-application"},"type":"array"}}},"description":"Response"}}GitHubBearerToken�X� ]Ce�A�I�//actions/list-self-hosted-runners-for-org/orgs/{org}/actions/runnersGETList self-hosted runners for an organizationLists all self-hosted runners configured in an organization.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/runner-paginated-no-labels"}},"schema":{"properties":{"runners":{"items":{"$ref":"#/components/schemas/runner-no-labels"},"type":"array"},"total_count":{"type":"number"}},"required":["total_count","runners"],"type":"object"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�~�
u���;�aQ/actions/remove-self-hosted-runner-from-group-for-org/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}DELETERemove a self-hosted runner from a group for an organizationRemoves a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/runner-group-id"},{"$ref":"#/components/parameters/runner-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�@� k�{�[�aQ/actions/add-self-hosted-runner-to-group-for-org/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}PUTAdd a self-hosted runner to a group for an organizationAdds a self-hosted runner to a runner group configured in an organization.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/runner-group-id"},{"$ref":"#/components/parameters/runner-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken
X �
"�X �?� AYI�g�!�!/actions/get-org-public-key/orgs/{org}/actions/secrets/public-keyGETGet an organization public keyGets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/actions-public-key"}},"schema":{"$ref":"#/components/schemas/actions-public-key"}}},"description":"Response"}}GitHubBearerToken�9� =C?��I�]/actions/list-org-secrets/orgs/{org}/actions/secretsGETList organization secretsLists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/organization-actions-secret-paginated"}},"schema":{"properties":{"secrets":{"items":{"$ref":"#/components/schemas/organization-actions-secret"},"type":"array"},"total_count":{"type":"integer"}},"required":["total_count","secrets"],"type":"object"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�F� a[m�!�{Q/actions/delete-self-hosted-runner-from-org/orgs/{org}/actions/runners/{runner_id}DELETEDelete a self-hosted runner from an organizationForces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/runner-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�u� Y[e�K�{�/actions/get-self-hosted-runner-for-org/orgs/{org}/actions/runners/{runner_id}GETGet a self-hosted runner for an organizationGets a specific self-hosted runner configured in an organization.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/runner-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/runner-no-labels"}},"schema":{"$ref":"#/components/schemas/runner-no-labels"}}},"description":"Response"}}GitHubBearerToken�a� S]_�q�!�-/actions/create-remove-token-for-org/orgs/{org}/actions/runners/remove-tokenPOSTCreate a remove token for an organizationReturns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
#### Example using remove token
To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this
endpoint.
```
./config.sh remove --token TOKEN
```{"parameters":[{"$ref":"#/components/parameters/org"}],"requestBody":null}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authentication-token-2"}},"schema":{"$ref":"#/components/schemas/authentication-token"}}},"description":"Response"}}GitHubBearerToken
l
7 ��l ��# ayw�c�'�[/actions/list-selected-repos-for-org-secret/orgs/{org}/actions/secrets/{secret_name}/repositoriesGETList selected repositories for an organization secretLists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/secret-name"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/per-page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/public-repository-paginated"}},"schema":{"properties":{"repositories":{"items":{"$ref":"#/components/schemas/minimal-repository"},"type":"array"},"total_count":{"type":"integer"}},"required":["total_count","repositories"],"type":"object"}}},"description":"Response"}}GitHubBearerToken��" ?_G�_�Q/actions/delete-org-secret/orgs/{org}/actions/secrets/{secret_name}DELETEDelete an organization secretDeletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/secret-name"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken� �! S_[�!�� /actions/create-or-update-org-secret/orgs/{org}/actions/secrets/{secret_name}PUTCreate or update an organization secretCreates or updates an organization secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to
use this endpoint.
#### Example encrypting a secret using Node.js
Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
```
const sodium = require('tweetsodium');
const key = "base64-encoded-public-key";
const value = "plain-text-secret";
// Convert the message and key to Uint8Array's (Buffer implements that interface)
const messageBytes = Buffer.from(value);
const keyBytes = Buffer.from(key, 'base64');
// Encrypt using LibSodi ;�E� 9_A�{��E/actions/get-org-secret/orgs/{org}/actions/secrets/{secret_name}GETGet an organization secretGets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/secret-name"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/organization-actions-secret"}},"schema":{"$ref":"#/components/schemas/organization-actions-secret"}}},"description":"Response"}}GitHubBearerToken um.
const encryptedBytes = sodium.seal(messageBytes, keyBytes);
// Base64 the encrypted secret
const encrypted = Buffer.from(encryptedBytes).toString('base64');
console.log(encrypted);
```
#### Example encrypting a secret using Python
Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.
```
from base64 import b64encode
from nacl import encoding, public
def encrypt(public_key: str, secret_value: str) -> str:
"""Encrypt a Unicode string using the public key."""
public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
sealed_box = public.SealedBox(public_key)
encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
return b64encode(encrypted).decode("utf-8")
```
#### Example encrypting a secret using C#
Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
```
var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
```
#### Example encrypting a secret using Ruby
Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
```ruby
require "rbnacl"
require "base64"
key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
public_key = RbNaCl::PublicKey.new(key)
box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
encrypted_secret = box.encrypt("my_secret")
# Print the base64 encoded secret
puts Base64.strict_encode64(encrypted_secret)
```{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/secret-name"}],"requestBody":{"content":{"application/json":{"example":{"encrypted_value":"c2VjcmV0","key_id":"012345678912345678","selected_repository_ids":["1296269","1296280"],"visibility":"selected"},"schema":{"properties":{"encrypted_value":{"description":"Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-an-organization-public-key) endpoint.","pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$","type":"string"},"key_id":{"description":"ID of the key you used to encrypt the secret.","type":"string"},"selected_repository_ids":{"description":"An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.","items":{"type":"string"},"type":"array"},"visibility":{"description":"Configures the access that repositories have to the organization secret. Can be one of: \n\\- `all` - All repositories in an organization can access the secret. \n\\- `private` - Private repositories in an organization can access the secret. \n\\- `selected` - Only specific repositories can access the secret.","enum":["all","private","selected"],"type":"string"}},"required":["visibility"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty-object"}}},"description":"Response when creating a secret"},"204":{"description":"Response when updating a secret"}}GitHubBearerToken
D {hD � �&
e�y�A�C�K/actions/remove-selected-repo-from-org-secret/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}DELETERemove selected repository from an organization secretRemoves a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/secret-name"},{"in":"path","name":"repository_id","required":true,"schema":{"type":"integer"},"style":"simple"}],"requestBody":null}{"204":{"description":"Response when repository was removed from the selected list"},"409":{"description":"Conflict when visibility type not set to selected"}}GitHubBearerToken��%
[�o�7�C�M/actions/add-selected-repo-to-org-secret/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}PUTAdd selected repository to an organization secretAdds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/secret-name"},{"in":"path","name":"repository_id","required":true,"schema":{"type":"integer"},"style":"simple"}],"requestBody":null}{"204":{"description":"No Content when repository was added to the selected list"},"409":{"description":"Conflict when visibility type is not set to selected"}}GitHubBearerToken��$ _yu�I�+Q/actions/set-selected-repos-for-org-secret/orgs/{org}/actions/secrets/{secret_name}/repositoriesPUTSet selected repositories for an organization secretReplaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/secret-name"}],"requestBody":{"content":{"application/json":{"example":{"selected_repository_ids":[64780797]},"schema":{"properties":{"selected_repository_ids":{"description":"An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.","items":{"type":"integer"},"type":"array"}},"required":["selected_repository_ids"],"type":"object"}}},"required":true}}{"204":{"description":"Response"}}GitHubBearerToken
� d 'b� � �7�+ 3CI
�w�5/orgs/delete-webhook/orgs/{org}/hooks/{hook_id}DELETEDelete an organization webhook{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/hook-id"}],"requestBody":null}{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken� �* -CC�E�w�]/orgs/get-webhook/orgs/{org}/hooks/{hook_id}GETGet an organization webhookReturns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization)."{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/hook-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/org-hook"}},"schema":{"$ref":"#/components/schemas/org-hook"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�A�) 3/I���K/orgs/create-webhook/orgs/{org}/hooksPOSTCreate an organization webhookHere's how you can create a hook that posts payloads in JSON format:{"parameters":[{"$ref":"#/components/parameters/org"}],"requestBody":{"content":{"application/json":{"example":{"active":true,"config":{"content_type":"json","url":"http://example.com/webhook"},"events":["push","pull_request"],"name":"web"},"schema":{"properties":{"active":{"default":true,"description":"Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.","type":"boolean"},"config":{"description":"Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@2.22/rest/reference/orgs#create-hook-config-params).","properties":{"content_type":{"$ref":"#/components/schemas/webhook-config-content-type"},"insecure_ssl":{"$ref":"#/components/schemas/webhook-config-insecure-ssl"},"password":{"example":"\"password\"","type":"string"},"secret":{"$ref":"#/components/schemas/webhook-config-secret"},"url":{"$ref":"#/components/schemas/webhook-config-url"},"username":{"example":"\"kdaigle\"","type":"string"}},"required":["url"],"type":"object"},"events":{"default":["push"],"description":"Determines what [events](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads) the hook is triggered for.","items":{"type":"string"},"type":"array"},"name":{"description":"Must be passed as \"web\".","type":"string"}},"required":["name","config"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/org-hook"}},"schema":{"$ref":"#/components/schemas/org-hook"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/orgs/octocat/hooks/1","schema":{"type":"string"},"style":"simple"}}},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�9�( 1/A
�I� /orgs/list-webhooks/orgs/{org}/hooksGETList organization webhooks{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/org-hook-items"}},"schema":{"items":{"$ref":"#/components/schemas/org-hook"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken��' K1K
�I�#/activity/list-public-org-events/orgs/{org}/eventsGETList public organization events{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/event"},"type":"array"}}},"description":"Response"}}GitHubBearerToken
� a� �3�.
?=��/�!�%/apps/get-org-installation/orgs/{org}/installationGETGet an organization installation for the authenticated appEnables an authenticated GitHub App to find the organization's installation information.
You must use a [JWT](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/installation-ghes-2"}},"schema":{"$ref":"#/components/schemas/installation-ghes-2"}}},"description":"Response"}}GitHubBearerToken�5�- /OE��w�5/orgs/ping-webhook/orgs/{org}/hooks/{hook_id}/pingsPOSTPing an organization webhookThis will trigger a [ping event](https://docs.github.com/enterprise-server@2.22/webhooks/#ping-event) to be sent to the hook.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/hook-id"}],"requestBody":null}{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�b�, 3CI�o�K�U/orgs/update-webhook/orgs/{org}/hooks/{hook_id}PATCHUpdate an organization webhookUpdates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization)."{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/hook-id"}],"requestBody":{"content":{"application/json":{"example":{"active":true,"events":["pull_request"]},"schema":{"properties":{"active":{"default":true,"description":"Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.","type":"boolean"},"config":{"description":"Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@2.22/rest/reference/orgs#update-hook-config-params).","properties":{"content_type":{"$ref":"#/components/schemas/webhook-config-content-type"},"insecure_ssl":{"$ref":"#/components/schemas/webhook-config-insecure-ssl"},"secret":{"$ref":"#/components/schemas/webhook-config-secret"},"url":{"$ref":"#/components/schemas/webhook-config-url"}},"required":["url"],"type":"object"},"events":{"default":["push"],"description":"Determines what [events](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads) the hook is triggered for.","items":{"type":"string"},"type":"array"},"name":{"example":"\"web\"","type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/org-hook-2"}},"schema":{"$ref":"#/components/schemas/org-hook"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
f df �z�0
31��#�c�/issues/list-for-org/orgs/{org}/issuesGETList organization issues assigned to the authenticated userList issues in an organization assigned to the authenticated user.
**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
request id, use the "[List pull requests](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#list-pull-requests)" endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"description":"Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation","in":"query","name":"filter","schema":{"default":"assigned","enum":["assigned","created","mentioned","subscribed","repos","all"],"type":"string"},"style":"form"},{"description":"Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.","in":"query","name":"state","schema":{"default":"open","enum":["open","closed","all"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/labels"},{"description":"What to sort results by. Can be either `created`, `updated`, `comments`.","in":"query","name":"sort","schema":{"default":"created","enum":["created","updated","comments"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/issue-with-repo-items"}},"schema":{"items":{"$ref":"#/components/schemas/issue"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken��/ C?a�=�I�U/orgs/list-app-installations/orgs/{org}/installationsGETList app installations for an organizationLists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/installation-paginated-ghes-2"}},"schema":{"properties":{"installations":{"items":{"$ref":"#/components/schemas/installation-ghes-2"},"type":"array"},"total_count":{"type":"integer"}},"required":["total_count","installations"],"type":"object"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
4 Ch�4 �h�4 EQY�%�y�Q/orgs/get-membership-for-user/orgs/{org}/memberships/{username}GETGet organization membership for a userIn order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"response-if-user-has-an-active-admin-membership-with-organization":{"$ref":"#/components/examples/org-membership-response-if-user-has-an-active-admin-membership-with-organization"}},"schema":{"$ref":"#/components/schemas/org-membership"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�D�3 1IG�!�y�5/orgs/remove-member/orgs/{org}/members/{username}DELETERemove an organization memberRemoving a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken�W�2 II]� �y�7/orgs/check-membership-for-user/orgs/{org}/members/{username}GETCheck organization membership for a userCheck if a user is, publicly or privately, a member of the organization.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"Response if requester is an organization member and user is a member"},"302":{"description":"Response if requester is not an organization member","headers":{"Location":{"example":"https://api.github.com/orgs/github/public_members/pezra","schema":{"type":"string"},"style":"simple"}}},"404":{"description":"Not Found if requester is an organization member and user is not a member"}}GitHubBearerToken�9�1 /3?�c�7�E/orgs/list-members/orgs/{org}/membersGETList organization membersList all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.{"parameters":[{"$ref":"#/components/parameters/org"},{"description":"Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. \n\\* `all` - All members the authenticated user can see.","in":"query","name":"filter","schema":{"default":"all","enum":["2fa_disabled","all"],"type":"string"},"style":"form"},{"description":"Filter members returned by their role. Can be one of: \n\\* `all` - All members of the organization, regardless of role. \n\\* `admin` - Organization owners. \n\\* `member` - Non-owner organization members.","in":"query","name":"role","schema":{"default":"all","enum":["all","admin","member"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/simple-user-items"}},"schema":{"items":{"$ref":"#/components/schemas/simple-user"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"302":{"description":"Response if requester is not an organization member","headers":{"Location":{"example":"https://api.github.com/orgs/github/public_members","schema":{"type":"string"},"style":"simple"}}},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� �� � �z�7 KOi�
�?�3/orgs/list-outside-collaborators/orgs/{org}/outside_collaboratorsGETList outside collaborators for an organizationList all users who are outside collaborators of an organization.{"parameters":[{"$ref":"#/components/parameters/org"},{"description":"Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. \n\\* `all`: All outside collaborators.","in":"query","name":"filter","schema":{"default":"all","enum":["2fa_disabled","all"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/simple-user-items"}},"schema":{"items":{"$ref":"#/components/schemas/simple-user"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken� �6 KQ_��y�/orgs/remove-membership-for-user/orgs/{org}/memberships/{username}DELETERemove organization membership for a userIn order to remove a user's membership with an organization, the authenticated user must be an organization owner.
If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken��5 EQY��W�Q/orgs/set-membership-for-user/orgs/{org}/memberships/{username}PUTSet organization membership for a userOnly authenticated organization owners can add a member to the organization or update the member's role.
* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@2.22/rest/reference/orgs#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.
* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.
**Rate limits**
To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/username"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"role":{"default":"member","description":"The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.","enum":["admin","member"],"type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"response-if-user-already-had-membership-with-organization":{"$ref":"#/components/examples/org-membership-response-if-user-has-an-active-admin-membership-with-organization"}},"schema":{"$ref":"#/components/schemas/org-membership"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
E �IAE �x�; gsa
��)/enterprise-admin/get-pre-receive-hook-for-org/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}GETGet a pre-receive hook for an organization{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/pre-receive-hook-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/org-pre-receive-hook"}},"schema":{"$ref":"#/components/schemas/org-pre-receive-hook"}}},"description":"Response"}}GitHubBearerToken��: kGa���g/enterprise-admin/list-pre-receive-hooks-for-org/orgs/{org}/pre-receive-hooksGETList pre-receive hooks for an organizationList all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/direction"},{"description":"The sort order for the response collection.","in":"query","name":"sort","schema":{"default":"created","enum":["created","updated","name"],"type":"string"},"style":"form"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/org-pre-receive-hook-items"}},"schema":{"items":{"$ref":"#/components/schemas/org-pre-receive-hook"},"type":"array"}}},"description":"Response"}}GitHubBearerToken��9 Mem�?�y�O/orgs/remove-outside-collaborator/orgs/{org}/outside_collaborators/{username}DELETERemove outside collaborator from an organizationRemoving a user from this list will remove them from all the organization's repositories.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"Response"},"422":{"content":{"application/json":{"examples":{"response-if-user-is-a-member-of-the-organization":{"value":{"documentation_url":"https://docs.github.com/enterprise-server@2.22/rest/reference/orgs#remove-outside-collaborator","message":"You cannot specify an organization member to remove as an outside collaborator."}}},"schema":{"properties":{"documentation_url":{"type":"string"},"message":{"type":"string"}},"type":"object"}}},"description":"Unprocessable Entity if user is a member of the organization"}}GitHubBearerToken� �8 cey�/�y�e/orgs/convert-member-to-outside-collaborator/orgs/{org}/outside_collaborators/{username}PUTConvert an organization member to outside collaboratorWhen an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)".{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"202":{"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object"}}},"description":"User is getting converted asynchronously"},"204":{"description":"User was converted"},"403":{"description":"Forbidden if user is the last owner of the organization or not a member of the organization"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
�
� �k � �=�? ;5I�g�I� /projects/create-for-org/orgs/{org}/projectsPOSTCreate an organization projectCreates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.{"parameters":[{"$ref":"#/components/parameters/org"}],"requestBody":{"content":{"application/json":{"example":{"body":"High-level roadmap for the upcoming year.","name":"Organization Roadmap"},"schema":{"properties":{"body":{"description":"The description of the project.","type":"string"},"name":{"description":"The name of the project.","type":"string"}},"required":["name"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/project-2"}},"schema":{"$ref":"#/components/schemas/project"}}},"description":"Response"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"},"422":{"$ref":"#/components/responses/validation_failed_simple"}}GitHubBearerToken��> 75A�g� �%/projects/list-for-org/orgs/{org}/projectsGETList organization projectsLists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.{"parameters":[{"$ref":"#/components/parameters/org"},{"description":"Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.","in":"query","name":"state","schema":{"default":"open","enum":["open","closed","all"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/project-items"}},"schema":{"items":{"$ref":"#/components/schemas/project"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"422":{"$ref":"#/components/responses/validation_failed_simple"}}GitHubBearerToken��=
�s{� �o�-/enterprise-admin/update-pre-receive-hook-enforcement-for-org/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}PATCHUpdate pre-receive hook enforcement for an organizationFor pre-receive hooks which are allowed to be configured at the org level, you can set `enforcement` and `allow_downstream_configuration`{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/pre-receive-hook-id"}],"requestBody":{"content":{"application/json":{"example":{"allow_downstream_configuration":false,"enforcement":"enabled"},"schema":{"properties":{"allow_downstream_configuration":{"description":"Whether repositories can override enforcement.","type":"boolean"},"enforcement":{"description":"The state of enforcement for the hook on this repository.","type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/org-pre-receive-hook-2"}},"schema":{"$ref":"#/components/schemas/org-pre-receive-hook"}}},"description":"Response"}}GitHubBearerToken�[�<
�s{���)/enterprise-admin/remove-pre-receive-hook-enforcement-for-org/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}DELETERemove pre-receive hook enforcement for an organizationRemoves any overrides for this hook at the org level for this org.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/pre-receive-hook-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/org-pre-receive-hook"}},"schema":{"$ref":"#/components/schemas/org-pre-receive-hook"}}},"description":"Response"}}GitHubBearerToken
,
� � (�, �!�D 1/Iq�i�O/repos/list-for-org/orgs/{org}/reposGETList organization repositoriesLists repositories for the specified organization.{"parameters":[{"$ref":"#/components/parameters/org"},{"description":"Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. However, the `internal` value is not yet supported when a GitHub App calls this API with an installation access token.","in":"query","name":"type","schema":{"enum":["all","public","private","forks","sources","member","internal"],"type":"string"},"style":"form"},{"description":"Can be one of `created`, `updated`, `pushed`, `full_name`.","in":"query","name":"sort","schema":{"default":"created","enum":["created","updated","pushed","full_name"],"type":"string"},"style":"form"},{"description":"Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc`","in":"query","name":"direction","schema":{"enum":["asc","desc"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/minimal-repository-items"}},"schema":{"items":{"$ref":"#/components/schemas/minimal-repository"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�S�C uW�
�yQ/orgs/remove-public-membership-for-authenticated-user/orgs/{org}/public_members/{username}DELETERemove public organization membership for the authenticated user{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�L�B
oW��)�y�5/orgs/set-public-membership-for-authenticated-user/orgs/{org}/public_members/{username}PUTSet public organization membership for the authenticated userThe user can publicize their own membership. (A user cannot publicize the membership for another user.)
Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-verbs)."{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken� �A WWk
�y� /orgs/check-public-membership-for-user/orgs/{org}/public_members/{username}GETCheck public organization membership for a user{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"Response if user is a public member"},"404":{"description":"Not Found if user is not a public member"}}GitHubBearerToken�t�@ =AM�/�I�3/orgs/list-public-members/orgs/{org}/public_membersGETList public organization membersMembers of an organization can choose to have their membership publicized or not.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/simple-user-items"}},"schema":{"items":{"$ref":"#/components/schemas/simple-user"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
v o ��|P��� }A 6
�
�
H
� k� �CM ����e1���K E������{dU=&�
�
�
�
�
�
�
�
n
Z
F
1
� � � � � � s X >� �Y ��~ � ���� * ����gN4�����dK4!����q[L+���$Kenterprise-admin/unsuspend-user�;yenterprise-admin/promote-user-to-be-site-administrator| ;issues/create-milestone� issue-issues/get-event�0eenterprise-admin/list-personal-access-tokens 3issues/delete-label�-issues/get-label�3issues/create-label�I
issues/li4kenterprise-admin/list-pre-receive-hooks-for-org �+[enterprise-admin/list-pre-receive-hooks2ienterprise-admin/list-pre-receive-environments/issues/add-labels�5issues/get-milestone�5menterprise-admin/list-pre-receive-hooks-for-repo�7issues/create-comment�3kenterprise-admin/update-pre-receive-environment$Menterprise-admin/update-org-name1genterprise-admin/update-ldap-mapping-for-user 1genterprise-admin/update-ldap-mapping-for-team
*Yenterprise-admin/update-global-webhook/centerprise-admin/sync-ldap-mapping-for-user
} /centerprise-admin/sync-ldap-mapping-for-team ; org#issues/listy<}enterprise-admin/list-runner-applications-for-enterprise[%Oenterprise-admin/list-public-keysC�enterprise-admin/update-pre-receive-hook-enforcement-for-repo�� is<}enterprise-admin/list-self-hosted-runners-for-enterpriseZ ;issues/delete-milestone�
orgs/updaE�
enterprise-admin/set-self-hosted-runners-in-group-for-enterpriseW1eenterprise-admin/start-configuration-process"Genterprise-admin/set-settings;{enterprise-admin/start-pre-receive-environment-download"Genterprise-admin/suspend-user�or3gists/list-for-userr ;issues/update-milestone�3issues/update-label�7issues/update-comment�'issues/update�'issues/unlock�/issues/set-labels�3issues/remove-label� ;issues/remove-assignees� =issues/remove-all-labels�#issues/lock�9issues/list-milestones� Cissues/list-labels-on-issue� Cissues/list-labels-for-repo�%Missues/list-labels-for-milestone�5issues/list-for-repo�3issues/list-for-org �'Qissues/list-for-authenticated-userT$Kissues/list-events-for-timeline� Cissues/list-events-for-repo�1issues/list-events�"Gissues/list-comments-for-repo�5issues/list-comments�7issues/list-assignees %Menterprise-admin/upgrade-license N� enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterpriseSI�enterprise-admin/remove-self-hosted-runner-from-group-for-enterpriseYC�enterprise-admin/remove-pre-receive-hook-enforcement-for-repo�B�enterprise-admin/remove-pre-receive-hook-enforcement-for-org �Q�%enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterpriseU/aenterprise-admin/remove-authorized-ssh-key (Uenterprise-admin/ping-global-webhookF�enterprise-admin/list-self-hosted-runners-in-group-for-enterpriseVC� enterprise-admin/list-self-hosted-runner-groups-for-enterpriseM1issues/get-comment�!issues/get�7issues/delete-comment�'issues/create�&Oissues/check-user-can-be-assigned 5issues/add-assignees�9gitignore/get-templatev Cgitignore/get-all-templatesu)git/update-ref�9git/list-matching-refs|%git/get-tree�#git/get-tag�#git/get-ref})git/get-commit{%git/get-bloby)git/delete-ref+git/create-tree�)git/create-tag�)git/create-ref~/git/create-commitz+git/create-blobx5gists/update-commentm%gists/updateh%gists/unstars!gists/starr1gists/list-starrede/gists/list-publicd-gists/list-forkso1gists/list-commitsn3gists/list-commentsi!gists/listb1gists/get-revisiont/gists/get-commentk
gists/getf!gists/forkp5gists/delete-commentl%gists/deleteg5gists/create-commentj%gists/createc9gists/check-is-starredq-_enterprise-admin/update-username-for-user D� enterprise-admin/update-self-hosted-runner-group-for-enterpriseQB�enterprise-admin/update-pre-receive-hook-enforcement-for-org �,]enterprise-admin/update-pre-receive-hook omepage":"https://github.com","name":"Hello-World","private":false},"schema":{"properties":{"allow_merge_commit":{"default":true,"description":"Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.","type":"boolean"},"allow_rebase_merge":{"default":true,"description":"Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.","type":"boolean"},"allow_squash_merge":{"default":true,"description":"Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.","type":"boolean"},"auto_init":{"default":false,"description":"Pass `true` to create an initial commit with empty README.","type":"boolean"},"delete_branch_on_merge":{"default":false,"description":"Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.","type":"boolean"},"description":{"description":"A short description of the repository.","type":"string"},"gitignore_template":{"description":"Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".","type":"string"},"has_issues":{"default":true,"description":"Either `true` to enable issues for this repository or `false` to disable them.","type":"boolean"},"has_projects":{"default":true,"description":"Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.","type":"boolean"},"has_wiki":{"default":true,"description":"Either `true` to enable the wiki for this repository or `false` to disable it.","type":"boolean"},"homepage":{"description":"A URL with more information about the repository.","type":"string"},"is_template":{"default":false,"description":"Either `true` to make this repo available as a template repository or `false` to prevent it.","type":"boolean"},"license_template":{"description":"Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".","type":"string"},"name":{"description":"The name of the repository.","type":"string"},"private":{"default":false,"description":"Whether the repository is private.","type":"boolean"},"team_id":{"description":"The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.","type":"integer"},"visibility":{"description":"Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.","enum":["public","private","internal"],"type":"string"}},"required":["name"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/repository"}},"schema":{"$ref":"#/components/schemas/repository"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/Hello-World","schema":{"type":"string"},"style":"simple"}}},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
o �
o �h�F !/!�)�I�{/teams/list/orgs/{org}/teamsGETList teamsLists all teams in an organization that are visible to the authenticated user.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-items"}},"schema":{"items":{"$ref":"#/components/schemas/team"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken��E 3/O�q�?�]/repos/create-in-org/orgs/{org}/reposPOSTCreate an organization repositoryCreates a new repository in the specified organization. The authenticated user must be a member of the organization.
**OAuth scope requirements**
When using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
* `repo` scope to create a private repository{"parameters":[{"$ref":"#/components/parameters/org"}],"requestBody":{"content":{"application/json":{"example":{"description":"This is your first repository","has_issues":true,"has_projects":true,"has_wiki":true,"h F
% c % �:�I 3G'��{Q/teams/delete-in-org/orgs/{org}/teams/{team_slug}DELETEDelete a teamTo delete a team, the authenticated user must be an organization owner or team maintainer.
If you are an organization owner, deleting a parent team will delete all of its child teams as well.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�(�H /G1�[�{�a/teams/get-by-name/orgs/{org}/teams/{team_slug}GETGet a team by nameGets a team using the team's `slug`. GitHub Enterprise Server generates the `slug` from the team `name`.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-full"}},"schema":{"$ref":"#/components/schemas/team-full"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�m�G %/'� � �U/teams/create/orgs/{org}/teamsPOSTCreate a teamTo create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization)."
When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)".{"parameters":[{"$ref":"#/components/parameters/org"}],"requestBody":{"content":{"application/json":{"example":{"description":"A great team","name":"Justice League","permission":"admin","privacy":"closed"},"schema":{"properties":{"description":{"description":"The description of the team.","type":"string"},"maintainers":{"description":"List GitHub IDs for organization members who will become team maintainers.","items":{"type":"string"},"type":"array"},"name":{"description":"The name of the team.","type":"string"},"parent_team_id":{"description":"The ID of a team to set as the parent team.","type":"integer"},"permission":{"default":"pull","description":"**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.","enum":["pull","push","admin"],"type":"string"},"privacy":{"description":"The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`","enum":["secret","closed"],"type":"string"},"repo_names":{"description":"The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.","items":{"type":"string"},"type":"array"}},"required":["name"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-full"}},"schema":{"$ref":"#/components/schemas/team-full"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
| �| �[�K G_-�A�m�C/teams/list-discussions-in-org/orgs/{org}/teams/{team_slug}/discussionsGETList discussionsList all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"description":"Pinned discussions only filter","in":"query","name":"pinned","schema":{"type":"string"},"style":"form"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-discussion-items"}},"schema":{"items":{"$ref":"#/components/schemas/team-discussion"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�!�J 3G'�Q�]�}/teams/update-in-org/orgs/{org}/teams/{team_slug}PATCHUpdate a teamTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"}],"requestBody":{"content":{"application/json":{"example":{"description":"new team description","name":"new team name","privacy":"closed"},"schema":{"properties":{"description":{"description":"The description of the team.","type":"string"},"name":{"description":"The name of the team.","type":"string"},"parent_team_id":{"description":"The ID of a team to set as the parent team.","nullable":true,"type":"integer"},"permission":{"default":"pull","description":"**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.","enum":["pull","push","admin"],"type":"string"},"privacy":{"description":"The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.","enum":["secret","closed"],"type":"string"}},"type":"object"}}}}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-full"}},"schema":{"$ref":"#/components/schemas/team-full"}}},"description":"Response"}}GitHubBearerToken
J� �R�N I�3�s�eQ/teams/delete-discussion-in-org/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}DELETEDelete a discussionDelete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/discussion-number"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�l�M
C�-�s�e�/teams/get-discussion-in-org/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}GETGet a discussionGet a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/discussion-number"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-discussion"}},"schema":{"$ref":"#/components/schemas/team-discussion"}}},"description":"Response"}}GitHubBearerToken�2�L I_3�1�O�/teams/create-discussion-in-org/orgs/{org}/teams/{team_slug}/discussionsPOSTCreate a discussionCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"}],"requestBody":{"content":{"application/json":{"example":{"body":"Hi! This is an area for us to collaborate as a team.","title":"Our first team post"},"schema":{"properties":{"body":{"description":"The discussion post's body text.","type":"string"},"private":{"default":false,"description":"Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.","type":"boolean"},"title":{"description":"The discussion post's title.","type":"string"}},"required":["title","body"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-discussion"}},"schema":{"$ref":"#/components/schemas/team-discussion"}}},"description":"Response"}}GitHubBearerToken
@� �6�Q
Y�C�c�)�5/teams/create-discussion-comment-in-org/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/commentsPOSTCreate a discussion commentCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/discussion-number"}],"requestBody":{"content":{"application/json":{"example":{"body":"Do you like apples?"},"schema":{"properties":{"body":{"description":"The discussion comment's body text.","type":"string"}},"required":["body"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-discussion-comment"}},"schema":{"$ref":"#/components/schemas/team-discussion-comment"}}},"description":"Response"}}GitHubBearerToken�t�P
W�=�}�g�c/teams/list-discussion-comments-in-org/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/commentsGETList discussion commentsList all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/discussion-number"},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-discussion-comment-items"}},"schema":{"items":{"$ref":"#/components/schemas/team-discussion-comment"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�<�O
I�3�c��/teams/update-discussion-in-org/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}PATCHUpdate a discussionEdits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/discussion-number"}],"requestBody":{"content":{"application/json":{"example":{"title":"Welcome to our first team post"},"schema":{"properties":{"body":{"description":"The discussion post's body text.","type":"string"},"title":{"description":"The discussion post's title.","type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-discussion-2"}},"schema":{"$ref":"#/components/schemas/team-discussion"}}},"description":"Response"}}GitHubBearerToken
� �� �f�T
Y�;C�/��9/teams/update-discussion-comment-in-org/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}PATCHUpdate a discussion commentEdits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/discussion-number"},{"$ref":"#/components/parameters/comment-number"}],"requestBody":{"content":{"application/json":{"example":{"body":"Do you like pineapples?"},"schema":{"properties":{"body":{"description":"The discussion comment's body text.","type":"string"}},"required":["body"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-discussion-comment-2"}},"schema":{"$ref":"#/components/schemas/team-discussion-comment"}}},"description":"Response"}}GitHubBearerToken�H�S Y�;C�'�IQ/teams/delete-discussion-comment-in-org/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}DELETEDelete a discussion commentDeletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/discussion-number"},{"$ref":"#/components/parameters/comment-number"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�s�R
S�;=�)�I�5/teams/get-discussion-comment-in-org/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}GETGet a discussion commentGet a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/discussion-number"},{"$ref":"#/components/parameters/comment-number"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-discussion-comment"}},"schema":{"$ref":"#/components/schemas/team-discussion-comment"}}},"description":"Response"}}GitHubBearerToken
[ �[ �(�V
s�Og�_�o�c/reactions/create-for-team-discussion-comment-in-org/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactionsPOSTCreate reaction for a team discussion commentCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/discussion-number"},{"$ref":"#/components/parameters/comment-number"}],"requestBody":{"content":{"application/json":{"example":{"content":"heart"},"schema":{"properties":{"content":{"description":"The [reaction type](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#reaction-types) to add to the team discussion comment.","enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"],"type":"string"}},"required":["content"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction"}},"schema":{"$ref":"#/components/schemas/reaction"}}},"description":"Response"},"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction"}},"schema":{"$ref":"#/components/schemas/reaction"}}},"description":"Response"}}GitHubBearerToken�u�U
o�Oe�u�7�'/reactions/list-for-team-discussion-comment-in-org/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactionsGETList reactions for a team discussion commentList the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/discussion-number"},{"$ref":"#/components/parameters/comment-number"},{"description":"Returns a single [reaction type](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment.","in":"query","name":"content","schema":{"enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction-items"}},"schema":{"items":{"$ref":"#/components/schemas/reaction"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
� �� �g�X
_�U�!�C�'/reactions/list-for-team-discussion-in-org/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactionsGETList reactions for a team discussionList the reactions to a [team discussion](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/discussion-number"},{"description":"Returns a single [reaction type](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion.","in":"query","name":"content","schema":{"enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction-items"}},"schema":{"items":{"$ref":"#/components/schemas/reaction"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�)�W e�k[�7�'Q/reactions/delete-for-team-discussion-comment/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}DELETEDelete team discussion comment reaction**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.
Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/discussion-number"},{"$ref":"#/components/parameters/comment-number"},{"$ref":"#/components/parameters/reaction-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken
� i�� � �[ ?W/��=�3/teams/list-members-in-org/orgs/{org}/teams/{team_slug}/membersGETList team membersTeam members will include the members of child teams.
To list members in a team, the team must be visible to the authenticated user.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"description":"Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.","in":"query","name":"role","schema":{"default":"all","enum":["member","maintainer","all"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/simple-user-items"}},"schema":{"items":{"$ref":"#/components/schemas/simple-user"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�$�Z U�7K�e�CQ/reactions/delete-for-team-discussion/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}DELETEDelete team discussion reaction**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.
Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/discussion-number"},{"$ref":"#/components/parameters/reaction-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken��Y
c�W�}�{�c/reactions/create-for-team-discussion-in-org/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactionsPOSTCreate reaction for a team discussionCreate a reaction to a [team discussion](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/discussion-number"}],"requestBody":{"content":{"application/json":{"example":{"content":"heart"},"schema":{"properties":{"content":{"description":"The [reaction type](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#reaction-types) to add to the team discussion.","enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"],"type":"string"}},"required":["content"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction"}},"schema":{"$ref":"#/components/schemas/reaction"}}},"description":"Response"},"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction"}},"schema":{"$ref":"#/components/schemas/reaction"}}},"description":"Response"}}GitHubBearerToken
- - �O�\ UuI�;�S� /teams/get-membership-for-user-in-org/orgs/{org}/teams/{team_slug}/memberships/{username}GETGet team membership for a userTeam members will include the members of child teams.
To get a user's membership with a team, the team must be visible to the authenticated user.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.
**Note:**
The response contains the `state` of the membership and the member's `role`.
The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#create-a-team).{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"response-if-user-is-a-team-maintainer":{"$ref":"#/components/examples/team-membership-response-if-user-is-a-team-maintainer"}},"schema":{"$ref":"#/components/schemas/team-membership"}}},"description":"Response"},"404":{"description":"if user has no team membership"}}GitHubBearerToken
� � �
�] iu]��I� /teams/add-or-update-membership-for-user-in-org/orgs/{org}/teams/{team_slug}/memberships/{username}PUTAdd or update team membership for a userTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."
An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team.
If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/username"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"role":{"default":"member","description":"The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.","enum":["member","maintainer"],"type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"response-if-users-membership-with-team-is-now-pending":{"$ref":"#/components/examples/team-membership-response-if-users-membership-with-team-is-now-pending"}},"schema":{"$ref":"#/components/schemas/team-membership"}}},"description":"Response"},"403":{"description":"Forbidden if team synchronization is set up"},"422":{"description":"Unprocessable Entity if you attempt to add an organization to a team"}}GitHubBearerToken
� 4+� �}�` asU�m�W�/teams/check-permissions-for-project-in-org/orgs/{org}/teams/{team_slug}/projects/{project_id}GETCheck team permissions for a projectChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/project-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-project"}},"schema":{"$ref":"#/components/schemas/team-project"}}},"description":"Response"},"404":{"description":"Not Found if project is not managed by this team"}}GitHubBearerToken��_ AY1�s�#�7/teams/list-projects-in-org/orgs/{org}/teams/{team_slug}/projectsGETList team projectsLists the organization projects for a team.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-project-items"}},"schema":{"items":{"$ref":"#/components/schemas/team-project"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�H�^ [uO�M�S�Y/teams/remove-membership-for-user-in-org/orgs/{org}/teams/{team_slug}/memberships/{username}DELETERemove team membership for a userTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."
**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"Response"},"403":{"description":"Forbidden if team synchronization is set up"}}GitHubBearerToken
" �E" � �c ;S9��#�O/teams/list-repos-in-org/orgs/{org}/teams/{team_slug}/reposGETList team repositoriesLists a team's repositories visible to the authenticated user.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/minimal-repository-items"}},"schema":{"items":{"$ref":"#/components/schemas/minimal-repository"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�l�b CsE�?�WQ/teams/remove-project-in-org/orgs/{org}/teams/{team_slug}/projects/{project_id}DELETERemove a project from a teamRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/project-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�G�a isY��/� /teams/add-or-update-project-permissions-in-org/orgs/{org}/teams/{team_slug}/projects/{project_id}PUTAdd or update team project permissionsAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/project-id"}],"requestBody":{"content":{"application/json":{"schema":{"nullable":true,"properties":{"permission":{"description":"The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-verbs).\"","enum":["read","write","admin"],"type":"string"}},"type":"object"}}}}}{"204":{"description":"Response"},"403":{"content":{"application/json":{"examples":{"response-if-the-project-is-not-owned-by-the-organization":{"value":{"documentation_url":"https://docs.github.com/enterprise-server@2.22/rest/reference/teams#add-or-update-team-project-permissions","message":"Must have admin rights to Repository."}}},"schema":{"properties":{"documentation_url":{"type":"string"},"message":{"type":"string"}},"type":"object"}}},"description":"Forbidden if the project is not owned by the organization"}}GitHubBearerToken
z z ��d [q[�5� �/teams/check-permissions-for-repo-in-org/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}GETCheck team permissions for a repositoryChecks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header.
If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"alternative-response-with-repository-permissions":{"$ref":"#/components/examples/team-repository-alternative-response-with-repository-permissions"}},"schema":{"$ref":"#/components/schemas/team-repository"}}},"description":"Alternative response with repository permissions"},"204":{"description":"Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header."},"404":{"description":"Not Found if team does not have permission for the repository"}}GitHubBearerToken
u �u �k�f =qK�y� Q/teams/remove-repo-in-org/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}DELETERemove a repository from a teamIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken��e cq_�y�CQ/teams/add-or-update-repo-permissions-in-org/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}PUTAdd or update team repository permissionsTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-verbs)."
**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.
For more information about the permission levels, see "[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)".{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"permission":{"description":"The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n\\* `maintain` - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations. \n\\* `triage` - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.","enum":["pull","push","admin","maintain","triage"],"type":"string"}},"type":"object"}}}}}{"204":{"description":"Response"}}GitHubBearerToken
T �
t
T �2�j 5OK
�W�=/projects/update-card/projects/columns/cards/{card_id}PATCHUpdate an existing project card{"parameters":[{"$ref":"#/components/parameters/card-id"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"archived":{"description":"Whether or not the card is archived","example":false,"type":"boolean"},"note":{"description":"The project card's note","example":"Update all gems","nullable":true,"type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/project-card"}},"schema":{"$ref":"#/components/schemas/project-card"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed_simple"}}GitHubBearerToken�f�i 5O7
�)�e/projects/delete-card/projects/columns/cards/{card_id}DELETEDelete a project card{"parameters":[{"$ref":"#/components/parameters/card-id"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"content":{"application/json":{"schema":{"properties":{"documentation_url":{"type":"string"},"errors":{"items":{"type":"string"},"type":"array"},"message":{"type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�H�h /O1
�)�;/projects/get-card/projects/columns/cards/{card_id}GETGet a project card{"parameters":[{"$ref":"#/components/parameters/card-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/project-card"}},"schema":{"$ref":"#/components/schemas/project-card"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�<�g ;S-��#�/teams/list-child-in-org/orgs/{org}/teams/{team_slug}/teamsGETList child teamsLists the child teams of the team specified by `{team_slug}`.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.{"parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/team-slug"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"response-if-child-teams-exist":{"$ref":"#/components/examples/team-items-response-if-child-teams-exist"}},"schema":{"items":{"$ref":"#/components/schemas/team"},"type":"array"}}},"description":"if child teams exist","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
� �W�� �z�n 9GO
�E�_/projects/update-column/projects/columns/{column_id}PATCHUpdate an existing project column{"parameters":[{"$ref":"#/components/parameters/column-id"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"description":"Name of the project column","example":"Remaining tasks","type":"string"}},"required":["name"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/project-column"}},"schema":{"$ref":"#/components/schemas/project-column"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken��m 9G;
�-� /projects/delete-column/projects/columns/{column_id}DELETEDelete a project column{"parameters":[{"$ref":"#/components/parameters/column-id"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken�N�l 3G5
�-�C/projects/get-column/projects/columns/{column_id}GETGet a project column{"parameters":[{"$ref":"#/components/parameters/column-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/project-column"}},"schema":{"$ref":"#/components/schemas/project-column"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�S�k 1[3
�M�/projects/move-card/projects/columns/cards/{card_id}/movesPOSTMove a project card{"parameters":[{"$ref":"#/components/parameters/card-id"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"column_id":{"description":"The unique identifier of the column the card should be moved to","example":42,"type":"integer"},"position":{"description":"The position of the card in a column. Can be one of: `top`, `bottom`, or `after:<card_id>` to place after the specified card.","example":"bottom","pattern":"^(?:top|bottom|after:\\d+)$","type":"string"}},"required":["position"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"content":{"application/json":{"schema":{"properties":{"documentation_url":{"type":"string"},"errors":{"items":{"properties":{"code":{"type":"string"},"field":{"type":"string"},"message":{"type":"string"},"resource":{"type":"string"}},"type":"object"},"type":"array"},"message":{"type":"string"}},"type":"object"}}},"description":"Forbidden"},"422":{"$ref":"#/components/responses/validation_failed"},"503":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string"},"documentation_url":{"type":"string"},"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"type":"array"},"message":{"type":"string"}},"type":"object"}}},"description":"Response"}}GitHubBearerToken
R �R �z�q 5S7
�c�S/projects/move-column/projects/columns/{column_id}/movesPOSTMove a project column{"parameters":[{"$ref":"#/components/parameters/column-id"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"position":{"description":"The position of the column in a project. Can be one of: `first`, `last`, or `after:<column_id>` to place after the specified column.","example":"last","pattern":"^(?:first|last|after:\\d+)$","type":"string"}},"required":["position"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed_simple"}}GitHubBearerToken�J�p 5S7
�o�g/projects/create-card/projects/columns/{column_id}/cardsPOSTCreate a project card{"parameters":[{"$ref":"#/components/parameters/column-id"}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"note":{"description":"The project card's note","example":"Update all gems","nullable":true,"type":"string"}},"required":["note"],"type":"object"},{"properties":{"content_id":{"description":"The unique identifier of the content associated with the card","example":42,"type":"integer"},"content_type":{"description":"The piece of content associated with the card","example":"PullRequest","type":"string"}},"required":["content_id","content_type"],"type":"object"}]}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/project-card"}},"schema":{"$ref":"#/components/schemas/project-card"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/validation-error"},{"$ref":"#/components/schemas/validation-error-simple"}]}}},"description":"Validation failed"},"503":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string"},"documentation_url":{"type":"string"},"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"type":"array"},"message":{"type":"string"}},"type":"object"}}},"description":"Response"}}GitHubBearerToken�^�o 3S1
��/projects/list-cards/projects/columns/{column_id}/cardsGETList project cards{"parameters":[{"$ref":"#/components/parameters/column-id"},{"description":"Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.","in":"query","name":"archived_state","schema":{"default":"not_archived","enum":["all","archived","not_archived"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/project-card-items"}},"schema":{"items":{"$ref":"#/components/schemas/project-card"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken
<
1
R< ��t +9-�?��E/projects/update/projects/{project_id}PATCHUpdate a projectUpdates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.{"parameters":[{"$ref":"#/components/parameters/project-id"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"body":{"description":"Body of the project","example":"This project represents the sprint of the first week in January","nullable":true,"type":"string"},"name":{"description":"Name of the project","example":"Week One Sprint","type":"string"},"organization_permission":{"description":"The baseline permission that all organization members have on this project","enum":["read","write","admin","none"],"type":"string"},"private":{"description":"Whether or not this project can be seen by everyone.","type":"boolean"},"state":{"description":"State of the project; either 'open' or 'closed'","example":"open","type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/project-3"}},"schema":{"$ref":"#/components/schemas/project"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"content":{"application/json":{"schema":{"properties":{"documentation_url":{"type":"string"},"errors":{"items":{"type":"string"},"type":"array"},"message":{"type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found if the authenticated user does not have access to the project"},"410":{"$ref":"#/components/responses/gone"},"422":{"$ref":"#/components/responses/validation_failed_simple"}}GitHubBearerToken�[�s +9-�3�/�K/projects/delete/projects/{project_id}DELETEDelete a projectDeletes a project board. Returns a `404 Not Found` status if projects are disabled.{"parameters":[{"$ref":"#/components/parameters/project-id"}],"requestBody":null}{"204":{"description":"Delete Success"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"content":{"application/json":{"schema":{"properties":{"documentation_url":{"type":"string"},"errors":{"items":{"type":"string"},"type":"array"},"message":{"type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"}}GitHubBearerToken�K�r %9'�)�/�G/projects/get/projects/{project_id}GETGet a projectGets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.{"parameters":[{"$ref":"#/components/parameters/project-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/project-3"}},"schema":{"$ref":"#/components/schemas/project"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken
� 5m� �B�w EkG���w/projects/remove-collaborator/projects/{project_id}/collaborators/{username}DELETERemove user as a collaboratorRemoves a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.{"parameters":[{"$ref":"#/components/parameters/project-id"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�D�v ?k=�G�q�w/projects/add-collaborator/projects/{project_id}/collaborators/{username}PUTAdd project collaboratorAdds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.{"parameters":[{"$ref":"#/components/parameters/project-id"},{"$ref":"#/components/parameters/username"}],"requestBody":{"content":{"application/json":{"schema":{"nullable":true,"properties":{"permission":{"default":"write","description":"The permission to grant the collaborator.","enum":["read","write","admin"],"example":"write","type":"string"}},"type":"object"}}}}}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�G�u CUA�I�!�Y/projects/list-collaborators/projects/{project_id}/collaboratorsGETList project collaboratorsLists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators.{"parameters":[{"$ref":"#/components/parameters/project-id"},{"description":"Filters the collaborators by their affiliation. Can be one of: \n\\* `outside`: Outside collaborators of a project that are not a member of the project's organization. \n\\* `direct`: Collaborators with permissions to a project, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.","in":"query","name":"affiliation","schema":{"default":"all","enum":["outside","direct","all"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/simple-user-items"}},"schema":{"items":{"$ref":"#/components/schemas/simple-user"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� - �|�{ )#m�5U�E/rate-limit/get/rate_limitGETGet rate limit status for the authenticated user**Note:** Accessing this endpoint does not count against your REST API rate limit.
**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/rate-limit-overview"}},"schema":{"$ref":"#/components/schemas/rate-limit-overview"}}},"description":"Response","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/x-rate-limit-limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/x-rate-limit-remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/x-rate-limit-reset"}}},"304":{"$ref":"#/components/responses/not_modified"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�(�z 9I;
�G�M/projects/create-column/projects/{project_id}/columnsPOSTCreate a project column{"parameters":[{"$ref":"#/components/parameters/project-id"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"description":"Name of the project column","example":"Remaining tasks","type":"string"}},"required":["name"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"example":{"cards_url":"https://api.github.com/projects/columns/367/cards","created_at":"2016-09-05T14:18:44Z","id":367,"name":"To Do","node_id":"MDEzOlByb2plY3RDb2x1bW4zNjc=","project_url":"https://api.github.com/projects/120","updated_at":"2016-09-05T14:22:28Z","url":"https://api.github.com/projects/columns/367"},"schema":{"$ref":"#/components/schemas/project-column"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed_simple"}}GitHubBearerToken�K�y 7I5
�W�
/projects/list-columns/projects/{project_id}/columnsGETList project columns{"parameters":[{"$ref":"#/components/parameters/project-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/project-column-items"}},"schema":{"items":{"$ref":"#/components/schemas/project-column"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken� �x
M�O�m��{/projects/get-permission-for-user/projects/{project_id}/collaborators/{username}/permissionGETGet project permission for a userReturns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.{"parameters":[{"$ref":"#/components/parameters/project-id"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/project-collaborator-permission"}},"schema":{"$ref":"#/components/schemas/project-collaborator-permission"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� |(� � �� %73��K�G/repos/update/repos/{owner}/{repo}PATCHUpdate a repository**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#replace-all-repository-topics) endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"description":"This is your first repository","has_issues":true,"has_projects ]�Z�~ %73� �u�/repos/delete/repos/{owner}/{repo}DELETEDelete a repositoryDeleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.
If an organization owner has configured the organization to prevent members from deleting organization-owned
repositories, you will get a `403 Forbidden` response.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"204":{"description":"Response"},"307":{"$ref":"#/components/responses/temporary_redirect"},"403":{"content":{"application/json":{"example":{"documentation_url":"https://docs.github.com/enterprise-server@2.22/rest/reference/repos#delete-a-repository","message":"Organization members cannot delete repositories."},"schema":{"properties":{"documentation_url":{"type":"string"},"message":{"type":"string"}},"type":"object"}}},"description":"If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�P�} 7-��u�'/repos/get/repos/{owner}/{repo}GETGet a repositoryWhen you pass the `scarlet-witch-preview` media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.
The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default-response":{"$ref":"#/components/examples/full-repository-default-response"},"response-with-scarlet-witch-preview-media-type":{"$ref":"#/components/examples/full-repository-response-with-scarlet-witch-preview-media-type"}},"schema":{"$ref":"#/components/schemas/full-repository"}}},"description":"Response"},"301":{"$ref":"#/components/responses/moved_permanently"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken� �| ;=A�%�1�y/reactions/delete-legacy/reactions/{reaction_id}DELETEDelete a reaction (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/).
OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#discussion-comments).{"parameters":[{"$ref":"#/components/parameters/reaction-id"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"410":{"$ref":"#/components/responses/gone"}}GitHubBearerToken ":true,"has_wiki":true,"homepage":"https://github.com","name":"Hello-World","private":true},"schema":{"properties":{"allow_forking":{"default":false,"description":"Either `true` to allow private forks, or `false` to prevent private forks.","type":"boolean"},"allow_merge_commit":{"default":true,"description":"Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.","type":"boolean"},"allow_rebase_merge":{"default":true,"description":"Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.","type":"boolean"},"allow_squash_merge":{"default":true,"description":"Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.","type":"boolean"},"archived":{"default":false,"description":"`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.","type":"boolean"},"default_branch":{"description":"Updates the default branch for this repository.","type":"string"},"delete_branch_on_merge":{"default":false,"description":"Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.","type":"boolean"},"description":{"description":"A short description of the repository.","type":"string"},"has_issues":{"default":true,"description":"Either `true` to enable issues for this repository or `false` to disable them.","type":"boolean"},"has_projects":{"default":true,"description":"Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.","type":"boolean"},"has_wiki":{"default":true,"description":"Either `true` to enable the wiki for this repository or `false` to disable it.","type":"boolean"},"homepage":{"description":"A URL with more information about the repository.","type":"string"},"is_template":{"default":false,"description":"Either `true` to make this repo available as a template repository or `false` to prevent it.","type":"boolean"},"name":{"description":"The name of the repository.","type":"string"},"private":{"default":false,"description":"Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.","type":"boolean"},"visibility":{"description":"Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`.\"","enum":["public","private","internal"],"type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/full-repository"}},"schema":{"$ref":"#/components/schemas/full-repository"}}},"description":"Response"},"307":{"$ref":"#/components/responses/temporary_redirect"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� ( K8� � �S� McE��I�e/actions/get-job-for-workflow-run/repos/{owner}/{repo}/actions/jobs/{job_id}GETGet a job for a workflow runGets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/job-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/job"}},"schema":{"$ref":"#/components/schemas/job"}}},"description":"Response"}}GitHubBearerToken�'�
?�5�e��Q/actions/download-artifact/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}GETDownload an artifactGets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in
the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to
the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.
GitHub Apps must have the `actions:read` permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/artifact-id"},{"in":"path","name":"archive_format","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":null}{"302":{"description":"Response","headers":{"Location":{"$ref":"#/components/headers/location"}}}}GitHubBearerToken�� ;w1�!�SQ/actions/delete-artifact/repos/{owner}/{repo}/actions/artifacts/{artifact_id}DELETEDelete an artifactDeletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/artifact-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�Y� 5w+� �S�y/actions/get-artifact/repos/{owner}/{repo}/actions/artifacts/{artifact_id}GETGet an artifactGets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/artifact-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/artifact"}},"schema":{"$ref":"#/components/schemas/artifact"}}},"description":"Response"}}GitHubBearerToken�T� K[K�� �/actions/list-artifacts-for-repo/repos/{owner}/{repo}/actions/artifactsGETList artifacts for a repositoryLists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/artifact-paginated"}},"schema":{"properties":{"artifacts":{"items":{"$ref":"#/components/schemas/artifact"},"type":"array"},"total_count":{"type":"integer"}},"required":["total_count","artifacts"],"type":"object"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
� � |� �� a}e�O�u�)/actions/create-registration-token-for-repo/repos/{owner}/{repo}/actions/runners/registration-tokenPOSTCreate a registration token for a repositoryReturns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate
using an access token with the `repo` scope to use this endpoint.
#### Example using registration token
Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.
```
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
```{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authentication-token"}},"schema":{"$ref":"#/components/schemas/authentication-token"}}},"description":"Response"}}GitHubBearerToken� � _k_�O�u�_/actions/list-runner-applications-for-repo/repos/{owner}/{repo}/actions/runners/downloadsGETList runner applications for a repositoryLists binaries for the runner application that you can download and run.
You must authenticate using an access token with the `repo` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/runner-application-items"}},"schema":{"items":{"$ref":"#/components/schemas/runner-application"},"type":"array"}}},"description":"Response"}}GitHubBearerToken�� _W_�/� �//actions/list-self-hosted-runners-for-repo/repos/{owner}/{repo}/actions/runnersGETList self-hosted runners for a repositoryLists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/runner-paginated-no-labels"}},"schema":{"properties":{"runners":{"items":{"$ref":"#/components/schemas/runner-no-labels"},"type":"array"},"total_count":{"type":"number"}},"required":["total_count","runners"],"type":"object"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�X� amU�?�I�/actions/download-job-logs-for-workflow-run/repos/{owner}/{repo}/actions/jobs/{job_id}/logsGETDownload job logs for a workflow runGets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look
for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can
use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must
have the `actions:read` permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/job-id"}],"requestBody":null}{"302":{"description":"Response","headers":{"Location":{"example":"https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D","schema":{"type":"string"},"style":"simple"}}}}GitHubBearerToken
� � �v� �h� SQS�I�e�9/actions/list-workflow-runs-for-repo/repos/{owner}/{repo}/actions/runsGETList workflow runs for a repositoryLists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#parameters).
Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/actor"},{"$ref":"#/components/parameters/workflow-run-branch"},{"$ref":"#/components/parameters/event"},{"$ref":"#/components/parameters/workflow-run-status"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/created"},{"$ref":"#/components/parameters/exclude-pull-requests"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/workflow-run-paginated"}},"schema":{"properties":{"total_count":{"type":"integer"},"workflow_runs":{"items":{"$ref":"#/components/schemas/workflow-run"},"type":"array"}},"required":["total_count","workflow_runs"],"type":"object"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�p� cog��OQ/actions/delete-self-hosted-runner-from-repo/repos/{owner}/{repo}/actions/runners/{runner_id}DELETEDelete a self-hosted runner from a repositoryForces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
You must authenticate using an access token with the `repo`
scope to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/runner-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken� �
[o_�;�O�/actions/get-self-hosted-runner-for-repo/repos/{owner}/{repo}/actions/runners/{runner_id}GETGet a self-hosted runner for a repositoryGets a specific self-hosted runner configured in a repository.
You must authenticate using an access token with the `repo` scope to use this
endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/runner-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/runner-no-labels"}},"schema":{"$ref":"#/components/schemas/runner-no-labels"}}},"description":"Response"}}GitHubBearerToken�o� UqY�)�u�-/actions/create-remove-token-for-repo/repos/{owner}/{repo}/actions/runners/remove-tokenPOSTCreate a remove token for a repositoryReturns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.
You must authenticate using an access token with the `repo` scope to use this endpoint.
#### Example using remove token
To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.
```
./config.sh remove --token TOKEN
```{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authentication-token-2"}},"schema":{"$ref":"#/components/schemas/authentication-token"}}},"description":"Response"}}GitHubBearerToken
D �
��D �e� Cq7� �I�/actions/cancel-workflow-run/repos/{owner}/{repo}/actions/runs/{run_id}/cancelPOSTCancel a workflow runCancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/run-id"}],"requestBody":null}{"202":{"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object"}}},"description":"Response"}}GitHubBearerToken�
� SwC� �q�/actions/list-workflow-run-artifacts/repos/{owner}/{repo}/actions/runs/{run_id}/artifactsGETList workflow run artifactsLists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/run-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/artifact-paginated"}},"schema":{"properties":{"artifacts":{"items":{"$ref":"#/components/schemas/artifact"},"type":"array"},"total_count":{"type":"integer"}},"required":["total_count","artifacts"],"type":"object"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�:� Cc7��IQ/actions/delete-workflow-run/repos/{owner}/{repo}/actions/runs/{run_id}DELETEDelete a workflow runDelete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is
private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use
this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/run-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken��
=c1��;� /actions/get-workflow-run/repos/{owner}/{repo}/actions/runs/{run_id}GETGet a workflow runGets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/run-id"},{"$ref":"#/components/parameters/exclude-pull-requests"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/workflow-run"}},"schema":{"$ref":"#/components/schemas/workflow-run"}}},"description":"Response"}}GitHubBearerToken
� �u` � �_� ;o/�%�I�/actions/re-run-workflow/repos/{owner}/{repo}/actions/runs/{run_id}/rerunPOSTRe-run a workflowRe-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/run-id"}],"requestBody":null}{"201":{"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object"}}},"description":"Response"}}GitHubBearerToken�� Mm=��IQ/actions/delete-workflow-run-logs/repos/{owner}/{repo}/actions/runs/{run_id}/logsDELETEDelete workflow run logsDeletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/run-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�D� QmA�;�I�/actions/download-workflow-run-logs/repos/{owner}/{repo}/actions/runs/{run_id}/logsGETDownload workflow run logsGets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for
`Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use
this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have
the `actions:read` permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/run-id"}],"requestBody":null}{"302":{"description":"Response","headers":{"Location":{"example":"https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D","schema":{"type":"string"},"style":"simple"}}}}GitHubBearerToken�?� QmE�1�g�q/actions/list-jobs-for-workflow-run/repos/{owner}/{repo}/actions/runs/{run_id}/jobsGETList jobs for a workflow runLists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#parameters).{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/run-id"},{"description":"Filters jobs by their `completed_at` timestamp. Can be one of: \n\\* `latest`: Returns jobs from the most recent execution of the workflow run. \n\\* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run.","in":"query","name":"filter","schema":{"default":"latest","enum":["latest","all"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/job-paginated"}},"schema":{"properties":{"jobs":{"items":{"$ref":"#/components/schemas/job"},"type":"array"},"total_count":{"type":"integer"}},"required":["total_count","jobs"],"type":"object"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
4 4 4 �T� ;s;�i�S�/actions/get-repo-secret/repos/{owner}/{repo}/actions/secrets/{secret_name}GETGet a repository secretGets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/secret-name"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/actions-secret"}},"schema":{"$ref":"#/components/schemas/actions-secret"}}},"description":"Response"}}GitHubBearerToken�$� CmC�M�u�!/actions/get-repo-public-key/repos/{owner}/{repo}/actions/secrets/public-keyGETGet a repository public keyGets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/actions-public-key"}},"schema":{"$ref":"#/components/schemas/actions-public-key"}}},"description":"Response"}}GitHubBearerToken�H� ?W;�� �)/actions/list-repo-secrets/repos/{owner}/{repo}/actions/secretsGETList repository secretsLists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/actions-secret-paginated"}},"schema":{"properties":{"secrets":{"items":{"$ref":"#/components/schemas/actions-secret"},"type":"array"},"total_count":{"type":"integer"}},"required":["total_count","secrets"],"type":"object"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
� � �u� UsU�
�-�!/actions/create-or-update-repo-secret/repos/{owner}/{repo}/actions/secrets/{secret_name}PUTCreate or update a repository secretCreates or updates a repository secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use
this endpoint.
#### Example encrypting a secret using Node.js
Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
```
const sodium = require('tweetsodium');
const key = "base64-encoded-public-key";
const value = "plain-text-secret";
// Convert the message and key to Uint8Array's (Buffer implements that interface)
const messageBytes = Buffer.from(value);
const keyBytes = Buffer.from(key, 'base64');
// Encrypt using LibSodium.
const encryptedBytes = sodium.seal(messageBytes, keyBytes);
// Base64 the encrypted secret
const encrypted = Buffer.from(encryptedBytes).toString('base64');
console.log(encrypted);
```
#### Example encrypting a secret using Python
Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.
```
from base64 import b64encode
from nacl import encoding, public
def encrypt(public_key: str, secret_value: str) -> str:
"""Encrypt a Unicode string using the public key."""
public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
sealed_box = public.SealedBox(public_key)
encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
return b64encode(encrypted).decode("utf-8")
```
#### Example encrypting a secret using C#
Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
```
var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
```
#### Example encrypting a secret using Ruby
Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
```ruby
require "rbnacl"
require "base64"
key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
public_key = RbNaCl::PublicKey.new(key)
box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
encrypted_secret = box.encrypt("my_secret")
# Print the base64 encoded secret
puts Base64.strict_encode64(encrypted_secret)
```{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/secret-name"}],"requestBody":{"content":{"application/json":{"example":{"encrypted_value":"c2VjcmV0","key_id":"012345678912345678"},"schema":{"properties":{"encrypted_value":{"description":"Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-a-repository-public-key) endpoint.","pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$","type":"string"},"key_id":{"description":"ID of the key you used to encrypt the secret.","type":"string"}},"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object"}}},"description":"Response when creating a secret"},"204":{"description":"Response when updating a secret"}}GitHubBearerToken
�
�
� �(� 5w)�=�S�y/actions/get-workflow/repos/{owner}/{repo}/actions/workflows/{workflow_id}GETGet a workflowGets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/workflow-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/workflow"}},"schema":{"$ref":"#/components/schemas/workflow"}}},"description":"Response"}}GitHubBearerToken�I� C[?�
� �/actions/list-repo-workflows/repos/{owner}/{repo}/actions/workflowsGETList repository workflowsLists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/workflow-paginated"}},"schema":{"properties":{"total_count":{"type":"integer"},"workflows":{"items":{"$ref":"#/components/schemas/workflow"},"type":"array"}},"required":["total_count","workflows"],"type":"object"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�-� AsA�K�SQ/actions/delete-repo-secret/repos/{owner}/{repo}/actions/secrets/{secret_name}DELETEDelete a repository secretDeletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/secret-name"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken
E uE �,�
A�1�u�C�9/actions/list-workflow-runs/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runsGETList workflow runsList all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#parameters).
Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/workflow-id"},{"$ref":"#/components/parameters/actor"},{"$ref":"#/components/parameters/workflow-run-branch"},{"$ref":"#/components/parameters/event"},{"$ref":"#/components/parameters/workflow-run-status"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/created"},{"$ref":"#/components/parameters/exclude-pull-requests"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/workflow-run-paginated"}},"schema":{"properties":{"total_count":{"type":"integer"},"workflow_runs":{"items":{"$ref":"#/components/schemas/workflow-run"},"type":"array"}},"required":["total_count","workflow_runs"],"type":"object"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�� M�
M��#Q/actions/create-workflow-dispatch/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatchesPOSTCreate a workflow dispatch eventYou can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)."
You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)."{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/workflow-id"}],"requestBody":{"content":{"application/json":{"example":{"inputs":{"home":"San Francisco, CA","name":"Mona the Octocat"},"ref":"topic-branch"},"schema":{"properties":{"inputs":{"additionalProperties":{"type":"string"},"description":"Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.","maxProperties":10,"type":"object"},"ref":{"description":"The git reference for the workflow. The reference can be a branch or tag name.","type":"string"}},"required":["ref"],"type":"object"}}},"required":true}}{"204":{"description":"Response"}}GitHubBearerToken
F � �� F � �" Cq7��I�/repos/get-branch-protection/repos/{owner}/{repo}/branches/{branch}/protectionGETGet branch protectionProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/branch-protection"}},"schema":{"$ref":"#/components/schemas/branch-protection"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�.�! -[%
�I�i/repos/get-branch/repos/{owner}/{repo}/branches/{branch}GETGet a branch{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/branch-with-protection"}}},"description":"Response"},"301":{"$ref":"#/components/responses/moved_permanently"},"404":{"$ref":"#/components/responses/not_found"},"415":{"$ref":"#/components/responses/preview_header_missing"}}GitHubBearerToken�w� 3I'
��;/repos/list-branches/repos/{owner}/{repo}/branchesGETList branches{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.","in":"query","name":"protected","schema":{"type":"boolean"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/short-branch-with-protection-items"}},"schema":{"items":{"$ref":"#/components/schemas/short-branch"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�]� OaK�Y�-�G/issues/check-user-can-be-assigned/repos/{owner}/{repo}/assignees/{assignee}GETCheck if a user can be assignedChecks if a user has permission to be assigned to an issue in this repository.
If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.
Otherwise a `404` status code is returned.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"in":"path","name":"assignee","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":null}{"204":{"description":"If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/basic-error"}}},"description":"Otherwise a `404` status code is returned."}}GitHubBearerToken�� 7K)�;� �/issues/list-assignees/repos/{owner}/{repo}/assigneesGETList assigneesLists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/simple-user-items"}},"schema":{"items":{"$ref":"#/components/schemas/simple-user"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"","nullable":true,"type":"boolean"},"enforce_admins":{"description":"Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.","nullable":true,"type":"boolean"},"required_conversation_resolution":{"description":"Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.","type":"boolean"},"required_linear_history":{"description":"Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://help.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.","type":"boolean"},"required_pull_request_reviews":{"description":"Require at least one approving review on a pull request, before merging. Set to `null` to disable.","nullable":true,"properties":{"dismiss_stale_reviews":{"description":"Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.","type":"boolean"},"dismissal_restrictions":{"description":"Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.","properties":{"teams":{"description":"The list of team `slug`s with dismissal access","items":{"type":"string"},"type":"array"},"users":{"description":"The list of user `login`s with dismissal access","items":{"type":"string"},"type":"array"}},"type":"object"},"require_code_owner_reviews":{"description":"Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them.","type":"boolean"},"required_approving_review_count":{"description":"Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.","type":"integer"}},"type":"object"},"required_status_checks":{"description":"Require status checks to pass before merging. Set to `null` to disable.","nullable":true,"properties":{"contexts":{"description":"The list of status checks to require in order to merge into this branch","items":{"type":"string"},"type":"array"},"strict":{"description":"Require branches to be up to date before merging.","type":"boolean"}},"required":["strict","contexts"],"type":"object"},"restrictions":{"description":"Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.","nullable":true,"properties":{"apps":{"description":"The list of app `slug`s with push access","items":{"type":"string"},"type":"array"},"teams":{"description":"The list of team `slug`s with push access","items":{"type":"string"},"type":"array"},"users":{"description":"The list of user `login`s with push access","items":{"type":"string"},"type":"array"}},"required":["users","teams"],"type":"object"}},"required":["required_status_checks","enforce_admins","required_pull_request_reviews","restrictions"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/protected-branch"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed_simple"}}GitHubBearerToken
�� �&�%
O�C��I�Y/repos/get-admin-branch-protection/repos/{owner}/{repo}/branches/{branch}/protection/enforce_adminsGETGet admin branch protectionProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/protected-branch-admin-enforced-2"}},"schema":{"$ref":"#/components/schemas/protected-branch-admin-enforced"}}},"description":"Response"}}GitHubBearerToken��$ Iq=��I�5/repos/delete-branch-protection/repos/{owner}/{repo}/branches/{branch}/protectionDELETEDelete branch protectionProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":null}{"204":{"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken�@�# Iq=�w�O�Q/repos/update-branch-protection/repos/{owner}/{repo}/branches/{branch}/protectionPUTUpdate branch protectionProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Protecting a branch requires admin or owner permissions to the repository.
**Note**: Passing new arrays of `users` and `teams` replaces their previous values.
**Note**: The list of users, apps, and teams in total is limited to 100 items.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":{"content":{"application/json":{"example":{"allow_deletions":true,"allow_force_pushes":true,"enforce_admins":true,"required_conversation_resolution":true,"required_linear_history":true,"required_pull_request_reviews":{"dismiss_stale_reviews":true,"dismissal_restrictions":{"teams":["justice-league"],"users":["octocat"]},"require_code_owner_reviews":true,"required_approving_review_count":2},"required_status_checks":{"contexts":["continuous-integration/travis-ci"],"strict":true},"restrictions":{"apps":["super-ci"],"teams":["justice-league"],"users":["octocat"]}},"schema":{"properties":{"allow_deletions":{"description":"Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.","type":"boolean"},"allow_force_pushes":{"description":"Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` h
; �Hy; �:�)
c�-W��I�5/repos/delete-pull-request-review-protection/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviewsDELETEDelete pull request review protectionProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":null}{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�K�(
]�-Q��I�i/repos/get-pull-request-review-protection/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviewsGETGet pull request review protectionProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/protected-branch-pull-request-review"}},"schema":{"$ref":"#/components/schemas/protected-branch-pull-request-review"}}},"description":"Response"}}GitHubBearerToken��'
U�I��I�5/repos/delete-admin-branch-protection/repos/{owner}/{repo}/branches/{branch}/protection/enforce_adminsDELETEDelete admin branch protectionProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":null}{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken� �&
O�C��I�Y/repos/set-admin-branch-protection/repos/{owner}/{repo}/branches/{branch}/protection/enforce_adminsPOSTSet admin branch protectionProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/protected-branch-admin-enforced-2"}},"schema":{"$ref":"#/components/schemas/protected-branch-admin-enforced"}}},"description":"Response"}}GitHubBearerToken
O � O � �+
W�K�e�I�9/repos/get-commit-signature-protection/repos/{owner}/{repo}/branches/{branch}/protection/required_signaturesGETGet commit signature protectionProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help.
**Note**: You must enable branch protection to require signed commits.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/protected-branch-admin-enforced"}},"schema":{"$ref":"#/components/schemas/protected-branch-admin-enforced"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken� �*
c�-W�I�7�]/repos/update-pull-request-review-protection/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviewsPATCHUpdate pull request review protectionProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
**Note**: Passing new arrays of `users` and `teams` replaces their previous values.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":{"content":{"application/json":{"example":{"dismiss_stale_reviews":true,"dismissal_restrictions":{"teams":["justice-league"],"users":["octocat"]},"require_code_owner_reviews":true,"required_approving_review_count":2},"schema":{"properties":{"dismiss_stale_reviews":{"description":"Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.","type":"boolean"},"dismissal_restrictions":{"description":"Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.","properties":{"teams":{"description":"The list of team `slug`s with dismissal access","items":{"type":"string"},"type":"array"},"users":{"description":"The list of user `login`s with dismissal access","items":{"type":"string"},"type":"array"}},"type":"object"},"require_code_owner_reviews":{"description":"Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed.","type":"boolean"},"required_approving_review_count":{"description":"Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.","type":"integer"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/protected-branch-pull-request-review"}},"schema":{"$ref":"#/components/schemas/protected-branch-pull-request-review"}}},"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� MQ� � �r�/ U� I��IQ/repos/remove-status-check-protection/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checksDELETERemove status check protectionProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�H�.
Q� E��I� /repos/get-status-checks-protection/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checksGETGet status checks protectionProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/status-check-policy"}},"schema":{"$ref":"#/components/schemas/status-check-policy"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�x�-
]�Q�1�I�5/repos/delete-commit-signature-protection/repos/{owner}/{repo}/branches/{branch}/protection/required_signaturesDELETEDelete commit signature protectionProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":null}{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�/�,
]�Q� �I�9/repos/create-commit-signature-protection/repos/{owner}/{repo}/branches/{branch}/protection/required_signaturesPOSTCreate commit signature protectionProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/protected-branch-admin-enforced"}},"schema":{"$ref":"#/components/schemas/protected-branch-admin-enforced"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
O l'
,
� � � �. � � Y 3 � � Z -
�
�
�
Z
A
(
� � � � �
\\ �� v X @ ) ���j3"
� ���'�ydJ. ����qV:@"�����nC* �����jZ6 ����rL/����tT,���S�t���]?
� �6oreactions/list-for-team-discussion-comment-in-org �+Yprojects/create-for-authenticated-user]0creactions/create-for-team-discussion-in-org �8sreactions/create-for-team-discussion-comment-legacy/8sreactions/create-for-team-discussion-comment-in-org �5mreactions/create-for-pull-request-review-comment�'Qreactions/create-for-issue-comment� Areactions/create-for-issue�(Sreactions/create-for-commit-comment[)rate-limit/get � Cpulls/update-review-comment�3pulls/update-review�3pulls/update-branch�%pulls/update�3pulls/submit-review� ;pulls/request-reviewers�%Mpulls/remove-requested-reviewers�#pulls/merge�1pulls/list-reviews�(Spulls/list-review-comments-for-repo� Apulls/list-review-comments�#Ipulls/list-requested-reviewers�-pulls/list-files�1pulls/list-commits�#Ipulls/list-comments-for-review�!pulls/list� =pulls/get-review-comment�-pulls/get-review� pulls/get�5pulls/dismiss-review� Cpulls/delete-review-comment� Cpulls/delete-pending-review� Cpulls/create-review-comment�3pulls/create-review�*Wpulls/create-reply-for-review-comment�%pulls/create�7pulls/check-if-merged�9projects/update-column �5projects/update-card �+projects/update �!Eprojects/remove-collaborator �5projects/move-column �1projects/move-card �9projects/list-for-repo�7projects/list-for-org �7projects/list-columns � Cprojects/list-collaborators �3projects/list-cards �%Mprojects/get-permission-for-user �3projects/get-column �/projects/get-card �%projects/get �9projects/delete-column �5projects/delete-card �+projects/delete � =projects/create-for-repo� ;projects/create-for-org �9projects/create-column �5projects/create-card � ?projects/add-collaborator �3orgs/update-webhook �#orgs/update �6oorgs/set-public-membership-for-authenticated-user �!Eorgs/set-membership-for-user �9uorgs/remove-public-membership-for-authenticated-user �%Morgs/remove-outside-collaborator �$Korgs/remove-membership-for-user �1orgs/remove-member �/orgs/ping-webhook �1orgs/list-webhooks � =orgs/list-public-members �$Korgs/list-outside-collaborators �/orgs/list-members � Corgs/list-app-installations � orgs/list �-orgs/get-webhook �!Eorgs/get-membership-for-user �
orgs/get �3orgs/delete-webhook �3orgs/create-webhook �0corgs/convert-member-to-outside-collaborator �*Worgs/check-public-membership-for-user �#Iorgs/check-membership-for-user �-_oauth-authorizations/update-authorization=$Moauth-authorizations/list-grants+,]oauth-authorizations/list-authorizations7M� oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint:<}oauth-authorizations/get-or-create-authorization-for-app9"Ioauth-authorizations/get-grant,*Yoauth-authorizations/get-authorization;%Ooauth-authorizations/delete-grant--_oauth-authorizations/delete-authorization<-_oauth-authorizations/create-authorization8 meta/root-meta/get-octocat � meta/get~3markdown/render-raw}+markdown/render|7licenses/get-for-repo�"Ilicenses/get-all-commonly-usedz
�
licenses/%Morgs/list-for-authenticated-user\2gorgs/update-membership-for-authenticated-user[/aorgs/get-membership-for-authenticated-userZ Ireactions/list-for-pull-request-review-comment�%Mreactions/list-for-issue-comment� =reactions/list-for-issue�&Oreactions/list-for-commit-commentZ ;reactions/delete-legacy �1ereactions/delete-for-team-discussion-comment �)Ureactions/delete-for-team-discussion �._reactions/delete-for-pull-request-comment�'%meta/get-zen�9projects/list-for-userx1orgs/list-for-userw(Sreactions/delete-for-commit-comment\0creactions/create-for-team-discussion-legacy11eorgs/list-memberships-for-authenticated-userY
/ �I/ ��2
K�1?��7�1/repos/set-status-check-contexts/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contextsPUTSet status check contextsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"example":{"contexts":["contexts"]},"properties":{"contexts":{"description":"contexts parameter","items":{"type":"string"},"type":"array"}},"required":["contexts"],"type":"object"},{"description":"contexts parameter","items":{"type":"string"},"type":"array"}]}}}}}{"200":{"content":{"application/json":{"example":["continuous-integration/travis-ci"],"schema":{"items":{"type":"string"},"type":"array"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�-�1
S�1G��I�=/repos/get-all-status-check-contexts/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contextsGETGet all status check contextsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":null}{"200":{"content":{"application/json":{"example":["continuous-integration/travis-ci"],"schema":{"items":{"type":"string"},"type":"array"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken��0
U� I�
�E�}/repos/update-status-check-protection/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checksPATCHUpdate status check protectionProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":{"content":{"application/json":{"example":{"contexts":["continuous-integration/travis-ci"],"strict":true},"schema":{"properties":{"contexts":{"description":"The list of status checks to require in order to merge into this branch","items":{"type":"string"},"type":"array"},"strict":{"description":"Require branches to be up to date before merging.","type":"boolean"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/status-check-policy"}},"schema":{"$ref":"#/components/schemas/status-check-policy"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
�o �Y�5
G� ;�G�I�!/repos/get-access-restrictions/repos/{owner}/{repo}/branches/{branch}/protection/restrictionsGETGet access restrictionsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Lists who has access to this protected branch.
**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/branch-restriction-policy"}},"schema":{"$ref":"#/components/schemas/branch-restriction-policy"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken� �4
Q�1E��7�1/repos/remove-status-check-contexts/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contextsDELETERemove status check contextsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"example":{"contexts":["contexts"]},"properties":{"contexts":{"description":"contexts parameter","items":{"type":"string"},"type":"array"}},"required":["contexts"],"type":"object"},{"description":"contexts parameter","items":{"type":"string"},"type":"array"}]}}}}}{"200":{"content":{"application/json":{"example":["continuous-integration/travis-ci"],"schema":{"items":{"type":"string"},"type":"array"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�j�3
K�1?��7�W/repos/add-status-check-contexts/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contextsPOSTAdd status check contextsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"example":{"contexts":["contexts"]},"properties":{"contexts":{"description":"contexts parameter","items":{"type":"string"},"type":"array"}},"required":["contexts"],"type":"object"},{"description":"contexts parameter","items":{"type":"string"},"type":"array"}]}}}}}{"200":{"content":{"application/json":{"example":["continuous-integration/travis-ci","continuous-integration/jenkins"],"schema":{"items":{"type":"string"},"type":"array"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
# �) # ��8
O�C�e�M�7/repos/set-app-access-restrictions/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/appsPUTSet app access restrictionsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
| Type | Description |
| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"example":{"apps":["my-app"]},"properties":{"apps":{"description":"apps parameter","items":{"type":"string"},"type":"array"}},"required":["apps"],"type":"object"},{"items":{"type":"string"},"type":"array"}]}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/integration-items"}},"schema":{"items":{"$ref":"#/components/schemas/integration"},"type":"array"}}},"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�0�7
i�e��I�'/repos/get-apps-with-access-to-protected-branch/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/appsGETGet apps with access to the protected branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/integration-items"}},"schema":{"items":{"$ref":"#/components/schemas/integration"},"type":"array"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken� �6 M� A��IQ/repos/delete-access-restrictions/repos/{owner}/{repo}/branches/{branch}/protection/restrictionsDELETEDelete access restrictionsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Disables the ability to restrict who can push to this branch.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken
� h � ��:
U�I��M�7/repos/remove-app-access-restrictions/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/appsDELETERemove app access restrictionsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
| Type | Description |
| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"example":{"apps":["my-app"]},"properties":{"apps":{"description":"apps parameter","items":{"type":"string"},"type":"array"}},"required":["apps"],"type":"object"},{"items":{"type":"string"},"type":"array"}]}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/integration-items"}},"schema":{"items":{"$ref":"#/components/schemas/integration"},"type":"array"}}},"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken��9
O�C��M�7/repos/add-app-access-restrictions/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/appsPOSTAdd app access restrictionsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
| Type | Description |
| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"example":{"apps":["my-app"]},"properties":{"apps":{"description":"apps parameter","items":{"type":"string"},"type":"array"}},"required":["apps"],"type":"object"},{"items":{"type":"string"},"type":"array"}]}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/integration-items"}},"schema":{"items":{"$ref":"#/components/schemas/integration"},"type":"array"}}},"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
/ �/ ��<
Q�E�O��/repos/set-team-access-restrictions/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teamsPUTSet team access restrictionsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
| Type | Description |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"example":{"teams":["my-team"]},"properties":{"teams":{"description":"teams parameter","items":{"type":"string"},"type":"array"}},"required":["teams"],"type":"object"},{"description":"teams parameter","items":{"type":"string"},"type":"array"}]}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-items"}},"schema":{"items":{"$ref":"#/components/schemas/team"},"type":"array"}}},"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�8�;
k�g�?�I� /repos/get-teams-with-access-to-protected-branch/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teamsGETGet teams with access to the protected branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Lists the teams who have push access to this branch. The list includes child teams.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-items"}},"schema":{"items":{"$ref":"#/components/schemas/team"},"type":"array"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
� �� �L�>
W�K�3��/repos/remove-team-access-restrictions/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teamsDELETERemove team access restrictionsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Removes the ability of a team to push to this branch. You can also remove push access for child teams.
| Type | Description |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"example":{"teams":["my-team"]},"properties":{"teams":{"description":"teams parameter","items":{"type":"string"},"type":"array"}},"required":["teams"],"type":"object"},{"description":"teams parameter","items":{"type":"string"},"type":"array"}]}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-items"}},"schema":{"items":{"$ref":"#/components/schemas/team"},"type":"array"}}},"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�(�=
Q�E�{��/repos/add-team-access-restrictions/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teamsPOSTAdd team access restrictionsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Grants the specified teams push access for this branch. You can also give push access to child teams.
| Type | Description |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"example":{"teams":["my-team"]},"properties":{"teams":{"description":"teams parameter","items":{"type":"string"},"type":"array"}},"required":["teams"],"type":"object"},{"description":"teams parameter","items":{"type":"string"},"type":"array"}]}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-items"}},"schema":{"items":{"$ref":"#/components/schemas/team"},"type":"array"}}},"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� �� �1�@
Q�E�9�Q�7/repos/set-user-access-restrictions/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/usersPUTSet user access restrictionsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.
| Type | Description |
| ------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"example":{"users":["mona"]},"properties":{"users":{"description":"users parameter","items":{"type":"string"},"type":"array"}},"required":["users"],"type":"object"},{"items":{"type":"string"},"type":"array"}]}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/simple-user-items"}},"schema":{"items":{"$ref":"#/components/schemas/simple-user"},"type":"array"}}},"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�(�?
k�g��I�'/repos/get-users-with-access-to-protected-branch/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/usersGETGet users with access to the protected branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Lists the people who have push access to this branch.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/simple-user-items"}},"schema":{"items":{"$ref":"#/components/schemas/simple-user"},"type":"array"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
E =E �t�B
W�K�-�Q�7/repos/remove-user-access-restrictions/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/usersDELETERemove user access restrictionsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Removes the ability of a user to push to this branch.
| Type | Description |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"example":{"users":["mona"]},"properties":{"users":{"description":"users parameter","items":{"type":"string"},"type":"array"}},"required":["users"],"type":"object"},{"items":{"type":"string"},"type":"array"}]}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/simple-user-items"}},"schema":{"items":{"$ref":"#/components/schemas/simple-user"},"type":"array"}}},"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�?�A
Q�E�S�Q�7/repos/add-user-access-restrictions/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/usersPOSTAdd user access restrictionsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Grants the specified people push access for this branch.
| Type | Description |
| ------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/branch"}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"example":{"users":["mona"]},"properties":{"users":{"description":"users parameter","items":{"type":"string"},"type":"array"}},"required":["users"],"type":"object"},{"items":{"type":"string"},"type":"array"}]}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/simple-user-items"}},"schema":{"items":{"$ref":"#/components/schemas/simple-user"},"type":"array"}}},"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken wline":4,"message":"Check your spelling for 'aples'","path":"README.md","raw_details":"Do you mean 'apples' or 'Naples'","start_line":4,"title":"Spell Checker"}],"images":[{"alt":"Super bananas","image_url":"http://example.com/images/42"}],"summary":"There are 0 failures, 2 warnings, and 1 notices.","text":"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.","title":"Mighty Readme report"},"started_at":"2017-11-30T19:39:10Z","status":"completed"}},"example-of-in-progress-conclusion":{"summary":"Response for in_progress conclusion","value":{"external_id":"42","head_sha":"ce587453ced02b1526dfb4cb910479d431683101","name":"mighty_readme","output":{"summary":"","text":"","title":"Mighty Readme report"},"started_at":"2018-05-04T01:14:52Z","status":"in_progress"}}},"schema":{"oneOf":[{"additionalProperties":true,"properties":{"status":{"enum":["completed"]}},"required":["status","conclusion"]},{"additionalProperties":true,"properties":{"status":{"enum":["queued","in_progress"]}}}],"properties":{"actions":{"description":"Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#check-runs-and-requested-actions).\"","items":{"properties":{"description":{"description":"A short explanation of what this action would do. The maximum size is 40 characters.","maxLength":40,"type":"string"},"identifier":{"description":"A reference for the action on the integrator's system. The maximum size is 20 characters.","maxLength":20,"type":"string"},"label":{"description":"The text to be displayed on a button in the web UI. The maximum size is 20 characters.","maxLength":20,"type":"string"}},"required":["label","description","identifier"],"type":"object"},"maxItems":3,"type":"array"},"completed_at":{"description":"The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","format":"date-time","type":"string"},"conclusion":{"description":"**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.","enum":["action_required","cancelled","failure","neutral","success","skipped","stale","timed_out"],"type":"string"},"details_url":{"description":"The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.","type":"string"},"external_id":{"description":"A reference for the run on the integrator's system.","type":"string"},"head_sha":{"description":"The SHA of the commit.","type":"string"},"name":{"description":"The name of the check. For example, \"code-coverage\".","type":"string"},"output":{"description":"Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`out put` object](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#output-object) description.","properties":{"annotations":{"description":"Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#annotations-object) description for details about how to use this parameter.","items":{"properties":{"annotation_level":{"description":"The level of the annotation. Can be one of `notice`, `warning`, or `failure`.","enum":["notice","warning","failure"],"type":"string"},"end_column":{"description":"The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.","type":"integer"},"end_line":{"description":"The end line of the annotation.","type":"integer"},"message":{"description":"A short description of the feedback for these lines of code. The maximum size is 64 KB.","type":"string"},"path":{"description":"The path of the file to add an annotation to. For example, `assets/css/main.css`.","type":"string"},"raw_details":{"description":"Details about this annotation. The maximum size is 64 KB.","type":"string"},"start_column":{"description":"The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.","type":"integer"},"start_line":{"description":"The start line of the annotation.","type":"integer"},"title":{"description":"The title that represents the annotation. The maximum size is 255 characters.","type":"string"}},"required":["path","start_line","end_line","annotation_level","message"],"type":"object"},"maxItems":50,"type":"array"},"images":{"description":"Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#images-object) description for details.","items":{"properties":{"alt":{"description":"The alternative text for the image.","type":"string"},"caption":{"description":"A short image description.","type":"string"},"image_url":{"description":"The full URL of the image.","type":"string"}},"required":["alt","image_url"],"type":"object"},"type":"array"},"summary":{"description":"The summary of the check run. This parameter supports Markdown.","maxLength":65535,"type":"string"},"text":{"description":"The details of the check run. This parameter supports Markdown.","maxLength":65535,"type":"string"},"title":{"description":"The title of the check run.","type":"string"}},"required":["title","summary"],"type":"object"},"started_at":{"description":"The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","format":"date-time","type":"string"},"status":{"default":"queued","description":"The current status. Can be one of `queued`, `in_progress`, or `completed`.","enum":["queued","in_progress","completed"],"type":"string"}},"required":["name","head_sha"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"example-of-completed-conclusion":{"$ref":"#/components/examples/check-run-example-of-completed-conclusion"}},"schema":{"$ref":"#/components/schemas/check-run"}}},"description":"Response"}}GitHubBearerToken
�
�� �1�D !k+�g�U�}/checks/get/repos/{owner}/{repo}/check-runs/{check_run_id}GETGet a check run**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/check-run-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/check-run"}},"schema":{"$ref":"#/components/schemas/check-run"}}},"description":"Response"}}GitHubBearerToken�O�C
'M1�A��U�m/checks/create/repos/{owner}/{repo}/check-runsPOSTCreate a check run**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.
In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"examples":{"example-of-completed-conclusion":{"summary":"Response for completed conclusion","value":{"actions":[{"description":"Allow us to fix these errors for you","identifier":"fix_errors","label":"Fix"}],"completed_at":"2017-11-30T19:49:10Z","conclusion":"success","head_sha":"ce587453ced02b1526dfb4cb910479d431683101","name":"mighty_readme","output":{"annotations":[{"annotation_level":"warning","end_line":2,"message":"Check your spelling for 'banaas'.","path":"README.md","raw_details":"Do you mean 'bananas' or 'banana'?","start_line":2,"title":"Spell Checker"},{"annotation_level":"warning","end_ v tion":"The name of the check. For example, \"code-coverage\".","type":"string"},"output":{"description":"Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#output-object-1) description.","properties":{"annotations":{"description":"Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#annotations-object-1) description for details.","items":{"properties":{"annotation_level":{"description":"The level of the annotation. Can be one of `notice`, `warning`, or `failure`.","enum":["notice","warning","failure"],"type":"string"},"end_column":{"description":"The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.","type":"integer"},"end_line":{"description":"The end line of the annotation.","type":"integer"},"message":{"description":"A short description of the feedback for these lines of code. The maximum size is 64 KB.","type":"string"},"path":{"description":"The path of the file to add an annotation to. For example, `assets/css/main.css`.","type":"string"},"raw_details":{"description":"Details about this annotation. The maximum size is 64 KB.","type":"string"},"start_column":{"description":"The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.","type":"integer"},"start_line":{"description":"The start line of the annotation.","type":"integer"},"title":{"description":"The title that represents the annotation. The maximum size is 255 characters.","type":"string"}},"required":["path","start_line","end_line","annotation_level","message"],"type":"object"},"maxItems":50,"type":"array"},"images":{"description":"Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#annotations-object-1) description for details.","items":{"properties":{"alt":{"description":"The alternative text for the image.","type":"string"},"caption":{"description":"A short image description.","type":"string"},"image_url":{"description":"The full URL of the image.","type":"string"}},"required":["alt","image_url"],"type":"object"},"type":"array"},"summary":{"description":"Can contain Markdown.","maxLength":65535,"type":"string"},"text":{"description":"Can contain Markdown.","maxLength":65535,"type":"string"},"title":{"description":"**Required**.","type":"string"}},"required":["summary"],"type":"object"},"started_at":{"description":"This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","format":"date-time","type":"string"},"status":{"description":"The current status. Can be one of `queued`, `in_progress`, or `completed`.","enum":["queued","in_progress","completed"],"type":"string"}},"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/check-run"}},"schema":{"$ref":"#/components/schemas/check-run"}}},"description":"Response"}}GitHubBearerToken
� � �y�E 'k1�K�q�}/checks/update/repos/{owner}/{repo}/check-runs/{check_run_id}PATCHUpdate a check run**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/check-run-id"}],"requestBody":{"content":{"application/json":{"example":{"completed_at":"2018-05-04T01:14:52Z","conclusion":"success","name":"mighty_readme","output":{"annotations":[{"annotation_level":"warning","end_line":2,"message":"Check your spelling for 'banaas'.","path":"README.md","raw_details":"Do you mean 'bananas' or 'banana'?","start_line":2,"title":"Spell Checker"},{"annotation_level":"warning","end_line":4,"message":"Check your spelling for 'aples'","path":"README.md","raw_details":"Do you mean 'apples' or 'Naples'","start_line":4,"title":"Spell Checker"}],"images":[{"alt":"Super bananas","image_url":"http://example.com/images/42"}],"summary":"There are 0 failures, 2 warnings, and 1 notices.","text":"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.","title":"Mighty Readme report"},"started_at":"2018-05-04T01:14:52Z","status":"completed"},"schema":{"anyOf":[{"additionalProperties":true,"properties":{"status":{"enum":["completed"]}},"required":["conclusion"]},{"additionalProperties":true,"properties":{"status":{"enum":["queued","in_progress"]}}}],"properties":{"actions":{"description":"Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#check-runs-and-requested-actions).\"","items":{"properties":{"description":{"description":"A short explanation of what this action would do. The maximum size is 40 characters.","maxLength":40,"type":"string"},"identifier":{"description":"A reference for the action on the integrator's system. The maximum size is 20 characters.","maxLength":20,"type":"string"},"label":{"description":"The text to be displayed on a button in the web UI. The maximum size is 20 characters.","maxLength":20,"type":"string"}},"required":["label","description","identifier"],"type":"object"},"maxItems":3,"type":"array"},"completed_at":{"description":"The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","format":"date-time","type":"string"},"conclusion":{"description":"**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.","enum":["action_required","cancelled","failure","neutral","success","skipped","stale","timed_out"],"type":"string"},"details_url":{"description":"The URL of the integrator's site that has the full details of the check.","type":"string"},"external_id":{"description":"A reference for the run on the integrator's system.","type":"string"},"name":{"descrip y
} } ��G 3Q5�'�k�]/checks/create-suite/repos/{owner}/{repo}/check-suitesPOSTCreate a check suite**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"head_sha":"d6fde92930d4715a2b49857d24b940956b26d2d3"},"schema":{"properties":{"head_sha":{"description":"The sha of the head commit.","type":"string"}},"required":["head_sha"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/check-suite"}},"schema":{"$ref":"#/components/schemas/check-suite"}}},"description":"when the suite already existed"},"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/check-suite"}},"schema":{"$ref":"#/components/schemas/check-suite"}}},"description":"Response when the suite was created"}}GitHubBearerToken�m�F
;�A�#�}�G/checks/list-annotations/repos/{owner}/{repo}/check-runs/{check_run_id}/annotationsGETList check run annotationsLists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/check-run-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/check-annotation-items"}},"schema":{"items":{"$ref":"#/components/schemas/check-annotation"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
R DR �n�I -s/�=�Y�/checks/get-suite/repos/{owner}/{repo}/check-suites/{check_suite_id}GETGet a check suite**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/check-suite-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/check-suite"}},"schema":{"$ref":"#/components/schemas/check-suite"}}},"description":"Response"}}GitHubBearerToken�8�H Gii�k�E�1/checks/set-suites-preferences/repos/{owner}/{repo}/check-suites/preferencesPATCHUpdate repository preferences for check suitesChanges the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"auto_trigger_checks":[{"app_id":4,"setting":false}]},"schema":{"properties":{"auto_trigger_checks":{"description":"Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#auto_trigger_checks-object) description for details.","items":{"properties":{"app_id":{"description":"The `id` of the GitHub App.","type":"integer"},"setting":{"default":true,"description":"Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.","type":"boolean"}},"required":["app_id","setting"],"type":"object"},"type":"array"}},"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/check-suite-preference"}},"schema":{"$ref":"#/components/schemas/check-suite-preference"}}},"description":"Response"}}GitHubBearerToken
� �� � �K�L Qaa� �Y�//code-scanning/list-alerts-for-repo/repos/{owner}/{repo}/code-scanning/alertsGETList code scanning alerts for a repositoryLists all open code scanning alerts for the default branch (usually `main`
or `master`). You must use an access token with the `security_events` scope to use
this endpoint. GitHub Apps must have the `security_events` read permission to use
this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/tool-name"},{"$ref":"#/components/parameters/tool-guid"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/git-ref"},{"description":"Set to `open`, `fixed`, or `dismissed` to list code scanning alerts in a specific state.","in":"query","name":"state","schema":{"$ref":"#/components/schemas/code-scanning-alert-state"},"style":"form"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/code-scanning-alert-items"}},"schema":{"items":{"$ref":"#/components/schemas/code-scanning-alert-items"},"type":"array"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"503":{"$ref":"#/components/responses/service_unavailable"}}GitHubBearerToken�8�K
9�;�#�Y�/checks/rerequest-suite/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequestPOSTRerequest a check suiteTriggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/check-suite-id"}],"requestBody":null}{"201":{"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object"}}},"description":"Response"}}GitHubBearerToken�j�J
7� M�}�5�!/checks/list-for-suite/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runsGETList check runs in a check suite**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/check-suite-id"},{"$ref":"#/components/parameters/check-name"},{"$ref":"#/components/parameters/status"},{"description":"Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.","in":"query","name":"filter","schema":{"default":"latest","enum":["latest","all"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/check-run-paginated"}},"schema":{"properties":{"check_runs":{"items":{"$ref":"#/components/schemas/check-run"},"type":"array"},"total_count":{"type":"integer"}},"required":["total_count","check_runs"],"type":"object"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
� }� �T�N AE�A�s�y/code-scanning/update-alert/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}PATCHUpdate a code scanning alertUpdates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/alert-number"}],"requestBody":{"content":{"application/json":{"example":{"dismissed_reason":"false positive","state":"dismissed"},"schema":{"properties":{"dismissed_reason":{"$ref":"#/components/schemas/code-scanning-alert-dismissed-reason"},"state":{"$ref":"#/components/schemas/code-scanning-alert-set-state"}},"required":["state"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/code-scanning-alert-dismissed"}},"schema":{"$ref":"#/components/schemas/code-scanning-alert"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"503":{"$ref":"#/components/responses/service_unavailable"}}GitHubBearerToken��M ;?�Y�U�e/code-scanning/get-alert/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}GETGet a code scanning alertGets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.
**Deprecation notice**:
The instances field is deprecated and will, in future, not be included in the response for this endpoint. From GitHub Enterprise Server 3.0, the same information can be retrieved via a GET request to the URL specified by `instances_url`, added in that release.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/alert-number"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/code-scanning-alert"}},"schema":{"$ref":"#/components/schemas/code-scanning-alert"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"503":{"$ref":"#/components/responses/service_unavailable"}}GitHubBearerToken
X X �$�O Qee�#�i�//code-scanning/list-recent-analyses/repos/{owner}/{repo}/code-scanning/analysesGETList code scanning analyses for a repositoryLists the details of all code scanning analyses for a repository,
starting with the most recent.
The response is paginated and you can use the `page` and `per_page` parameters
to list the analyses you're interested in.
By default 30 analyses are listed per page.
The `rules_count` field in the response give the number of rules
that were run in the analysis.
For very old analyses this data is not available,
and `0` is returned in this field.
You must use an access token with the `security_events` scope to use this endpoint.
GitHub Apps must have the `security_events` read permission to use this endpoint.
**Deprecation notice**:
The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/tool-name"},{"$ref":"#/components/parameters/tool-guid"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/per-page"},{"description":"The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/<branch name>` or simply `<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.","in":"query","name":"ref","schema":{"$ref":"#/components/schemas/code-scanning-ref"},"style":"form"},{"description":"Filter analyses belonging to the same SARIF upload.","in":"query","name":"sarif_id","schema":{"$ref":"#/components/schemas/code-scanning-analysis-sarif-id"},"style":"form"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/code-scanning-analysis-items"}},"schema":{"items":{"$ref":"#/components/schemas/code-scanning-analysis"},"type":"array"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"503":{"$ref":"#/components/responses/service_unavailable"}}GitHubBearerToken
, , �P�P AaM�� � /code-scanning/upload-sarif/repos/{owner}/{repo}/code-scanning/sarifsPOSTUpload an analysis as SARIF dataUploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.
There are two places where you can upload code scanning results.
- If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests)."
- If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)."
You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:
```
gzip -c analysis-data.sarif | base64 -w0
```
SARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.
The `202 Accepted`, response includes an `id` value.
You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.
For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)."{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"checkout_uri":{"description":"The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.","example":"file:///github/workspace/","format":"uri","type":"string"},"commit_sha":{"$ref":"#/components/schemas/code-scanning-analysis-commit-sha"},"ref":{"$ref":"#/components/schemas/code-scanning-ref"},"sarif":{"$ref":"#/components/schemas/code-scanning-analysis-sarif-file-2"},"started_at":{"description":"The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","format":"date-time","type":"string"},"tool_name":{"description":"The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.","type":"string"}},"required":["commit_sha","ref","sarif"],"type":"object"}}},"required":true}}{"202":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/code-scanning-sarif-upload"}},"schema":{"$ref":"#/components/schemas/code-scanning-sarifs-receipt"}}},"description":"Response"},"400":{"description":"Bad Request if the sarif field is invalid"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"413":{"description":"Payload Too Large if the sarif field is too large"},"503":{"$ref":"#/components/responses/service_unavailable"}}GitHubBearerToken
� �� ��R =ie�]�M�/repos/check-collaborator/repos/{owner}/{repo}/collaborators/{username}GETCheck if a user is a repository collaboratorFor organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
Team members will include the members of child teams.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"Response if user is a collaborator"},"404":{"description":"Not Found if user is not a collaborator"}}GitHubBearerToken�'�Q =SG�w�s�/repos/list-collaborators/repos/{owner}/{repo}/collaboratorsGETList repository collaboratorsFor organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
Team members will include the members of child teams.
You must have push access to the repository in order to list collaborators.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"Filter collaborators returned by their affiliation. Can be one of: \n\\* `outside`: All outside collaborators of an organization-owned repository. \n\\* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.","in":"query","name":"affiliation","schema":{"default":"all","enum":["outside","direct","all"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/collaborator-items"}},"schema":{"items":{"$ref":"#/components/schemas/collaborator"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
� L� �J�T
?iM
�MQ/repos/remove-collaborator/repos/{owner}/{repo}/collaborators/{username}DELETERemove a repository collaborator{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�0�S 9iG�c�5�m/repos/add-collaborator/repos/{owner}/{repo}/collaborators/{username}PUTAdd a repository collaboratorThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
For more information on permission levels, see "[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)".
Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-verbs)."
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#invitations).
**Rate limits**
You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/username"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"permission":{"default":"push","description":"The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.","enum":["pull","push","admin","maintain","triage"],"type":"string"},"permissions":{"example":"\"push\"","type":"string"}},"type":"object"}}}}}{"201":{"content":{"application/json":{"examples":{"response-when-a-new-invitation-is-created":{"$ref":"#/components/examples/repository-invitation-response-when-a-new-invitation-is-created"}},"schema":{"$ref":"#/components/schemas/repository-invitation"}}},"description":"Response when a new invitation is created"},"204":{"description":"Response when person is already a collaborator"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� � �� �h�Y Cc;
�u�y/repos/update-commit-comment/repos/{owner}/{repo}/comments/{comment_id}PATCHUpdate a commit comment{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"requestBody":{"content":{"application/json":{"example":{"body":"Nice change"},"schema":{"properties":{"body":{"description":"The contents of the comment","type":"string"}},"required":["body"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/commit-comment-2"}},"schema":{"$ref":"#/components/schemas/commit-comment"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�u�X Cc;
�Q�5/repos/delete-commit-comment/repos/{owner}/{repo}/comments/{comment_id}DELETEDelete a commit comment{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"requestBody":null}{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken� �W =c5
�Q�u/repos/get-commit-comment/repos/{owner}/{repo}/comments/{comment_id}GETGet a commit comment{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/commit-comment"}},"schema":{"$ref":"#/components/schemas/commit-comment"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�"�V SIW�� �?/repos/list-commit-comments-for-repo/repos/{owner}/{repo}/commentsGETList commit comments for a repositoryCommit Comments use [these custom media types](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types/).
Comments are ordered by ascending ID.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/commit-comment-items"}},"schema":{"items":{"$ref":"#/components/schemas/commit-comment"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�=�U [W��M�{/repos/get-collaborator-permission-level/repos/{owner}/{repo}/collaborators/{username}/permissionGETGet repository permissions for a userChecks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"response-if-user-has-admin-permissions":{"$ref":"#/components/examples/repository-collaborator-permission-response-if-user-has-admin-permissions"}},"schema":{"$ref":"#/components/schemas/repository-collaborator-permission"}}},"description":"if user has admin permissions"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
]� �5�\ S�M�?�/Q/reactions/delete-for-commit-comment/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}DELETEDelete a commit comment reaction**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.
Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#comments).{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"},{"$ref":"#/components/parameters/reaction-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken� �[ SwU�Q�e�s/reactions/create-for-commit-comment/repos/{owner}/{repo}/comments/{comment_id}/reactionsPOSTCreate reaction for a commit commentCreate a reaction to a [commit comment](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"requestBody":{"content":{"application/json":{"example":{"content":"heart"},"schema":{"properties":{"content":{"description":"The [reaction type](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#reaction-types) to add to the commit comment.","enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"],"type":"string"}},"required":["content"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction"}},"schema":{"$ref":"#/components/schemas/reaction"}}},"description":"Reaction exists"},"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction"}},"schema":{"$ref":"#/components/schemas/reaction"}}},"description":"Reaction created"},"415":{"$ref":"#/components/responses/preview_header_missing"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken� �Z OwS�{�-� /reactions/list-for-commit-comment/repos/{owner}/{repo}/comments/{comment_id}/reactionsGETList reactions for a commit commentList the reactions to a [commit comment](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#comments).{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"},{"description":"Returns a single [reaction type](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment.","in":"query","name":"content","schema":{"enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction-items"}},"schema":{"items":{"$ref":"#/components/schemas/reaction"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
� � ��] 1G%�i�Y�;/repos/list-commits/repos/{owner}/{repo}/commitsGETList commits**Signature verification object**
The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
These are the possible values for `reason` in the `verification` object:
| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).","in":"query","name":"sha","schema":{"type":"string"},"style":"form"},{"description":"Only commits containing this file path will be returned.","in":"query","name":"path","schema":{"type":"string"},"style":"form"},{"description":"GitHub login or email address by which to filter by commit author.","in":"query","name":"author","schema":{"type":"string"},"style":"form"},{"$ref":"#/components/parameters/since"},{"description":"Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","in":"query","name":"until","schema":{"format":"date-time","type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/commit-items"}},"schema":{"items":{"$ref":"#/components/schemas/commit"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"400":{"$ref":"#/components/responses/bad_request"},"404":{"$ref":"#/components/responses/not_found"},"409":{"$ref":"#/components/responses/conflict"},"500":{"$ref":"#/components/responses/internal_error"}}GitHubBearerToken
i ��i �m�` Cs;�S� �/repos/create-commit-comment/repos/{owner}/{repo}/commits/{commit_sha}/commentsPOSTCreate a commit commentCreate a comment for a commit using its `:commit_sha`.
This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/commit-sha"}],"requestBody":{"content":{"application/json":{"example":{"body":"Great stuff","line":1,"path":"file1.txt","position":4},"schema":{"properties":{"body":{"description":"The contents of the comment.","type":"string"},"line":{"description":"**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.","type":"integer"},"path":{"description":"Relative path of the file to comment on.","type":"string"},"position":{"description":"Line index in the diff to comment on.","type":"integer"}},"required":["body"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/commit-comment"}},"schema":{"$ref":"#/components/schemas/commit-comment"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/Hello-World/comments/1","schema":{"type":"string"},"style":"simple"}}},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�c�_ Is5�+�y�?/repos/list-comments-for-commit/repos/{owner}/{repo}/commits/{commit_sha}/commentsGETList commit commentsUse the `:commit_sha` to specify the commit that will have its comments listed.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/commit-sha"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/commit-comment-items"}},"schema":{"items":{"$ref":"#/components/schemas/commit-comment"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�;�^
S� G�S�Q�;/repos/list-branches-for-head-commit/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-headGETList branches for HEAD commitProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/commit-sha"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/branch-short-items"}},"schema":{"items":{"$ref":"#/components/schemas/branch-short"},"type":"array"}}},"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
�
� ��a kmc�1�y�S/repos/list-pull-requests-associated-with-commit/repos/{owner}/{repo}/commits/{commit_sha}/pullsGETList pull requests associated with a commitLists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#list-pull-requests) endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/commit-sha"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pull-request-simple-items"}},"schema":{"items":{"$ref":"#/components/schemas/pull-request-simple"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
� � ��b -S%�'�5�7/repos/get-commit/repos/{owner}/{repo}/commits/{ref}GETGet a commitReturns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.
**Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
You can pass the appropriate [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.
To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
**Signature verification object**
The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
These are the possible values for `reason` in the `verification` object:
| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/per-page"},{"description":"ref parameter","in":"path","name":"ref","required":true,"schema":{"type":"string"},"style":"simple","x-multi-segment":true}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/commit"}},"schema":{"$ref":"#/components/schemas/commit"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"},"500":{"$ref":"#/components/responses/internal_error"}}GitHubBearerToken
Z �Z �|�d AmW�!�/�1/checks/list-suites-for-ref/repos/{owner}/{repo}/commits/{ref}/check-suitesGETList check suites for a Git reference**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"ref parameter","in":"path","name":"ref","required":true,"schema":{"type":"string"},"style":"simple","x-multi-segment":true},{"description":"Filters check suites by GitHub App `id`.","example":1,"in":"query","name":"app_id","schema":{"type":"integer"},"style":"form"},{"$ref":"#/components/parameters/check-name"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/check-suite-paginated"}},"schema":{"properties":{"check_suites":{"items":{"$ref":"#/components/schemas/check-suite"},"type":"array"},"total_count":{"type":"integer"}},"required":["total_count","check_suites"],"type":"object"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�"�c 3iS�E�}�!/checks/list-for-ref/repos/{owner}/{repo}/commits/{ref}/check-runsGETList check runs for a Git reference**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"ref parameter","in":"path","name":"ref","required":true,"schema":{"type":"string"},"style":"simple","x-multi-segment":true},{"$ref":"#/components/parameters/check-name"},{"$ref":"#/components/parameters/status"},{"description":"Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.","in":"query","name":"filter","schema":{"default":"latest","enum":["latest","all"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"in":"query","name":"app_id","schema":{"type":"integer"},"style":"form"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/check-run-paginated"}},"schema":{"properties":{"check_runs":{"items":{"$ref":"#/components/schemas/check-run"},"type":"array"},"total_count":{"type":"integer"}},"required":["total_count","check_runs"],"type":"object"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
� \�� � �g 7]3���o/repos/compare-commits/repos/{owner}/{repo}/compare/{basehead}GETCompare two commitsThe `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `<USERNAME>:branch`.
The response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](htt ��v�f QeU�'�5�/repos/list-commit-statuses-for-ref/repos/{owner}/{repo}/commits/{ref}/statusesGETList commit statuses for a referenceUsers with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.
This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"ref parameter","in":"path","name":"ref","required":true,"schema":{"type":"string"},"style":"simple","x-multi-segment":true},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/status-items"}},"schema":{"items":{"$ref":"#/components/schemas/status"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"301":{"$ref":"#/components/responses/moved_permanently"}}GitHubBearerToken� �e Oam�g�5�/repos/get-combined-status-for-ref/repos/{owner}/{repo}/commits/{ref}/statusGETGet the combined status for a specific referenceUsers with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.
Additionally, a combined `state` is returned. The `state` is one of:
* **failure** if any of the contexts report as `error` or `failure`
* **pending** if there are no statuses or a context is `pending`
* **success** if the latest status for all contexts is `success`{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"ref parameter","in":"path","name":"ref","required":true,"schema":{"type":"string"},"style":"simple","x-multi-segment":true},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/combined-commit-status"}},"schema":{"$ref":"#/components/schemas/combined-commit-status"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken ps://docs.github.com/enterprise-server@2.22/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.
The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.
**Working with large comparisons**
The response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [List commits](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#list-commits) to enumerate all commits in the range.
For comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long
to generate. You can typically resolve this error by using a smaller commit range.
**Signature verification object**
The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
These are the possible values for `reason` in the `verification` object:
| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"The base branch and head branch to compare. This parameter expects the format `{base}...{head}`.","in":"path","name":"basehead","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/commit-comparison"}},"schema":{"$ref":"#/components/schemas/commit-comparison"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_error"}}GitHubBearerToken
L L �0�h
I�#C�7�=�G/apps/create-content-attachment/repos/{owner}/{repo}/content_references/{content_reference_id}/attachmentsPOSTCreate a content attachmentCreates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads/#content_reference) to create an attachment.
The app must create a content attachment within six hours of the content reference URL being posted. See "[Using content attachments](https://docs.github.com/enterprise-server@2.22/apps/using-content-attachments/)" for details about content attachments.
You must use an [installation access token](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.{"parameters":[{"description":"The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.","in":"path","name":"owner","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.","in":"path","name":"repo","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The `id` of the `content_reference` event.","in":"path","name":"content_reference_id","required":true,"schema":{"type":"integer"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"body":{"description":"The body of the attachment","example":"Body of the attachment","maxLength":262144,"type":"string"},"title":{"description":"The title of the attachment","example":"Title of the attachment","maxLength":1024,"type":"string"}},"required":["title","body"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/content-reference-attachment"}},"schema":{"$ref":"#/components/schemas/content-reference-attachment"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"},"415":{"$ref":"#/components/responses/preview_header_missing"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� � � �i /W9�E��G/repos/get-content/repos/{owner}/{repo}/contents/{path}GETGet repository contentGets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit
`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support [a custom media type](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#custom-media-types) for
retrieving the raw content or rendered HTML (when supported). All content types support [a custom media
type](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent
object format.
**Note**:
* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@2.22/rest/reference/git#trees).
* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees
API](https://docs.github.com/enterprise-server@2.22/rest/reference/git#get-a-tree).
* This API supports files up to 1 megabyte in size.
#### If the content is a directory
The response will be an array of objects, one object for each item in the directory.
When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value
_should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).
In the next major version of the API, the type will be returned as "submodule".
#### If the content is a symlink
If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the
API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object
describing the symlink itself.
#### If the content is a submodule
The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific
commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out
the submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the
github.com URLs (`html_url` and `_links["html"]`) will have null values.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"path parameter","in":"path","name":"path","required":true,"schema":{"type":"string"},"style":"simple","x-multi-segment":true},{"description":"The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)","in":"query","name":"ref","schema":{"type":"string"},"style":"form"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"response-if-content-is-a-directory":{"$ref":"#/components/examples/content-file-response-if-content-is-a-directory"},"response-if-content-is-a-file":{"$ref":"#/components/examples/content-file-response-if-content-is-a-file"},"response-if-content-is-a-submodule":{"$ref":"#/components/examples/content-file-response-if-content-is-a-submodule"},"response-if-content-is-a-symlink":{"$ref":"#/components/examples/content-file-response-if-content-is-a-symlink"}},"schema":{"oneOf":[{"$ref":"#/components/schemas/content-directory"},{"$ref":"#/components/schemas/content-file"},{"$ref":"#/components/schemas/content-symlink"},{"$ref":"#/components/schemas/content-submodule"}]}},"application/vnd.github.v3.object":{"schema":{"$ref":"#/components/schemas/content-tree"}}},"description":"Response"},"302":{"$ref":"#/components/responses/found"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
� � �|�j UWI�
��u/repos/create-or-update-file-contents/repos/{owner}/{repo}/contents/{path}PUTCreate or update file contentsCreates a new file or replaces an existing file in a repository.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"path parameter","in":"path","name":"path","required":true,"schema":{"type":"string"},"style":"simple","x-multi-segment":true}],"requestBody":{"content":{"application/json":{"examples":{"example-for-creating-a-file":{"summary":"Example for creating a file","value":{"committer":{"email":"octocat@github.com","name":"Monalisa Octocat"},"content":"bXkgbmV3IGZpbGUgY29udGVudHM=","message":"my commit message"}},"example-for-updating-a-file":{"summary":"Example for updating a file","value":{"committer":{"email":"octocat@github.com","name":"Monalisa Octocat"},"content":"bXkgdXBkYXRlZCBmaWxlIGNvbnRlbnRz","message":"a new commit message","sha":"95b966ae1c166bd92f8ae7d1c313e738c731dfc3"}}},"schema":{"properties":{"author":{"description":"The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.","properties":{"date":{"example":"\"2013-01-15T17:13:22+05:00\"","type":"string"},"email":{"description":"The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.","type":"string"},"name":{"description":"The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.","type":"string"}},"required":["name","email"],"type":"object"},"branch":{"description":"The branch name. Default: the repository’s default branch (usually `master`)","type":"string"},"committer":{"description":"The person that committed the file. Default: the authenticated user.","properties":{"date":{"example":"\"2013-01-05T13:13:22+05:00\"","type":"string"},"email":{"description":"The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.","type":"string"},"name":{"description":"The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.","type":"string"}},"required":["name","email"],"type":"object"},"content":{"description":"The new file content, using Base64 encoding.","type":"string"},"message":{"description":"The commit message.","type":"string"},"sha":{"description":"**Required if you are updating a file**. The blob SHA of the file being replaced.","type":"string"}},"required":["message","content"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"example-for-updating-a-file":{"$ref":"#/components/examples/file-commit-example-for-updating-a-file"}},"schema":{"$ref":"#/components/schemas/file-commit"}}},"description":"Response"},"201":{"content":{"application/json":{"examples":{"example-for-creating-a-file":{"$ref":"#/components/examples/file-commit-example-for-creating-a-file"}},"schema":{"$ref":"#/components/schemas/file-commit"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"409":{"$ref":"#/components/responses/conflict"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
A A �;�k /W'�%�u�7/repos/delete-file/repos/{owner}/{repo}/contents/{path}DELETEDelete a fileDeletes a file in a repository.
You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.
The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.
You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"path parameter","in":"path","name":"path","required":true,"schema":{"type":"string"},"style":"simple","x-multi-segment":true}],"requestBody":{"content":{"application/json":{"example":{"committer":{"email":"octocat@github.com","name":"Monalisa Octocat"},"message":"my commit message","sha":"329688480d39049927147c162b9d2deaf885005f"},"schema":{"properties":{"author":{"description":"object containing information about the author.","properties":{"email":{"description":"The email of the author (or committer) of the commit","type":"string"},"name":{"description":"The name of the author (or committer) of the commit","type":"string"}},"type":"object"},"branch":{"description":"The branch name. Default: the repository’s default branch (usually `master`)","type":"string"},"committer":{"description":"object containing information about the committer.","properties":{"email":{"description":"The email of the author (or committer) of the commit","type":"string"},"name":{"description":"The name of the author (or committer) of the commit","type":"string"}},"type":"object"},"message":{"description":"The commit message.","type":"string"},"sha":{"description":"The blob SHA of the file being replaced.","type":"string"}},"required":["message","sha"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/file-commit"}},"schema":{"$ref":"#/components/schemas/file-commit"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"409":{"$ref":"#/components/responses/conflict"},"422":{"$ref":"#/components/responses/validation_failed"},"503":{"$ref":"#/components/responses/service_unavailable"}}GitHubBearerToken
p �p �7�m 9O-���//repos/list-deployments/repos/{owner}/{repo}/deploymentsGETList deploymentsSimple filtering of deployments is available via query parameters:{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"The SHA recorded at creation time.","in":"query","name":"sha","schema":{"default":"none","type":"string"},"style":"form"},{"description":"The name of the ref. This can be a branch, tag, or SHA.","in":"query","name":"ref","schema":{"default":"none","type":"string"},"style":"form"},{"description":"The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).","in":"query","name":"task","schema":{"default":"none","type":"string"},"style":"form"},{"description":"The name of the environment that was deployed to (e.g., `staging` or `production`).","in":"query","name":"environment","schema":{"default":"none","nullable":true,"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/deployment-items"}},"schema":{"items":{"$ref":"#/components/schemas/deployment"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�Q�l ;QE�g�Q�'/repos/list-contributors/repos/{owner}/{repo}/contributorsGETList repository contributorsLists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.
GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"Set to `1` or `true` to include anonymous contributors in results.","in":"query","name":"anon","schema":{"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"response-if-repository-contains-content":{"$ref":"#/components/examples/contributor-items-response-if-repository-contains-content"}},"schema":{"items":{"$ref":"#/components/schemas/contributor"},"type":"array"}}},"description":"if repository contains content","headers":{"Link":{"$ref":"#/components/headers/link"}}},"204":{"description":"Response if repository is empty"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken base branch, which is `master` in the response example
* There are no merge conflicts
If there are no new commits in the base branch, a new request to create a deployment should give a successful
response.
#### Merge conflict response
This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't
be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.
#### Failed commit status checks
This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`
status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"examples":{"advanced-example":{"summary":"Advanced example","value":{"auto_merge":false,"description":"Deploy request from hubot","payload":"{ \"deploy\": \"migrate\" }","ref":"topic-branch","required_contexts":["ci/janky","security/brakeman"]}},"simple-example":{"summary":"Simple example","value":{"description":"Deploy request from hubot","payload":"{ \"deploy\": \"migrate\" }","ref":"topic-branch"}}},"schema":{"properties":{"auto_merge":{"default":true,"description":"Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.","type":"boolean"},"description":{"default":"","description":"Short description of the deployment.","nullable":true,"type":"string"},"environment":{"default":"production","description":"Name for the target deployment environment (e.g., `production`, `staging`, `qa`).","type":"string"},"payload":{"oneOf":[{"additionalProperties":true,"type":"object"},{"default":"","description":"JSON payload with extra information about the deployment.","type":"string"}]},"production_environment":{"description":"Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.22/rest/overview/api-previews#enhanced-deployments) custom media type.","type":"boolean"},"ref":{"description":"The ref to deploy. This can be a branch, tag, or SHA.","type":"string"},"required_contexts":{"description":"The [status](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.","items":{"type":"string"},"type":"array"},"task":{"default":"deploy","description":"Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).","type":"string"},"transient_environment":{"default":false,"description":"Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.22/rest/overview/api-previews#enhanced-deployments) custom media type.","type":"boolean"}},"required":["ref"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"simple-example":{"$ref":"#/components/examples/deployment-simple-example"}},"schema":{"$ref":"#/components/schemas/deployment"}}},"description":"Response"},"202":{"content":{"application/json":{"examples":{"merged-branch-response":{"value":{"message":"Auto-merged master into topic-branch on deployment."}}},"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Merged branch response"},"409":{"description":"Conflict when there is a merge conflict or the commit's status checks failed"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
�� ��p ;o3�C�W�7/repos/delete-deployment/repos/{owner}/{repo}/deployments/{deployment_id}DELETEDelete a deploymentTo ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment.
To set a deployment as inactive, you must:
* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
* Mark the active deployment as inactive by adding any non-successful deployment status.
For more information, see "[Create a deployment](https://docs.github.com/enterprise-server@2.22/rest/reference/repos/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#create-a-deployment-status)."{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/deployment-id"}],"requestBody":null}{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed_simple"}}GitHubBearerToken��o 5o-
�W�e/repos/get-deployment/repos/{owner}/{repo}/deployments/{deployment_id}GETGet a deployment{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/deployment-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/deployment"}},"schema":{"$ref":"#/components/schemas/deployment"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�?�n ;O3� �I�{/repos/create-deployment/repos/{owner}/{repo}/deploymentsPOSTCreate a deploymentDeployments offer a few configurable parameters with certain defaults.
The `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them
before we merge a pull request.
The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have
multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter
makes it easier to track which environments have requested deployments. The default environment is `production`.
The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If
the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,
the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will
return a failure response.
By default, [commit statuses](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#statuses) for every submitted context must be in a `success`
state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to
specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do
not require any contexts or create any commit statuses, the deployment will always succeed.
The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text
field that will be passed on when a deployment event is dispatched.
The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might
be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an
application with debugging enabled.
Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref.
#### Merged branch response
You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating
a deployment. This auto-merge happens when:
* Auto-merge option is enabled in the repository
* Topic branch does not include the latest changes on the �
� � � �q
I�=���//repos/list-deployment-statuses/repos/{owner}/{repo}/deployments/{deployment_id}/statusesGETList deployment statusesUsers with pull access can view deployment statuses for a deployment:{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/deployment-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/deployment-status-items"}},"schema":{"items":{"$ref":"#/components/schemas/deployment-status"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
u u ��r
I�A��K�A/repos/create-deployment-status/repos/{owner}/{repo}/deployments/{deployment_id}/statusesPOSTCreate a deployment statusUsers with `push` access can create deployment statuses for a given deployment.
GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/deployment-id"}],"requestBody":{"content":{"application/json":{"example":{"description":"Deployment finished successfully.","environment":"production","log_url":"https://example.com/deployment/42/output","state":"success"},"schema":{"properties":{"auto_inactive":{"description":"Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.22/rest/overview/api-previews#enhanced-deployments) custom media type.","type":"boolean"},"description":{"default":"","description":"A short description of the status. The maximum description length is 140 characters.","type":"string"},"environment":{"description":"Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`.","enum":["production","staging","qa"],"type":"string"},"environment_url":{"default":"","description":"Sets the URL for accessing your environment. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.22/rest/overview/api-previews#enhanced-deployments) custom media type.","type":"string"},"log_url":{"default":"","description":"The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.22/rest/overview/api-previews#enhanced-deployments) custom media type.","type":"string"},"state":{"description":"The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.22/rest/overview/api-previews#enhanced-deployments) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.","enum":["error","failure","inactive","in_progress","queued","pending","success"],"type":"string"},"target_url":{"default":"","description":"The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.","type":"string"}},"required":["state"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/deployment-status"}},"schema":{"$ref":"#/components/schemas/deployment-status"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/example/deployments/42/statuses/1","schema":{"type":"string"},"style":"simple"}}},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
�
![� �=�u ?E9
� �#/activity/list-repo-events/repos/{owner}/{repo}/eventsGETList repository events{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/event"},"type":"array"}}},"description":"Response"}}GitHubBearerToken�B�t CMQ�}�m�E/repos/create-dispatch-event/repos/{owner}/{repo}/dispatchesPOSTCreate a repository dispatch eventYou can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads/#repository_dispatch)."
The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.
This endpoint requires write access to the repository by providing either:
- Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation.
- GitHub Apps with both `metadata:read` and `contents:read&write` permissions.
This input example shows how you can use the `client_payload` as a test to debug your workflow.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"client_payload":{"integration":true,"unit":false},"event_type":"on-demand-test"},"schema":{"properties":{"client_payload":{"additionalProperties":true,"description":"JSON payload with extra information about the webhook event that your action or worklow may use.","maxProperties":10,"type":"object"},"event_type":{"description":"A custom webhook event name.","maxLength":100,"minLength":1,"type":"string"}},"required":["event_type"],"type":"object"}}},"required":true}}{"204":{"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�[�s
C�;���/repos/get-deployment-status/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}GETGet a deployment statusUsers with pull access can view a deployment status for a deployment:{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/deployment-id"},{"in":"path","name":"status_id","required":true,"schema":{"type":"integer"},"style":"simple"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/deployment-status"}},"schema":{"$ref":"#/components/schemas/deployment-status"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
� �� � �v�y %a!��-�%/git/get-blob/repos/{owner}/{repo}/git/blobs/{file_sha}GETGet a blobThe `content` in the response will always be Base64 encoded.
_Note_: This API supports blobs up to 100 megabytes in size.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"in":"path","name":"file_sha","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/blob"}},"schema":{"$ref":"#/components/schemas/blob"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken��x +K'
��/git/create-blob/repos/{owner}/{repo}/git/blobsPOSTCreate a blob{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"content":"Content of the blob","encoding":"utf-8"},"schema":{"properties":{"content":{"description":"The new blob's content.","type":"string"},"encoding":{"default":"utf-8","description":"The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.","type":"string"}},"required":["content"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/short-blob"}},"schema":{"$ref":"#/components/schemas/short-blob"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15","schema":{"type":"string"},"style":"simple"}}},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"409":{"$ref":"#/components/responses/conflict"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken� �w /C'� �1�9/repos/create-fork/repos/{owner}/{repo}/forksPOSTCreate a forkCreate a fork for the authenticated user.
**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"schema":{"nullable":true,"properties":{"organization":{"description":"Optional parameter to specify the organization name if forking into an organization.","type":"string"}},"type":"object"}}}}}{"202":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/full-repository"}},"schema":{"$ref":"#/components/schemas/full-repository"}}},"description":"Response"},"400":{"$ref":"#/components/responses/bad_request"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�S�v -C!
�]�;/repos/list-forks/repos/{owner}/{repo}/forksGETList forks{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"The sort order. Can be either `newest`, `oldest`, or `stargazers`.","in":"query","name":"sort","schema":{"default":"newest","enum":["newest","oldest","stargazers","watchers"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/minimal-repository-items-2"}},"schema":{"items":{"$ref":"#/components/schemas/minimal-repository"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"400":{"$ref":"#/components/responses/bad_request"}}GitHubBearerToken 3:30+12:00","email":"octocat@github.com","name":"Mona Octocat"},"message":"my commit message","parents":["7d1b31e74ee336d15cbd21741bc88a537ed063a0"],"signature":"-----BEGIN PGP SIGNATURE-----\n\niQIzBAABAQAdFiEESn/54jMNIrGSE6Tp6cQjvhfv7nAFAlnT71cACgkQ6cQjvhfv\n7nCWwA//XVqBKWO0zF+bZl6pggvky3Oc2j1pNFuRWZ29LXpNuD5WUGXGG209B0hI\nDkmcGk19ZKUTnEUJV2Xd0R7AW01S/YSub7OYcgBkI7qUE13FVHN5ln1KvH2all2n\n2+JCV1HcJLEoTjqIFZSSu/sMdhkLQ9/NsmMAzpf/iIM0nQOyU4YRex9eD1bYj6nA\nOQPIDdAuaTQj1gFPHYLzM4zJnCqGdRlg0sOM/zC5apBNzIwlgREatOYQSCfCKV7k\nnrU34X8b9BzQaUx48Qa+Dmfn5KQ8dl27RNeWAqlkuWyv3pUauH9UeYW+KyuJeMkU\n+NyHgAsWFaCFl23kCHThbLStMZOYEnGagrd0hnm1TPS4GJkV4wfYMwnI4KuSlHKB\njHl3Js9vNzEUQipQJbgCgTiWvRJoK3ENwBTMVkKHaqT4x9U4Jk/XZB6Q8MA09ezJ\n3QgiTjTAGcum9E9QiJqMYdWQPWkaBIRRz5cET6HPB48YNXAAUsfmuYsGrnVLYbG+\nUpC6I97VybYHTy2O9XSGoaLeMI9CsFn38ycAxxbWagk5mhclNTP5mezIq6wKSwmr\nX11FW3n1J23fWZn5HJMBsRnUCgzqzX3871IqLYHqRJ/bpZ4h20RhTyPj5c/z7QXp\neSakNQMfbbMcljkha+ZMuVQX1K9aRlVqbmv3ZMWh+OijLYVU2bc=\n=5Io4\n-----END PGP SIGNATURE-----\n","tree":"827efc6d56897b048c772eb4087f854f46256132"},"schema":{"properties":{"author":{"description":"Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.","properties":{"date":{"description":"Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","format":"date-time","type":"string"},"email":{"description":"The email of the author (or committer) of the commit","type":"string"},"name":{"description":"The name of the author (or committer) of the commit","type":"string"}},"required":["name","email"],"type":"object"},"committer":{"description":"Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.","properties":{"date":{"description":"Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","format":"date-time","type":"string"},"email":{"description":"The email of the author (or committer) of the commit","type":"string"},"name":{"description":"The name of the author (or committer) of the commit","type":"string"}},"type":"object"},"message":{"description":"The commit message","type":"string"},"parents":{"description":"The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.","items":{"type":"string"},"type":"array"},"signature":{"description":"The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits.","type":"string"},"tree":{"description":"The SHA of the tree object this commit points to","type":"string"}},"required":["message","tree"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/git-commit"}},"schema":{"$ref":"#/components/schemas/git-commit"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd","schema":{"type":"string"},"style":"simple"}}},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� � �c�z /O+�C� �G/git/create-commit/repos/{owner}/{repo}/git/commitsPOSTCreate a commitCreates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).
**Signature verification object**
The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
These are the possible values for `reason` in the `verification` object:
| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"author":{"date":"2008-07-09T16:1 �
� � �L�{ )i%�5�Q�i/git/get-commit/repos/{owner}/{repo}/git/commits/{commit_sha}GETGet a commitGets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).
**Signature verification object**
The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
These are the possible values for `reason` in the `verification` object:
| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/commit-sha"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/git-commit-2"}},"schema":{"$ref":"#/components/schemas/git-commit"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
r Qr �[�} #S+�=�
�Y/git/get-ref/repos/{owner}/{repo}/git/ref/{ref}GETGet a referenceReturns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/<branch name>` for branches and `tags/<tag name>` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.
**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@2.22/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"ref parameter","in":"path","name":"ref","required":true,"schema":{"type":"string"},"style":"simple","x-multi-segment":true}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/git-ref"}},"schema":{"$ref":"#/components/schemas/git-ref"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�+�| 9g=�/�5�#/git/list-matching-refs/repos/{owner}/{repo}/git/matching-refs/{ref}GETList matching referencesReturns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/<branch name>` for branches and `tags/<tag name>` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.
When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.
**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@2.22/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"ref parameter","in":"path","name":"ref","required":true,"schema":{"type":"string"},"style":"simple","x-multi-segment":true},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/git-ref-items"}},"schema":{"items":{"$ref":"#/components/schemas/git-ref"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
�
���� �}� )I3� ��Q/git/create-tag/repos/{owner}/{repo}/git/tagsPOSTCreate a tag objectNote that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@2.22/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.c ��D� )U1
�o�i/git/update-ref/repos/{owner}/{repo}/git/refs/{ref}PATCHUpdate a reference{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"ref parameter","in":"path","name":"ref","required":true,"schema":{"type":"string"},"style":"simple","x-multi-segment":true}],"requestBody":{"content":{"application/json":{"example":{"force":true,"sha":"aa218f56b14c9653891f9e74264a383fa43fefbd"},"schema":{"properties":{"force":{"default":false,"description":"Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.","type":"boolean"},"sha":{"description":"The SHA1 value to set this reference to","type":"string"}},"required":["sha"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/git-ref"}},"schema":{"$ref":"#/components/schemas/git-ref"}}},"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�B� )U1
�
�E/git/delete-ref/repos/{owner}/{repo}/git/refs/{ref}DELETEDelete a reference{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"ref parameter","in":"path","name":"ref","required":true,"schema":{"type":"string"},"style":"simple","x-multi-segment":true}],"requestBody":null}{"204":{"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�7�~ )I1� �� /git/create-ref/repos/{owner}/{repo}/git/refsPOSTCreate a referenceCreates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"ref":"refs/heads/featureA","sha":"aa218f56b14c9653891f9e74264a383fa43fefbd"},"schema":{"properties":{"key":{"example":"\"refs/heads/newbranch\"","type":"string"},"ref":{"description":"The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.","type":"string"},"sha":{"description":"The SHA1 value for this reference.","type":"string"}},"required":["ref","sha"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/git-ref"}},"schema":{"$ref":"#/components/schemas/git-ref"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA","schema":{"type":"string"},"style":"simple"}}},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken om/enterprise-server@2.22/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary.
**Signature verification object**
The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
These are the possible values for `reason` in the `verification` object:
| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"message":"initial version","object":"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c","tag":"v0.0.1","tagger":{"date":"2011-06-17T14:53:35-07:00","email":"octocat@github.com","name":"Monalisa Octocat"},"type":"commit"},"schema":{"properties":{"message":{"description":"The tag message.","type":"string"},"object":{"description":"The SHA of the git object this is tagging.","type":"string"},"tag":{"description":"The tag's name. This is typically a version (e.g., \"v0.0.1\").","type":"string"},"tagger":{"description":"An object with information about the individual creating the tag.","properties":{"date":{"description":"When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","format":"date-time","type":"string"},"email":{"description":"The email of the author of the tag","type":"string"},"name":{"description":"The name of the author of the tag","type":"string"}},"required":["name","email"],"type":"object"},"type":{"description":"The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.","enum":["commit","tree","blob"],"type":"string"}},"required":["tag","message","object","type"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/git-tag"}},"schema":{"$ref":"#/components/schemas/git-tag"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac","schema":{"type":"string"},"style":"simple"}}},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� � �� #] �i�+�Y/git/get-tag/repos/{owner}/{repo}/git/tags/{tag_sha}GETGet a tag**Signature verification object**
The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
These are the possible values for `reason` in the `verification` object:
| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"in":"path","name":"tag_sha","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/git-tag"}},"schema":{"$ref":"#/components/schemas/git-tag"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
�u� +K'�{�G�/git/create-tree/repos/{owner}/{repo}/git/treesPOSTCreate a treeThe tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.
If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@2.22/rest/reference/git#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@2.22/rest/reference/git#update-a-reference)."{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"base_tree":"9fb037999f264ba9a7fc6274d15fa3ae2ab98312","tree":[{"mode":"100644","path":"file.rb","sha":"44b4fc6d56897b048c772eb4087f854f46256132","type":"blob"}]},"schema":{"properties":{"base_tree":{"description":"The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.\n","type":"string"},"tree":{"description":"Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.","items":{"properties":{"content":{"description":"The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.","type":"string"},"mode":{"description":"The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.","enum":["100644","100755","040000","160000","120000"],"type":"string"},"path":{"description":"The file referenced in the tree.","type":"string"},"sha":{"description":"The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.","nullable":true,"type":"string"},"type":{"description":"Either `blob`, `tree`, or `commit`.","enum":["blob","tree","commit"],"type":"string"}},"type":"object"},"type":"array"}},"required":["tree"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/git-tree"}},"schema":{"$ref":"#/components/schemas/git-tree"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7","schema":{"type":"string"},"style":"simple"}}},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
�
:� �d� 3C=
� �{/repos/list-webhooks/repos/{owner}/{repo}/hooksGETList repository webhooks{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/hook-items"}},"schema":{"items":{"$ref":"#/components/schemas/hook"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�B� %a!�K�'�y/git/get-tree/repos/{owner}/{repo}/git/trees/{tree_sha}GETGet a treeReturns a single tree using the SHA1 value for that tree.
If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"in":"path","name":"tree_sha","required":true,"schema":{"type":"string"},"style":"simple","x-multi-segment":true},{"description":"Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `\"true\"`, and `\"false\"`. Omit this parameter to prevent recursively returning objects or subtrees.","in":"query","name":"recursive","schema":{"type":"string"},"style":"form"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default-response":{"$ref":"#/components/examples/git-tree-default-response"},"response-recursively-retrieving-a-tree":{"$ref":"#/components/examples/git-tree-response-recursively-retrieving-a-tree"}},"schema":{"$ref":"#/components/schemas/git-tree"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
�
E� �i� 5WC
�K�5/repos/delete-webhook/repos/{owner}/{repo}/hooks/{hook_id}DELETEDelete a repository webhook{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/hook-id"}],"requestBody":null}{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�A� /W=�5�K�M/repos/get-webhook/repos/{owner}/{repo}/hooks/{hook_id}GETGet a repository webhookReturns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)."{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/hook-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/hook"}},"schema":{"$ref":"#/components/schemas/hook"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�r� 5CC�'�G�G/repos/create-webhook/repos/{owner}/{repo}/hooksPOSTCreate a repository webhookRepositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can
share the same `config` as long as those webhooks do not have any `events` that overlap.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"active":true,"config":{"content_type":"json","insecure_ssl":"0","url":"https://example.com/webhook"},"events":["push","pull_request"],"name":"web"},"schema":{"additionalProperties":false,"nullable":true,"properties":{"active":{"default":true,"description":"Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.","type":"boolean"},"config":{"description":"Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#create-hook-config-params).","properties":{"content_type":{"$ref":"#/components/schemas/webhook-config-content-type"},"digest":{"example":"\"sha256\"","type":"string"},"insecure_ssl":{"$ref":"#/components/schemas/webhook-config-insecure-ssl"},"secret":{"$ref":"#/components/schemas/webhook-config-secret"},"token":{"example":"\"abc\"","type":"string"},"url":{"$ref":"#/components/schemas/webhook-config-url"}},"type":"object"},"events":{"default":["push"],"description":"Determines what [events](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads) the hook is triggered for.","items":{"type":"string"},"type":"array"},"name":{"description":"Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.","type":"string"}},"type":"object"}}}}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/hook"}},"schema":{"$ref":"#/components/schemas/hook"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/Hello-World/hooks/12345678","schema":{"type":"string"},"style":"simple"}}},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� dy� � � ;cM�a�K�5/repos/test-push-webhook/repos/{owner}/{repo}/hooks/{hook_id}/testsPOSTTest the push repository webhookThis will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.
**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/hook-id"}],"requestBody":null}{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�g�
1c?��K�5/repos/ping-webhook/repos/{owner}/{repo}/hooks/{hook_id}/pingsPOSTPing a repository webhookThis will trigger a [ping event](https://docs.github.com/enterprise-server@2.22/webhooks/#ping-event) to be sent to the hook.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/hook-id"}],"requestBody":null}{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�� 5WC�e�E�A/repos/update-webhook/repos/{owner}/{repo}/hooks/{hook_id}PATCHUpdate a repository webhookUpdates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)."{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/hook-id"}],"requestBody":{"content":{"application/json":{"example":{"active":true,"add_events":["pull_request"]},"schema":{"properties":{"active":{"default":true,"description":"Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.","type":"boolean"},"add_events":{"description":"Determines a list of events to be added to the list of events that the Hook triggers for.","items":{"type":"string"},"type":"array"},"config":{"description":"Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#create-hook-config-params).","properties":{"address":{"example":"\"bar@example.com\"","type":"string"},"content_type":{"$ref":"#/components/schemas/webhook-config-content-type"},"insecure_ssl":{"$ref":"#/components/schemas/webhook-config-insecure-ssl"},"room":{"example":"\"The Serious Room\"","type":"string"},"secret":{"$ref":"#/components/schemas/webhook-config-secret"},"url":{"$ref":"#/components/schemas/webhook-config-url"}},"required":["url"],"type":"object"},"events":{"default":["push"],"description":"Determines what [events](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.","items":{"type":"string"},"type":"array"},"remove_events":{"description":"Determines a list of events to be removed from the list of events that the Hook triggers for.","items":{"type":"string"},"type":"array"}},"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/hook"}},"schema":{"$ref":"#/components/schemas/hook"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� ) A�� �3� ;oI
�E�-/repos/update-invitation/repos/{owner}/{repo}/invitations/{invitation_id}PATCHUpdate a repository invitation{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/invitation-id"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"permissions":{"description":"The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.","enum":["read","write","maintain","triage","admin"],"type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/repository-invitation"}},"schema":{"$ref":"#/components/schemas/repository-invitation"}}},"description":"Response"}}GitHubBearerToken�N�
;oI
�WQ/repos/delete-invitation/repos/{owner}/{repo}/invitations/{invitation_id}DELETEDelete a repository invitation{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/invitation-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�d�
9OC�� �[/repos/list-invitations/repos/{owner}/{repo}/invitationsGETList repository invitationsWhen authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/repository-invitation-items"}},"schema":{"items":{"$ref":"#/components/schemas/repository-invitation"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�S� AQ{�5�u�}/apps/get-repo-installation/repos/{owner}/{repo}/installationGETGet a repository installation for the authenticated appEnables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.
You must use a [JWT](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/installation-ghes-2"}},"schema":{"$ref":"#/components/schemas/installation-ghes-2"}}},"description":"Response"},"301":{"$ref":"#/components/responses/moved_permanently"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
� � �B� 5E9�W�!�g/issues/list-for-repo/repos/{owner}/{repo}/issuesGETList repository issuesList issues in a repository.
**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
request id, use the "[List pull requests](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#list-pull-requests)" endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.","in":"query","name":"milestone","schema":{"type":"string"},"style":"form"},{"description":"Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.","in":"query","name":"state","schema":{"default":"open","enum":["open","closed","all"],"type":"string"},"style":"form"},{"description":"Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.","in":"query","name":"assignee","schema":{"type":"string"},"style":"form"},{"description":"The user that created the issue.","in":"query","name":"creator","schema":{"type":"string"},"style":"form"},{"description":"A user that's mentioned in the issue.","in":"query","name":"mentioned","schema":{"type":"string"},"style":"form"},{"$ref":"#/components/parameters/labels"},{"description":"What to sort results by. Can be either `created`, `updated`, `comments`.","in":"query","name":"sort","schema":{"default":"created","enum":["created","updated","comments"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/issue-items"}},"schema":{"items":{"$ref":"#/components/schemas/issue"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"301":{"$ref":"#/components/responses/moved_permanently"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� � � � 'E+�m�)�/issues/create/repos/{owner}/{repo}/issuesPOSTCreate an issueAny user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.
This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"assignees":["octocat"],"body":"I'm having a problem with this.","labels":["bug"],"milestone":1,"title":"Found a bug"},"schema":{"properties":{"assignee":{"description":"Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_","nullable":true,"type":"string"},"assignees":{"description":"Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._","items":{"type":"string"},"type":"array"},"body":{"description":"The contents of the issue.","type":"string"},"labels":{"description":"Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._","items":{"oneOf":[{"type":"string"},{"properties":{"color":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"}]},"type":"array"},"milestone":{"nullable":true,"oneOf":[{"type":"string"},{"description":"The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._","type":"integer"}]},"title":{"description":"The title of the issue.","oneOf":[{"type":"string"},{"type":"integer"}]}},"required":["title"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/issue"}},"schema":{"$ref":"#/components/schemas/issue"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/Hello-World/issues/1347","schema":{"type":"string"},"style":"simple"}}},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"},"422":{"$ref":"#/components/responses/validation_failed"},"503":{"$ref":"#/components/responses/service_unavailable"}}GitHubBearerToken
� ��� �'�
M�S�}�-� /reactions/list-for-issue-comment/repos/{owner}/{repo}/issues/comments/{comment_id}/reactionsGETList reactions for an issue commentList the reactions to an [issue comment](https://docs.github.com/enterprise-server@2.22/rest/reference/issues#comments).{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"},{"description":"Returns a single [reaction type](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment.","in":"query","name":"content","schema":{"enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction-items"}},"schema":{"items":{"$ref":"#/components/schemas/reaction"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�i� 7q;
�m�/issues/update-comment/repos/{owner}/{repo}/issues/comments/{comment_id}PATCHUpdate an issue comment{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"requestBody":{"content":{"application/json":{"example":{"body":"Me too"},"schema":{"properties":{"body":{"description":"The contents of the comment.","type":"string"}},"required":["body"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/issue-comment"}},"schema":{"$ref":"#/components/schemas/issue-comment"}}},"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�C�
7q;
�QQ/issues/delete-comment/repos/{owner}/{repo}/issues/comments/{comment_id}DELETEDelete an issue comment{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken� � 1q5
�Q�q/issues/get-comment/repos/{owner}/{repo}/issues/comments/{comment_id}GETGet an issue comment{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/issue-comment"}},"schema":{"$ref":"#/components/schemas/issue-comment"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�� GWU{� �/issues/list-comments-for-repo/repos/{owner}/{repo}/issues/commentsGETList issue comments for a repositoryBy default, Issue Comments are ordered by ascending ID.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/sort"},{"description":"Either `asc` or `desc`. Ignored without the `sort` parameter.","in":"query","name":"direction","schema":{"enum":["asc","desc"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/issue-comment-items"}},"schema":{"items":{"$ref":"#/components/schemas/issue-comment"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
�
��1� �
� -i1
�/�'/issues/get-event/repos/{owner}/{repo}/issues/events/{event_id}GETGet an issue event{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"in":"path","name":"event_id","required":true,"schema":{"type":"integer"},"style":"simple"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/issue-event"}},"schema":{"$ref":"#/components/schemas/issue-event"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"}}GitHubBearerToken�� CSQ
� �'/issues/list-events-for-repo/repos/{owner}/{repo}/issues/eventsGETList issue events for a repository{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/issue-event-items"}},"schema":{"items":{"$ref":"#/components/schemas/issue-event"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�J� Q�!M�]�/Q/reactions/delete-for-issue-comment/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}DELETEDelete an issue comment reaction**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.
Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@2.22/rest/reference/issues#comments).{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"},{"$ref":"#/components/parameters/reaction-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�e�
Q�U�Q�c�u/reactions/create-for-issue-comment/repos/{owner}/{repo}/issues/comments/{comment_id}/reactionsPOSTCreate reaction for an issue commentCreate a reaction to an [issue comment](https://docs.github.com/enterprise-server@2.22/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"requestBody":{"content":{"application/json":{"example":{"content":"heart"},"schema":{"properties":{"content":{"description":"The [reaction type](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#reaction-types) to add to the issue comment.","enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"],"type":"string"}},"required":["content"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction"}},"schema":{"$ref":"#/components/schemas/reaction"}}},"description":"Reaction exists"},"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction"}},"schema":{"$ref":"#/components/schemas/reaction"}}},"description":"Reaction created"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� � �|� !c%��U� /issues/get/repos/{owner}/{repo}/issues/{issue_number}GETGet an issueThe API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was
[transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If
the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API
returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read
access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe
to the [`issues`](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads/#issues) webhook.
**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
request id, use the "[List pull requests](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#list-pull-requests)" endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/issue"}},"schema":{"$ref":"#/components/schemas/issue"}}},"description":"Response"},"301":{"$ref":"#/components/responses/moved_permanently"},"304":{"$ref":"#/components/responses/not_modified"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"}}GitHubBearerToken
� z� �� 5w?�?��m/issues/add-assignees/repos/{owner}/{repo}/issues/{issue_number}/assigneesPOSTAdd assignees to an issueAdds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"requestBody":{"content":{"application/json":{"example":{"assignees":["hubot","other_user"]},"schema":{"properties":{"assignees":{"description":"Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._","items":{"type":"string"},"type":"array"}},"type":"object"}}}}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/issue"}},"schema":{"$ref":"#/components/schemas/issue"}}},"description":"Response"}}GitHubBearerToken�� 'c+��i�o/issues/update/repos/{owner}/{repo}/issues/{issue_number}PATCHUpdate an issueIssue owners and users with push access can edit an issue.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"requestBody":{"content":{"application/json":{"example":{"assignees":["octocat"],"body":"I'm having a problem with this.","labels":["bug"],"milestone":1,"state":"open","title":"Found a bug"},"schema":{"properties":{"assignee":{"description":"Login for the user that this issue should be assigned to. **This field is deprecated.**","nullable":true,"type":"string"},"assignees":{"description":"Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._","items":{"type":"string"},"type":"array"},"body":{"description":"The contents of the issue.","nullable":true,"type":"string"},"labels":{"description":"Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._","items":{"oneOf":[{"type":"string"},{"properties":{"color":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"}]},"type":"array"},"milestone":{"nullable":true,"oneOf":[{"type":"string"},{"description":"The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._","type":"integer"}]},"state":{"description":"State of the issue. Either `open` or `closed`.","enum":["open","closed"],"type":"string"},"title":{"description":"The title of the issue.","nullable":true,"oneOf":[{"type":"string"},{"type":"integer"}]}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/issue"}},"schema":{"$ref":"#/components/schemas/issue"}}},"description":"Response"},"301":{"$ref":"#/components/responses/moved_permanently"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"},"422":{"$ref":"#/components/responses/validation_failed"},"503":{"$ref":"#/components/responses/service_unavailable"}}GitHubBearerToken
K � P K �@�! 1q/
�}�5/issues/list-events/repos/{owner}/{repo}/issues/{issue_number}/eventsGETList issue events{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/issue-event-for-issue-items"}},"schema":{"items":{"$ref":"#/components/schemas/issue-event-for-issue"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"410":{"$ref":"#/components/responses/gone"}}GitHubBearerToken�=� 7u;�c�q�K/issues/create-comment/repos/{owner}/{repo}/issues/{issue_number}/commentsPOSTCreate an issue commentThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"requestBody":{"content":{"application/json":{"example":{"body":"Me too"},"schema":{"properties":{"body":{"description":"The contents of the comment.","type":"string"}},"required":["body"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/issue-comment"}},"schema":{"$ref":"#/components/schemas/issue-comment"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/Hello-World/issues/comments/1","schema":{"type":"string"},"style":"simple"}}},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�<� 5u3c�O�y/issues/list-comments/repos/{owner}/{repo}/issues/{issue_number}/commentsGETList issue commentsIssue Comments are ordered by ascending ID.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/issue-comment-items"}},"schema":{"items":{"$ref":"#/components/schemas/issue-comment"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"}}GitHubBearerToken�l� ;wIe��m/issues/remove-assignees/repos/{owner}/{repo}/issues/{issue_number}/assigneesDELETERemove assignees from an issueRemoves one or more assignees from an issue.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"requestBody":{"content":{"application/json":{"example":{"assignees":["hubot","other_user"]},"schema":{"properties":{"assignees":{"description":"Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._","items":{"type":"string"},"type":"array"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/issue"}},"schema":{"$ref":"#/components/schemas/issue"}}},"description":"Response"}}GitHubBearerToken
� a�6
�����c/��
�
|�
U
9
� � � � j < � � � �^ � m C &
�
��
�
�
o
K
* � � � � � q @ & ����rK"���yL%����hN4�����R2 ����J����zQ) ���~hO>& ����d9
�aclls/3pull)Urepos/remove-app-access-restrictions:1repos/ping-webhook�#repos/merge�3repos/list-webhooks�-repos/list-teams+repos/list-tags3repos/list-releases� ?repos/list-release-assets�4krepos/list-pull-requests-associated-with-commita/repos/list-public ;repos/list-pages-builds�5repos/list-languages�9repos/list-invitations�-repos/list-forksv1repos/list-for-org �9repos/l6oreactions/list-for-team-discussion-comment-legacy.6oreactions/list-for-team-discussion-comment-in-org �1repos/list-commits]'Qrepos/list-commit-statuses-for-reff(Srepos/list-commit-comments-for-repoV#Irepos/list-comments-for-commit_ =repos/list-collaboratorsQ(Srepos/list-branches-for-head-commit^3repos/list-branches /repos/get-webhook�4krepos/get-users-with-access-to-protected-branch?4krepos/get-teams-with-access-to-protected-branch;'Qrepos/get-status-checks-protection. =repos/get-release-by-tag� ;repos/get-release-asset�/repos/get-release�"Grepos/get-readme-in-directory�-repos/get-readme� Arepos/get-punch-card-stats -]repos/get-pull-request-review-protection("Grepos/get-participation-stats�7repos/get-pages-build�+repos/get-pages� =repos/get-latest-release�!Erepos/get-latest-pages-build� Crepos/get-deployment-statuss5repos/get-deploymento5repos/get-deploy-key�!Erepos/get-contributors-stats�/repos/get-contenti*Wrepos/get-commit-signature-protection+ =repos/get-commit-commentW$Krepos/get-commit-activity-stats�-repos/get-commitb&Orepos/get-combined-status-for-refe,[repos/get-collaborator-permission-levelU#Irepos/get-code-frequency-stats� Crepos/get-branch-protection"-repos/get-branch!3irepos/get-apps-with-access-to-protected-branch75repos/get-all-topics (Srepos/get-all-status-check-contexts1&Orepos/get-admin-branch-protection%"Grepos/get-access-restrictions5 repos/get �#Irepos/download-zipball-archive #Irepos/download-tarball-archive5repos/delete-webhook� Arepos/delete-release-asset�5repos/delete-release�0crepos/delete-pull-request-review-protection) ;repos/delete-pages-site� ;repos/delete-invitation�/repos/delete-filek ;repos/delete-deploymentp ;repos/delete-deploy-key�-]repos/delete-commit-signature-protection- Crepos/delete-commit-commentX#Irepos/delete-branch-protection$)Urepos/delete-admin-branch-protection'%Mrepos/delete-access-restrictions6%repos/delete �5repos/create-webhook� Crepos/create-using-template
5repos/create-release� ;repos/create-pages-site�)Urepos/create-or-update-file-contentsj3repos/create-in-org �/repos/create-forkw Crepos/create-dispatch-eventt#Irepos/create-deployment-statusr ;repos/create-deploymentn ;repos/create-deploy-key� Arepos/create-commit-status-]repos/create-commit-signature-protection, Crepos/create-commit-comment`7repos/compare-commitsg =repos/check-collaboratorR'Qrepos/add-user-access-restrictionsA'Qrepos/add-team-access-restrictions=$Krepos/add-status-check-contexts39repos/add-collaboratorS&Orepos/add-app-access-restrictions9._reactions/list-for-team-discussion-legacy0._reactions/list-for-team-discussion-in-org �)Ureactions/delete-for-team-discussion �ect._reactions/delete-for-pull-request-comment�'Qreactions/delete-for-issue-comment�(Srepos/create-for-authenticated-user` repos/list ;reactions/delete-legacy �3irepos/accept-invitation-for-authenticated-userc4krepos/decline-invitation-for-authenticated-userb repos/replace-al3ireactions/list-for-pull-request-review-comment�%Mreactions/list-for-issue-comment� =reactions/list-for-issue�&Oreactions/list-for-commit-commentZ1ereactions/delete-for-team-discussion-comment �
|
L�� | �~�% =qK
�U�+/issues/remove-all-labels/repos/{owner}/{repo}/issues/{issue_number}/labelsDELETERemove all labels from an issue{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"requestBody":null}{"204":{"description":"Response"},"410":{"$ref":"#/components/responses/gone"}}GitHubBearerToken��$ /q9
�3�y/issues/add-labels/repos/{owner}/{repo}/issues/{issue_number}/labelsPOSTAdd labels to an issue{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"requestBody":{"content":{"application/json":{"example":{"labels":["bug","enhancement"]},"schema":{"oneOf":[{"properties":{"labels":{"description":"The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.","items":{"type":"string"},"minItems":1,"type":"array"}},"type":"object"},{"items":{"type":"string"},"minItems":1,"type":"array"},{"properties":{"labels":{"items":{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"minItems":1,"type":"array"}},"type":"object"},{"items":{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"minItems":1,"type":"array"},{"type":"string"}]}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/label-items"}},"schema":{"items":{"$ref":"#/components/schemas/label"},"type":"array"}}},"description":"Response"},"410":{"$ref":"#/components/responses/gone"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�D�# /q;��3�y/issues/set-labels/repos/{owner}/{repo}/issues/{issue_number}/labelsPUTSet labels for an issueRemoves any previous labels and sets the new labels for an issue.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"requestBody":{"content":{"application/json":{"example":{"labels":["bug","enhancement"]},"schema":{"oneOf":[{"properties":{"labels":{"description":"The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.","items":{"type":"string"},"minItems":1,"type":"array"}},"type":"object"},{"items":{"type":"string"},"minItems":1,"type":"array"},{"properties":{"labels":{"items":{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"minItems":1,"type":"array"}},"type":"object"},{"items":{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"minItems":1,"type":"array"},{"type":"string"}]}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/label-items"}},"schema":{"items":{"$ref":"#/components/schemas/label"},"type":"array"}}},"description":"Response"},"410":{"$ref":"#/components/responses/gone"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�0�" Cq=
�}�u/issues/list-labels-on-issue/repos/{owner}/{repo}/issues/{issue_number}/labelsGETList labels for an issue{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/label-items"}},"schema":{"items":{"$ref":"#/components/schemas/label"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"410":{"$ref":"#/components/responses/gone"}}GitHubBearerToken
P ���P �%�) =wC�[�!�e/reactions/list-for-issue/repos/{owner}/{repo}/issues/{issue_number}/reactionsGETList reactions for an issueList the reactions to an [issue](https://docs.github.com/enterprise-server@2.22/rest/reference/issues).{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"},{"description":"Returns a single [reaction type](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue.","in":"query","name":"content","schema":{"enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction-items"}},"schema":{"items":{"$ref":"#/components/schemas/reaction"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"}}GitHubBearerToken�S�( 'm+��U�/issues/unlock/repos/{owner}/{repo}/issues/{issue_number}/lockDELETEUnlock an issueUsers with push access can unlock an issue's conversation.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"requestBody":null}{"204":{"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�K�' #m'�A�E�g/issues/lock/repos/{owner}/{repo}/issues/{issue_number}/lockPUTLock an issueUsers with push access can lock an issue or pull request's conversation.
Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-verbs)."{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"requestBody":{"content":{"application/json":{"schema":{"nullable":true,"properties":{"lock_reason":{"description":"The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`","enum":["off-topic","too heated","resolved","spam"],"type":"string"}},"type":"object"}}}}}{"204":{"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�]�& 3E�Y��m/issues/remove-label/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}DELETERemove a label from an issueRemoves the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"},{"in":"path","name":"name","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/label-items-2"}},"schema":{"items":{"$ref":"#/components/schemas/label"},"type":"array"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"}}GitHubBearerToken
D
�A�D �8�- 9A-
� �//repos/list-deploy-keys/repos/{owner}/{repo}/keysGETList deploy keys{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/deploy-key-items"}},"schema":{"items":{"$ref":"#/components/schemas/deploy-key"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�=�, KuO
�}�q/issues/list-events-for-timeline/repos/{owner}/{repo}/issues/{issue_number}/timelineGETList timeline events for an issue{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/timeline-issue-events"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"}}GitHubBearerToken��+ A�=�!�3Q/reactions/delete-for-issue/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}DELETEDelete an issue reaction**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.
Delete a reaction to an [issue](https://docs.github.com/enterprise-server@2.22/rest/reference/issues/).{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"},{"$ref":"#/components/parameters/reaction-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken� �* AwE�!�W�W/reactions/create-for-issue/repos/{owner}/{repo}/issues/{issue_number}/reactionsPOSTCreate reaction for an issueCreate a reaction to an [issue](https://docs.github.com/enterprise-server@2.22/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/issue-number"}],"requestBody":{"content":{"application/json":{"example":{"content":"heart"},"schema":{"properties":{"content":{"description":"The [reaction type](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#reaction-types) to add to the issue.","enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"],"type":"string"}},"required":["content"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction"}},"schema":{"$ref":"#/components/schemas/reaction"}}},"description":"Response"},"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction"}},"schema":{"$ref":"#/components/schemas/reaction"}}},"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� ��L� �s�1 CEE
� �/issues/list-labels-for-repo/repos/{owner}/{repo}/labelsGETList labels for a repository{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/label-items"}},"schema":{"items":{"$ref":"#/components/schemas/label"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken��0 ;S3�U�IQ/repos/delete-deploy-key/repos/{owner}/{repo}/keys/{key_id}DELETEDelete a deploy keyDeploy keys are immutable. If you need to update a key, remove the key and create a new one instead.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/key-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�p�/ 5S-
�I�e/repos/get-deploy-key/repos/{owner}/{repo}/keys/{key_id}GETGet a deploy key{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/key-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/deploy-key"}},"schema":{"$ref":"#/components/schemas/deploy-key"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�%�. ;A3Y�I�/repos/create-deploy-key/repos/{owner}/{repo}/keysPOSTCreate a deploy keyYou can create a read-only deploy key.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"key":"ssh-rsa AAA...","read_only":true,"title":"octocat@octomac"},"schema":{"properties":{"key":{"description":"The contents of the key.","type":"string"},"read_only":{"description":"If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://help.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://help.github.com/articles/permission-levels-for-a-user-account-repository/).\"","type":"boolean"},"title":{"description":"A name for the key.","type":"string"}},"required":["key"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/deploy-key"}},"schema":{"$ref":"#/components/schemas/deploy-key"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/Hello-World/keys/1","schema":{"type":"string"},"style":"simple"}}},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
�
9*�� ��5 3S)
��q/issues/update-label/repos/{owner}/{repo}/labels/{name}PATCHUpdate a label{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"in":"path","name":"name","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":{"color":"b01f26","description":"Small bug fix required","new_name":"bug :bug:"},"schema":{"properties":{"color":{"description":"The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.","type":"string"},"description":{"description":"A short description of the label.","type":"string"},"new_name":{"description":"The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"","type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/label-2"}},"schema":{"$ref":"#/components/schemas/label"}}},"description":"Response"}}GitHubBearerToken�S�4
3S)
�%Q/issues/delete-label/repos/{owner}/{repo}/labels/{name}DELETEDelete a label{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"in":"path","name":"name","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken� �3 -S#
�%�Q/issues/get-label/repos/{owner}/{repo}/labels/{name}GETGet a label{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"in":"path","name":"name","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/label"}},"schema":{"$ref":"#/components/schemas/label"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�C�2 3E)
��_/issues/create-label/repos/{owner}/{repo}/labelsPOSTCreate a label{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"color":"f29513","description":"Something isn't working","name":"bug"},"schema":{"properties":{"color":{"description":"The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.","type":"string"},"description":{"description":"A short description of the label.","type":"string"},"name":{"description":"The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"","type":"string"}},"required":["name"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/label"}},"schema":{"$ref":"#/components/schemas/label"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/Hello-World/labels/bug","schema":{"type":"string"},"style":"simple"}}},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
�
�
�� � �0�9 9M+
�#�/issues/list-milestones/repos/{owner}/{repo}/milestonesGETList milestones{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"The state of the milestone. Either `open`, `closed`, or `all`.","in":"query","name":"state","schema":{"default":"open","enum":["open","closed","all"],"type":"string"},"style":"form"},{"description":"What to sort results by. Either `due_on` or `completeness`.","in":"query","name":"sort","schema":{"default":"due_on","enum":["due_on","completeness"],"type":"string"},"style":"form"},{"description":"The direction of the sort. Either `asc` or `desc`.","in":"query","name":"direction","schema":{"default":"asc","enum":["asc","desc"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/milestone-items"}},"schema":{"items":{"$ref":"#/components/schemas/milestone"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�t�8 #E)
�G�/repos/merge/repos/{owner}/{repo}/mergesPOSTMerge a branch{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"base":"master","commit_message":"Shipped cool_feature!","head":"cool_feature"},"schema":{"properties":{"base":{"description":"The name of the base branch that the head will be merged into.","type":"string"},"commit_message":{"description":"Commit message to use for the merge commit. If omitted, a default message will be used.","type":"string"},"head":{"description":"The head to merge. This can be a branch name or a commit SHA1.","type":"string"}},"required":["base","head"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/commit"}},"schema":{"$ref":"#/components/schemas/commit"}}},"description":"Successful Response (The resulting merge commit)"},"204":{"description":"Response when already merged"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"description":"Not Found when the base or head does not exist"},"409":{"description":"Conflict when there is a merge conflict"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�<�7 7GM�1�u�/licenses/get-for-repo/repos/{owner}/{repo}/licenseGETGet the license for a repositoryThis method returns the contents of the repository's license file, if one is detected.
Similar to [Get repository content](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/license-content"}},"schema":{"$ref":"#/components/schemas/license-content"}}},"description":"Response"}}GitHubBearerToken� �6 5K?� �u�y/repos/list-languages/repos/{owner}/{repo}/languagesGETList repository languagesLists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/language"}},"schema":{"$ref":"#/components/schemas/language"}}},"description":"Response"}}GitHubBearerToken
�
��� ��= ;s1
�-�}/issues/update-milestone/repos/{owner}/{repo}/milestones/{milestone_number}PATCHUpdate a milestone{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/milestone-number"}],"requestBody":{"content":{"application/json":{"example":{"description":"Tracking milestone for version 1.0","due_on":"2012-10-09T23:39:01Z","state":"open","title":"v1.0"},"schema":{"properties":{"description":{"description":"A description of the milestone.","type":"string"},"due_on":{"description":"The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","format":"date-time","type":"string"},"state":{"default":"open","description":"The state of the milestone. Either `open` or `closed`.","enum":["open","closed"],"type":"string"},"title":{"description":"The title of the milestone.","type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/milestone"}},"schema":{"$ref":"#/components/schemas/milestone"}}},"description":"Response"}}GitHubBearerToken�z�< ;s1
�]�5/issues/delete-milestone/repos/{owner}/{repo}/milestones/{milestone_number}DELETEDelete a milestone{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/milestone-number"}],"requestBody":null}{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken��; 5s+
�]�a/issues/get-milestone/repos/{owner}/{repo}/milestones/{milestone_number}GETGet a milestone{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/milestone-number"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/milestone"}},"schema":{"$ref":"#/components/schemas/milestone"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�]�: ;M1
��s/issues/create-milestone/repos/{owner}/{repo}/milestonesPOSTCreate a milestone{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"description":"Tracking milestone for version 1.0","due_on":"2012-10-09T23:39:01Z","state":"open","title":"v1.0"},"schema":{"properties":{"description":{"description":"A description of the milestone.","type":"string"},"due_on":{"description":"The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","format":"date-time","type":"string"},"state":{"default":"open","description":"The state of the milestone. Either `open` or `closed`.","enum":["open","closed"],"type":"string"},"title":{"description":"The title of the milestone.","type":"string"}},"required":["title"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/milestone"}},"schema":{"$ref":"#/components/schemas/milestone"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/Hello-World/milestones/1","schema":{"type":"string"},"style":"simple"}}},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
�
Z ��� �F�A +C_
�u�M/repos/get-pages/repos/{owner}/{repo}/pagesGETGet a GitHub Enterprise Server Pages site{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/page"}},"schema":{"$ref":"#/components/schemas/page"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�4�@ ]SW�=��/activity/mark-repo-notifications-as-read/repos/{owner}/{repo}/notificationsPUTMark repository notifications as readMarks all notifications in a repository as "read" removes them from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@2.22/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"last_read_at":{"description":"Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.","format":"date-time","type":"string"}},"type":"object"}}}}}{"202":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"url":{"type":"string"}},"type":"object"}}},"description":"Response"},"205":{"description":"Reset Content"}}GitHubBearerToken�Y�? {S}e�s� /activity/list-repo-notifications-for-authenticated-user/repos/{owner}/{repo}/notificationsGETList repository notifications for the authenticated userList all notifications for the current user.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/participating"},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/before"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/thread-items"}},"schema":{"items":{"$ref":"#/components/schemas/thread"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�"�> M�W
��/issues/list-labels-for-milestone/repos/{owner}/{repo}/milestones/{milestone_number}/labelsGETList labels for issues in a milestone{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/milestone-number"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/label-items"}},"schema":{"items":{"$ref":"#/components/schemas/label"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
� - � �m�C ;Ce�?��?/repos/create-pages-site/repos/{owner}/{repo}/pagesPOSTCreate a GitHub Enterprise Server Pages siteConfigures a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)."{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"source":{"branch":"main","path":"/docs"}},"schema":{"description":"The source branch and directory used to publish your Pages site.","nullable":true,"properties":{"source":{"description":"The source branch and directory used to publish your Pages site.","properties":{"branch":{"description":"The repository branch used to publish your site's source files.","type":"string"},"path":{"default":"/","description":"The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`","enum":["/","/docs"],"type":"string"}},"required":["branch"],"type":"object"}},"required":["source"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/page"}},"schema":{"$ref":"#/components/schemas/page"}}},"description":"Response"},"409":{"$ref":"#/components/responses/conflict"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�O�B
_C� �W�{�-/repos/update-information-about-pages-site/repos/{owner}/{repo}/pagesPUTUpdate information about a GitHub Enterprise Server Pages siteUpdates information for a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"cname":"octocatblog.com","source":{"branch":"main","path":"/"}},"schema":{"anyOf":[{"required":["source"]},{"required":["cname"]},{"required":["public"]},{"required":["https_enforced"]}],"properties":{"cname":{"description":"Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/).\"","nullable":true,"type":"string"},"https_enforced":{"description":"Specify whether HTTPS should be enforced for the repository.","type":"boolean"},"public":{"description":"Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan.","type":"boolean"},"source":{"anyOf":[{"description":"Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.","enum":["gh-pages","master","master /docs"],"type":"string"},{"description":"Update the source for the repository. Must include the branch name and path.","properties":{"branch":{"description":"The repository branch used to publish your site's source files.","type":"string"},"path":{"description":"The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.","enum":["/","/docs"],"type":"string"}},"required":["branch","path"],"type":"object"}]}},"type":"object"}}},"required":true}}{"204":{"description":"Response"},"400":{"$ref":"#/components/responses/bad_request"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
s z K�� s ��I m[[��u�/enterprise-admin/list-pre-receive-hooks-for-repo/repos/{owner}/{repo}/pre-receive-hooksGETList pre-receive hooks for a repositoryList all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/direction"},{"in":"query","name":"sort","schema":{"default":"created","enum":["created","updated","name"],"type":"string"},"style":"form"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/repository-pre-receive-hook-items"}},"schema":{"items":{"$ref":"#/components/schemas/repository-pre-receive-hook"},"type":"array"}}},"description":"Response"}}GitHubBearerToken��H 7g]
�/�/repos/get-pages-build/repos/{owner}/{repo}/pages/builds/{build_id}GETGet GitHub Enterprise Server Pages build{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"in":"path","name":"build_id","required":true,"schema":{"type":"integer"},"style":"simple"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/page-build"}},"schema":{"$ref":"#/components/schemas/page-build"}}},"description":"Response"}}GitHubBearerToken�(�G E_9
�u�/repos/get-latest-pages-build/repos/{owner}/{repo}/pages/builds/latestGETGet latest Pages build{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/page-build"}},"schema":{"$ref":"#/components/schemas/page-build"}}},"description":"Response"}}GitHubBearerToken�L�F ?Qi��u� /repos/request-pages-build/repos/{owner}/{repo}/pages/buildsPOSTRequest a GitHub Enterprise Server Pages buildYou can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/page-build-status"}},"schema":{"$ref":"#/components/schemas/page-build-status"}}},"description":"Response"}}GitHubBearerToken�[�E ;Qa
� �//repos/list-pages-builds/repos/{owner}/{repo}/pages/buildsGETList GitHub Enterprise Server Pages builds{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/page-build-items"}},"schema":{"items":{"$ref":"#/components/schemas/page-build"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken��D ;Ce
�u�)/repos/delete-pages-site/repos/{owner}/{repo}/pagesDELETEDelete a GitHub Enterprise Server Pages site{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
�
�
��� � �M 9I=�]�_�K/projects/list-for-repo/repos/{owner}/{repo}/projectsGETList repository projectsLists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.","in":"query","name":"state","schema":{"default":"open","enum":["open","closed","all"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/project-items-2"}},"schema":{"items":{"$ref":"#/components/schemas/project"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"},"422":{"$ref":"#/components/responses/validation_failed_simple"}}GitHubBearerToken�>�L��u�W�_�I/enterprise-admin/update-pre-receive-hook-enforcement-for-repo/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}PATCHUpdate pre-receive hook enforcement for a repositoryFor pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement`{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pre-receive-hook-id"}],"requestBody":{"content":{"application/json":{"example":{"enforcement":"enabled"},"schema":{"properties":{"enforcement":{"description":"The state of enforcement for the hook on this repository.","enum":["enabled","disabled","testing"],"type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/repository-pre-receive-hook-2"}},"schema":{"$ref":"#/components/schemas/repository-pre-receive-hook"}}},"description":"Response"}}GitHubBearerToken�1�K��u�;�c�E/enterprise-admin/remove-pre-receive-hook-enforcement-for-repo/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}DELETERemove pre-receive hook enforcement for a repositoryDeletes any overridden enforcement on this repository for the specified hook.
Responds with effective values inherited from owner and/or global level.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pre-receive-hook-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/repository-pre-receive-hook"}},"schema":{"$ref":"#/components/schemas/repository-pre-receive-hook"}}},"description":"Responds with effective values inherited from owner and/or global level."}}GitHubBearerToken�9�J i�[
�c�E/enterprise-admin/get-pre-receive-hook-for-repo/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}GETGet a pre-receive hook for a repository{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pre-receive-hook-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/repository-pre-receive-hook"}},"schema":{"$ref":"#/components/schemas/repository-pre-receive-hook"}}},"description":"Response"}}GitHubBearerToken
�h�O !C1�3�e�1/pulls/list/repos/{owner}/{repo}/pullsGETList pull requestsDraft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"Either `open`, `closed`, or `all` to filter by state.","in":"query","name":"state","schema":{"default":"open","enum":["open","closed","all"],"type":"string"},"style":"form"},{"description":"Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.","in":"query","name":"head","schema":{"type":"string"},"style":"form"},{"description":"Filter pulls by base branch name. Example: `gh-pages`.","in":"query","name":"base","schema":{"type":"string"},"style":"form"},{"description":"What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).","in":"query","name":"sort","schema":{"default":"created","enum":["created","updated","popularity","long-running"],"type":"string"},"style":"form"},{"description":"The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.","in":"query","name":"direction","schema":{"enum":["asc","desc"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pull-request-simple-items"}},"schema":{"items":{"$ref":"#/components/schemas/pull-request-simple"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�z�N =IC�]�=� /projects/create-for-repo/repos/{owner}/{repo}/projectsPOSTCreate a repository projectCreates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"body":"Developer documentation project for the developer site.","name":"Projects Documentation"},"schema":{"properties":{"body":{"description":"The description of the project.","type":"string"},"name":{"description":"The name of the project.","type":"string"}},"required":["name"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/project-3"}},"schema":{"$ref":"#/components/schemas/project"}}},"description":"Response"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"410":{"$ref":"#/components/responses/gone"},"422":{"$ref":"#/components/responses/validation_failed_simple"}}GitHubBearerToken
4 4 �H�P %C7�A�A�{/pulls/create/repos/{owner}/{repo}/pullsPOSTCreate a pull requestDraft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
You can create a new pull request.
This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"base":"master","body":"Please pull these awesome changes in!","head":"octocat:new-feature","title":"Amazing new feature"},"schema":{"properties":{"base":{"description":"The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.","type":"string"},"body":{"description":"The contents of the pull request.","type":"string"},"draft":{"description":"Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.","type":"boolean"},"head":{"description":"The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.","type":"string"},"issue":{"example":1,"type":"integer"},"maintainer_can_modify":{"description":"Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.","type":"boolean"},"title":{"description":"The title of the new pull request.","type":"string"}},"required":["head","base"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pull-request"}},"schema":{"$ref":"#/components/schemas/pull-request"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/Hello-World/pulls/1347","schema":{"type":"string"},"style":"simple"}}},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
u � H�u �$�T CoaW�!�I/pulls/update-review-comment/repos/{owner}/{repo}/pulls/comments/{comment_id}PATCHUpdate a review comment for a pull requestEnables you to edit a review comment.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"requestBody":{"content":{"application/json":{"example":{"body":"I like this too!"},"schema":{"properties":{"body":{"description":"The text of the reply to the review comment.","type":"string"}},"required":["body"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pull-request-review-comment-2"}},"schema":{"$ref":"#/components/schemas/pull-request-review-comment"}}},"description":"Response"}}GitHubBearerToken�'�S Coa?�Q�5/pulls/delete-review-comment/repos/{owner}/{repo}/pulls/comments/{comment_id}DELETEDelete a review comment for a pull requestDeletes a review comment.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"requestBody":null}{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�g�R =o[Y�Q�-/pulls/get-review-comment/repos/{owner}/{repo}/pulls/comments/{comment_id}GETGet a review comment for a pull requestProvides details for a review comment.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pull-request-review-comment-2"}},"schema":{"$ref":"#/components/schemas/pull-request-review-comment"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�I�Q SUU�y�7�s/pulls/list-review-comments-for-repo/repos/{owner}/{repo}/pulls/commentsGETList review comments in a repositoryLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"in":"query","name":"sort","schema":{"enum":["created","updated","created_at"],"type":"string"},"style":"form"},{"description":"Can be either `asc` or `desc`. Ignored without `sort` parameter.","in":"query","name":"direction","schema":{"enum":["asc","desc"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pull-request-review-comment-items"}},"schema":{"items":{"$ref":"#/components/schemas/pull-request-review-comment"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
� p� �a�W _� Y�s�/Q/reactions/delete-for-pull-request-comment/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}DELETEDelete a pull request comment reaction**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`
Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#review-comments).{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"},{"$ref":"#/components/parameters/reaction-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�'�V
m�o���u/reactions/create-for-pull-request-review-comment/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactionsPOSTCreate reaction for a pull request review commentCreate a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"}],"requestBody":{"content":{"application/json":{"example":{"content":"heart"},"schema":{"properties":{"content":{"description":"The [reaction type](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#reaction-types) to add to the pull request review comment.","enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"],"type":"string"}},"required":["content"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction"}},"schema":{"$ref":"#/components/schemas/reaction"}}},"description":"Reaction exists"},"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction"}},"schema":{"$ref":"#/components/schemas/reaction"}}},"description":"Reaction created"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�a�U
i�m�#�G� /reactions/list-for-pull-request-review-comment/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactionsGETList reactions for a pull request review commentList the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#review-comments).{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/comment-id"},{"description":"Returns a single [reaction type](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment.","in":"query","name":"content","schema":{"enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction-items"}},"schema":{"items":{"$ref":"#/components/schemas/reaction"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
e e ��X _1��S�'/pulls/get/repos/{owner}/{repo}/pulls/{pull_number}GETGet a pull requestDraft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Lists details of a pull request by providing its number.
When you get, [create](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@2.22/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.
The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:
* If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.
* If merged via a [squash](https://help.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.
* If [rebased](https://help.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.
Pass the appropriate [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pull-request"}},"schema":{"$ref":"#/components/schemas/pull-request"}}},"description":"Pass the appropriate [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats."},"304":{"$ref":"#/components/responses/not_modified"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_error"}}GitHubBearerToken
� �� �'�Z AqY�[��s/pulls/list-review-comments/repos/{owner}/{repo}/pulls/{pull_number}/commentsGETList review comments on a pull requestLists all review comments for a pull request. By default, review comments are in ascending order by ID.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"},{"$ref":"#/components/parameters/sort"},{"description":"Can be either `asc` or `desc`. Ignored without `sort` parameter.","in":"query","name":"direction","schema":{"enum":["asc","desc"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pull-request-review-comment-items"}},"schema":{"items":{"$ref":"#/components/schemas/pull-request-review-comment"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�D�Y %_7�3�C�a/pulls/update/repos/{owner}/{repo}/pulls/{pull_number}PATCHUpdate a pull requestDraft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"}],"requestBody":{"content":{"application/json":{"example":{"base":"master","body":"updated body","state":"open","title":"new title"},"schema":{"properties":{"base":{"description":"The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.","type":"string"},"body":{"description":"The contents of the pull request.","type":"string"},"maintainer_can_modify":{"description":"Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.","type":"boolean"},"state":{"description":"State of this Pull Request. Either `open` or `closed`.","enum":["open","closed"],"type":"string"},"title":{"description":"The title of the pull request.","type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pull-request"}},"schema":{"$ref":"#/components/schemas/pull-request"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken nt may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"}],"requestBody":{"content":{"application/json":{"examples":{"example-for-a-multi-line-comment":{"summary":"Example for a multi-line comment","value":{"body":"Great stuff!","commit_id":"6dcb09b5b57875f334f61aebed695e2e4193db5e","line":2,"path":"file1.txt","side":"RIGHT","start_line":1,"start_side":"RIGHT"}},"example-for-a-single-line-comment":{"summary":"Example for a single-line comment","value":{"body":"Let's add this deleted line back.","commit_id":"6dcb09b5b57875f334f61aebed695e2e4193db5e","line":5,"path":"file1.txt","side":"LEFT"}}},"schema":{"properties":{"body":{"description":"The text of the review comment.","type":"string"},"commit_id":{"description":"The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.","type":"string"},"in_reply_to":{"example":2,"type":"integer"},"line":{"description":"The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.","type":"integer"},"path":{"description":"The relative path to the file that necessitates a comment.","type":"string"},"position":{"description":"The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.","type":"integer"},"side":{"description":"In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.","enum":["LEFT","RIGHT"],"type":"string"},"start_line":{"description":"**Required when using multi-line comments**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.","type":"integer"},"start_side":{"description":"**Required when using multi-line comments**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.","enum":["LEFT","RIGHT","side"],"type":"string"}},"required":["body"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"example-for-a-multi-line-comment":{"$ref":"#/components/examples/pull-request-review-comment-example-for-a-multi-line-comment"}},"schema":{"$ref":"#/components/schemas/pull-request-review-comment"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1","schema":{"type":"string"},"style":"simple"}}},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
a � a �v�] 1oI�w�{� /pulls/list-commits/repos/{owner}/{repo}/pulls/{pull_number}/commitsGETList commits on a pull requestLists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#list-commits) endpoint.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/commit-items"}},"schema":{"items":{"$ref":"#/components/schemas/commit"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�&�\
W�S�e�]�O/pulls/create-reply-for-review-comment/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/repliesPOSTCreate a reply for a review commentCreates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.
This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"},{"$ref":"#/components/parameters/comment-id"}],"requestBody":{"content":{"application/json":{"example":{"body":"Great stuff!"},"schema":{"properties":{"body":{"description":"The text of the review comment.","type":"string"}},"required":["body"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pull-request-review-comment"}},"schema":{"$ref":"#/components/schemas/pull-request-review-comment"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1","schema":{"type":"string"},"style":"simple"}}},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�o�[ Cqa�;�c�7/pulls/create-review-comment/repos/{owner}/{repo}/pulls/{pull_number}/commentsPOSTCreate a review comment for a pull request
Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-server@2.22/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.
You can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.
**Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoi �
� �
� � �}�` #k5� � �/pulls/merge/repos/{owner}/{repo}/pulls/{pull_number}/mergePUTMerge a pull requestThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.22/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"}],"requestBody":{"content":{"application/json":{"schema":{"nullable":true,"properties":{"commit_message":{"description":"Extra detail to append to automatic commit message.","type":"string"},"commit_title":{"description":"Title for the automatic commit message.","type":"string"},"merge_method":{"description":"Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.","enum":["merge","squash","rebase"],"type":"string"},"sha":{"description":"SHA that pull request head must match to allow merge.","type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"response-if-merge-was-successful":{"$ref":"#/components/examples/pull-request-merge-result-response-if-merge-was-successful"}},"schema":{"$ref":"#/components/schemas/pull-request-merge-result"}}},"description":"if merge was successful"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"405":{"content":{"application/json":{"examples":{"response-if-merge-cannot-be-performed":{"value":{"message":"Pull Request is not mergeable"}}},"schema":{"properties":{"documentation_url":{"type":"string"},"message":{"type":"string"}},"type":"object"}}},"description":"Method Not Allowed if merge cannot be performed"},"409":{"content":{"application/json":{"examples":{"response-if-sha-was-provided-and-pull-request-head-did-not-match":{"value":{"message":"Head branch was modified. Review and try the merge again."}}},"schema":{"properties":{"documentation_url":{"type":"string"},"message":{"type":"string"}},"type":"object"}}},"description":"Conflict if sha was provided and pull request head did not match"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�5�_ 7k[
�S� /pulls/check-if-merged/repos/{owner}/{repo}/pulls/{pull_number}/mergeGETCheck if a pull request has been merged{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"}],"requestBody":null}{"204":{"description":"Response if pull request has been merged"},"404":{"description":"Not Found if pull request has not been merged"}}GitHubBearerToken�a�^ -k=�o�{�/pulls/list-files/repos/{owner}/{repo}/pulls/{pull_number}/filesGETList pull requests files**Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/diff-entry-items"}},"schema":{"items":{"$ref":"#/components/schemas/diff-entry"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"422":{"$ref":"#/components/responses/validation_failed"},"500":{"$ref":"#/components/responses/internal_error"}}GitHubBearerToken
�
D�� �K�c M�i
�S�/pulls/remove-requested-reviewers/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewersDELETERemove requested reviewers from a pull request{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"}],"requestBody":{"content":{"application/json":{"example":{"reviewers":["octocat","hubot","other_user"],"team_reviewers":["justice-league"]},"schema":{"properties":{"reviewers":{"description":"An array of user `login`s that will be removed.","items":{"type":"string"},"type":"array"},"team_reviewers":{"description":"An array of team `slug`s that will be removed.","items":{"type":"string"},"type":"array"}},"required":["reviewers"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pull-request-simple"}}},"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�-�b
;�U� ��//pulls/request-reviewers/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewersPOSTRequest reviewers for a pull requestThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.22/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"}],"requestBody":{"content":{"application/json":{"example":{"reviewers":["octocat","hubot","other_user"],"team_reviewers":["justice-league"]},"schema":{"anyOf":[{"required":["reviewers"]},{"required":["team_reviewers"]}],"properties":{"reviewers":{"description":"An array of user `login`s that will be requested.","items":{"type":"string"},"type":"array"},"team_reviewers":{"description":"An array of team `slug`s that will be requested.","items":{"type":"string"},"type":"array"}},"type":"object"}}}}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pull-request-review-request"}},"schema":{"$ref":"#/components/schemas/pull-request-simple"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"description":"Unprocessable Entity if user is not a collaborator"}}GitHubBearerToken�8�a I�c
�{�C/pulls/list-requested-reviewers/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewersGETList requested reviewers for a pull request{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/simple-pull-request-review-request"}},"schema":{"$ref":"#/components/schemas/pull-request-review-request"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
"
��" �4�h C�a
�-� /pulls/delete-pending-review/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}DELETEDelete a pending review for a pull request{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"},{"$ref":"#/components/parameters/review-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pull-request-review"}},"schema":{"$ref":"#/components/schemas/pull-request-review"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed_simple"}}GitHubBearerToken�T�g 3�Qm��+/pulls/update-review/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}PUTUpdate a review for a pull requestUpdate the review summary comment with new text.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"},{"$ref":"#/components/parameters/review-id"}],"requestBody":{"content":{"application/json":{"example":{"body":"This is close to perfect! Please address the suggested inline change. And add more about this."},"schema":{"properties":{"body":{"description":"The body text of the pull request review.","type":"string"}},"required":["body"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pull-request-review-5"}},"schema":{"$ref":"#/components/schemas/pull-request-review"}}},"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed_simple"}}GitHubBearerToken�\�f -�K
�-�
/pulls/get-review/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}GETGet a review for a pull request{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"},{"$ref":"#/components/parameters/review-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pull-request-review-4"}},"schema":{"$ref":"#/components/schemas/pull-request-review"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken��e 3oQ��+� /pulls/create-review/repos/{owner}/{repo}/pulls/{pull_number}/reviewsPOSTCreate a review for a pull requestThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#secondary-rate-limits ��y�d 1oKs�{�)/pulls/list-reviews/repos/{owner}/{repo}/pulls/{pull_number}/reviewsGETList reviews for a pull requestThe list of reviews returns in chronological order.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pull-request-review-items"}},"schema":{"items":{"$ref":"#/components/schemas/pull-request-review"},"type":"array"}}},"description":"The list of reviews returns in chronological order.","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken )" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
Pull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.
**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#get-a-pull-request) endpoint.
The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"}],"requestBody":{"content":{"application/json":{"example":{"body":"This is close to perfect! Please address the suggested inline change.","comments":[{"body":"Please add more information here, and fix this typo.","path":"file.md","position":6}],"commit_id":"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091","event":"REQUEST_CHANGES"},"schema":{"properties":{"body":{"description":"**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.","type":"string"},"comments":{"description":"Use the following table to specify the location, destination, and contents of the draft review comment.","items":{"properties":{"body":{"description":"Text of the review comment.","type":"string"},"line":{"example":28,"type":"integer"},"path":{"description":"The relative path to the file that necessitates a review comment.","type":"string"},"position":{"description":"The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.","type":"integer"},"side":{"example":"RIGHT","type":"string"},"start_line":{"example":26,"type":"integer"},"start_side":{"example":"LEFT","type":"string"}},"required":["path","body"],"type":"object"},"type":"array"},"commit_id":{"description":"The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value.","type":"string"},"event":{"description":"The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.","enum":["APPROVE","REQUEST_CHANGES","COMMENT"],"type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pull-request-review"}},"schema":{"$ref":"#/components/schemas/pull-request-review"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed_simple"}}GitHubBearerToken
� ��� �7�k 3�Q
�a�s/pulls/submit-review/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/eventsPOSTSubmit a review for a pull request{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"},{"$ref":"#/components/parameters/review-id"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"body":{"description":"The body text of the pull request review","type":"string"},"event":{"description":"The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.","enum":["APPROVE","REQUEST_CHANGES","COMMENT"],"type":"string"}},"required":["event"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pull-request-review-4"}},"schema":{"$ref":"#/components/schemas/pull-request-review"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed_simple"}}GitHubBearerToken�<�j
5� S�%�+�/pulls/dismiss-review/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissalsPUTDismiss a review for a pull request**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"},{"$ref":"#/components/parameters/review-id"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"event":{"example":"\"APPROVE\"","type":"string"},"message":{"description":"The message for the pull request review dismissal","type":"string"}},"required":["message"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pull-request-review-3"}},"schema":{"$ref":"#/components/schemas/pull-request-review"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed_simple"}}GitHubBearerToken�K�i I�[o�U�#/pulls/list-comments-for-review/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/commentsGETList comments for a pull request reviewList comments for a specific pull request review.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"},{"$ref":"#/components/parameters/review-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/review-comment-items"}},"schema":{"items":{"$ref":"#/components/schemas/review-comment"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
D
?�D �a�n GQ[�C�9�a/repos/get-readme-in-directory/repos/{owner}/{repo}/readme/{dir}GETGet a repository README for a directoryGets the README from a repository directory.
READMEs support [custom media types](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"The alternate path to look for a README file","in":"path","name":"dir","required":true,"schema":{"type":"string"},"style":"simple","x-multi-segment":true},{"description":"The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)","in":"query","name":"ref","schema":{"type":"string"},"style":"form"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/content-file"}},"schema":{"$ref":"#/components/schemas/content-file"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken��m -E;�A�c�a/repos/get-readme/repos/{owner}/{repo}/readmeGETGet a repository READMEGets the preferred README for a repository.
READMEs support [custom media types](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)","in":"query","name":"ref","schema":{"type":"string"},"style":"form"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/content-file"}},"schema":{"$ref":"#/components/schemas/content-file"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�=�l 3{E��s�/pulls/update-branch/repos/{owner}/{repo}/pulls/{pull_number}/update-branchPUTUpdate a pull request branchUpdates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/pull-number"}],"requestBody":{"content":{"application/json":{"example":{"expected_head_sha":"6dcb09b5b57875f334f61aebed695e2e4193db5e"},"schema":{"nullable":true,"properties":{"expected_head_sha":{"description":"The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.","type":"string"}},"type":"object"}}}}}{"202":{"content":{"application/json":{"example":{"message":"Updating pull request branch.","url":"https://github.com/repos/octocat/Hello-World/pulls/53"},"schema":{"properties":{"message":{"type":"string"},"url":{"type":"string"}},"type":"object"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
5 5 �O�p 5I-�c��/repos/create-release/repos/{owner}/{repo}/releasesPOSTCreate a releaseUsers with push access to the repository can create a release.
This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"body":"Description of the release","draft":false,"name":"v1.0.0","prerelease":false,"tag_name":"v1.0.0","target_commitish":"master"},"schema":{"properties":{"body":{"description":"Text describing the contents of the tag.","type":"string"},"draft":{"default":false,"description":"`true` to create a draft (unpublished) release, `false` to create a published one.","type":"boolean"},"name":{"description":"The name of the release.","type":"string"},"prerelease":{"default":false,"description":"`true` to identify the release as a prerelease. `false` to identify the release as a full release.","type":"boolean"},"tag_name":{"description":"The name of the tag.","type":"string"},"target_commitish":{"description":"Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).","type":"string"}},"required":["tag_name"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/release"}},"schema":{"$ref":"#/components/schemas/release"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/Hello-World/releases/1","schema":{"type":"string"},"style":"simple"}}},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�t�o 3I'�/� �/repos/list-releases/repos/{owner}/{repo}/releasesGETList releasesThis returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#list-repository-tags).
Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/release-items"}},"schema":{"items":{"$ref":"#/components/schemas/release"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
�
� � < � ��u =_?k�
�Y/repos/get-release-by-tag/repos/{owner}/{repo}/releases/tags/{tag}GETGet a release by tag nameGet a published release with the specified tag.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"description":"tag parameter","in":"path","name":"tag","required":true,"schema":{"type":"string"},"style":"simple","x-multi-segment":true}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/release"}},"schema":{"$ref":"#/components/schemas/release"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�L�t =W9�o�u�u/repos/get-latest-release/repos/{owner}/{repo}/releases/latestGETGet the latest releaseView the latest published full release for the repository.
The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/release"}},"schema":{"$ref":"#/components/schemas/release"}}},"description":"Response"}}GitHubBearerToken��s Am9��1�
/repos/update-release-asset/repos/{owner}/{repo}/releases/assets/{asset_id}PATCHUpdate a release assetUsers with push access to the repository can edit a release asset.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/asset-id"}],"requestBody":{"content":{"application/json":{"example":{"label":"Mac binary","name":"foo-1.0.0-osx.zip"},"schema":{"properties":{"label":{"description":"An alternate short description of the asset. Used in place of the filename.","type":"string"},"name":{"description":"The file name of the asset.","type":"string"},"state":{"example":"\"uploaded\"","type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/release-asset"}},"schema":{"$ref":"#/components/schemas/release-asset"}}},"description":"Response"}}GitHubBearerToken�C�r
Am9
�MQ/repos/delete-release-asset/repos/{owner}/{repo}/releases/assets/{asset_id}DELETEDelete a release asset{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/asset-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken��q ;m3�+�M�Y/repos/get-release-asset/repos/{owner}/{repo}/releases/assets/{asset_id}GETGet a release assetTo download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/asset-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/release-asset"}},"schema":{"$ref":"#/components/schemas/release-asset"}}},"description":"To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response."},"302":{"$ref":"#/components/responses/found"},"404":{"$ref":"#/components/responses/not_found"},"415":{"$ref":"#/components/responses/preview_header_missing"}}GitHubBearerToken
o 7
��o �
�y ?q3
�y�;/repos/list-release-assets/repos/{owner}/{repo}/releases/{release_id}/assetsGETList release assets{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/release-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/release-asset-items"}},"schema":{"items":{"$ref":"#/components/schemas/release-asset"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�?�x 5c-��I�u/repos/update-release/repos/{owner}/{repo}/releases/{release_id}PATCHUpdate a releaseUsers with push access to the repository can edit a release.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/release-id"}],"requestBody":{"content":{"application/json":{"example":{"body":"Description of the release","draft":false,"name":"v1.0.0","prerelease":false,"tag_name":"v1.0.0","target_commitish":"master"},"schema":{"properties":{"body":{"description":"Text describing the contents of the tag.","type":"string"},"draft":{"description":"`true` makes the release a draft, and `false` publishes the release.","type":"boolean"},"name":{"description":"The name of the release.","type":"string"},"prerelease":{"description":"`true` to identify the release as a prerelease, `false` to identify the release as a full release.","type":"boolean"},"tag_name":{"description":"The name of the tag.","type":"string"},"target_commitish":{"description":"Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).","type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/release"}},"schema":{"$ref":"#/components/schemas/release"}}},"description":"Response"}}GitHubBearerToken�s�w 5c-� �QQ/repos/delete-release/repos/{owner}/{repo}/releases/{release_id}DELETEDelete a releaseUsers with push access to the repository can delete a release.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/release-id"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�E�v /c'�i�Q�%/repos/get-release/repos/{owner}/{repo}/releases/{release_id}GETGet a release**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#hypermedia).{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/release-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/release"}},"schema":{"$ref":"#/components/schemas/release"}}},"description":"**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#hypermedia)."},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
% � % �{�{ OM+�u� �+/activity/list-stargazers-for-repo/repos/{owner}/{repo}/stargazersGETList stargazersLists the people that have starred the repository.
You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types/) via the `Accept` header:{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"alternative-response-with-star-creation-timestamps":{"$ref":"#/components/examples/stargazer-items-alternative-response-with-star-creation-timestamps"},"default-response":{"$ref":"#/components/examples/simple-user-items-default-response"}},"schema":{"anyOf":[{"items":{"$ref":"#/components/schemas/simple-user"},"type":"array"},{"items":{"$ref":"#/components/schemas/stargazer"},"type":"array"}]}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�X�z Aq9�/�+�w/repos/upload-release-asset/repos/{owner}/{repo}/releases/{release_id}/assetsPOSTUpload a release assetThis endpoint makes use of [a Hypermedia relation](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in
the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#create-a-release) to upload a release asset.
You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.
Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example:
`application/zip`
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,
you'll still need to pass your authentication to be able to upload an asset.
When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.
**Notes:**
* GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List assets for a release](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#list-assets-for-a-release)"
endpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).
* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/release-id"},{"in":"query","name":"name","required":true,"schema":{"type":"string"},"style":"form"},{"in":"query","name":"label","schema":{"type":"string"},"style":"form"}],"requestBody":{"content":{"*/*":{"schema":{"description":"The raw file data","type":"string"}}}}}{"201":{"content":{"application/json":{"examples":{"response-for-successful-upload":{"$ref":"#/components/examples/release-asset-response-for-successful-upload"}},"schema":{"$ref":"#/components/schemas/release-asset"}}},"description":"Response for successful upload"},"422":{"description":"Response if you upload an asset with the same filename as another uploaded asset"}}GitHubBearerToken
v
9�v �\� G_C�u�u�s/repos/get-participation-stats/repos/{owner}/{repo}/stats/participationGETGet the weekly commit countReturns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.
The array order is oldest week (index 0) to most recent week.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/participation-stats"}},"schema":{"$ref":"#/components/schemas/participation-stats"}}},"description":"The array order is oldest week (index 0) to most recent week."},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�_�~ E]S�K�u�/repos/get-contributors-stats/repos/{owner}/{repo}/stats/contributorsGETGet all contributor commit activity
Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:
* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).
* `a` - Number of additions
* `d` - Number of deletions
* `c` - Number of commits{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/contributor-activity-items"}},"schema":{"items":{"$ref":"#/components/schemas/contributor-activity"},"type":"array"}}},"description":"* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits"},"202":{"$ref":"#/components/responses/accepted"},"204":{"$ref":"#/components/responses/no_content"}}GitHubBearerToken�H�} KcU� �u�/repos/get-commit-activity-stats/repos/{owner}/{repo}/stats/commit_activityGETGet the last year of commit activityReturns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/commit-activity-items"}},"schema":{"items":{"$ref":"#/components/schemas/commit-activity"},"type":"array"}}},"description":"Response"},"202":{"$ref":"#/components/responses/accepted"},"204":{"$ref":"#/components/responses/no_content"}}GitHubBearerToken�w�| IaI�C�u�Q/repos/get-code-frequency-stats/repos/{owner}/{repo}/stats/code_frequencyGETGet the weekly commit activityReturns a weekly aggregate of the number of additions and deletions pushed to a repository.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/code-frequency-stat-items"}},"schema":{"items":{"$ref":"#/components/schemas/code-frequency-stat"},"type":"array"}}},"description":"Returns a weekly aggregate of the number of additions and deletions pushed to a repository."},"202":{"$ref":"#/components/responses/accepted"},"204":{"$ref":"#/components/responses/no_content"}}GitHubBearerToken
� � �z� KO's� �3/activity/list-watchers-for-repo/repos/{owner}/{repo}/subscribersGETList watchersLists the people watching the specified repository.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/simple-user-items"}},"schema":{"items":{"$ref":"#/components/schemas/simple-user"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�}� AU9�y�e�Y/repos/create-commit-status/repos/{owner}/{repo}/statuses/{sha}POSTCreate a commit statusUsers with push access in a repository can create commit statuses for a given SHA.
Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"in":"path","name":"sha","required":true,"schema":{"type":"string"},"style":"simple","x-multi-segment":true}],"requestBody":{"content":{"application/json":{"example":{"context":"continuous-integration/jenkins","description":"The build succeeded!","state":"success","target_url":"https://example.com/build/status"},"schema":{"properties":{"context":{"default":"default","description":"A string label to differentiate this status from the status of other systems. This field is case-insensitive.","type":"string"},"description":{"description":"A short description of the status.","type":"string"},"state":{"description":"The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.","enum":["error","failure","pending","success"],"type":"string"},"target_url":{"description":"The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`","type":"string"}},"required":["state"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/status"}},"schema":{"$ref":"#/components/schemas/status"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e","schema":{"type":"string"},"style":"simple"}}}}GitHubBearerToken�u� AY]��u� /repos/get-punch-card-stats/repos/{owner}/{repo}/stats/punch_cardGETGet the hourly commit count for each dayEach array contains the day number, hour number, and number of commits:
* `0-6`: Sunday - Saturday
* `0-23`: Hour of day
* Number of commits
For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/code-frequency-stat-items-2"}},"schema":{"items":{"$ref":"#/components/schemas/code-frequency-stat"},"type":"array"}}},"description":"For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits."},"204":{"$ref":"#/components/responses/no_content"}}GitHubBearerToken
�
Q��{ � �%� ISS� �#�)/repos/download-tarball-archive/repos/{owner}/{repo}/tarball/{ref}GETDownload a repository archive (tar)Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually
`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
the `Location` header to make a second `GET` request.
**Note**: For private repositories, these links are temporary and expire after five minutes.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"in":"path","name":"ref","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":null}{"302":{"description":"Response","headers":{"Location":{"example":"https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires","schema":{"type":"string"},"style":"simple"}}}}GitHubBearerToken�'� +A5
� �/repos/list-tags/repos/{owner}/{repo}/tagsGETList repository tags{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/tag-items"}},"schema":{"items":{"$ref":"#/components/schemas/tag"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�>� OQM�S�uQ/activity/delete-repo-subscription/repos/{owner}/{repo}/subscriptionDELETEDelete a repository subscriptionThis endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@2.22/rest/reference/activity#set-a-repository-subscription).{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�e� IQG�i�Y�5/activity/set-repo-subscription/repos/{owner}/{repo}/subscriptionPUTSet a repository subscriptionIf you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@2.22/rest/reference/activity#delete-a-repository-subscription) completely.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"ignored":{"description":"Determines if all notifications should be blocked from this repository.","type":"boolean"},"subscribed":{"description":"Determines if notifications should be received from this repository.","type":"boolean"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/repository-subscription"}},"schema":{"$ref":"#/components/schemas/repository-subscription"}}},"description":"Response"}}GitHubBearerToken�+� IQG
�u�/activity/get-repo-subscription/repos/{owner}/{repo}/subscriptionGETGet a repository subscription{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"response-if-you-subscribe-to-the-repository":{"$ref":"#/components/examples/repository-subscription-response-if-you-subscribe-to-the-repository"}},"schema":{"$ref":"#/components/schemas/repository-subscription"}}},"description":"if you subscribe to the repository"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"description":"Not Found if you don't subscribe to the repository"}}GitHubBearerToken
T
� {]T �� )I7�3��!/repos/transfer/repos/{owner}/{repo}/transferPOSTTransfer a repositoryA transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/).{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"new_owner":"github","team_ids":[12,345]},"schema":{"properties":{"new_owner":{"description":"The username or organization name the repository will be transferred to.","type":"string"},"team_ids":{"description":"ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.","items":{"type":"integer"},"type":"array"}},"required":["new_owner"],"type":"object"}}},"required":true}}{"202":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/minimal-repository"}},"schema":{"$ref":"#/components/schemas/minimal-repository"}}},"description":"Response"}}GitHubBearerToken��
=EG
� �Q/repos/replace-all-topics/repos/{owner}/{repo}/topicsPUTReplace all repository topics{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"example":{"names":["octocat","atom","electron","api"]},"schema":{"properties":{"names":{"description":"An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.","items":{"type":"string"},"type":"array"}},"required":["names"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/topic"}},"schema":{"$ref":"#/components/schemas/topic"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"415":{"$ref":"#/components/responses/preview_header_missing"},"422":{"$ref":"#/components/responses/validation_failed_simple"}}GitHubBearerToken�Q� 5E?
� �O/repos/get-all-topics/repos/{owner}/{repo}/topicsGETGet all repository topics{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/per-page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/topic"}},"schema":{"$ref":"#/components/schemas/topic"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"415":{"$ref":"#/components/responses/preview_header_missing"}}GitHubBearerToken�,� -C7
� �/repos/list-teams/repos/{owner}/{repo}/teamsGETList repository teams{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-items"}},"schema":{"items":{"$ref":"#/components/schemas/team"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
" W" �1�
CmU� �C� /repos/create-using-template/repos/{template_owner}/{template_repo}/generatePOSTCreate a repository using a templateCreates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.
**OAuth scope requirements**
When using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
* `repo` scope to create a private repository{"parameters":[{"in":"path","name":"template_owner","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"template_repo","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":{"description":"This is your first repository","include_all_branches":false,"name":"Hello-World","owner":"octocat","private":false},"schema":{"properties":{"description":{"description":"A short description of the new repository.","type":"string"},"include_all_branches":{"default":false,"description":"Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.","type":"boolean"},"name":{"description":"The name of the new repository.","type":"string"},"owner":{"description":"The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.","type":"string"},"private":{"default":false,"description":"Either `true` to create a new private repository or `false` to create a new public one.","type":"boolean"}},"required":["name"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/repository-3"}},"schema":{"$ref":"#/components/schemas/repository"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/Hello-World","schema":{"type":"string"},"style":"simple"}}}}GitHubBearerToken�%� ISS� �#�)/repos/download-zipball-archive/repos/{owner}/{repo}/zipball/{ref}GETDownload a repository archive (zip)Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually
`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
the `Location` header to make a second `GET` request.
**Note**: For private repositories, these links are temporary and expire after five minutes.{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"},{"in":"path","name":"ref","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":null}{"302":{"description":"Response","headers":{"Location":{"example":"https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires","schema":{"type":"string"},"style":"simple"}}}}GitHubBearerToken
K
K �1� /'=�[�1�Q/repos/list-public/repositoriesGETList public repositoriesLists all public repositories in the order that they were created.
Note:
- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.
- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.{"parameters":[{"$ref":"#/components/parameters/since-repo"},{"description":"Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.","in":"query","name":"visibility","schema":{"default":"public","enum":["all","public"],"example":"all","type":"string"},"style":"form"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/public-repository-items"}},"schema":{"items":{"$ref":"#/components/schemas/minimal-repository"},"type":"array"}}},"description":"Response","headers":{"Link":{"example":"<https://api.github.com/repositories?since=364>; rel=\"next\"","schema":{"type":"string"},"style":"simple"}}},"304":{"$ref":"#/components/responses/not_modified"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� � �'� #%#��U� /search/code/search/codeGETSearch codeSearches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#pagination).
When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.22/rest/reference/search#text-match-metadata).
For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:
`q=addClass+in:file+language:js+repo:jquery/jquery`
This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.
#### Considerations for code search
Due to the complexity of searching code, there are a few restrictions on how searches are performed:
* Only the _default branch_ is considered. In most cases, this will be the `master` branch.
* Only files smaller than 384 KB are searchable.
* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing
language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.{"parameters":[{"description":"The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.22/rest/reference/search#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers.","in":"query","name":"q","required":true,"schema":{"type":"string"},"style":"form"},{"description":"Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@2.22/rest/reference/search#ranking-search-results)","in":"query","name":"sort","schema":{"enum":["indexed"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/code-search-result-item-paginated"}},"schema":{"properties":{"incomplete_results":{"type":"boolean"},"items":{"items":{"$ref":"#/components/schemas/code-search-result-item"},"type":"array"},"total_count":{"type":"integer"}},"required":["total_count","incomplete_results","items"],"type":"object"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"},"503":{"$ref":"#/components/responses/service_unavailable"}}GitHubBearerToken
� � �9� )+)�s�O�A/search/commits/search/commitsGETSearch commitsFind commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#pagination).
When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match
metadata](https://docs.github.com/enterprise-server@2.22/rest/reference/search#text-match-metadata).
For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:
`q=repo:octocat/Spoon-Knife+css`{"parameters":[{"description":"The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.22/rest/reference/search#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers.","in":"query","name":"q","required":true,"schema":{"type":"string"},"style":"form"},{"description":"Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@2.22/rest/reference/search#ranking-search-results)","in":"query","name":"sort","schema":{"enum":["author-date","committer-date"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/commit-search-result-item-paginated"}},"schema":{"properties":{"incomplete_results":{"type":"boolean"},"items":{"items":{"$ref":"#/components/schemas/commit-search-result-item"},"type":"array"},"total_count":{"type":"integer"}},"required":["total_count","incomplete_results","items"],"type":"object"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"}}GitHubBearerToken
� � �n� K)K�E�Y�
/search/issues-and-pull-requests/search/issuesGETSearch issues and pull requestsFind issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#pagination).
When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted
search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.22/rest/reference/search#text-match-metadata).
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
`q=windows+label:bug+language:python+state:open&sort=created&order=asc`
This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
**Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)."{"parameters":[{"description":"The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.22/rest/reference/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.","in":"query","name":"q","required":true,"schema":{"type":"string"},"style":"form"},{"description":"Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-server@2.22/rest/reference/search#ranking-search-results)","in":"query","name":"sort","schema":{"enum":["comments","reactions","reactions-+1","reactions--1","reactions-smile","reactions-thinking_face","reactions-heart","reactions-tada","interactions","created","updated"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/issue-search-result-item-paginated"}},"schema":{"properties":{"incomplete_results":{"type":"boolean"},"items":{"items":{"$ref":"#/components/schemas/issue-search-result-item"},"type":"array"},"total_count":{"type":"integer"}},"required":["total_count","incomplete_results","items"],"type":"object"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"},"503":{"$ref":"#/components/responses/service_unavailable"}}GitHubBearerToken
? ? �=� ')'���y/search/labels/search/labelsGETSearch labelsFind labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#pagination).
When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.22/rest/reference/search#text-match-metadata).
For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:
`q=bug+defect+enhancement&repository_id=64778136`
The labels that best match the query appear first in the search results.{"parameters":[{"description":"The id of the repository.","in":"query","name":"repository_id","required":true,"schema":{"type":"integer"},"style":"form"},{"description":"The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.22/rest/reference/search#constructing-a-search-query).","in":"query","name":"q","required":true,"schema":{"type":"string"},"style":"form"},{"description":"Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@2.22/rest/reference/search#ranking-search-results)","in":"query","name":"sort","schema":{"enum":["created","updated"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/label-search-result-item-paginated"}},"schema":{"properties":{"incomplete_results":{"type":"boolean"},"items":{"items":{"$ref":"#/components/schemas/label-search-result-item"},"type":"array"},"total_count":{"type":"integer"}},"required":["total_count","incomplete_results","items"],"type":"object"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
$ $ �X� %53�� �%/search/repos/search/repositoriesGETSearch repositoriesFind repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#pagination).
When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.22/rest/reference/search#text-match-metadata).
For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:
`q=tetris+language:assembly&sort=stars&order=desc`
This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.
When you include the `mercy` preview header, you can also search for multiple topics by adding more `topic:` instances. For example, your query might look like this:
`q=topic:ruby+topic:rails`{"parameters":[{"description":"The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.22/rest/reference/search#constructing-a-search-query). See \"[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.","in":"query","name":"q","required":true,"schema":{"type":"string"},"style":"form"},{"description":"Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@2.22/rest/reference/search#ranking-search-results)","in":"query","name":"sort","schema":{"enum":["stars","forks","help-wanted-issues","updated"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/repo-search-result-item-paginated"}},"schema":{"properties":{"incomplete_results":{"type":"boolean"},"items":{"items":{"$ref":"#/components/schemas/repo-search-result-item"},"type":"array"},"total_count":{"type":"integer"}},"required":["total_count","incomplete_results","items"],"type":"object"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"422":{"$ref":"#/components/responses/validation_failed"},"503":{"$ref":"#/components/responses/service_unavailable"}}GitHubBearerToken
�`� ')'�w�%�;/search/topics/search/topicsGETSearch topicsFind topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://help.github.com/articles/searching-topics/)" for a detailed list of qualifiers.
When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.22/rest/reference/search#text-match-metadata).
For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:
`q=ruby+is:featured`
This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.{"parameters":[{"description":"The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.22/rest/reference/search#constructing-a-search-query).","in":"query","name":"q","required":true,"schema":{"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/topic-search-result-item-paginated"}},"schema":{"properties":{"incomplete_results":{"type":"boolean"},"items":{"items":{"$ref":"#/components/schemas/topic-search-result-item"},"type":"array"},"total_count":{"type":"integer"}},"required":["total_count","incomplete_results","items"],"type":"object"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"415":{"$ref":"#/components/responses/preview_header_missing"}}GitHubBearerToken
� K� � �1�
e5G�kUQ/enterprise-admin/start-configuration-process/setup/api/configurePOSTStart a configuration processThis endpoint allows you to start a configuration process at any time for your updated settings to take effect:{"parameters":[],"requestBody":null}{"202":{"description":"Response"}}GitHubBearerToken�� _9E�SU�)/enterprise-admin/get-configuration-status/setup/api/configcheckGETGet the configuration statusThis endpoint allows you to check the status of the most recent configuration process:
Note that you may need to wait several seconds after you start a process before you can check its status.
The different statuses are:
| Status | Description |
| ------------- | --------------------------------- |
| `PENDING` | The job has not started yet |
| `CONFIGURING` | The job is running |
| `DONE` | The job has finished correctly |
| `FAILED` | The job has finished unexpectedly |{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/configuration-status"}},"schema":{"$ref":"#/components/schemas/configuration-status"}}},"description":"Response"}}GitHubBearerToken�1� %'%��I�%/search/users/search/usersGETSearch usersFind users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#pagination).
When searching for users, you can get text match metadata for the issue **login**, **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.22/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.22/rest/reference/search#text-match-metadata).
For example, if you're looking for a list of popular users, you might try this query:
`q=tom+repos:%3E42+followers:%3E1000`
This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.{"parameters":[{"description":"The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.22/rest/reference/search#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers.","in":"query","name":"q","required":true,"schema":{"type":"string"},"style":"form"},{"description":"Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@2.22/rest/reference/search#ranking-search-results)","in":"query","name":"sort","schema":{"enum":["followers","repositories","joined"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/user-search-result-item-paginated"}},"schema":{"properties":{"incomplete_results":{"type":"boolean"},"items":{"items":{"$ref":"#/components/schemas/user-search-result-item"},"type":"array"},"total_count":{"type":"integer"}},"required":["total_count","incomplete_results","items"],"type":"object"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"422":{"$ref":"#/components/responses/validation_failed"},"503":{"$ref":"#/components/responses/service_unavailable"}}GitHubBearerToken
l � ��
eSC
U�3/enterprise-admin/get-all-authorized-ssh-keys/setup/api/settings/authorized-keysGETGet all authorized SSH keys{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/ssh-key-items"}},"schema":{"items":{"$ref":"#/components/schemas/ssh-key"},"type":"array"}}},"description":"Response"}}GitHubBearerToken�3� G3%�!�eQ/enterprise-admin/set-settings/setup/api/settingsPUTSet settingsFor a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#get-settings).
**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).{"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"example":{"settings":"{ \"enterprise\": { \"public_pages\": true }}"},"schema":{"properties":{"settings":{"description":"A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#get-settings).","type":"string"}},"required":["settings"],"type":"object"}}},"required":true}}{"204":{"description":"Response"}}GitHubBearerToken�J�
G3%
U�%/enterprise-admin/get-settings/setup/api/settingsGETGet settings{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/enterprise-settings"}},"schema":{"$ref":"#/components/schemas/enterprise-settings"}}},"description":"Response"}}GitHubBearerToken�a� s9Q�W�Y�!/enterprise-admin/enable-or-disable-maintenance-mode/setup/api/maintenancePOSTEnable or disable maintenance mode**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).{"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"example":{"maintenance":"{\"enabled\":true, \"when\":\"now\"}"},"schema":{"properties":{"maintenance":{"description":"A JSON string with the attributes `enabled` and `when`.\n\nThe possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).","type":"string"}},"required":["maintenance"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/maintenance-status"}},"schema":{"$ref":"#/components/schemas/maintenance-status"}}},"description":"Response"}}GitHubBearerToken��
[9AgU�!/enterprise-admin/get-maintenance-status/setup/api/maintenanceGETGet the maintenance statusCheck your installation's maintenance status:{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/maintenance-status"}},"schema":{"$ref":"#/components/schemas/maintenance-status"}}},"description":"Response"}}GitHubBearerToken
� Z� �*� aSE�W�Y�3/enterprise-admin/remove-authorized-ssh-key/setup/api/settings/authorized-keysDELETERemove an authorized SSH key**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).{"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"example":{"authorized_key":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw=="},"schema":{"properties":{"authorized_key":{"description":"The public SSH key.","type":"string"}},"required":["authorized_key"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/ssh-key-items"}},"schema":{"items":{"$ref":"#/components/schemas/ssh-key"},"type":"array"}}},"description":"Response"}}GitHubBearerToken�"� [S?�W�Y�3/enterprise-admin/add-authorized-ssh-key/setup/api/settings/authorized-keysPOSTAdd an authorized SSH key**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).{"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"example":{"authorized_key":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw=="},"schema":{"properties":{"authorized_key":{"description":"The public SSH key.","type":"string"}},"required":["authorized_key"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/ssh-key-items"}},"schema":{"items":{"$ref":"#/components/schemas/ssh-key"},"type":"array"}}},"description":"Response"}}GitHubBearerToken
} V� <������������~eT<���vK-��X�X;'
�
�
�
�
S
9
� � � � � k X F 3 ! � � h 4
�
�
r
E
� � � f : ����}T+
����bR5���i;!��x��H�� � � Ausers/update-authenticatedC)users/unfollowK6ousers/list-public-ssh-keys-for-authenticated-userU/ausers/list-gpg-keys-for-authenticated-userL0cusers/list-followers-for-authenticated-userG._users/list-followed-by-authenticated-userH-]users/list-emails-for-authenticated-userD4kusers/get-public-ssh-key-for-authenticated-userW-]users/get-gpg-key-for-authenticated-userN ;users/get-authenticatedB%users/followJ7qusers/delete-public-ssh-key-for-authenticated-userX0cusers/delete-gpg-key-for-authenticated-userO._users/delete-email-for-authenticated-userF7qusers/create-public-ssh-key-for-authenticated-userV0cusers/create-gpg-key-for-authenticated-userM4kusers/check-person-is-followed-by-authenticatedI+Yusers/add-email-for-authenticated-userE3teams/update-legacy#3teams/update-in-org �#Iteams/update-discussion-legacy(#Iteams/update-discussion-in-org �+Yteams/update-discussion-comment-legacy-+Ytea3repos/list-for-user{&Orepos/set-app-access-restrictions8&Orepos/set-admin-branch-protection& ?repos/request-pages-build� =repos/replace-all-topics
*Wrepos/remove-user-access-restrictionsB*Wrepos/remove-team-access-restrictions>)Urepos/remove-status-check-protection/'Qrepos/remove-status-check-contexts4 ?repos/remove-collaboratorT)Urepos/remove-app-access-restrictions:1repos/ping-webhook�#repos/merge�3repos/list-webhooks�-repos/list-teams3repos/list-releases� ?repos/list-release-assets�4krepos/list-pull-requests-associated-with-commita/repos/list-public ;repos/list-pages-builds� ;teams/list-child-in-org �!teams/list �)Uteams/get-membership-for-user-legacy6)Uteams/get-membership-for-user-in-org � ;teams/get-member-legacy3-teams/get-legacy! Cteams/get-discussion-legacy& Cteams/get-discussion-in-org �(Steams/get-discussion-comment-legacy+(Steams/get-discussion-comment-in-org �/teams/get-by-name �3teams/delete-legacy"3teams/delete-in-org �#Iteams/delete-discussion-legacy'#Iteams/delete-discussion-in-org �+Yteams/delete-discussion-comment-legacy,+Yteams/delete-discussion-comment-in-org �#Iteams/create-discussion-legacy%#Iteams/create-discussion-in-org �+Yteams/create-discussion-comment-legacy*+Yteams/create-discussion-comment-in-org �%teams/create �,[teams/check-permissions-for-repo-legacy>,[teams/check-permissions-for-repo-in-org �/ateams/check-permissions-for-project-legacy:/ateams/check-permissions-for-project-in-org �0cteams/add-or-update-repo-permissions-legacy?0cteams/add-or-update-repo-permissions-in-org �3iteams/add-or-update-project-permissions-legacy;3iteams/add-or-update-project-permissions-in-org �3iteams/add-or-update-membership-for-user-legacy73iteams/add-or-update-membership-for-user-in-org � ;teams/add-member-legacy4%search/users'search/topics%search/repos'search/labels$Ksearch/issues-and-pull-requests)search/commits#search/code Arepos/upload-release-asset�5repos/update-webhook�)Urepos/update-status-check-protection0 Arepos/update-release-asset�5repos/update-release�0crepos/update-pull-request-review-protection* ;repos/update-invitation�._repos/update-information-about-pages-site� Crepos/update-commit-commentY#Irepos/update-branch-protection#%repos/update �)repos/transfer ;repos/test-push-webhook�'Qrepos/set-user-access-restrictions@'Qrepos/set-team-access-restrictions<+repos/list-tags1repos/list-for-org �&Orepos/list-for-authenticated-user_9repos/list-deploymentsm#Irepos/list-deployment-statusesq9repos/list-deploy-keys�$Krepos/set-status-check-contexts2 5repos/list-languages�2grepos/list-invitations-for-authenticated-usera9repos/list-invitations�-repos/list-forksv
� D3� ��! --3�'�)�a/teams/get-legacy/teams/{team_id}GETGet a team (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#get-a-team-by-name) endpoint.{"parameters":[{"$ref":"#/components/parameters/team-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-full"}},"schema":{"$ref":"#/components/schemas/team-full"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�
� M1/�q�9Q/enterprise-admin/upgrade-license/setup/api/upgradePOSTUpgrade a licenseThis API upgrades your license and also triggers the configuration process.
**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).{"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"license":{"description":"The content of your new _.ghl_ license file.","type":"string"}},"type":"object"}}}}}{"202":{"description":"Response"}}GitHubBearerToken�8� o-;�o�gQ/enterprise-admin/create-enterprise-server-license/setup/api/startPOSTCreate a GitHub licenseWhen you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.
Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process.
When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:
1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.
2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.
**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).{"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"license":{"description":"The content of your _.ghl_ license file.","type":"string"},"password":{"description":"You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.","type":"string"},"settings":{"description":"An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#get-settings).","type":"string"}},"required":["license"],"type":"object"}}},"required":true}}{"202":{"description":"Response"}}GitHubBearerToken
� �� �|�# 3-9��?�'/teams/update-legacy/teams/{team_id}PATCHUpdate a team (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#update-a-team) endpoint.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.{"parameters":[{"$ref":"#/components/parameters/team-id"}],"requestBody":{"content":{"application/json":{"example":{"description":"new team description","name":"new team name","privacy":"closed"},"schema":{"properties":{"description":{"description":"The description of the team.","type":"string"},"name":{"description":"The name of the team.","type":"string"},"parent_team_id":{"description":"The ID of a team to set as the parent team.","nullable":true,"type":"integer"},"permission":{"default":"pull","description":"**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.","enum":["pull","push","admin"],"type":"string"},"privacy":{"description":"The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.","enum":["secret","closed"],"type":"string"}},"required":["name"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-full"}},"schema":{"$ref":"#/components/schemas/team-full"}}},"description":"Response"},"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-full"}},"schema":{"$ref":"#/components/schemas/team-full"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken��" 3-9� �)�)/teams/delete-legacy/teams/{team_id}DELETEDelete a team (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#delete-a-team) endpoint.
To delete a team, the authenticated user must be an organization owner or team maintainer.
If you are an organization owner, deleting a parent team will delete all of its child teams as well.{"parameters":[{"$ref":"#/components/parameters/team-id"}],"requestBody":null}{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� �� ��% IEE�G�}�/teams/create-discussion-legacy/teams/{team_id}/discussionsPOSTCreate a discussion (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#create-a-discussion) endpoint.
Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.{"parameters":[{"$ref":"#/components/parameters/team-id"}],"requestBody":{"content":{"application/json":{"example":{"body":"Hi! This is an area for us to collaborate as a team.","title":"Our first team post"},"schema":{"properties":{"body":{"description":"The discussion post's body text.","type":"string"},"private":{"default":false,"description":"Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.","type":"boolean"},"title":{"description":"The discussion post's title.","type":"string"}},"required":["title","body"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-discussion"}},"schema":{"$ref":"#/components/schemas/team-discussion"}}},"description":"Response"}}GitHubBearerToken�<�$ GE?�M�+�C/teams/list-discussions-legacy/teams/{team_id}/discussionsGETList discussions (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#list-discussions) endpoint.
List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-discussion-items"}},"schema":{"items":{"$ref":"#/components/schemas/team-discussion"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
+ N 1+ ��( ImE�K�/�/teams/update-discussion-legacy/teams/{team_id}/discussions/{discussion_number}PATCHUpdate a discussion (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#update-a-discussion) endpoint.
Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/discussion-number"}],"requestBody":{"content":{"application/json":{"example":{"title":"Welcome to our first team post"},"schema":{"properties":{"body":{"description":"The discussion post's body text.","type":"string"},"title":{"description":"The discussion post's title.","type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-discussion-2"}},"schema":{"$ref":"#/components/schemas/team-discussion"}}},"description":"Response"}}GitHubBearerToken��' ImE�]�Q/teams/delete-discussion-legacy/teams/{team_id}/discussions/{discussion_number}DELETEDelete a discussion (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#delete-a-discussion) endpoint.
Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/discussion-number"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�.�& Cm?�S��/teams/get-discussion-legacy/teams/{team_id}/discussions/{discussion_number}GETGet a discussion (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#get-a-discussion) endpoint.
Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/discussion-number"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-discussion"}},"schema":{"$ref":"#/components/schemas/team-discussion"}}},"description":"Response"}}GitHubBearerToken
7 ?7 ��* YU�[�W�5/teams/create-discussion-comment-legacy/teams/{team_id}/discussions/{discussion_number}/commentsPOSTCreate a discussion comment (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#create-a-discussion-comment) endpoint.
Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/discussion-number"}],"requestBody":{"content":{"application/json":{"example":{"body":"Do you like apples?"},"schema":{"properties":{"body":{"description":"The discussion comment's body text.","type":"string"}},"required":["body"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-discussion-comment"}},"schema":{"$ref":"#/components/schemas/team-discussion-comment"}}},"description":"Response"}}GitHubBearerToken�=�) WO�k��c/teams/list-discussion-comments-legacy/teams/{team_id}/discussions/{discussion_number}/commentsGETList discussion comments (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#list-discussion-comments) endpoint.
List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/discussion-number"},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-discussion-comment-items"}},"schema":{"items":{"$ref":"#/components/schemas/team-discussion-comment"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
! �H! �#�-
Y�!U��C�9/teams/update-discussion-comment-legacy/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}PATCHUpdate a discussion comment (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#update-a-discussion-comment) endpoint.
Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/discussion-number"},{"$ref":"#/components/parameters/comment-number"}],"requestBody":{"content":{"application/json":{"example":{"body":"Do you like pineapples?"},"schema":{"properties":{"body":{"description":"The discussion comment's body text.","type":"string"}},"required":["body"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-discussion-comment-2"}},"schema":{"$ref":"#/components/schemas/team-discussion-comment"}}},"description":"Response"}}GitHubBearerToken��, Y�!U�y�wQ/teams/delete-discussion-comment-legacy/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}DELETEDelete a discussion comment (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#delete-a-discussion-comment) endpoint.
Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/discussion-number"},{"$ref":"#/components/parameters/comment-number"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�,�+
S�!O�u�w�5/teams/get-discussion-comment-legacy/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}GETGet a discussion comment (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#get-a-discussion-comment) endpoint.
Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/discussion-number"},{"$ref":"#/components/parameters/comment-number"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-discussion-comment"}},"schema":{"$ref":"#/components/schemas/team-discussion-comment"}}},"description":"Response"}}GitHubBearerToken
N 'N �U�/
s�5y�}� �y/reactions/create-for-team-discussion-comment-legacy/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactionsPOSTCreate reaction for a team discussion comment (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)" endpoint.
Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/discussion-number"},{"$ref":"#/components/parameters/comment-number"}],"requestBody":{"content":{"application/json":{"example":{"content":"heart"},"schema":{"properties":{"content":{"description":"The [reaction type](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#reaction-types) to add to the team discussion comment.","enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"],"type":"string"}},"required":["content"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction"}},"schema":{"$ref":"#/components/schemas/reaction"}}},"description":"Response"}}GitHubBearerToken�U�.
o�5w��e�'/reactions/list-for-team-discussion-comment-legacy/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactionsGETList reactions for a team discussion comment (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint.
List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/discussion-number"},{"$ref":"#/components/parameters/comment-number"},{"description":"Returns a single [reaction type](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment.","in":"query","name":"content","schema":{"enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction-items"}},"schema":{"items":{"$ref":"#/components/schemas/reaction"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
^ �^ �I�1
c�i�-�)�y/reactions/create-for-team-discussion-legacy/teams/{team_id}/discussions/{discussion_number}/reactionsPOSTCreate reaction for a team discussion (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint.
Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion.{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/discussion-number"}],"requestBody":{"content":{"application/json":{"example":{"content":"heart"},"schema":{"properties":{"content":{"description":"The [reaction type](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#reaction-types) to add to the team discussion.","enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"],"type":"string"}},"required":["content"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction"}},"schema":{"$ref":"#/components/schemas/reaction"}}},"description":"Response"}}GitHubBearerToken�Q�0
_�g�O�q�'/reactions/list-for-team-discussion-legacy/teams/{team_id}/discussions/{discussion_number}/reactionsGETList reactions for a team discussion (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint.
List the reactions to a [team discussion](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/discussion-number"},{"description":"Returns a single [reaction type](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion.","in":"query","name":"content","schema":{"enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/reaction-items"}},"schema":{"items":{"$ref":"#/components/schemas/reaction"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
P P �A�3 ;S=�}��G/teams/get-member-legacy/teams/{team_id}/members/{username}GETGet team member (Legacy)The "Get team member" endpoint (described below) is deprecated.
We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.
To list members in a team, the team must be visible to the authenticated user.{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"if user is a member"},"404":{"description":"if user is not a member"}}GitHubBearerToken�g�2 ?=A� �k�/teams/list-members-legacy/teams/{team_id}/membersGETList team members (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#list-team-members) endpoint.
Team members will include the members of child teams.{"parameters":[{"$ref":"#/components/parameters/team-id"},{"description":"Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.","in":"query","name":"role","schema":{"default":"all","enum":["member","maintainer","all"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/simple-user-items"}},"schema":{"items":{"$ref":"#/components/schemas/simple-user"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
Q < Q �g�5 ASC�'��W/teams/remove-member-legacy/teams/{team_id}/members/{username}DELETERemove team member (Legacy)The "Remove team member" endpoint (described below) is deprecated.
We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"Response"},"404":{"description":"Not Found if team synchronization is setup"}}GitHubBearerToken�@�4 ;S=�_��c/teams/add-member-legacy/teams/{team_id}/members/{username}PUTAdd team member (Legacy)The "Add team member" endpoint (described below) is deprecated.
We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."
Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-verbs)."{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"description":"Not Found if team synchronization is set up"},"422":{"description":"Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization"}}GitHubBearerToken
�
� �.�6 U[[�]��/teams/get-membership-for-user-legacy/teams/{team_id}/memberships/{username}GETGet team membership for a user (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#get-team-membership-for-a-user) endpoint.
Team members will include the members of child teams.
To get a user's membership with a team, the team must be visible to the authenticated user.
**Note:**
The response contains the `state` of the membership and the member's `role`.
The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#create-a-team).{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"response-if-user-is-a-team-maintainer":{"$ref":"#/components/examples/team-membership-response-if-user-is-a-team-maintainer"}},"schema":{"$ref":"#/components/schemas/team-membership"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
� � � �7 i[o��w�/teams/add-or-update-membership-for-user-legacy/teams/{team_id}/memberships/{username}PUTAdd or update team membership for a user (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."
If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/username"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"role":{"default":"member","description":"The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.","enum":["member","maintainer"],"type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"response-if-users-membership-with-team-is-now-pending":{"$ref":"#/components/examples/team-membership-response-if-users-membership-with-team-is-now-pending"}},"schema":{"$ref":"#/components/schemas/team-membership"}}},"description":"Response"},"403":{"description":"Forbidden if team synchronization is set up"},"404":{"$ref":"#/components/responses/not_found"},"422":{"description":"Unprocessable Entity if you attempt to add an organization to a team"}}GitHubBearerToken
B �8B �r�: aYg�1��/teams/check-permissions-for-project-legacy/teams/{team_id}/projects/{project_id}GETCheck team permissions for a project (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#check-team-permissions-for-a-project) endpoint.
Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/project-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-project"}},"schema":{"$ref":"#/components/schemas/team-project"}}},"description":"Response"},"404":{"description":"Not Found if project is not managed by this team"}}GitHubBearerToken��9 A?C�
�Q�/teams/list-projects-legacy/teams/{team_id}/projectsGETList team projects (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#list-team-projects) endpoint.
Lists the organization projects for a team.{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-project-items"}},"schema":{"items":{"$ref":"#/components/schemas/team-project"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�)�8 [[a�}��E/teams/remove-membership-for-user-legacy/teams/{team_id}/memberships/{username}DELETERemove team membership for a user (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#remove-team-membership-for-a-user) endpoint.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"Response"},"403":{"description":"if team synchronization is set up"}}GitHubBearerToken
a �a �{�< CYW�_��'/teams/remove-project-legacy/teams/{team_id}/projects/{project_id}DELETERemove a project from a team (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#remove-a-project-from-a-team) endpoint.
Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/project-id"}],"requestBody":null}{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"415":{"$ref":"#/components/responses/preview_header_missing"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken� �; iYk�g�=�u/teams/add-or-update-project-permissions-legacy/teams/{team_id}/projects/{project_id}PUTAdd or update team project permissions (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#add-or-update-team-project-permissions) endpoint.
Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/project-id"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"permission":{"description":"The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-verbs).\"","enum":["read","write","admin"],"type":"string"}},"type":"object"}}}}}{"204":{"description":"Response"},"403":{"content":{"application/json":{"examples":{"response-if-the-project-is-not-owned-by-the-organization":{"value":{"documentation_url":"https://docs.github.com/enterprise-server@2.22/rest/reference/teams#add-or-update-team-project-permissions","message":"Must have admin rights to Repository."}}},"schema":{"properties":{"documentation_url":{"type":"string"},"message":{"type":"string"}},"type":"object"}}},"description":"Forbidden if the project is not owned by the organization"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� �� �0�> [Wm�!�K�c/teams/check-permissions-for-repo-legacy/teams/{team_id}/repos/{owner}/{repo}GETCheck team permissions for a repository (Legacy)**Note**: Repositories inherited through a parent team will also be checked.
**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#check-team-permissions-for-a-repository) endpoint.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types/) via the `Accept` header:{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"alternative-response-with-extra-repository-information":{"$ref":"#/components/examples/team-repository-alternative-response-with-extra-repository-information"}},"schema":{"$ref":"#/components/schemas/team-repository"}}},"description":"Alternative response with extra repository information"},"204":{"description":"Response if repository is managed by this team"},"404":{"description":"Not Found if repository is not managed by this team"}}GitHubBearerToken�z�= ;9K�?�Q�3/teams/list-repos-legacy/teams/{team_id}/reposGETList team repositories (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#list-team-repositories) endpoint.{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/minimal-repository-items"}},"schema":{"items":{"$ref":"#/components/schemas/minimal-repository"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
� �� �Z�@ =W]�1�KQ/teams/remove-repo-legacy/teams/{team_id}/repos/{owner}/{repo}DELETERemove a repository from a team (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#remove-a-repository-from-a-team) endpoint.
If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�1�? cWq�� �)/teams/add-or-update-repo-permissions-legacy/teams/{team_id}/repos/{owner}/{repo}PUTAdd or update team repository permissions (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint.
To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.
Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-verbs)."{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"permission":{"description":"The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.","enum":["pull","push","admin"],"type":"string"}},"type":"object"}}}}}{"204":{"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� �<�C AG�u�?�//users/update-authenticated/userPATCHUpdate the authenticated user**Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.{"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"properties":{"bio":{"description":"The new short biography of the user.","type":"string"},"blog":{"description":"The new blog URL of the user.","example":"blog.example.com","type":"string"},"company":{"description":"The new company of the user.","example":"Acme corporation","type":"string"},"email":{"description":"The publicly visible email address of the user.","example":"omar@example.com","type":"string"},"hireable":{"description":"The new hiring availability of the user.","type":"boolean"},"location":{"description":"The new location of the user.","example":"Berlin, Germany","type":"string"},"name":{"description":"The new name of the user.","example":"Omar Jahandar","type":"string"},"twitter_username":{"description":"The new Twitter username of the user.","example":"therealomarj","nullable":true,"type":"string"}},"type":"object"}}}}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/private-user"}},"schema":{"$ref":"#/components/schemas/private-user"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�.�B ;A�uU�/users/get-authenticated/userGETGet the authenticated userIf the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information.
If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information.{"parameters":[],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"response-with-public-and-private-profile-information":{"$ref":"#/components/examples/private-user-response-with-public-and-private-profile-information"},"response-with-public-profile-information":{"$ref":"#/components/examples/private-user-response-with-public-profile-information"}},"schema":{"oneOf":[{"$ref":"#/components/schemas/private-user"},{"$ref":"#/components/schemas/public-user"}]}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken�z�A ;9?�+�Q�S/teams/list-child-legacy/teams/{team_id}/teamsGETList child teams (Legacy)**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#list-child-teams) endpoint.{"parameters":[{"$ref":"#/components/parameters/team-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"response-if-child-teams-exist":{"$ref":"#/components/examples/team-items-response-if-child-teams-exist"}},"schema":{"items":{"$ref":"#/components/schemas/team"},"type":"array"}}},"description":"if child teams exist","headers":{"Link":{"$ref":"#/components/headers/link"}}},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
A �8A �s�F _%qq��w/users/delete-email-for-authenticated-user/user/emailsDELETEDelete an email address for the authenticated userThis endpoint is accessible with the `user` scope.{"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"description":"Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.","example":{"emails":["octocat@github.com","mona@github.com"]},"properties":{"emails":{"description":"Email addresses associated with the GitHub user account.","items":{"example":"username@example.com","minItems":1,"type":"string"},"type":"array"}},"required":["emails"],"type":"object"},{"items":{"example":"username@example.com","minItems":1,"type":"string"},"type":"array"},{"type":"string"}]}}}}}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�W�E Y%kq��Q/users/add-email-for-authenticated-user/user/emailsPOSTAdd an email address for the authenticated userThis endpoint is accessible with the `user` scope.{"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"example":{"emails":["octocat@github.com","mona@github.com"]},"properties":{"emails":{"description":"Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.","example":[],"items":{"example":"username@example.com","minItems":1,"type":"string"},"type":"array"}},"required":["emails"],"type":"object"},{"items":{"example":"username@example.com","minItems":1,"type":"string"},"type":"array"},{"type":"string"}]}}}}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/email-items"}},"schema":{"items":{"$ref":"#/components/schemas/email"},"type":"array"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�i�D ]%k�'�{�Q/users/list-emails-for-authenticated-user/user/emailsGETList email addresses for the authenticated userLists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.{"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/email-items-2"}},"schema":{"items":{"$ref":"#/components/schemas/email"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
v
*��v �!�K )A+��+�/users/unfollow/user/following/{username}DELETEUnfollow a userUnfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.{"parameters":[{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken��J %A'�Q�+�/users/follow/user/following/{username}PUTFollow a userNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-verbs)."
Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.{"parameters":[{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken��I kA{
�+�A/users/check-person-is-followed-by-authenticated/user/following/{username}GETCheck if a person is followed by the authenticated user{"parameters":[{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"if the person is followed by the authenticated user"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/basic-error"}}},"description":"if the person is not followed by the authenticated user"}}GitHubBearerToken�j�H _+iu�{�/users/list-followed-by-authenticated-user/user/followingGETList the people the authenticated user followsLists the people who the authenticated user follows.{"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/simple-user-items"}},"schema":{"items":{"$ref":"#/components/schemas/simple-user"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken�d�G c+]q�{�/users/list-followers-for-authenticated-user/user/followersGETList followers of the authenticated userLists the people following the authenticated user.{"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/simple-user-items"}},"schema":{"items":{"$ref":"#/components/schemas/simple-user"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken
9 +�k9 �.�O cCc�5�/�w/users/delete-gpg-key-for-authenticated-user/user/gpg_keys/{gpg_key_id}DELETEDelete a GPG key for the authenticated userRemoves a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).{"parameters":[{"$ref":"#/components/parameters/gpg-key-id"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�h�N ]C]� �/�'/users/get-gpg-key-for-authenticated-user/user/gpg_keys/{gpg_key_id}GETGet a GPG key for the authenticated userView 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://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).{"parameters":[{"$ref":"#/components/parameters/gpg-key-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/gpg-key"}},"schema":{"$ref":"#/components/schemas/gpg-key"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�P�M c)c�%�}�/users/create-gpg-key-for-authenticated-user/user/gpg_keysPOSTCreate a GPG key for the authenticated userAdds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).{"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"properties":{"armored_public_key":{"description":"A GPG key in ASCII-armored format.","type":"string"}},"required":["armored_public_key"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/gpg-key"}},"schema":{"$ref":"#/components/schemas/gpg-key"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�Q�L a)]�y�{�U/users/list-gpg-keys-for-authenticated-user/user/gpg_keysGETList GPG keys for the authenticated userLists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).{"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/gpg-key-items"}},"schema":{"items":{"$ref":"#/components/schemas/gpg-key"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
i Hi �[�Q sqw�)�a�_/apps/list-installation-repos-for-authenticated-user/user/installations/{installation_id}/repositoriesGETList repositories accessible to the user access tokenList repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.
The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
You must use a [user-to-server OAuth access token](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.
The access the user has to each repository is included in the hash under the `permissions` key.{"parameters":[{"$ref":"#/components/parameters/installation-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/repository-paginated"}},"schema":{"properties":{"repositories":{"items":{"$ref":"#/components/schemas/repository"},"type":"array"},"repository_selection":{"type":"string"},"total_count":{"type":"integer"}},"required":["total_count","repositories"],"type":"object"}}},"description":"The access the user has to each repository is included in the hash under the `permissions` key.","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�4�P
i3�� �{�S/apps/list-installations-for-authenticated-user/user/installationsGETList app installations accessible to the user access tokenLists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.
You must use a [user-to-server OAuth access token](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.
The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
You can find the permissions for the installation under the `permissions` key.{"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/base-installation-for-auth-user-paginated-ghes-2"}},"schema":{"properties":{"installations":{"items":{"$ref":"#/components/schemas/installation-ghes-2"},"type":"array"},"total_count":{"type":"integer"}},"required":["total_count","installations"],"type":"object"}}},"description":"You can find the permissions for the installation under the `permissions` key.","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"415":{"$ref":"#/components/responses/preview_header_missing"}}GitHubBearerToken
> (> �f�S
�e�?��/apps/remove-repo-from-installation-for-authenticated-user/user/installations/{installation_id}/repositories/{repository_id}DELETERemove a repository from an app installationRemove a single repository from an installation. The authenticated user must have admin access to the repository.
You must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@2.22/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@2.22/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.{"parameters":[{"$ref":"#/components/parameters/installation-id"},{"$ref":"#/components/parameters/repository-id"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�T�R
u�[�5��/apps/add-repo-to-installation-for-authenticated-user/user/installations/{installation_id}/repositories/{repository_id}PUTAdd a repository to an app installationAdd a single repository to an installation. The authenticated user must have admin access to the repository.
You must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@2.22/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@2.22/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.{"parameters":[{"$ref":"#/components/parameters/installation-id"},{"$ref":"#/components/parameters/repository-id"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
� �� �z�U o!k�G�{�E/users/list-public-ssh-keys-for-authenticated-user/user/keysGETList public SSH keys for the authenticated userLists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).{"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/key-items"}},"schema":{"items":{"$ref":"#/components/schemas/key"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�#�T
Q%��G��}/issues/list-for-authenticated-user/user/issuesGETList user account issues assigned to the authenticated userList issues across owned and member repositories assigned to the authenticated user.
**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
request id, use the "[List pull requests](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#list-pull-requests)" endpoint.{"parameters":[{"description":"Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation","in":"query","name":"filter","schema":{"default":"assigned","enum":["assigned","created","mentioned","subscribed","repos","all"],"type":"string"},"style":"form"},{"description":"Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.","in":"query","name":"state","schema":{"default":"open","enum":["open","closed","all"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/labels"},{"description":"What to sort results by. Can be either `created`, `updated`, `comments`.","in":"query","name":"sort","schema":{"default":"created","enum":["created","updated","comments"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/issue-with-repo-items"}},"schema":{"items":{"$ref":"#/components/schemas/issue"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
h
��� h � �Y e9}
� �/orgs/list-memberships-for-authenticated-user/user/memberships/orgsGETList organization memberships for the authenticated user{"parameters":[{"description":"Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships.","in":"query","name":"state","schema":{"enum":["active","pending"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/org-membership-items"}},"schema":{"items":{"$ref":"#/components/schemas/org-membership"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken� �X q3q�I�'�/users/delete-public-ssh-key-for-authenticated-user/user/keys/{key_id}DELETEDelete a public SSH key for the authenticated userRemoves a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).{"parameters":[{"$ref":"#/components/parameters/key-id"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�l�W k3k� �'�/users/get-public-ssh-key-for-authenticated-user/user/keys/{key_id}GETGet a public SSH key for the authenticated userView extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).{"parameters":[{"$ref":"#/components/parameters/key-id"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/key"}},"schema":{"$ref":"#/components/schemas/key"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken� �V q!q�9�E� /users/create-public-ssh-key-for-authenticated-user/user/keysPOSTCreate a public SSH key for the authenticated userAdds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).{"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The public SSH key to add to your GitHub account.","pattern":"^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ","type":"string"},"title":{"description":"A descriptive name for the new key.","example":"Personal MacBook Air","type":"string"}},"required":["key"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/key"}},"schema":{"$ref":"#/components/schemas/key"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
L
�
�L �F�] Y)7
��C/projects/create-for-authenticated-user/user/projectsPOSTCreate a user project{"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"properties":{"body":{"description":"Body of the project","example":"This project represents the sprint of the first week in January","nullable":true,"type":"string"},"name":{"description":"Name of the project","example":"Week One Sprint","type":"string"}},"required":["name"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/project"}},"schema":{"$ref":"#/components/schemas/project"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"415":{"$ref":"#/components/responses/preview_header_missing"},"422":{"$ref":"#/components/responses/validation_failed_simple"}}GitHubBearerToken�g�\ M!g�k�{�!/orgs/list-for-authenticated-user/user/orgsGETList organizations for the authenticated userList organizations for the authenticated user.
**OAuth scope requirements**
This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response.{"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/organization-simple-items"}},"schema":{"items":{"$ref":"#/components/schemas/organization-simple"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken�i�[ gE�
�M�Q/orgs/update-membership-for-authenticated-user/user/memberships/orgs/{org}PATCHUpdate an organization membership for the authenticated user{"parameters":[{"$ref":"#/components/parameters/org"}],"requestBody":{"content":{"application/json":{"example":{"state":"active"},"schema":{"properties":{"state":{"description":"The state that the membership should be in. Only `\"active\"` will be accepted.","enum":["active"],"type":"string"}},"required":["state"],"type":"object"}}},"required":true}}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/org-membership-2"}},"schema":{"$ref":"#/components/schemas/org-membership"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken��Z aE
�!�Y/orgs/get-membership-for-authenticated-user/user/memberships/orgs/{org}GETGet an organization membership for the authenticated user{"parameters":[{"$ref":"#/components/parameters/org"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/org-membership"}},"schema":{"$ref":"#/components/schemas/org-membership"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
� � � �p�_ O#e��u�#/repos/list-for-authenticated-user/user/reposGETList repositories for the authenticated userLists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.
The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.{"parameters":[{"description":"Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.","in":"query","name":"visibility","schema":{"default":"all","enum":["all","public","private"],"type":"string"},"style":"form"},{"description":"Comma-separated list of values. Can include: \n\\* `owner`: Repositories that are owned by the authenticated user. \n\\* `collaborator`: Repositories that the user has been added to as a collaborator. \n\\* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.","in":"query","name":"affiliation","schema":{"default":"owner,collaborator,organization_member","type":"string"},"style":"form"},{"description":"Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.","in":"query","name":"type","schema":{"default":"all","enum":["all","owner","public","private","member"],"type":"string"},"style":"form"},{"description":"Can be one of `created`, `updated`, `pushed`, `full_name`.","in":"query","name":"sort","schema":{"default":"full_name","enum":["created","updated","pushed","full_name"],"type":"string"},"style":"form"},{"description":"Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`","in":"query","name":"direction","schema":{"enum":["asc","desc"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/before"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/repository-items-default-response"}},"schema":{"items":{"$ref":"#/components/schemas/repository"},"type":"array"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�0�^ k3y� �{�Q/users/list-public-emails-for-authenticated-user/user/public_emailsGETList public email addresses for the authenticated userLists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@2.22/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.{"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/email-items-2"}},"schema":{"items":{"$ref":"#/components/schemas/email"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
u u ��` S#i�s�5�/repos/create-for-authenticated-user/user/reposPOSTCreate a repository for the authenticated userCreates a new repository for the authenticated user.
**OAuth scope requirements**
When using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
* `repo` scope to create a private repository.{"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_merge_commit":{"default":true,"description":"Whether to allow merge commits for pull requests.","example":true,"type":"boolean"},"allow_rebase_merge":{"default":true,"description":"Whether to allow rebase merges for pull requests.","example":true,"type":"boolean"},"allow_squash_merge":{"default":true,"description":"Whether to allow squash merges for pull requests.","example":true,"type":"boolean"},"auto_init":{"default":false,"description":"Whether the repository is initialized with a minimal README.","type":"boolean"},"delete_branch_on_merge":{"default":false,"description":"Whether to delete head branches when pull requests are merged","example":false,"type":"boolean"},"description":{"description":"A short description of the repository.","type":"string"},"gitignore_template":{"description":"The desired language or platform to apply to the .gitignore.","example":"Haskell","type":"string"},"has_downloads":{"default":true,"description":"Whether downloads are enabled.","example":true,"type":"boolean"},"has_issues":{"default":true,"description":"Whether issues are enabled.","example":true,"type":"boolean"},"has_projects":{"default":true,"description":"Whether projects are enabled.","example":true,"type":"boolean"},"has_wiki":{"default":true,"description":"Whether the wiki is enabled.","example":true,"type":"boolean"},"homepage":{"description":"A URL with more information about the repository.","type":"string"},"is_template":{"default":false,"description":"Whether this repository acts as a template that can be used to generate new repositories.","example":true,"type":"boolean"},"license_template":{"description":"The license keyword of the open source license for this repository.","example":"mit","type":"string"},"name":{"description":"The name of the repository.","example":"Team Environment","type":"string"},"private":{"default":false,"description":"Whether the repository is private.","type":"boolean"},"team_id":{"description":"The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.","type":"integer"}},"required":["name"],"type":"object"}}},"required":true}}{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/repository"}},"schema":{"$ref":"#/components/schemas/repository"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/repos/octocat/Hello-World","schema":{"type":"string"},"style":"simple"}}},"304":{"$ref":"#/components/responses/not_modified"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� w
��c � �-�e uE�
�u�+/activity/check-repo-is-starred-by-authenticated-user/user/starred/{owner}/{repo}GETCheck if a repository is starred by the authenticated user{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"204":{"description":"Response if this repository is starred by you"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/basic-error"}}},"description":"Not Found if this repository is not starred by you"}}GitHubBearerToken�S�d o's�}�%� /activity/list-repos-starred-by-authenticated-user/user/starredGETList repositories starred by the authenticated userLists repositories the authenticated user has starred.
You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types/) via the `Accept` header:{"parameters":[{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default-response":{"$ref":"#/components/examples/repository-items-default-response"}},"schema":{"items":{"$ref":"#/components/schemas/repository"},"type":"array"}},"application/vnd.github.v3.star+json":{"examples":{"alternative-response-with-star-creation-timestamps":{"$ref":"#/components/examples/starred-repository-items-alternative-response-with-star-creation-timestamps"}},"schema":{"items":{"$ref":"#/components/schemas/starred-repository"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken�Y�c ieI
�5�e/repos/accept-invitation-for-authenticated-user/user/repository_invitations/{invitation_id}PATCHAccept a repository invitation{"parameters":[{"$ref":"#/components/parameters/invitation-id"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"409":{"$ref":"#/components/responses/conflict"}}GitHubBearerToken�\�b keK
�5�e/repos/decline-invitation-for-authenticated-user/user/repository_invitations/{invitation_id}DELETEDecline a repository invitation{"parameters":[{"$ref":"#/components/parameters/invitation-id"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"409":{"$ref":"#/components/responses/conflict"}}GitHubBearerToken��a gEy�k�{�
/repos/list-invitations-for-authenticated-user/user/repository_invitationsGETList repository invitations for the authenticated userWhen authenticating as a user, this endpoint will list all currently open repository invitations for that user.{"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/repository-invitation-items"}},"schema":{"items":{"$ref":"#/components/schemas/repository-invitation"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
-
�� - �F�j !!���5/users/list/usersGETList usersLists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.
Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users.{"parameters":[{"$ref":"#/components/parameters/since-user"},{"$ref":"#/components/parameters/per-page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/simple-user-items"}},"schema":{"items":{"$ref":"#/components/schemas/simple-user"},"type":"array"}}},"description":"Response","headers":{"Link":{"example":"<https://api.github.com/users?since=135>; rel=\"next\"","schema":{"type":"string"},"style":"simple"}}},"304":{"$ref":"#/components/responses/not_modified"}}GitHubBearerToken��i O#W�q�{�]/teams/list-for-authenticated-user/user/teamsGETList teams for the authenticated userList all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/).{"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/team-full-items"}},"schema":{"items":{"$ref":"#/components/schemas/team-full"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken� �h q3sy�{� /activity/list-watched-repos-for-authenticated-user/user/subscriptionsGETList repositories watched by the authenticated userLists repositories the authenticated user is watching.{"parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/minimal-repository-items"}},"schema":{"items":{"$ref":"#/components/schemas/minimal-repository"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}}GitHubBearerToken��g cEi
�u�/activity/unstar-repo-for-authenticated-user/user/starred/{owner}/{repo}DELETEUnstar a repository for the authenticated user{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken�e�f _Ee�W�u�/activity/star-repo-for-authenticated-user/user/starred/{owner}/{repo}PUTStar a repository for the authenticated userNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-verbs)."{"parameters":[{"$ref":"#/components/parameters/owner"},{"$ref":"#/components/parameters/repo"}],"requestBody":null}{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
� ��k� �-�n UKG
�S�#/activity/list-public-events-for-user/users/{username}/events/publicGETList public events for a user{"parameters":[{"$ref":"#/components/parameters/username"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/event"},"type":"array"}}},"description":"Response"}}GitHubBearerToken�X�m kSs�I�!�#/activity/list-org-events-for-authenticated-user/users/{username}/events/orgs/{org}GETList organization events for the authenticated userThis is the user's organization dashboard. You must be authenticated as the user to view this.{"parameters":[{"$ref":"#/components/parameters/username"},{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/event"},"type":"array"}}},"description":"Response"}}GitHubBearerToken�.�l c=Y�{�S�#/activity/list-events-for-authenticated-user/users/{username}/eventsGETList events for the authenticated userIf you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.{"parameters":[{"$ref":"#/components/parameters/username"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/event"},"type":"array"}}},"description":"Response"}}GitHubBearerToken��k 7/!�Y�+� /users/get-by-username/users/{username}GETGet a userProvides publicly available information about someone with a GitHub account.
GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below"
The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#authentication).
The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@2.22/rest/reference/users#emails)".{"parameters":[{"$ref":"#/components/parameters/username"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default-response":{"$ref":"#/components/examples/public-user-default-response"},"response-with-git-hub-plan-information":{"$ref":"#/components/examples/public-user-response-with-git-hub-plan-information"}},"schema":{"oneOf":[{"$ref":"#/components/schemas/private-user"},{"$ref":"#/components/schemas/public-user"}]}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}}GitHubBearerToken
�
� J ��� �d�s EA=� �S�#/users/list-gpg-keys-for-user/users/{username}/gpg_keysGETList GPG keys for a userLists the GPG keys for a user. This information is accessible by anyone.{"parameters":[{"$ref":"#/components/parameters/username"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/gpg-key-items"}},"schema":{"items":{"$ref":"#/components/schemas/gpg-key"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken� �r 3;7a�%� /gists/list-for-user/users/{username}/gistsGETList gists for a userLists public gists for the specified user:{"parameters":[{"$ref":"#/components/parameters/username"},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/base-gist-items"}},"schema":{"items":{"$ref":"#/components/schemas/base-gist"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken�9�q I_U
�i�/users/check-following-for-user/users/{username}/following/{target_user}GETCheck if a user follows another user{"parameters":[{"$ref":"#/components/parameters/username"},{"in":"path","name":"target_user","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":null}{"204":{"description":"if the user follows the target user"},"404":{"description":"if the user does not follow the target user"}}GitHubBearerToken�[�p GCIm�S�3/users/list-following-for-user/users/{username}/followingGETList the people a user followsLists the people who the specified user follows.{"parameters":[{"$ref":"#/components/parameters/username"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/simple-user-items"}},"schema":{"items":{"$ref":"#/components/schemas/simple-user"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�S�o GC=i�S�3/users/list-followers-for-user/users/{username}/followersGETList followers of a userLists the people following the specified user.{"parameters":[{"$ref":"#/components/parameters/username"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/simple-user-items"}},"schema":{"items":{"$ref":"#/components/schemas/simple-user"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
3m ���d= �����e8
�
�
�
�
a
5
� � � � k 6 � � m 5 #
�
�
�
h
X
* � � � � T 2�m��� $Kusers/list-public-keys-for-userv Ausers/update-authenticatedC)users/unfollowK6ousers/list-public-ssh-keys-for-authenticated-userU4kusers/list-public-emails-for-authenticated-user^!Eusers/list-gpg-keys-for-users/ausers/list-gpg-keys-for-authenticated-userL"Gusers/list-following-for-userp"Gusers/list-followers-for-usero0cusers/list-followers-for-authenticated-userG._users/list-followed-by-authenticated-userH-]users/list-emails-for-authenticated-userD!users/listj4kusers/get-public-ssh-key-for-authenticated-userW-]users/get-gpg-key-for-authenticated-userN Ausers/get-context-for-usert7users/get-by-usernamek ;users/get-authenticatedB%users/followJ7qusers/delete-public-ssh-key-for-authenticated-userX0cusers/delete-gpg-key-for-authenticated-userO._users/delete-email-for-authenticated-userF7qusers/create-public-ssh-key-for-authenticated-userV0cusers/create-gpg-key-for-authenticated-userM4kusers/check-person-is-followed-by-authenticatedI#Iusers/check-following-for-userq+Yusers/add-email-for-authenticated-userE3teams/update-legacy#3teams/update-in-org �#Iteams/update-discussion-legacy(#Iteams/update-discussion-in-org �+Yteams/update-discussion-comment-legacy-+Yteams/update-discussion-comment-in-org � =teams/remove-repo-legacy@ =teams/remove-repo-in-org � Cteams/remove-project-legacy< Cteams/remove-project-in-org �,[teams/remove-membership-for-user-legacy8,[teams/remove-membership-for-user-in-org � Ateams/remove-member-legacy5 ;teams/list-repos-legacy= ;teams/list-repos-in-org � Ateams/list-projects-legacy9 Ateams/list-projects-in-org � ?teams/list-members-legacy2 ?teams/list-members-in-org �&Oteams/list-for-authenticated-useri"Gteams/list-discussions-legacy$"Gteams/list-discussions-in-org �*Wteams/list-discussion-comments-legacy)*Wteams/list-discussion-comments-in-org �
2 ��` 2 �*�w 19G� �S�S/orgs/list-for-user/users/{username}/orgsGETList organizations for a userList [public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.
This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@2.22/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead.{"parameters":[{"$ref":"#/components/parameters/username"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/organization-simple-items"}},"schema":{"items":{"$ref":"#/components/schemas/organization-simple"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�r�v K9C�)�S�//users/list-public-keys-for-user/users/{username}/keysGETList public keys for a userLists the _verified_ public SSH keys for a user. This is accessible by anyone.{"parameters":[{"$ref":"#/components/parameters/username"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/key-simple-items"}},"schema":{"items":{"$ref":"#/components/schemas/key-simple"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�/�u AIo�#�+�%/apps/get-user-installation/users/{username}/installationGETGet a user installation for the authenticated appEnables an authenticated GitHub App to find the user’s installation information.
You must use a [JWT](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.{"parameters":[{"$ref":"#/components/parameters/username"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/installation-ghes-2"}},"schema":{"$ref":"#/components/schemas/installation-ghes-2"}}},"description":"Response"}}GitHubBearerToken�s�t ACW�u�O�U/users/get-context-for-user/users/{username}/hovercardGETGet contextual information for a userProvides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.
The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:
```shell
curl -u username:token
https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192
```{"parameters":[{"$ref":"#/components/parameters/username"},{"description":"Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`.","in":"query","name":"subject_type","schema":{"enum":["organization","repository","issue","pull_request"],"type":"string"},"style":"form"},{"description":"Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.","in":"query","name":"subject_id","schema":{"type":"string"},"style":"form"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/hovercard"}},"schema":{"$ref":"#/components/schemas/hovercard"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
V �
Jq} V �#�}
aECm�+Q/enterprise-admin/demote-site-administrator/users/{username}/site_adminDELETEDemote a site administratorYou can demote any user account except your own.{"parameters":[{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�p�| yE_�W�+Q/enterprise-admin/promote-user-to-be-site-administrator/users/{username}/site_adminPUTPromote a user to be a site administratorNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-verbs)."{"parameters":[{"$ref":"#/components/parameters/username"}],"requestBody":null}{"204":{"description":"Response"}}GitHubBearerToken�
�{ 3;E�%�{�O/repos/list-for-user/users/{username}/reposGETList repositories for a userLists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.{"parameters":[{"$ref":"#/components/parameters/username"},{"description":"Can be one of `all`, `owner`, `member`.","in":"query","name":"type","schema":{"default":"owner","enum":["all","owner","member"],"type":"string"},"style":"form"},{"description":"Can be one of `created`, `updated`, `pushed`, `full_name`.","in":"query","name":"sort","schema":{"default":"full_name","enum":["created","updated","pushed","full_name"],"type":"string"},"style":"form"},{"description":"Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`","in":"query","name":"direction","schema":{"enum":["asc","desc"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/minimal-repository-items"}},"schema":{"items":{"$ref":"#/components/schemas/minimal-repository"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�G�z g]W
�S�#/activity/list-received-public-events-for-user/users/{username}/received_events/publicGETList public events received by a user{"parameters":[{"$ref":"#/components/parameters/username"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/event"},"type":"array"}}},"description":"Response"}}GitHubBearerToken��y YOi� �S�#/activity/list-received-events-for-user/users/{username}/received_eventsGETList events received by the authenticated userThese are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.{"parameters":[{"$ref":"#/components/parameters/username"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/event"},"type":"array"}}},"description":"Response"}}GitHubBearerToken�,�x 9A1
��/projects/list-for-user/users/{username}/projectsGETList user projects{"parameters":[{"$ref":"#/components/parameters/username"},{"description":"Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.","in":"query","name":"state","schema":{"default":"open","enum":["open","closed","all"],"type":"string"},"style":"form"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/project-items-3"}},"schema":{"items":{"$ref":"#/components/schemas/project"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"422":{"$ref":"#/components/responses/validation_failed"}}GitHubBearerToken
� �a � �F� KC-�I�AQ/enterprise-admin/unsuspend-user/users/{username}/suspendedDELETEUnsuspend a userIf your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://help.github.com/enterprise/admin/guides/user-management/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.{"parameters":[{"$ref":"#/components/parameters/username"}],"requestBody":{"content":{"application/json":{"schema":{"nullable":true,"properties":{"reason":{"description":"The reason the user is being unsuspended. This message will be logged in the [audit log](https://help.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.","type":"string"}},"type":"object"}}}}}{"204":{"description":"Response"}}GitHubBearerToken�C� GC)�Y�9Q/enterprise-admin/suspend-user/users/{username}/suspendedPUTSuspend a userIf your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://help.github.com/enterprise/admin/guides/user-management/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.
You can suspend any user account except your own.
Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-verbs)."{"parameters":[{"$ref":"#/components/parameters/username"}],"requestBody":{"content":{"application/json":{"schema":{"nullable":true,"properties":{"reason":{"description":"The reason the user is being suspended. This message will be logged in the [audit log](https://help.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.","type":"string"}},"type":"object"}}}}}{"204":{"description":"Response"}}GitHubBearerToken�n� SKSY�S�O/activity/list-repos-watched-by-user/users/{username}/subscriptionsGETList repositories watched by a userLists repositories a user is watching.{"parameters":[{"$ref":"#/components/parameters/username"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/minimal-repository-items"}},"schema":{"items":{"$ref":"#/components/schemas/minimal-repository"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken�b�~ S?S�]�}�/activity/list-repos-starred-by-user/users/{username}/starredGETList repositories starred by a userLists repositories a user has starred.
You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types/) via the `Accept` header:{"parameters":[{"$ref":"#/components/parameters/username"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"requestBody":null}{"200":{"content":{"application/json":{"examples":{"default-response":{"$ref":"#/components/examples/repository-items-default-response"}},"schema":{"anyOf":[{"items":{"$ref":"#/components/schemas/starred-repository"},"type":"array"},{"items":{"$ref":"#/components/schemas/repository"},"type":"array"}]}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}}GitHubBearerToken
�k�
%7eU�=/meta/get-zen/zenGETGet the Zen of GitHubGet a random sentence from the Zen of GitHub{"parameters":[],"requestBody":null}{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Response"}}GitHubBearerToken