Skip to content

Commit 0ec7c3f

Browse files
github-openapi-botgithub-openapi-bot
authored
Update OpenAPI Descriptions
1 parent 02c4df5 commit 0ec7c3f

9 files changed

Lines changed: 56 additions & 1776 deletions

File tree

‎lib/rest/static/decorated/ghes-2.18.json‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47662,7 +47662,6 @@
4766247662
}
4766347663
],
4766447664
"summary": "Merge a pull request",
47665-
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.18/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
4766647665
"tags": [
4766747666
"pulls"
4766847667
],
@@ -47736,7 +47735,7 @@
4773647735
"category": "pulls",
4773747736
"categoryLabel": "Pulls",
4773847737
"notes": [],
47739-
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@2.18/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
47738+
"descriptionHTML": "",
4774047739
"bodyParameters": [
4774147740
{
4774247741
"type": "string",
@@ -47961,7 +47960,6 @@
4796147960
}
4796247961
],
4796347962
"summary": "Request reviewers for a pull request",
47964-
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.18/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
4796547963
"tags": [
4796647964
"pulls"
4796747965
],
@@ -48029,7 +48027,7 @@
4802948027
"subcategory": "review-requests",
4803048028
"subcategoryLabel": "Review requests",
4803148029
"notes": [],
48032-
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@2.18/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
48030+
"descriptionHTML": "",
4803348031
"bodyParameters": [
4803448032
{
4803548033
"type": "array of strings",

‎lib/rest/static/decorated/ghes-2.19.json‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48464,7 +48464,6 @@
4846448464
}
4846548465
],
4846648466
"summary": "Merge a pull request",
48467-
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.19/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
4846848467
"tags": [
4846948468
"pulls"
4847048469
],
@@ -48538,7 +48537,7 @@
4853848537
"category": "pulls",
4853948538
"categoryLabel": "Pulls",
4854048539
"notes": [],
48541-
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@2.19/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
48540+
"descriptionHTML": "",
4854248541
"bodyParameters": [
4854348542
{
4854448543
"type": "string",
@@ -48763,7 +48762,6 @@
4876348762
}
4876448763
],
4876548764
"summary": "Request reviewers for a pull request",
48766-
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.19/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
4876748765
"tags": [
4876848766
"pulls"
4876948767
],
@@ -48831,7 +48829,7 @@
4883148829
"subcategory": "review-requests",
4883248830
"subcategoryLabel": "Review requests",
4883348831
"notes": [],
48834-
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@2.19/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
48832+
"descriptionHTML": "",
4883548833
"bodyParameters": [
4883648834
{
4883748835
"type": "array of strings",

‎lib/rest/static/decorated/ghes-2.20.json‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49118,7 +49118,6 @@
4911849118
}
4911949119
],
4912049120
"summary": "Merge a pull request",
49121-
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.20/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
4912249121
"tags": [
4912349122
"pulls"
4912449123
],
@@ -49192,7 +49191,7 @@
4919249191
"category": "pulls",
4919349192
"categoryLabel": "Pulls",
4919449193
"notes": [],
49195-
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@2.20/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
49194+
"descriptionHTML": "",
4919649195
"bodyParameters": [
4919749196
{
4919849197
"type": "string",
@@ -49417,7 +49416,6 @@
4941749416
}
4941849417
],
4941949418
"summary": "Request reviewers for a pull request",
49420-
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.20/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
4942149419
"tags": [
4942249420
"pulls"
4942349421
],
@@ -49485,7 +49483,7 @@
4948549483
"subcategory": "review-requests",
4948649484
"subcategoryLabel": "Review requests",
4948749485
"notes": [],
49488-
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@2.20/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
49486+
"descriptionHTML": "",
4948949487
"bodyParameters": [
4949049488
{
4949149489
"type": "array of strings",

‎lib/rest/static/decorated/github.ae.json‎

Lines changed: 0 additions & 132 deletions
Large diffs are not rendered by default.

‎lib/rest/static/dereferenced/api.github.com.deref.json‎

Lines changed: 50 additions & 125 deletions
Original file line numberDiff line numberDiff line change
@@ -77907,34 +77907,19 @@
7790777907
"description": "a description of the group",
7790877908
"example": "A group of Developers working on AzureAD SAML SSO",
7790977909
"type": "string"
77910+
},
77911+
"status": {
77912+
"description": "synchronization status for this group mapping",
77913+
"example": "unsynced",
77914+
"type": "string"
77915+
},
77916+
"synced_at": {
77917+
"description": "the time of the last sync for this group-mapping",
77918+
"example": "2019-06-03 22:27:15:000 -700",
77919+
"type": "string"
7791077920
}
7791177921
}
7791277922
}
77913-
},
77914-
"group_id": {
77915-
"description": "The ID of the group",
77916-
"example": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa",
77917-
"type": "string"
77918-
},
77919-
"group_name": {
77920-
"description": "The name of the group",
77921-
"example": "saml-azuread-test",
77922-
"type": "string"
77923-
},
77924-
"group_description": {
77925-
"description": "a description of the group",
77926-
"example": "A group of Developers working on AzureAD SAML SSO",
77927-
"type": "string"
77928-
},
77929-
"status": {
77930-
"description": "synchronization status for this group mapping",
77931-
"example": "unsynced",
77932-
"type": "string"
77933-
},
77934-
"synced_at": {
77935-
"description": "the time of the last sync for this group-mapping",
77936-
"example": "2019-06-03 22:27:15:000 -700",
77937-
"type": "string"
7793877923
}
7793977924
}
7794077925
},
@@ -90268,34 +90253,19 @@
9026890253
"description": "a description of the group",
9026990254
"example": "A group of Developers working on AzureAD SAML SSO",
9027090255
"type": "string"
90256+
},
90257+
"status": {
90258+
"description": "synchronization status for this group mapping",
90259+
"example": "unsynced",
90260+
"type": "string"
90261+
},
90262+
"synced_at": {
90263+
"description": "the time of the last sync for this group-mapping",
90264+
"example": "2019-06-03 22:27:15:000 -700",
90265+
"type": "string"
9027190266
}
9027290267
}
9027390268
}
90274-
},
90275-
"group_id": {
90276-
"description": "The ID of the group",
90277-
"example": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa",
90278-
"type": "string"
90279-
},
90280-
"group_name": {
90281-
"description": "The name of the group",
90282-
"example": "saml-azuread-test",
90283-
"type": "string"
90284-
},
90285-
"group_description": {
90286-
"description": "a description of the group",
90287-
"example": "A group of Developers working on AzureAD SAML SSO",
90288-
"type": "string"
90289-
},
90290-
"status": {
90291-
"description": "synchronization status for this group mapping",
90292-
"example": "unsynced",
90293-
"type": "string"
90294-
},
90295-
"synced_at": {
90296-
"description": "the time of the last sync for this group-mapping",
90297-
"example": "2019-06-03 22:27:15:000 -700",
90298-
"type": "string"
9029990269
}
9030090270
}
9030190271
},
@@ -90457,34 +90427,19 @@
9045790427
"description": "a description of the group",
9045890428
"example": "A group of Developers working on AzureAD SAML SSO",
9045990429
"type": "string"
90430+
},
90431+
"status": {
90432+
"description": "synchronization status for this group mapping",
90433+
"example": "unsynced",
90434+
"type": "string"
90435+
},
90436+
"synced_at": {
90437+
"description": "the time of the last sync for this group-mapping",
90438+
"example": "2019-06-03 22:27:15:000 -700",
90439+
"type": "string"
9046090440
}
9046190441
}
9046290442
}
90463-
},
90464-
"group_id": {
90465-
"description": "The ID of the group",
90466-
"example": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa",
90467-
"type": "string"
90468-
},
90469-
"group_name": {
90470-
"description": "The name of the group",
90471-
"example": "saml-azuread-test",
90472-
"type": "string"
90473-
},
90474-
"group_description": {
90475-
"description": "a description of the group",
90476-
"example": "A group of Developers working on AzureAD SAML SSO",
90477-
"type": "string"
90478-
},
90479-
"status": {
90480-
"description": "synchronization status for this group mapping",
90481-
"example": "unsynced",
90482-
"type": "string"
90483-
},
90484-
"synced_at": {
90485-
"description": "the time of the last sync for this group-mapping",
90486-
"example": "2019-06-03 22:27:15:000 -700",
90487-
"type": "string"
9048890443
}
9048990444
}
9049090445
},
@@ -293049,34 +293004,19 @@
293049293004
"description": "a description of the group",
293050293005
"example": "A group of Developers working on AzureAD SAML SSO",
293051293006
"type": "string"
293007+
},
293008+
"status": {
293009+
"description": "synchronization status for this group mapping",
293010+
"example": "unsynced",
293011+
"type": "string"
293012+
},
293013+
"synced_at": {
293014+
"description": "the time of the last sync for this group-mapping",
293015+
"example": "2019-06-03 22:27:15:000 -700",
293016+
"type": "string"
293052293017
}
293053293018
}
293054293019
}
293055-
},
293056-
"group_id": {
293057-
"description": "The ID of the group",
293058-
"example": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa",
293059-
"type": "string"
293060-
},
293061-
"group_name": {
293062-
"description": "The name of the group",
293063-
"example": "saml-azuread-test",
293064-
"type": "string"
293065-
},
293066-
"group_description": {
293067-
"description": "a description of the group",
293068-
"example": "A group of Developers working on AzureAD SAML SSO",
293069-
"type": "string"
293070-
},
293071-
"status": {
293072-
"description": "synchronization status for this group mapping",
293073-
"example": "unsynced",
293074-
"type": "string"
293075-
},
293076-
"synced_at": {
293077-
"description": "the time of the last sync for this group-mapping",
293078-
"example": "2019-06-03 22:27:15:000 -700",
293079-
"type": "string"
293080293020
}
293081293021
}
293082293022
},
@@ -293289,34 +293229,19 @@
293289293229
"description": "a description of the group",
293290293230
"example": "A group of Developers working on AzureAD SAML SSO",
293291293231
"type": "string"
293232+
},
293233+
"status": {
293234+
"description": "synchronization status for this group mapping",
293235+
"example": "unsynced",
293236+
"type": "string"
293237+
},
293238+
"synced_at": {
293239+
"description": "the time of the last sync for this group-mapping",
293240+
"example": "2019-06-03 22:27:15:000 -700",
293241+
"type": "string"
293292293242
}
293293293243
}
293294293244
}
293295-
},
293296-
"group_id": {
293297-
"description": "The ID of the group",
293298-
"example": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa",
293299-
"type": "string"
293300-
},
293301-
"group_name": {
293302-
"description": "The name of the group",
293303-
"example": "saml-azuread-test",
293304-
"type": "string"
293305-
},
293306-
"group_description": {
293307-
"description": "a description of the group",
293308-
"example": "A group of Developers working on AzureAD SAML SSO",
293309-
"type": "string"
293310-
},
293311-
"status": {
293312-
"description": "synchronization status for this group mapping",
293313-
"example": "unsynced",
293314-
"type": "string"
293315-
},
293316-
"synced_at": {
293317-
"description": "the time of the last sync for this group-mapping",
293318-
"example": "2019-06-03 22:27:15:000 -700",
293319-
"type": "string"
293320293245
}
293321293246
}
293322293247
},

0 commit comments

Comments
 (0)