Skip to content

Commit b89d7d6

Browse files
Update OpenAPI 3.1 Descriptions
1 parent db2fe50 commit b89d7d6

File tree

4 files changed

+10
-8
lines changed

4 files changed

+10
-8
lines changed

descriptions-next/api.github.com/api.github.com.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30823,7 +30823,7 @@
3082330823
"/repos/{owner}/{repo}/community/profile": {
3082430824
"get": {
3082530825
"summary": "Get community profile metrics",
30826-
"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.",
30826+
"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.",
3082730827
"tags": [
3082830828
"repos"
3082930829
],

descriptions-next/api.github.com/api.github.com.yaml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22224,9 +22224,10 @@ paths:
2222422224
get:
2222522225
summary: Get community profile metrics
2222622226
description: |-
22227-
This endpoint will return all community profile metrics, including an
22228-
overall health score, repository description, the presence of documentation, detected
22229-
code of conduct, detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE,
22227+
Returns all community profile metrics for a repository. The repository must be public, and cannot be a fork.
22228+
22229+
The returned metrics include an overall health score, the repository description, the presence of documentation, the
22230+
detected code of conduct, the detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE,
2223022231
README, and CONTRIBUTING files.
2223122232

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280650,7 +280650,7 @@
280650280650
"/repos/{owner}/{repo}/community/profile": {
280651280651
"get": {
280652280652
"summary": "Get community profile metrics",
280653-
"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.",
280653+
"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.",
280654280654
"tags": [
280655280655
"repos"
280656280656
],

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47889,9 +47889,10 @@ paths:
4788947889
get:
4789047890
summary: Get community profile metrics
4789147891
description: |-
47892-
This endpoint will return all community profile metrics, including an
47893-
overall health score, repository description, the presence of documentation, detected
47894-
code of conduct, detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE,
47892+
Returns all community profile metrics for a repository. The repository must be public, and cannot be a fork.
47893+
47894+
The returned metrics include an overall health score, the repository description, the presence of documentation, the
47895+
detected code of conduct, the detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE,
4789547896
README, and CONTRIBUTING files.
4789647897

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

0 commit comments

Comments
 (0)