Skip to content

Commit ef387e4

Browse files
author
Sarah Edwards
authored
Merge pull request #17154 from github/openapi-update-4c3c34d090578794b4ce8a45185511e872332f09bb45c9ed520b8415a28fbf16
Updating OpenAPI descriptions
2 parents bc1e8a8 + 65b5c70 commit ef387e4

14 files changed

Lines changed: 633 additions & 24 deletions

‎lib/rest/static/decorated/api.github.com.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44178,7 +44178,7 @@
4417844178
}
4417944179
],
4418044180
"summary": "Get the code of conduct for a repository",
44181-
"description": "This method returns the contents of the repository's code of conduct file, if one is detected.",
44181+
"description": "Returns the contents of the repository's code of conduct file, if one is detected.\n\nA code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.",
4418244182
"tags": [
4418344183
"codes-of-conduct"
4418444184
],
@@ -44206,7 +44206,7 @@
4420644206
"categoryLabel": "Codes of conduct",
4420744207
"notes": [],
4420844208
"bodyParameters": [],
44209-
"descriptionHTML": "<p>This method returns the contents of the repository's code of conduct file, if one is detected.</p>",
44209+
"descriptionHTML": "<p>Returns the contents of the repository's code of conduct file, if one is detected.</p>\n<p>A code of conduct is detected if there is a file named <code>CODE_OF_CONDUCT</code> in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.</p>",
4421044210
"responses": [
4421144211
{
4421244212
"httpStatusCode": "200",
@@ -44253,7 +44253,7 @@
4425344253
}
4425444254
],
4425544255
"summary": "Get community profile metrics",
44256-
"description": "This endpoint will return all community profile metrics, including an\noverall health score, repository description, the presence of documentation, detected\ncode of conduct, detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\n`content_reports_enabled` is only returned for organization-owned repositories.",
44256+
"description": "This endpoint will return all community profile metrics, including an\noverall health score, repository description, the presence of documentation, detected\ncode of conduct, detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthese four documents are present: README, CONTRIBUTING, LICENSE, and\nCODE_OF_CONDUCT. For example, if all four documents are present, then\nthe `health_percentage` is `100`. If only one is present, then the\n`health_percentage` is `25`.\n\n`content_reports_enabled` is only returned for organization-owned repositories.",
4425744257
"tags": [
4425844258
"repos"
4425944259
],
@@ -44275,7 +44275,7 @@
4427544275
"subcategoryLabel": "Community",
4427644276
"notes": [],
4427744277
"bodyParameters": [],
44278-
"descriptionHTML": "<p>This endpoint will return all community profile metrics, including an\noverall health score, repository description, the presence of documentation, detected\ncode of conduct, detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE,\nREADME, and CONTRIBUTING files.</p>\n<p><code>content_reports_enabled</code> is only returned for organization-owned repositories.</p>",
44278+
"descriptionHTML": "<p>This endpoint will return all community profile metrics, including an\noverall health score, repository description, the presence of documentation, detected\ncode of conduct, detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE,\nREADME, and CONTRIBUTING files.</p>\n<p>The <code>health_percentage</code> score is defined as a percentage of how many of\nthese four documents are present: README, CONTRIBUTING, LICENSE, and\nCODE_OF_CONDUCT. For example, if all four documents are present, then\nthe <code>health_percentage</code> is <code>100</code>. If only one is present, then the\n<code>health_percentage</code> is <code>25</code>.</p>\n<p><code>content_reports_enabled</code> is only returned for organization-owned repositories.</p>",
4427944279
"responses": [
4428044280
{
4428144281
"httpStatusCode": "200",

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29735,7 +29735,7 @@
2973529735
}
2973629736
],
2973729737
"summary": "Get the code of conduct for a repository",
29738-
"description": "This method returns the contents of the repository's code of conduct file, if one is detected.",
29738+
"description": "Returns the contents of the repository's code of conduct file, if one is detected.\n\nA code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.",
2973929739
"tags": [
2974029740
"codes-of-conduct"
2974129741
],
@@ -29763,7 +29763,7 @@
2976329763
"categoryLabel": "Codes of conduct",
2976429764
"notes": [],
2976529765
"bodyParameters": [],
29766-
"descriptionHTML": "<p>This method returns the contents of the repository's code of conduct file, if one is detected.</p>",
29766+
"descriptionHTML": "<p>Returns the contents of the repository's code of conduct file, if one is detected.</p>\n<p>A code of conduct is detected if there is a file named <code>CODE_OF_CONDUCT</code> in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.</p>",
2976729767
"responses": [
2976829768
{
2976929769
"httpStatusCode": "200",

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30298,7 +30298,7 @@
3029830298
}
3029930299
],
3030030300
"summary": "Get the code of conduct for a repository",
30301-
"description": "This method returns the contents of the repository's code of conduct file, if one is detected.",
30301+
"description": "Returns the contents of the repository's code of conduct file, if one is detected.\n\nA code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.",
3030230302
"tags": [
3030330303
"codes-of-conduct"
3030430304
],
@@ -30326,7 +30326,7 @@
3032630326
"categoryLabel": "Codes of conduct",
3032730327
"notes": [],
3032830328
"bodyParameters": [],
30329-
"descriptionHTML": "<p>This method returns the contents of the repository's code of conduct file, if one is detected.</p>",
30329+
"descriptionHTML": "<p>Returns the contents of the repository's code of conduct file, if one is detected.</p>\n<p>A code of conduct is detected if there is a file named <code>CODE_OF_CONDUCT</code> in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.</p>",
3033030330
"responses": [
3033130331
{
3033230332
"httpStatusCode": "200",

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30765,7 +30765,7 @@
3076530765
}
3076630766
],
3076730767
"summary": "Get the code of conduct for a repository",
30768-
"description": "This method returns the contents of the repository's code of conduct file, if one is detected.",
30768+
"description": "Returns the contents of the repository's code of conduct file, if one is detected.\n\nA code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.",
3076930769
"tags": [
3077030770
"codes-of-conduct"
3077130771
],
@@ -30793,7 +30793,7 @@
3079330793
"categoryLabel": "Codes of conduct",
3079430794
"notes": [],
3079530795
"bodyParameters": [],
30796-
"descriptionHTML": "<p>This method returns the contents of the repository's code of conduct file, if one is detected.</p>",
30796+
"descriptionHTML": "<p>Returns the contents of the repository's code of conduct file, if one is detected.</p>\n<p>A code of conduct is detected if there is a file named <code>CODE_OF_CONDUCT</code> in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.</p>",
3079730797
"responses": [
3079830798
{
3079930799
"httpStatusCode": "200",

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34325,7 +34325,7 @@
3432534325
}
3432634326
],
3432734327
"summary": "Get the code of conduct for a repository",
34328-
"description": "This method returns the contents of the repository's code of conduct file, if one is detected.",
34328+
"description": "Returns the contents of the repository's code of conduct file, if one is detected.\n\nA code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.",
3432934329
"tags": [
3433034330
"codes-of-conduct"
3433134331
],
@@ -34353,7 +34353,7 @@
3435334353
"categoryLabel": "Codes of conduct",
3435434354
"notes": [],
3435534355
"bodyParameters": [],
34356-
"descriptionHTML": "<p>This method returns the contents of the repository's code of conduct file, if one is detected.</p>",
34356+
"descriptionHTML": "<p>Returns the contents of the repository's code of conduct file, if one is detected.</p>\n<p>A code of conduct is detected if there is a file named <code>CODE_OF_CONDUCT</code> in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.</p>",
3435734357
"responses": [
3435834358
{
3435934359
"httpStatusCode": "200",

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41817,7 +41817,7 @@
4181741817
}
4181841818
],
4181941819
"summary": "Get the code of conduct for a repository",
41820-
"description": "This method returns the contents of the repository's code of conduct file, if one is detected.",
41820+
"description": "Returns the contents of the repository's code of conduct file, if one is detected.\n\nA code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.",
4182141821
"tags": [
4182241822
"codes-of-conduct"
4182341823
],
@@ -41845,7 +41845,7 @@
4184541845
"categoryLabel": "Codes of conduct",
4184641846
"notes": [],
4184741847
"bodyParameters": [],
41848-
"descriptionHTML": "<p>This method returns the contents of the repository's code of conduct file, if one is detected.</p>",
41848+
"descriptionHTML": "<p>Returns the contents of the repository's code of conduct file, if one is detected.</p>\n<p>A code of conduct is detected if there is a file named <code>CODE_OF_CONDUCT</code> in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.</p>",
4184941849
"responses": [
4185041850
{
4185141851
"httpStatusCode": "200",

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32207,7 +32207,7 @@
3220732207
}
3220832208
],
3220932209
"summary": "Get the code of conduct for a repository",
32210-
"description": "This method returns the contents of the repository's code of conduct file, if one is detected.",
32210+
"description": "Returns the contents of the repository's code of conduct file, if one is detected.\n\nA code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.",
3221132211
"tags": [
3221232212
"codes-of-conduct"
3221332213
],
@@ -32235,7 +32235,7 @@
3223532235
"categoryLabel": "Codes of conduct",
3223632236
"notes": [],
3223732237
"bodyParameters": [],
32238-
"descriptionHTML": "<p>This method returns the contents of the repository's code of conduct file, if one is detected.</p>",
32238+
"descriptionHTML": "<p>Returns the contents of the repository's code of conduct file, if one is detected.</p>\n<p>A code of conduct is detected if there is a file named <code>CODE_OF_CONDUCT</code> in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.</p>",
3223932239
"responses": [
3224032240
{
3224132241
"httpStatusCode": "200",

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

Lines changed: 89 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117922,6 +117922,15 @@
117922117922
"conclusion": {
117923117923
"type": "string",
117924117924
"example": "neutral",
117925+
"enum": [
117926+
"success",
117927+
"failure",
117928+
"neutral",
117929+
"cancelled",
117930+
"skipped",
117931+
"timed_out",
117932+
"action_required"
117933+
],
117925117934
"nullable": true
117926117935
},
117927117936
"started_at": {
@@ -118643,6 +118652,15 @@
118643118652
"conclusion": {
118644118653
"type": "string",
118645118654
"example": "neutral",
118655+
"enum": [
118656+
"success",
118657+
"failure",
118658+
"neutral",
118659+
"cancelled",
118660+
"skipped",
118661+
"timed_out",
118662+
"action_required"
118663+
],
118646118664
"nullable": true
118647118665
},
118648118666
"started_at": {
@@ -119488,6 +119506,15 @@
119488119506
"conclusion": {
119489119507
"type": "string",
119490119508
"example": "neutral",
119509+
"enum": [
119510+
"success",
119511+
"failure",
119512+
"neutral",
119513+
"cancelled",
119514+
"skipped",
119515+
"timed_out",
119516+
"action_required"
119517+
],
119491119518
"nullable": true
119492119519
},
119493119520
"started_at": {
@@ -120272,11 +120299,25 @@
120272120299
"status": {
120273120300
"type": "string",
120274120301
"example": "completed",
120302+
"enum": [
120303+
"queued",
120304+
"in_progress",
120305+
"completed"
120306+
],
120275120307
"nullable": true
120276120308
},
120277120309
"conclusion": {
120278120310
"type": "string",
120279120311
"example": "neutral",
120312+
"enum": [
120313+
"success",
120314+
"failure",
120315+
"neutral",
120316+
"cancelled",
120317+
"skipped",
120318+
"timed_out",
120319+
"action_required"
120320+
],
120280120321
"nullable": true
120281120322
},
120282120323
"url": {
@@ -122751,11 +122792,25 @@
122751122792
"status": {
122752122793
"type": "string",
122753122794
"example": "completed",
122795+
"enum": [
122796+
"queued",
122797+
"in_progress",
122798+
"completed"
122799+
],
122754122800
"nullable": true
122755122801
},
122756122802
"conclusion": {
122757122803
"type": "string",
122758122804
"example": "neutral",
122805+
"enum": [
122806+
"success",
122807+
"failure",
122808+
"neutral",
122809+
"cancelled",
122810+
"skipped",
122811+
"timed_out",
122812+
"action_required"
122813+
],
122759122814
"nullable": true
122760122815
},
122761122816
"url": {
@@ -124092,6 +124147,15 @@
124092124147
"conclusion": {
124093124148
"type": "string",
124094124149
"example": "neutral",
124150+
"enum": [
124151+
"success",
124152+
"failure",
124153+
"neutral",
124154+
"cancelled",
124155+
"skipped",
124156+
"timed_out",
124157+
"action_required"
124158+
],
124095124159
"nullable": true
124096124160
},
124097124161
"started_at": {
@@ -136641,6 +136705,15 @@
136641136705
"conclusion": {
136642136706
"type": "string",
136643136707
"example": "neutral",
136708+
"enum": [
136709+
"success",
136710+
"failure",
136711+
"neutral",
136712+
"cancelled",
136713+
"skipped",
136714+
"timed_out",
136715+
"action_required"
136716+
],
136644136717
"nullable": true
136645136718
},
136646136719
"started_at": {
@@ -137304,11 +137377,25 @@
137304137377
"status": {
137305137378
"type": "string",
137306137379
"example": "completed",
137380+
"enum": [
137381+
"queued",
137382+
"in_progress",
137383+
"completed"
137384+
],
137307137385
"nullable": true
137308137386
},
137309137387
"conclusion": {
137310137388
"type": "string",
137311137389
"example": "neutral",
137390+
"enum": [
137391+
"success",
137392+
"failure",
137393+
"neutral",
137394+
"cancelled",
137395+
"skipped",
137396+
"timed_out",
137397+
"action_required"
137398+
],
137312137399
"nullable": true
137313137400
},
137314137401
"url": {
@@ -139585,7 +139672,7 @@
139585139672
"/repos/{owner}/{repo}/community/code_of_conduct": {
139586139673
"get": {
139587139674
"summary": "Get the code of conduct for a repository",
139588-
"description": "This method returns the contents of the repository's code of conduct file, if one is detected.",
139675+
"description": "Returns the contents of the repository's code of conduct file, if one is detected.\n\nA code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.",
139589139676
"tags": [
139590139677
"codes-of-conduct"
139591139678
],
@@ -139685,7 +139772,7 @@
139685139772
"/repos/{owner}/{repo}/community/profile": {
139686139773
"get": {
139687139774
"summary": "Get community profile metrics",
139688-
"description": "This endpoint will return all community profile metrics, including an\noverall health score, repository description, the presence of documentation, detected\ncode of conduct, detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\n`content_reports_enabled` is only returned for organization-owned repositories.",
139775+
"description": "This endpoint will return all community profile metrics, including an\noverall health score, repository description, the presence of documentation, detected\ncode of conduct, detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthese four documents are present: README, CONTRIBUTING, LICENSE, and\nCODE_OF_CONDUCT. For example, if all four documents are present, then\nthe `health_percentage` is `100`. If only one is present, then the\n`health_percentage` is `25`.\n\n`content_reports_enabled` is only returned for organization-owned repositories.",
139689139776
"tags": [
139690139777
"repos"
139691139778
],

0 commit comments

Comments
 (0)