Skip to content

Commit f0a0148

Browse files
authored
Merge pull request #1558 from github/openapi-update-14cb4dfc9718b70174594a215bc8fcd060cc11ceaffe096b3c78966f72ad9367
Update OpenAPI 3.0 Descriptions
2 parents db2fe50 + 85da53e commit f0a0148

File tree

4 files changed

+10
-8
lines changed

4 files changed

+10
-8
lines changed

descriptions/api.github.com/api.github.com.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30673,7 +30673,7 @@
3067330673
"/repos/{owner}/{repo}/community/profile": {
3067430674
"get": {
3067530675
"summary": "Get community profile metrics",
30676-
"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.",
30676+
"description": "Returns all community profile metrics for a repository. The repository must be public, and cannot be a fork.\n\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the 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.",
3067730677
"tags": [
3067830678
"repos"
3067930679
],

descriptions/api.github.com/api.github.com.yaml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22152,9 +22152,10 @@ paths:
2215222152
get:
2215322153
summary: Get community profile metrics
2215422154
description: |-
22155-
This endpoint will return all community profile metrics, including an
22156-
overall health score, repository description, the presence of documentation, detected
22157-
code of conduct, detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE,
22155+
Returns all community profile metrics for a repository. The repository must be public, and cannot be a fork.
22156+
22157+
The returned metrics include an overall health score, the repository description, the presence of documentation, the
22158+
detected code of conduct, the detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE,
2215822159
README, and CONTRIBUTING files.
2215922160

2216022161
The `health_percentage` score is defined as a percentage of how many of

descriptions/api.github.com/dereferenced/api.github.com.deref.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237782,7 +237782,7 @@
237782237782
"/repos/{owner}/{repo}/community/profile": {
237783237783
"get": {
237784237784
"summary": "Get community profile metrics",
237785-
"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.",
237785+
"description": "Returns all community profile metrics for a repository. The repository must be public, and cannot be a fork.\n\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the 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.",
237786237786
"tags": [
237787237787
"repos"
237788237788
],

descriptions/api.github.com/dereferenced/api.github.com.deref.yaml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46631,9 +46631,10 @@ paths:
4663146631
get:
4663246632
summary: Get community profile metrics
4663346633
description: |-
46634-
This endpoint will return all community profile metrics, including an
46635-
overall health score, repository description, the presence of documentation, detected
46636-
code of conduct, detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE,
46634+
Returns all community profile metrics for a repository. The repository must be public, and cannot be a fork.
46635+
46636+
The returned metrics include an overall health score, the repository description, the presence of documentation, the
46637+
detected code of conduct, the detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE,
4663746638
README, and CONTRIBUTING files.
4663846639

4663946640
The `health_percentage` score is defined as a percentage of how many of

0 commit comments

Comments
 (0)