Skip to content

Commit 55f3d72

Browse files
docs-botSiaraMist
andauthored
Update OpenAPI Description (#53963)
Co-authored-by: Siara <[email protected]>
1 parent 195c073 commit 55f3d72

File tree

11 files changed

+91
-67
lines changed

11 files changed

+91
-67
lines changed

src/github-apps/lib/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@
6060
"2022-11-28"
6161
]
6262
},
63-
"sha": "b1a9b605ce4d053e9554509fb4503109617a85f3"
63+
"sha": "780e4964a55558c28e9bf35256510c3ad3882948"
6464
}

src/rest/data/fpt-2022-11-28/schema.json

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -231406,12 +231406,13 @@
231406231406
{
231407231407
"name": "sort",
231408231408
"in": "query",
231409-
"description": "<p>The property by which to sort the results.\n<code>created</code> means when the alert was created.\n<code>updated</code> means when the alert's state last changed.</p>",
231409+
"description": "<p>The property by which to sort the results.\n<code>created</code> means when the alert was created.\n<code>updated</code> means when the alert's state last changed.\n<code>epss_percentage</code> sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.</p>",
231410231410
"schema": {
231411231411
"type": "string",
231412231412
"enum": [
231413231413
"created",
231414-
"updated"
231414+
"updated",
231415+
"epss_percentage"
231415231416
],
231416231417
"default": "created"
231417231418
}
@@ -233269,12 +233270,13 @@
233269233270
{
233270233271
"name": "sort",
233271233272
"in": "query",
233272-
"description": "<p>The property by which to sort the results.\n<code>created</code> means when the alert was created.\n<code>updated</code> means when the alert's state last changed.</p>",
233273+
"description": "<p>The property by which to sort the results.\n<code>created</code> means when the alert was created.\n<code>updated</code> means when the alert's state last changed.\n<code>epss_percentage</code> sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.</p>",
233273233274
"schema": {
233274233275
"type": "string",
233275233276
"enum": [
233276233277
"created",
233277-
"updated"
233278+
"updated",
233279+
"epss_percentage"
233278233280
],
233279233281
"default": "created"
233280233282
}
@@ -235157,12 +235159,13 @@
235157235159
{
235158235160
"name": "sort",
235159235161
"in": "query",
235160-
"description": "<p>The property by which to sort the results.\n<code>created</code> means when the alert was created.\n<code>updated</code> means when the alert's state last changed.</p>",
235162+
"description": "<p>The property by which to sort the results.\n<code>created</code> means when the alert was created.\n<code>updated</code> means when the alert's state last changed.\n<code>epss_percentage</code> sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.</p>",
235161235163
"schema": {
235162235164
"type": "string",
235163235165
"enum": [
235164235166
"created",
235165-
"updated"
235167+
"updated",
235168+
"epss_percentage"
235166235169
],
235167235170
"default": "created"
235168235171
}
@@ -596045,7 +596048,7 @@
596045596048
}
596046596049
],
596047596050
"previews": [],
596048-
"descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account. This method takes their durable user <code>ID</code> instead of their <code>login</code>, which can change over time.</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub. For more information, see <a href=\"https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"<a href=\"https://docs.github.com/rest/users/emails\">Emails API</a>\".</p>",
596051+
"descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account. This method takes their durable user <code>ID</code> instead of their <code>login</code>, which can change over time.</p>\n<p>If you are requesting information about an <a href=\"https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users\">Enterprise Managed User</a>, or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a <code>404 Not Found</code> status.</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub. For more information, see <a href=\"https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see <a href=\"https://docs.github.com/rest/users/emails\">Emails API</a>.</p>",
596049596052
"statusCodes": [
596050596053
{
596051596054
"httpStatusCode": "200",
@@ -597623,7 +597626,7 @@
597623597626
}
597624597627
],
597625597628
"previews": [],
597626-
"descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account.</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub. For more information, see <a href=\"https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"<a href=\"https://docs.github.com/rest/users/emails\">Emails API</a>\".</p>",
597629+
"descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account.</p>\n<p>If you are requesting information about an <a href=\"https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users\">Enterprise Managed User</a>, or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a <code>404 Not Found</code> status.</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub. For more information, see <a href=\"https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see <a href=\"https://docs.github.com/rest/users/emails\">Emails API</a>.</p>",
597627597630
"statusCodes": [
597628597631
{
597629597632
"httpStatusCode": "200",

src/rest/data/ghec-2022-11-28/schema.json

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -242888,12 +242888,13 @@
242888242888
{
242889242889
"name": "sort",
242890242890
"in": "query",
242891-
"description": "<p>The property by which to sort the results.\n<code>created</code> means when the alert was created.\n<code>updated</code> means when the alert's state last changed.</p>",
242891+
"description": "<p>The property by which to sort the results.\n<code>created</code> means when the alert was created.\n<code>updated</code> means when the alert's state last changed.\n<code>epss_percentage</code> sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.</p>",
242892242892
"schema": {
242893242893
"type": "string",
242894242894
"enum": [
242895242895
"created",
242896-
"updated"
242896+
"updated",
242897+
"epss_percentage"
242897242898
],
242898242899
"default": "created"
242899242900
}
@@ -244751,12 +244752,13 @@
244751244752
{
244752244753
"name": "sort",
244753244754
"in": "query",
244754-
"description": "<p>The property by which to sort the results.\n<code>created</code> means when the alert was created.\n<code>updated</code> means when the alert's state last changed.</p>",
244755+
"description": "<p>The property by which to sort the results.\n<code>created</code> means when the alert was created.\n<code>updated</code> means when the alert's state last changed.\n<code>epss_percentage</code> sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.</p>",
244755244756
"schema": {
244756244757
"type": "string",
244757244758
"enum": [
244758244759
"created",
244759-
"updated"
244760+
"updated",
244761+
"epss_percentage"
244760244762
],
244761244763
"default": "created"
244762244764
}
@@ -246639,12 +246641,13 @@
246639246641
{
246640246642
"name": "sort",
246641246643
"in": "query",
246642-
"description": "<p>The property by which to sort the results.\n<code>created</code> means when the alert was created.\n<code>updated</code> means when the alert's state last changed.</p>",
246644+
"description": "<p>The property by which to sort the results.\n<code>created</code> means when the alert was created.\n<code>updated</code> means when the alert's state last changed.\n<code>epss_percentage</code> sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.</p>",
246643246645
"schema": {
246644246646
"type": "string",
246645246647
"enum": [
246646246648
"created",
246647-
"updated"
246649+
"updated",
246650+
"epss_percentage"
246648246651
],
246649246652
"default": "created"
246650246653
}
@@ -635060,7 +635063,7 @@
635060635063
}
635061635064
],
635062635065
"previews": [],
635063-
"descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account. This method takes their durable user <code>ID</code> instead of their <code>login</code>, which can change over time.</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub Enterprise Cloud <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/users/emails\">Emails API</a>\".</p>",
635066+
"descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account. This method takes their durable user <code>ID</code> instead of their <code>login</code>, which can change over time.</p>\n<p>If you are requesting information about an <a href=\"https://docs.github.com/enterprise-cloud@latest//enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users\">Enterprise Managed User</a>, or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a <code>404 Not Found</code> status.</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub Enterprise Cloud <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/users/emails\">Emails API</a>.</p>",
635064635067
"statusCodes": [
635065635068
{
635066635069
"httpStatusCode": "200",
@@ -636638,7 +636641,7 @@
636638636641
}
636639636642
],
636640636643
"previews": [],
636641-
"descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account.</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub Enterprise Cloud <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/users/emails\">Emails API</a>\".</p>",
636644+
"descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account.</p>\n<p>If you are requesting information about an <a href=\"https://docs.github.com/enterprise-cloud@latest//enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users\">Enterprise Managed User</a>, or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a <code>404 Not Found</code> status.</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub Enterprise Cloud <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/users/emails\">Emails API</a>.</p>",
636642636645
"statusCodes": [
636643636646
{
636644636647
"httpStatusCode": "200",

0 commit comments

Comments
 (0)