jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-23 21:07:12 -05:00
Code Issues Projects Releases Wiki Activity

Update OpenAPI Description (#53090)

Browse Source
This commit is contained in:
docs-bot
2024-11-13 11:43:45 -05:00
committed by GitHub
parent 4edaf8511c
commit 4f19ff381e
13 changed files with 1301 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/github-apps/lib/config.json
View File

@@ -60,5 +60,5 @@
"2022-11-28"
]
},
"sha": "c9cd73bd34f020305d23f5d3b63e3c59624f1537"
"sha": "a0508cecd18ab26b525527e4ba35bd9c6d725c4f"
}

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

@@ -361700,6 +361700,7 @@
{
"property_name": "environment",
"url": "https://api.github.com/orgs/github/properties/schema/environment",
"source_type": "organization",
"value_type": "single_select",
"required": true,
"default_value": "production",
@@ -361713,11 +361714,13 @@
{
"property_name": "service",
"url": "https://api.github.com/orgs/github/properties/schema/service",
"source_type": "organization",
"value_type": "string"
},
{
"property_name": "team",
"url": "https://api.github.com/orgs/github/properties/schema/team",
"source_type": "organization",
"value_type": "string",
"description": "Team owning the repository"
}
@@ -361738,6 +361741,17 @@
"format": "uri",
"description": "The URL that can be used to fetch, update, or delete info about this property via the API."
},
"source_type": {
"type": "string",
"description": "The source type of the property",
"enum": [
"organization",
"enterprise"
],
"examples": [
"organization"
]
},
"value_type": {
"type": "string",
"enum": [
@@ -361872,6 +361886,15 @@
"name": "url",
"description": "<p>The URL that can be used to fetch, update, or delete info about this property via the API.</p>"
},
{
"type": "string",
"name": "source_type",
"description": "<p>The source type of the property</p>",
"enum": [
"organization",
"enterprise"
]
},
{
"type": "string",
"name": "value_type",
@@ -361971,6 +361994,7 @@
{
"property_name": "environment",
"url": "https://api.github.com/orgs/github/properties/schema/environment",
"source_type": "organization",
"value_type": "single_select",
"required": true,
"default_value": "production",
@@ -361984,11 +362008,13 @@
{
"property_name": "service",
"url": "https://api.github.com/orgs/github/properties/schema/service",
"source_type": "organization",
"value_type": "string"
},
{
"property_name": "team",
"url": "https://api.github.com/orgs/github/properties/schema/team",
"source_type": "organization",
"value_type": "string",
"description": "Team owning the repository"
}
@@ -362009,6 +362035,17 @@
"format": "uri",
"description": "The URL that can be used to fetch, update, or delete info about this property via the API."
},
"source_type": {
"type": "string",
"description": "The source type of the property",
"enum": [
"organization",
"enterprise"
],
"examples": [
"organization"
]
},
"value_type": {
"type": "string",
"enum": [
@@ -362162,6 +362199,7 @@
"example": {
"property_name": "environment",
"url": "https://api.github.com/orgs/github/properties/schema/environment",
"source_type": "organization",
"value_type": "single_select",
"required": true,
"default_value": "production",
@@ -362185,6 +362223,17 @@
"format": "uri",
"description": "The URL that can be used to fetch, update, or delete info about this property via the API."
},
"source_type": {
"type": "string",
"description": "The source type of the property",
"enum": [
"organization",
"enterprise"
],
"examples": [
"organization"
]
},
"value_type": {
"type": "string",
"enum": [
@@ -362386,6 +362435,7 @@
"example": {
"property_name": "environment",
"url": "https://api.github.com/orgs/github/properties/schema/environment",
"source_type": "organization",
"value_type": "single_select",
"required": true,
"default_value": "production",
@@ -362409,6 +362459,17 @@
"format": "uri",
"description": "The URL that can be used to fetch, update, or delete info about this property via the API."
},
"source_type": {
"type": "string",
"description": "The source type of the property",
"enum": [
"organization",
"enterprise"
],
"examples": [
"organization"
]
},
"value_type": {
"type": "string",
"enum": [
@@ -367836,6 +367897,34 @@
"null"
]
},
"base_role": {
"type": [
"string",
"null"
],
"description": "The system role from which this role inherits permissions.",
"enum": [
"read",
"triage",
"write",
"maintain",
"admin",
null
]
},
"source": {
"type": [
"string",
"null"
],
"description": "Source answers the question, \"where did this role come from?\"",
"enum": [
"Organization",
"Enterprise",
"Predefined",
null
]
},
"permissions": {
"description": "A list of permissions included in this role.",
"type": "array",
@@ -368602,6 +368691,34 @@
"null"
]
},
"base_role": {
"type": [
"string",
"null"
],
"description": "The system role from which this role inherits permissions.",
"enum": [
"read",
"triage",
"write",
"maintain",
"admin",
null
]
},
"source": {
"type": [
"string",
"null"
],
"description": "Source answers the question, \"where did this role come from?\"",
"enum": [
"Organization",
"Enterprise",
"Predefined",
null
]
},
"permissions": {
"description": "A list of permissions included in this role.",
"type": "array",
@@ -368920,6 +369037,18 @@
"description": "The Relationship a Team has with a role.",
"type": "object",
"properties": {
"assignment": {
"type": "string",
"description": "Determines if the team has a direct, indirect, or mixed relationship to a role",
"enum": [
"direct",
"indirect",
"mixed"
],
"examples": [
"direct"
]
},
"id": {
"type": "integer"
},
@@ -369247,6 +369376,133 @@
"description": "The Relationship a User has with a role.",
"type": "object",
"properties": {
"assignment": {
"type": "string",
"description": "Determines if the user has a direct, indirect, or mixed relationship to a role",
"enum": [
"direct",
"indirect",
"mixed"
],
"examples": [
"direct"
]
},
"inherited_from": {
"description": "Team the user has gotten the role through",
"type": "array",
"items": {
"title": "Team Simple",
"description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier of the team",
"type": "integer",
"examples": [
1
]
},
"node_id": {
"type": "string",
"examples": [
"MDQ6VGVhbTE="
]
},
"url": {
"description": "URL for the team",
"type": "string",
"format": "uri",
"examples": [
"https://api.github.com/organizations/1/team/1"
]
},
"members_url": {
"type": "string",
"examples": [
"https://api.github.com/organizations/1/team/1/members{/member}"
]
},
"name": {
"description": "Name of the team",
"type": "string",
"examples": [
"Justice League"
]
},
"description": {
"description": "Description of the team",
"type": [
"string",
"null"
],
"examples": [
"A great team."
]
},
"permission": {
"description": "Permission that the team will have for its repositories",
"type": "string",
"examples": [
"admin"
]
},
"privacy": {
"description": "The level of privacy this team should have",
"type": "string",
"examples": [
"closed"
]
},
"notification_setting": {
"description": "The notification setting the team has set",
"type": "string",
"examples": [
"notifications_enabled"
]
},
"html_url": {
"type": "string",
"format": "uri",
"examples": [
"https://github.com/orgs/rails/teams/core"
]
},
"repositories_url": {
"type": "string",
"format": "uri",
"examples": [
"https://api.github.com/organizations/1/team/1/repos"
]
},
"slug": {
"type": "string",
"examples": [
"justice-league"
]
},
"ldap_dn": {
"description": "Distinguished Name (DN) that team maps to within LDAP environment",
"type": "string",
"examples": [
"uid=example,ou=users,dc=github,dc=com"
]
}
},
"required": [
"id",
"node_id",
"url",
"members_url",
"name",
"description",
"permission",
"html_url",
"repositories_url",
"slug"
]
}
},
"name": {
"type": [
"string",
@@ -461006,7 +461262,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>To download the asset's binary content, set the <code>Accept</code> header of the request to <a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\"><code>application/octet-stream</code></a>. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a <code>200</code> or <code>302</code> response.</p>",
"descriptionHTML": "<p>To download the asset's binary content:</p>\n<ul>\n<li>If within a browser, fetch the location specified in the <code>browser_download_url</code> key provided in the response.</li>\n<li>Alternatively, set the <code>Accept</code> header of the request to\n<a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\"><code>application/octet-stream</code></a>.\nThe API will either redirect the client to the location, or stream it directly if possible.\nAPI clients should handle both a <code>200</code> or <code>302</code> response.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",

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

@@ -379383,6 +379383,7 @@
{
"property_name": "environment",
"url": "https://api.github.com/orgs/github/properties/schema/environment",
"source_type": "organization",
"value_type": "single_select",
"required": true,
"default_value": "production",
@@ -379396,11 +379397,13 @@
{
"property_name": "service",
"url": "https://api.github.com/orgs/github/properties/schema/service",
"source_type": "organization",
"value_type": "string"
},
{
"property_name": "team",
"url": "https://api.github.com/orgs/github/properties/schema/team",
"source_type": "organization",
"value_type": "string",
"description": "Team owning the repository"
}
@@ -379421,6 +379424,17 @@
"format": "uri",
"description": "The URL that can be used to fetch, update, or delete info about this property via the API."
},
"source_type": {
"type": "string",
"description": "The source type of the property",
"enum": [
"organization",
"enterprise"
],
"examples": [
"organization"
]
},
"value_type": {
"type": "string",
"enum": [
@@ -379555,6 +379569,15 @@
"name": "url",
"description": "<p>The URL that can be used to fetch, update, or delete info about this property via the API.</p>"
},
{
"type": "string",
"name": "source_type",
"description": "<p>The source type of the property</p>",
"enum": [
"organization",
"enterprise"
]
},
{
"type": "string",
"name": "value_type",
@@ -379654,6 +379677,7 @@
{
"property_name": "environment",
"url": "https://api.github.com/orgs/github/properties/schema/environment",
"source_type": "organization",
"value_type": "single_select",
"required": true,
"default_value": "production",
@@ -379667,11 +379691,13 @@
{
"property_name": "service",
"url": "https://api.github.com/orgs/github/properties/schema/service",
"source_type": "organization",
"value_type": "string"
},
{
"property_name": "team",
"url": "https://api.github.com/orgs/github/properties/schema/team",
"source_type": "organization",
"value_type": "string",
"description": "Team owning the repository"
}
@@ -379692,6 +379718,17 @@
"format": "uri",
"description": "The URL that can be used to fetch, update, or delete info about this property via the API."
},
"source_type": {
"type": "string",
"description": "The source type of the property",
"enum": [
"organization",
"enterprise"
],
"examples": [
"organization"
]
},
"value_type": {
"type": "string",
"enum": [
@@ -379845,6 +379882,7 @@
"example": {
"property_name": "environment",
"url": "https://api.github.com/orgs/github/properties/schema/environment",
"source_type": "organization",
"value_type": "single_select",
"required": true,
"default_value": "production",
@@ -379868,6 +379906,17 @@
"format": "uri",
"description": "The URL that can be used to fetch, update, or delete info about this property via the API."
},
"source_type": {
"type": "string",
"description": "The source type of the property",
"enum": [
"organization",
"enterprise"
],
"examples": [
"organization"
]
},
"value_type": {
"type": "string",
"enum": [
@@ -380069,6 +380118,7 @@
"example": {
"property_name": "environment",
"url": "https://api.github.com/orgs/github/properties/schema/environment",
"source_type": "organization",
"value_type": "single_select",
"required": true,
"default_value": "production",
@@ -380092,6 +380142,17 @@
"format": "uri",
"description": "The URL that can be used to fetch, update, or delete info about this property via the API."
},
"source_type": {
"type": "string",
"description": "The source type of the property",
"enum": [
"organization",
"enterprise"
],
"examples": [
"organization"
]
},
"value_type": {
"type": "string",
"enum": [
@@ -388695,6 +388756,34 @@
"null"
]
},
"base_role": {
"type": [
"string",
"null"
],
"description": "The system role from which this role inherits permissions.",
"enum": [
"read",
"triage",
"write",
"maintain",
"admin",
null
]
},
"source": {
"type": [
"string",
"null"
],
"description": "Source answers the question, \"where did this role come from?\"",
"enum": [
"Organization",
"Enterprise",
"Predefined",
null
]
},
"permissions": {
"description": "A list of permissions included in this role.",
"type": "array",
@@ -389056,6 +389145,34 @@
"null"
]
},
"base_role": {
"type": [
"string",
"null"
],
"description": "The system role from which this role inherits permissions.",
"enum": [
"read",
"triage",
"write",
"maintain",
"admin",
null
]
},
"source": {
"type": [
"string",
"null"
],
"description": "Source answers the question, \"where did this role come from?\"",
"enum": [
"Organization",
"Enterprise",
"Predefined",
null
]
},
"permissions": {
"description": "A list of permissions included in this role.",
"type": "array",
@@ -389823,6 +389940,34 @@
"null"
]
},
"base_role": {
"type": [
"string",
"null"
],
"description": "The system role from which this role inherits permissions.",
"enum": [
"read",
"triage",
"write",
"maintain",
"admin",
null
]
},
"source": {
"type": [
"string",
"null"
],
"description": "Source answers the question, \"where did this role come from?\"",
"enum": [
"Organization",
"Enterprise",
"Predefined",
null
]
},
"permissions": {
"description": "A list of permissions included in this role.",
"type": "array",
@@ -390183,6 +390328,34 @@
"null"
]
},
"base_role": {
"type": [
"string",
"null"
],
"description": "The system role from which this role inherits permissions.",
"enum": [
"read",
"triage",
"write",
"maintain",
"admin",
null
]
},
"source": {
"type": [
"string",
"null"
],
"description": "Source answers the question, \"where did this role come from?\"",
"enum": [
"Organization",
"Enterprise",
"Predefined",
null
]
},
"permissions": {
"description": "A list of permissions included in this role.",
"type": "array",
@@ -390569,6 +390742,18 @@
"description": "The Relationship a Team has with a role.",
"type": "object",
"properties": {
"assignment": {
"type": "string",
"description": "Determines if the team has a direct, indirect, or mixed relationship to a role",
"enum": [
"direct",
"indirect",
"mixed"
],
"examples": [
"direct"
]
},
"id": {
"type": "integer"
},
@@ -390896,6 +391081,133 @@
"description": "The Relationship a User has with a role.",
"type": "object",
"properties": {
"assignment": {
"type": "string",
"description": "Determines if the user has a direct, indirect, or mixed relationship to a role",
"enum": [
"direct",
"indirect",
"mixed"
],
"examples": [
"direct"
]
},
"inherited_from": {
"description": "Team the user has gotten the role through",
"type": "array",
"items": {
"title": "Team Simple",
"description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier of the team",
"type": "integer",
"examples": [
1
]
},
"node_id": {
"type": "string",
"examples": [
"MDQ6VGVhbTE="
]
},
"url": {
"description": "URL for the team",
"type": "string",
"format": "uri",
"examples": [
"https://api.github.com/organizations/1/team/1"
]
},
"members_url": {
"type": "string",
"examples": [
"https://api.github.com/organizations/1/team/1/members{/member}"
]
},
"name": {
"description": "Name of the team",
"type": "string",
"examples": [
"Justice League"
]
},
"description": {
"description": "Description of the team",
"type": [
"string",
"null"
],
"examples": [
"A great team."
]
},
"permission": {
"description": "Permission that the team will have for its repositories",
"type": "string",
"examples": [
"admin"
]
},
"privacy": {
"description": "The level of privacy this team should have",
"type": "string",
"examples": [
"closed"
]
},
"notification_setting": {
"description": "The notification setting the team has set",
"type": "string",
"examples": [
"notifications_enabled"
]
},
"html_url": {
"type": "string",
"format": "uri",
"examples": [
"https://github.com/orgs/rails/teams/core"
]
},
"repositories_url": {
"type": "string",
"format": "uri",
"examples": [
"https://api.github.com/organizations/1/team/1/repos"
]
},
"slug": {
"type": "string",
"examples": [
"justice-league"
]
},
"ldap_dn": {
"description": "Distinguished Name (DN) that team maps to within LDAP environment",
"type": "string",
"examples": [
"uid=example,ou=users,dc=github,dc=com"
]
}
},
"required": [
"id",
"node_id",
"url",
"members_url",
"name",
"description",
"permission",
"html_url",
"repositories_url",
"slug"
]
}
},
"name": {
"type": [
"string",
@@ -482799,7 +483111,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>To download the asset's binary content, set the <code>Accept</code> header of the request to <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\"><code>application/octet-stream</code></a>. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a <code>200</code> or <code>302</code> response.</p>",
"descriptionHTML": "<p>To download the asset's binary content:</p>\n<ul>\n<li>If within a browser, fetch the location specified in the <code>browser_download_url</code> key provided in the response.</li>\n<li>Alternatively, set the <code>Accept</code> header of the request to\n<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\"><code>application/octet-stream</code></a>.\nThe API will either redirect the client to the location, or stream it directly if possible.\nAPI clients should handle both a <code>200</code> or <code>302</code> response.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",

2
src/rest/data/ghes-3.10-2022-11-28/schema.json
View File

@@ -410448,7 +410448,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>To download the asset's binary content, set the <code>Accept</code> header of the request to <a href=\"https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\"><code>application/octet-stream</code></a>. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a <code>200</code> or <code>302</code> response.</p>",
"descriptionHTML": "<p>To download the asset's binary content:</p>\n<ul>\n<li>If within a browser, fetch the location specified in the <code>browser_download_url</code> key provided in the response.</li>\n<li>Alternatively, set the <code>Accept</code> header of the request to\n<a href=\"https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\"><code>application/octet-stream</code></a>.\nThe API will either redirect the client to the location, or stream it directly if possible.\nAPI clients should handle both a <code>200</code> or <code>302</code> response.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",

2
src/rest/data/ghes-3.11-2022-11-28/schema.json
View File

@@ -416322,7 +416322,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>To download the asset's binary content, set the <code>Accept</code> header of the request to <a href=\"https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\"><code>application/octet-stream</code></a>. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a <code>200</code> or <code>302</code> response.</p>",
"descriptionHTML": "<p>To download the asset's binary content:</p>\n<ul>\n<li>If within a browser, fetch the location specified in the <code>browser_download_url</code> key provided in the response.</li>\n<li>Alternatively, set the <code>Accept</code> header of the request to\n<a href=\"https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\"><code>application/octet-stream</code></a>.\nThe API will either redirect the client to the location, or stream it directly if possible.\nAPI clients should handle both a <code>200</code> or <code>302</code> response.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",

2
src/rest/data/ghes-3.12-2022-11-28/schema.json
View File

@@ -419193,7 +419193,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>To download the asset's binary content, set the <code>Accept</code> header of the request to <a href=\"https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\"><code>application/octet-stream</code></a>. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a <code>200</code> or <code>302</code> response.</p>",
"descriptionHTML": "<p>To download the asset's binary content:</p>\n<ul>\n<li>If within a browser, fetch the location specified in the <code>browser_download_url</code> key provided in the response.</li>\n<li>Alternatively, set the <code>Accept</code> header of the request to\n<a href=\"https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\"><code>application/octet-stream</code></a>.\nThe API will either redirect the client to the location, or stream it directly if possible.\nAPI clients should handle both a <code>200</code> or <code>302</code> response.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",

65
src/rest/data/ghes-3.13-2022-11-28/schema.json
View File

@@ -94088,7 +94088,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of <code>401 - Unauthorized</code>, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.</p>\n<p>Optionally, you can use the <code>repositories</code> or <code>repository_ids</code> body parameters to specify individual repositories that the installation access token can access. If you don't use <code>repositories</code> or <code>repository_ids</code> to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.</p>\n<p>Optionally, use the <code>permissions</code> body parameter to specify the permissions that the installation access token should have. If <code>permissions</code> is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.</p>\n<p>When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"descriptionHTML": "<p>Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of <code>401 - Unauthorized</code>, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.</p>\n<p>Optionally, you can use the <code>repositories</code> or <code>repository_ids</code> body parameters to specify individual repositories that the installation access token can access. If you don't use <code>repositories</code> or <code>repository_ids</code> to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.</p>\n<p>Optionally, use the <code>permissions</code> body parameter to specify the permissions that the installation access token should have. If <code>permissions</code> is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -326006,6 +326006,7 @@
{
"property_name": "environment",
"url": "https://api.github.com/orgs/github/properties/schema/environment",
"source_type": "organization",
"value_type": "single_select",
"required": true,
"default_value": "production",
@@ -326019,11 +326020,13 @@
{
"property_name": "service",
"url": "https://api.github.com/orgs/github/properties/schema/service",
"source_type": "organization",
"value_type": "string"
},
{
"property_name": "team",
"url": "https://api.github.com/orgs/github/properties/schema/team",
"source_type": "organization",
"value_type": "string",
"description": "Team owning the repository"
}
@@ -326044,6 +326047,17 @@
"format": "uri",
"description": "The URL that can be used to fetch, update, or delete info about this property via the API."
},
"source_type": {
"type": "string",
"description": "The source type of the property",
"enum": [
"organization",
"enterprise"
],
"examples": [
"organization"
]
},
"value_type": {
"type": "string",
"enum": [
@@ -326178,6 +326192,15 @@
"name": "url",
"description": "<p>The URL that can be used to fetch, update, or delete info about this property via the API.</p>"
},
{
"type": "string",
"name": "source_type",
"description": "<p>The source type of the property</p>",
"enum": [
"organization",
"enterprise"
]
},
{
"type": "string",
"name": "value_type",
@@ -326277,6 +326300,7 @@
{
"property_name": "environment",
"url": "https://api.github.com/orgs/github/properties/schema/environment",
"source_type": "organization",
"value_type": "single_select",
"required": true,
"default_value": "production",
@@ -326290,11 +326314,13 @@
{
"property_name": "service",
"url": "https://api.github.com/orgs/github/properties/schema/service",
"source_type": "organization",
"value_type": "string"
},
{
"property_name": "team",
"url": "https://api.github.com/orgs/github/properties/schema/team",
"source_type": "organization",
"value_type": "string",
"description": "Team owning the repository"
}
@@ -326315,6 +326341,17 @@
"format": "uri",
"description": "The URL that can be used to fetch, update, or delete info about this property via the API."
},
"source_type": {
"type": "string",
"description": "The source type of the property",
"enum": [
"organization",
"enterprise"
],
"examples": [
"organization"
]
},
"value_type": {
"type": "string",
"enum": [
@@ -326468,6 +326505,7 @@
"example": {
"property_name": "environment",
"url": "https://api.github.com/orgs/github/properties/schema/environment",
"source_type": "organization",
"value_type": "single_select",
"required": true,
"default_value": "production",
@@ -326491,6 +326529,17 @@
"format": "uri",
"description": "The URL that can be used to fetch, update, or delete info about this property via the API."
},
"source_type": {
"type": "string",
"description": "The source type of the property",
"enum": [
"organization",
"enterprise"
],
"examples": [
"organization"
]
},
"value_type": {
"type": "string",
"enum": [
@@ -326692,6 +326741,7 @@
"example": {
"property_name": "environment",
"url": "https://api.github.com/orgs/github/properties/schema/environment",
"source_type": "organization",
"value_type": "single_select",
"required": true,
"default_value": "production",
@@ -326715,6 +326765,17 @@
"format": "uri",
"description": "The URL that can be used to fetch, update, or delete info about this property via the API."
},
"source_type": {
"type": "string",
"description": "The source type of the property",
"enum": [
"organization",
"enterprise"
],
"examples": [
"organization"
]
},
"value_type": {
"type": "string",
"enum": [
@@ -421563,7 +421624,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>To download the asset's binary content, set the <code>Accept</code> header of the request to <a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\"><code>application/octet-stream</code></a>. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a <code>200</code> or <code>302</code> response.</p>",
"descriptionHTML": "<p>To download the asset's binary content:</p>\n<ul>\n<li>If within a browser, fetch the location specified in the <code>browser_download_url</code> key provided in the response.</li>\n<li>Alternatively, set the <code>Accept</code> header of the request to\n<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\"><code>application/octet-stream</code></a>.\nThe API will either redirect the client to the location, or stream it directly if possible.\nAPI clients should handle both a <code>200</code> or <code>302</code> response.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",

314
src/rest/data/ghes-3.14-2022-11-28/schema.json
View File

@@ -326018,6 +326018,7 @@
{
"property_name": "environment",
"url": "https://api.github.com/orgs/github/properties/schema/environment",
"source_type": "organization",
"value_type": "single_select",
"required": true,
"default_value": "production",
@@ -326031,11 +326032,13 @@
{
"property_name": "service",
"url": "https://api.github.com/orgs/github/properties/schema/service",
"source_type": "organization",
"value_type": "string"
},
{
"property_name": "team",
"url": "https://api.github.com/orgs/github/properties/schema/team",
"source_type": "organization",
"value_type": "string",
"description": "Team owning the repository"
}
@@ -326056,6 +326059,17 @@
"format": "uri",
"description": "The URL that can be used to fetch, update, or delete info about this property via the API."
},
"source_type": {
"type": "string",
"description": "The source type of the property",
"enum": [
"organization",
"enterprise"
],
"examples": [
"organization"
]
},
"value_type": {
"type": "string",
"enum": [
@@ -326190,6 +326204,15 @@
"name": "url",
"description": "<p>The URL that can be used to fetch, update, or delete info about this property via the API.</p>"
},
{
"type": "string",
"name": "source_type",
"description": "<p>The source type of the property</p>",
"enum": [
"organization",
"enterprise"
]
},
{
"type": "string",
"name": "value_type",
@@ -326289,6 +326312,7 @@
{
"property_name": "environment",
"url": "https://api.github.com/orgs/github/properties/schema/environment",
"source_type": "organization",
"value_type": "single_select",
"required": true,
"default_value": "production",
@@ -326302,11 +326326,13 @@
{
"property_name": "service",
"url": "https://api.github.com/orgs/github/properties/schema/service",
"source_type": "organization",
"value_type": "string"
},
{
"property_name": "team",
"url": "https://api.github.com/orgs/github/properties/schema/team",
"source_type": "organization",
"value_type": "string",
"description": "Team owning the repository"
}
@@ -326327,6 +326353,17 @@
"format": "uri",
"description": "The URL that can be used to fetch, update, or delete info about this property via the API."
},
"source_type": {
"type": "string",
"description": "The source type of the property",
"enum": [
"organization",
"enterprise"
],
"examples": [
"organization"
]
},
"value_type": {
"type": "string",
"enum": [
@@ -326480,6 +326517,7 @@
"example": {
"property_name": "environment",
"url": "https://api.github.com/orgs/github/properties/schema/environment",
"source_type": "organization",
"value_type": "single_select",
"required": true,
"default_value": "production",
@@ -326503,6 +326541,17 @@
"format": "uri",
"description": "The URL that can be used to fetch, update, or delete info about this property via the API."
},
"source_type": {
"type": "string",
"description": "The source type of the property",
"enum": [
"organization",
"enterprise"
],
"examples": [
"organization"
]
},
"value_type": {
"type": "string",
"enum": [
@@ -326704,6 +326753,7 @@
"example": {
"property_name": "environment",
"url": "https://api.github.com/orgs/github/properties/schema/environment",
"source_type": "organization",
"value_type": "single_select",
"required": true,
"default_value": "production",
@@ -326727,6 +326777,17 @@
"format": "uri",
"description": "The URL that can be used to fetch, update, or delete info about this property via the API."
},
"source_type": {
"type": "string",
"description": "The source type of the property",
"enum": [
"organization",
"enterprise"
],
"examples": [
"organization"
]
},
"value_type": {
"type": "string",
"enum": [
@@ -332626,6 +332687,34 @@
"null"
]
},
"base_role": {
"type": [
"string",
"null"
],
"description": "The system role from which this role inherits permissions.",
"enum": [
"read",
"triage",
"write",
"maintain",
"admin",
null
]
},
"source": {
"type": [
"string",
"null"
],
"description": "Source answers the question, \"where did this role come from?\"",
"enum": [
"Organization",
"Enterprise",
"Predefined",
null
]
},
"permissions": {
"description": "A list of permissions included in this role.",
"type": "array",
@@ -332974,6 +333063,34 @@
"null"
]
},
"base_role": {
"type": [
"string",
"null"
],
"description": "The system role from which this role inherits permissions.",
"enum": [
"read",
"triage",
"write",
"maintain",
"admin",
null
]
},
"source": {
"type": [
"string",
"null"
],
"description": "Source answers the question, \"where did this role come from?\"",
"enum": [
"Organization",
"Enterprise",
"Predefined",
null
]
},
"permissions": {
"description": "A list of permissions included in this role.",
"type": "array",
@@ -333741,6 +333858,34 @@
"null"
]
},
"base_role": {
"type": [
"string",
"null"
],
"description": "The system role from which this role inherits permissions.",
"enum": [
"read",
"triage",
"write",
"maintain",
"admin",
null
]
},
"source": {
"type": [
"string",
"null"
],
"description": "Source answers the question, \"where did this role come from?\"",
"enum": [
"Organization",
"Enterprise",
"Predefined",
null
]
},
"permissions": {
"description": "A list of permissions included in this role.",
"type": "array",
@@ -334087,6 +334232,34 @@
"null"
]
},
"base_role": {
"type": [
"string",
"null"
],
"description": "The system role from which this role inherits permissions.",
"enum": [
"read",
"triage",
"write",
"maintain",
"admin",
null
]
},
"source": {
"type": [
"string",
"null"
],
"description": "Source answers the question, \"where did this role come from?\"",
"enum": [
"Organization",
"Enterprise",
"Predefined",
null
]
},
"permissions": {
"description": "A list of permissions included in this role.",
"type": "array",
@@ -334473,6 +334646,18 @@
"description": "The Relationship a Team has with a role.",
"type": "object",
"properties": {
"assignment": {
"type": "string",
"description": "Determines if the team has a direct, indirect, or mixed relationship to a role",
"enum": [
"direct",
"indirect",
"mixed"
],
"examples": [
"direct"
]
},
"id": {
"type": "integer"
},
@@ -334800,6 +334985,133 @@
"description": "The Relationship a User has with a role.",
"type": "object",
"properties": {
"assignment": {
"type": "string",
"description": "Determines if the user has a direct, indirect, or mixed relationship to a role",
"enum": [
"direct",
"indirect",
"mixed"
],
"examples": [
"direct"
]
},
"inherited_from": {
"description": "Team the user has gotten the role through",
"type": "array",
"items": {
"title": "Team Simple",
"description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier of the team",
"type": "integer",
"examples": [
1
]
},
"node_id": {
"type": "string",
"examples": [
"MDQ6VGVhbTE="
]
},
"url": {
"description": "URL for the team",
"type": "string",
"format": "uri",
"examples": [
"https://api.github.com/organizations/1/team/1"
]
},
"members_url": {
"type": "string",
"examples": [
"https://api.github.com/organizations/1/team/1/members{/member}"
]
},
"name": {
"description": "Name of the team",
"type": "string",
"examples": [
"Justice League"
]
},
"description": {
"description": "Description of the team",
"type": [
"string",
"null"
],
"examples": [
"A great team."
]
},
"permission": {
"description": "Permission that the team will have for its repositories",
"type": "string",
"examples": [
"admin"
]
},
"privacy": {
"description": "The level of privacy this team should have",
"type": "string",
"examples": [
"closed"
]
},
"notification_setting": {
"description": "The notification setting the team has set",
"type": "string",
"examples": [
"notifications_enabled"
]
},
"html_url": {
"type": "string",
"format": "uri",
"examples": [
"https://github.com/orgs/rails/teams/core"
]
},
"repositories_url": {
"type": "string",
"format": "uri",
"examples": [
"https://api.github.com/organizations/1/team/1/repos"
]
},
"slug": {
"type": "string",
"examples": [
"justice-league"
]
},
"ldap_dn": {
"description": "Distinguished Name (DN) that team maps to within LDAP environment",
"type": "string",
"examples": [
"uid=example,ou=users,dc=github,dc=com"
]
}
},
"required": [
"id",
"node_id",
"url",
"members_url",
"name",
"description",
"permission",
"html_url",
"repositories_url",
"slug"
]
}
},
"name": {
"type": [
"string",
@@ -424561,7 +424873,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>To download the asset's binary content, set the <code>Accept</code> header of the request to <a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\"><code>application/octet-stream</code></a>. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a <code>200</code> or <code>302</code> response.</p>",
"descriptionHTML": "<p>To download the asset's binary content:</p>\n<ul>\n<li>If within a browser, fetch the location specified in the <code>browser_download_url</code> key provided in the response.</li>\n<li>Alternatively, set the <code>Accept</code> header of the request to\n<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\"><code>application/octet-stream</code></a>.\nThe API will either redirect the client to the location, or stream it directly if possible.\nAPI clients should handle both a <code>200</code> or <code>302</code> response.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",

314
src/rest/data/ghes-3.15-2022-11-28/schema.json
View File

@@ -330778,6 +330778,7 @@
{
"property_name": "environment",
"url": "https://api.github.com/orgs/github/properties/schema/environment",
"source_type": "organization",
"value_type": "single_select",
"required": true,
"default_value": "production",
@@ -330791,11 +330792,13 @@
{
"property_name": "service",
"url": "https://api.github.com/orgs/github/properties/schema/service",
"source_type": "organization",
"value_type": "string"
},
{
"property_name": "team",
"url": "https://api.github.com/orgs/github/properties/schema/team",
"source_type": "organization",
"value_type": "string",
"description": "Team owning the repository"
}
@@ -330816,6 +330819,17 @@
"format": "uri",
"description": "The URL that can be used to fetch, update, or delete info about this property via the API."
},
"source_type": {
"type": "string",
"description": "The source type of the property",
"enum": [
"organization",
"enterprise"
],
"examples": [
"organization"
]
},
"value_type": {
"type": "string",
"enum": [
@@ -330950,6 +330964,15 @@
"name": "url",
"description": "<p>The URL that can be used to fetch, update, or delete info about this property via the API.</p>"
},
{
"type": "string",
"name": "source_type",
"description": "<p>The source type of the property</p>",
"enum": [
"organization",
"enterprise"
]
},
{
"type": "string",
"name": "value_type",
@@ -331049,6 +331072,7 @@
{
"property_name": "environment",
"url": "https://api.github.com/orgs/github/properties/schema/environment",
"source_type": "organization",
"value_type": "single_select",
"required": true,
"default_value": "production",
@@ -331062,11 +331086,13 @@
{
"property_name": "service",
"url": "https://api.github.com/orgs/github/properties/schema/service",
"source_type": "organization",
"value_type": "string"
},
{
"property_name": "team",
"url": "https://api.github.com/orgs/github/properties/schema/team",
"source_type": "organization",
"value_type": "string",
"description": "Team owning the repository"
}
@@ -331087,6 +331113,17 @@
"format": "uri",
"description": "The URL that can be used to fetch, update, or delete info about this property via the API."
},
"source_type": {
"type": "string",
"description": "The source type of the property",
"enum": [
"organization",
"enterprise"
],
"examples": [
"organization"
]
},
"value_type": {
"type": "string",
"enum": [
@@ -331240,6 +331277,7 @@
"example": {
"property_name": "environment",
"url": "https://api.github.com/orgs/github/properties/schema/environment",
"source_type": "organization",
"value_type": "single_select",
"required": true,
"default_value": "production",
@@ -331263,6 +331301,17 @@
"format": "uri",
"description": "The URL that can be used to fetch, update, or delete info about this property via the API."
},
"source_type": {
"type": "string",
"description": "The source type of the property",
"enum": [
"organization",
"enterprise"
],
"examples": [
"organization"
]
},
"value_type": {
"type": "string",
"enum": [
@@ -331464,6 +331513,7 @@
"example": {
"property_name": "environment",
"url": "https://api.github.com/orgs/github/properties/schema/environment",
"source_type": "organization",
"value_type": "single_select",
"required": true,
"default_value": "production",
@@ -331487,6 +331537,17 @@
"format": "uri",
"description": "The URL that can be used to fetch, update, or delete info about this property via the API."
},
"source_type": {
"type": "string",
"description": "The source type of the property",
"enum": [
"organization",
"enterprise"
],
"examples": [
"organization"
]
},
"value_type": {
"type": "string",
"enum": [
@@ -337386,6 +337447,34 @@
"null"
]
},
"base_role": {
"type": [
"string",
"null"
],
"description": "The system role from which this role inherits permissions.",
"enum": [
"read",
"triage",
"write",
"maintain",
"admin",
null
]
},
"source": {
"type": [
"string",
"null"
],
"description": "Source answers the question, \"where did this role come from?\"",
"enum": [
"Organization",
"Enterprise",
"Predefined",
null
]
},
"permissions": {
"description": "A list of permissions included in this role.",
"type": "array",
@@ -337747,6 +337836,34 @@
"null"
]
},
"base_role": {
"type": [
"string",
"null"
],
"description": "The system role from which this role inherits permissions.",
"enum": [
"read",
"triage",
"write",
"maintain",
"admin",
null
]
},
"source": {
"type": [
"string",
"null"
],
"description": "Source answers the question, \"where did this role come from?\"",
"enum": [
"Organization",
"Enterprise",
"Predefined",
null
]
},
"permissions": {
"description": "A list of permissions included in this role.",
"type": "array",
@@ -338514,6 +338631,34 @@
"null"
]
},
"base_role": {
"type": [
"string",
"null"
],
"description": "The system role from which this role inherits permissions.",
"enum": [
"read",
"triage",
"write",
"maintain",
"admin",
null
]
},
"source": {
"type": [
"string",
"null"
],
"description": "Source answers the question, \"where did this role come from?\"",
"enum": [
"Organization",
"Enterprise",
"Predefined",
null
]
},
"permissions": {
"description": "A list of permissions included in this role.",
"type": "array",
@@ -338874,6 +339019,34 @@
"null"
]
},
"base_role": {
"type": [
"string",
"null"
],
"description": "The system role from which this role inherits permissions.",
"enum": [
"read",
"triage",
"write",
"maintain",
"admin",
null
]
},
"source": {
"type": [
"string",
"null"
],
"description": "Source answers the question, \"where did this role come from?\"",
"enum": [
"Organization",
"Enterprise",
"Predefined",
null
]
},
"permissions": {
"description": "A list of permissions included in this role.",
"type": "array",
@@ -339260,6 +339433,18 @@
"description": "The Relationship a Team has with a role.",
"type": "object",
"properties": {
"assignment": {
"type": "string",
"description": "Determines if the team has a direct, indirect, or mixed relationship to a role",
"enum": [
"direct",
"indirect",
"mixed"
],
"examples": [
"direct"
]
},
"id": {
"type": "integer"
},
@@ -339587,6 +339772,133 @@
"description": "The Relationship a User has with a role.",
"type": "object",
"properties": {
"assignment": {
"type": "string",
"description": "Determines if the user has a direct, indirect, or mixed relationship to a role",
"enum": [
"direct",
"indirect",
"mixed"
],
"examples": [
"direct"
]
},
"inherited_from": {
"description": "Team the user has gotten the role through",
"type": "array",
"items": {
"title": "Team Simple",
"description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier of the team",
"type": "integer",
"examples": [
1
]
},
"node_id": {
"type": "string",
"examples": [
"MDQ6VGVhbTE="
]
},
"url": {
"description": "URL for the team",
"type": "string",
"format": "uri",
"examples": [
"https://api.github.com/organizations/1/team/1"
]
},
"members_url": {
"type": "string",
"examples": [
"https://api.github.com/organizations/1/team/1/members{/member}"
]
},
"name": {
"description": "Name of the team",
"type": "string",
"examples": [
"Justice League"
]
},
"description": {
"description": "Description of the team",
"type": [
"string",
"null"
],
"examples": [
"A great team."
]
},
"permission": {
"description": "Permission that the team will have for its repositories",
"type": "string",
"examples": [
"admin"
]
},
"privacy": {
"description": "The level of privacy this team should have",
"type": "string",
"examples": [
"closed"
]
},
"notification_setting": {
"description": "The notification setting the team has set",
"type": "string",
"examples": [
"notifications_enabled"
]
},
"html_url": {
"type": "string",
"format": "uri",
"examples": [
"https://github.com/orgs/rails/teams/core"
]
},
"repositories_url": {
"type": "string",
"format": "uri",
"examples": [
"https://api.github.com/organizations/1/team/1/repos"
]
},
"slug": {
"type": "string",
"examples": [
"justice-league"
]
},
"ldap_dn": {
"description": "Distinguished Name (DN) that team maps to within LDAP environment",
"type": "string",
"examples": [
"uid=example,ou=users,dc=github,dc=com"
]
}
},
"required": [
"id",
"node_id",
"url",
"members_url",
"name",
"description",
"permission",
"html_url",
"repositories_url",
"slug"
]
}
},
"name": {
"type": [
"string",
@@ -429948,7 +430260,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>To download the asset's binary content, set the <code>Accept</code> header of the request to <a href=\"https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\"><code>application/octet-stream</code></a>. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a <code>200</code> or <code>302</code> response.</p>",
"descriptionHTML": "<p>To download the asset's binary content:</p>\n<ul>\n<li>If within a browser, fetch the location specified in the <code>browser_download_url</code> key provided in the response.</li>\n<li>Alternatively, set the <code>Accept</code> header of the request to\n<a href=\"https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\"><code>application/octet-stream</code></a>.\nThe API will either redirect the client to the location, or stream it directly if possible.\nAPI clients should handle both a <code>200</code> or <code>302</code> response.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",

2
src/rest/lib/config.json
View File

@@ -50,5 +50,5 @@
]
}
},
"sha": "c9cd73bd34f020305d23f5d3b63e3c59624f1537"
"sha": "a0508cecd18ab26b525527e4ba35bd9c6d725c4f"
}

18
src/webhooks/data/fpt/schema.json
View File

@@ -13239,6 +13239,15 @@
"name": "url",
"description": "<p>The URL that can be used to fetch, update, or delete info about this property via the API.</p>"
},
{
"type": "string",
"name": "source_type",
"description": "<p>The source type of the property</p>",
"enum": [
"organization",
"enterprise"
]
},
{
"type": "string",
"name": "value_type",
@@ -13418,6 +13427,15 @@
"name": "url",
"description": "<p>The URL that can be used to fetch, update, or delete info about this property via the API.</p>"
},
{
"type": "string",
"name": "source_type",
"description": "<p>The source type of the property</p>",
"enum": [
"organization",
"enterprise"
]
},
{
"type": "string",
"name": "value_type",

18
src/webhooks/data/ghec/schema.json
View File

@@ -15573,6 +15573,15 @@
"name": "url",
"description": "<p>The URL that can be used to fetch, update, or delete info about this property via the API.</p>"
},
{
"type": "string",
"name": "source_type",
"description": "<p>The source type of the property</p>",
"enum": [
"organization",
"enterprise"
]
},
{
"type": "string",
"name": "value_type",
@@ -15752,6 +15761,15 @@
"name": "url",
"description": "<p>The URL that can be used to fetch, update, or delete info about this property via the API.</p>"
},
{
"type": "string",
"name": "source_type",
"description": "<p>The source type of the property</p>",
"enum": [
"organization",
"enterprise"
]
},
{
"type": "string",
"name": "value_type",

2
src/webhooks/lib/config.json
View File

@@ -1,3 +1,3 @@
{
"sha": "c9cd73bd34f020305d23f5d3b63e3c59624f1537"
"sha": "a0508cecd18ab26b525527e4ba35bd9c6d725c4f"
}