Skip to content

Commit 484cab2

Browse files
Add decorated OpenAPI schema files
1 parent c410ae4 commit 484cab2

7 files changed

Lines changed: 16 additions & 16 deletions

File tree

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",

0 commit comments

Comments
 (0)