Skip to content

Commit c410ae4

Browse files
github-openapi-botgithub-openapi-bot
committed
Updating OpenAPI descriptions
1 parent 6286018 commit c410ae4

7 files changed

Lines changed: 617 additions & 8 deletions

File tree

‎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
],

‎lib/rest/static/dereferenced/ghes-2.18.deref.json‎

Lines changed: 88 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75238,6 +75238,15 @@
7523875238
"conclusion": {
7523975239
"type": "string",
7524075240
"example": "neutral",
75241+
"enum": [
75242+
"success",
75243+
"failure",
75244+
"neutral",
75245+
"cancelled",
75246+
"skipped",
75247+
"timed_out",
75248+
"action_required"
75249+
],
7524175250
"nullable": true
7524275251
},
7524375252
"started_at": {
@@ -75958,6 +75967,15 @@
7595875967
"conclusion": {
7595975968
"type": "string",
7596075969
"example": "neutral",
75970+
"enum": [
75971+
"success",
75972+
"failure",
75973+
"neutral",
75974+
"cancelled",
75975+
"skipped",
75976+
"timed_out",
75977+
"action_required"
75978+
],
7596175979
"nullable": true
7596275980
},
7596375981
"started_at": {
@@ -76802,6 +76820,15 @@
7680276820
"conclusion": {
7680376821
"type": "string",
7680476822
"example": "neutral",
76823+
"enum": [
76824+
"success",
76825+
"failure",
76826+
"neutral",
76827+
"cancelled",
76828+
"skipped",
76829+
"timed_out",
76830+
"action_required"
76831+
],
7680576832
"nullable": true
7680676833
},
7680776834
"started_at": {
@@ -77589,11 +77616,25 @@
7758977616
"status": {
7759077617
"type": "string",
7759177618
"example": "completed",
77619+
"enum": [
77620+
"queued",
77621+
"in_progress",
77622+
"completed"
77623+
],
7759277624
"nullable": true
7759377625
},
7759477626
"conclusion": {
7759577627
"type": "string",
7759677628
"example": "neutral",
77629+
"enum": [
77630+
"success",
77631+
"failure",
77632+
"neutral",
77633+
"cancelled",
77634+
"skipped",
77635+
"timed_out",
77636+
"action_required"
77637+
],
7759777638
"nullable": true
7759877639
},
7759977640
"url": {
@@ -80041,11 +80082,25 @@
8004180082
"status": {
8004280083
"type": "string",
8004380084
"example": "completed",
80085+
"enum": [
80086+
"queued",
80087+
"in_progress",
80088+
"completed"
80089+
],
8004480090
"nullable": true
8004580091
},
8004680092
"conclusion": {
8004780093
"type": "string",
8004880094
"example": "neutral",
80095+
"enum": [
80096+
"success",
80097+
"failure",
80098+
"neutral",
80099+
"cancelled",
80100+
"skipped",
80101+
"timed_out",
80102+
"action_required"
80103+
],
8004980104
"nullable": true
8005080105
},
8005180106
"url": {
@@ -81372,6 +81427,15 @@
8137281427
"conclusion": {
8137381428
"type": "string",
8137481429
"example": "neutral",
81430+
"enum": [
81431+
"success",
81432+
"failure",
81433+
"neutral",
81434+
"cancelled",
81435+
"skipped",
81436+
"timed_out",
81437+
"action_required"
81438+
],
8137581439
"nullable": true
8137681440
},
8137781441
"started_at": {
@@ -92332,6 +92396,15 @@
9233292396
"conclusion": {
9233392397
"type": "string",
9233492398
"example": "neutral",
92399+
"enum": [
92400+
"success",
92401+
"failure",
92402+
"neutral",
92403+
"cancelled",
92404+
"skipped",
92405+
"timed_out",
92406+
"action_required"
92407+
],
9233592408
"nullable": true
9233692409
},
9233792410
"started_at": {
@@ -92994,11 +93067,25 @@
9299493067
"status": {
9299593068
"type": "string",
9299693069
"example": "completed",
93070+
"enum": [
93071+
"queued",
93072+
"in_progress",
93073+
"completed"
93074+
],
9299793075
"nullable": true
9299893076
},
9299993077
"conclusion": {
9300093078
"type": "string",
9300193079
"example": "neutral",
93080+
"enum": [
93081+
"success",
93082+
"failure",
93083+
"neutral",
93084+
"cancelled",
93085+
"skipped",
93086+
"timed_out",
93087+
"action_required"
93088+
],
9300293089
"nullable": true
9300393090
},
9300493091
"url": {
@@ -95240,7 +95327,7 @@
9524095327
"/repos/{owner}/{repo}/community/code_of_conduct": {
9524195328
"get": {
9524295329
"summary": "Get the code of conduct for a repository",
95243-
"description": "This method returns the contents of the repository's code of conduct file, if one is detected.",
95330+
"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.",
9524495331
"tags": [
9524595332
"codes-of-conduct"
9524695333
],

0 commit comments

Comments
 (0)