Update OpenAPI Description (#37010)
Co-authored-by: Rachael Sewell <rachmari@github.com>
This commit is contained in:
docubot
@@ -74229,7 +74229,7 @@
|
||||
"type": "object",
|
||||
"name": "merge_group",
|
||||
"in": "body",
|
||||
"description": "",
|
||||
"description": "<p>A group of pull requests that the merge queue has grouped together to be merged.</p>",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
@@ -74259,92 +74259,72 @@
|
||||
{
|
||||
"type": "object",
|
||||
"name": "head_commit",
|
||||
"description": "",
|
||||
"description": "<p>A commit.</p>",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
"type": "object",
|
||||
"name": "author",
|
||||
"description": "<p>Metaproperties for Git author/committer information.</p>",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "date",
|
||||
"description": ""
|
||||
},
|
||||
{
|
||||
"type": "string or null",
|
||||
"name": "email",
|
||||
"description": "",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "name",
|
||||
"description": "<p>The git author's name.</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "username",
|
||||
"description": ""
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"name": "committer",
|
||||
"description": "<p>Metaproperties for Git author/committer information.</p>",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "date",
|
||||
"description": ""
|
||||
},
|
||||
{
|
||||
"type": "string or null",
|
||||
"name": "email",
|
||||
"description": "",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "name",
|
||||
"description": "<p>The git author's name.</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "username",
|
||||
"description": ""
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "id",
|
||||
"description": "",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "message",
|
||||
"description": "",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "timestamp",
|
||||
"description": "",
|
||||
"description": "<p>SHA for the commit</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "tree_id",
|
||||
"description": "",
|
||||
"description": "<p>SHA for the commit's tree</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "message",
|
||||
"description": "<p>Message describing the purpose of the commit</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "timestamp",
|
||||
"description": "<p>Timestamp of the commit</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "object or null",
|
||||
"name": "author",
|
||||
"description": "<p>Information about the Git author</p>",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "name",
|
||||
"description": "<p>Name of the commit's author</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "email",
|
||||
"description": "<p>Git email address of the commit's author</p>",
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "object or null",
|
||||
"name": "committer",
|
||||
"description": "<p>Information about the Git committer</p>",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "name",
|
||||
"description": "<p>Name of the commit's committer</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "email",
|
||||
"description": "<p>Git email address of the commit's committer</p>",
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -74377,6 +74357,172 @@
|
||||
],
|
||||
"action": "checks_requested",
|
||||
"category": "merge_group"
|
||||
},
|
||||
"destroyed": {
|
||||
"descriptionHtml": "<p>The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.</p>\n<p>When you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.</p>",
|
||||
"summaryHtml": "<p>This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"<a href=\"https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue\">Managing a merge queue</a>.\"</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.</p>\n<p><strong>Note</strong>: The pull request merge queue feature is currently in public beta and subject to change.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "action",
|
||||
"in": "body",
|
||||
"description": "",
|
||||
"isRequired": true,
|
||||
"enum": [
|
||||
"destroyed"
|
||||
],
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "reason",
|
||||
"in": "body",
|
||||
"description": "<p>Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated).</p>",
|
||||
"enum": [
|
||||
"merged",
|
||||
"invalidated",
|
||||
"dequeued"
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"name": "installation",
|
||||
"in": "body",
|
||||
"description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"name": "merge_group",
|
||||
"in": "body",
|
||||
"description": "<p>A group of pull requests that the merge queue has grouped together to be merged.</p>",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "head_sha",
|
||||
"description": "<p>The SHA of the merge group.</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "head_ref",
|
||||
"description": "<p>The full ref of the merge group.</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "base_sha",
|
||||
"description": "<p>The SHA of the merge group's parent commit.</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "base_ref",
|
||||
"description": "<p>The full ref of the branch the merge group will be merged into.</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"name": "head_commit",
|
||||
"description": "<p>A commit.</p>",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "id",
|
||||
"description": "<p>SHA for the commit</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "tree_id",
|
||||
"description": "<p>SHA for the commit's tree</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "message",
|
||||
"description": "<p>Message describing the purpose of the commit</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "timestamp",
|
||||
"description": "<p>Timestamp of the commit</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "object or null",
|
||||
"name": "author",
|
||||
"description": "<p>Information about the Git author</p>",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "name",
|
||||
"description": "<p>Name of the commit's author</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "email",
|
||||
"description": "<p>Git email address of the commit's author</p>",
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "object or null",
|
||||
"name": "committer",
|
||||
"description": "<p>Information about the Git committer</p>",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "name",
|
||||
"description": "<p>Name of the commit's committer</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "email",
|
||||
"description": "<p>Git email address of the commit's committer</p>",
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"name": "organization",
|
||||
"in": "body",
|
||||
"description": "<p>A GitHub organization.</p>",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"name": "repository",
|
||||
"in": "body",
|
||||
"description": "<p>A repository on GitHub.</p>",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"name": "sender",
|
||||
"in": "body",
|
||||
"description": "<p>A GitHub user.</p>",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
],
|
||||
"availability": [
|
||||
"app"
|
||||
],
|
||||
"action": "destroyed",
|
||||
"category": "merge_group"
|
||||
}
|
||||
},
|
||||
"meta": {
|
||||
|
||||
@@ -74229,7 +74229,7 @@
|
||||
"type": "object",
|
||||
"name": "merge_group",
|
||||
"in": "body",
|
||||
"description": "",
|
||||
"description": "<p>A group of pull requests that the merge queue has grouped together to be merged.</p>",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
@@ -74259,92 +74259,72 @@
|
||||
{
|
||||
"type": "object",
|
||||
"name": "head_commit",
|
||||
"description": "",
|
||||
"description": "<p>A commit.</p>",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
"type": "object",
|
||||
"name": "author",
|
||||
"description": "<p>Metaproperties for Git author/committer information.</p>",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "date",
|
||||
"description": ""
|
||||
},
|
||||
{
|
||||
"type": "string or null",
|
||||
"name": "email",
|
||||
"description": "",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "name",
|
||||
"description": "<p>The git author's name.</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "username",
|
||||
"description": ""
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"name": "committer",
|
||||
"description": "<p>Metaproperties for Git author/committer information.</p>",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "date",
|
||||
"description": ""
|
||||
},
|
||||
{
|
||||
"type": "string or null",
|
||||
"name": "email",
|
||||
"description": "",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "name",
|
||||
"description": "<p>The git author's name.</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "username",
|
||||
"description": ""
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "id",
|
||||
"description": "",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "message",
|
||||
"description": "",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "timestamp",
|
||||
"description": "",
|
||||
"description": "<p>SHA for the commit</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "tree_id",
|
||||
"description": "",
|
||||
"description": "<p>SHA for the commit's tree</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "message",
|
||||
"description": "<p>Message describing the purpose of the commit</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "timestamp",
|
||||
"description": "<p>Timestamp of the commit</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "object or null",
|
||||
"name": "author",
|
||||
"description": "<p>Information about the Git author</p>",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "name",
|
||||
"description": "<p>Name of the commit's author</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "email",
|
||||
"description": "<p>Git email address of the commit's author</p>",
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "object or null",
|
||||
"name": "committer",
|
||||
"description": "<p>Information about the Git committer</p>",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "name",
|
||||
"description": "<p>Name of the commit's committer</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "email",
|
||||
"description": "<p>Git email address of the commit's committer</p>",
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -74377,6 +74357,172 @@
|
||||
],
|
||||
"action": "checks_requested",
|
||||
"category": "merge_group"
|
||||
},
|
||||
"destroyed": {
|
||||
"descriptionHtml": "<p>The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.</p>\n<p>When you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.</p>",
|
||||
"summaryHtml": "<p>This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue\">Managing a merge queue</a>.\"</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.</p>\n<p><strong>Note</strong>: The pull request merge queue feature is currently in public beta and subject to change.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "action",
|
||||
"in": "body",
|
||||
"description": "",
|
||||
"isRequired": true,
|
||||
"enum": [
|
||||
"destroyed"
|
||||
],
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "reason",
|
||||
"in": "body",
|
||||
"description": "<p>Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated).</p>",
|
||||
"enum": [
|
||||
"merged",
|
||||
"invalidated",
|
||||
"dequeued"
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"name": "installation",
|
||||
"in": "body",
|
||||
"description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"name": "merge_group",
|
||||
"in": "body",
|
||||
"description": "<p>A group of pull requests that the merge queue has grouped together to be merged.</p>",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "head_sha",
|
||||
"description": "<p>The SHA of the merge group.</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "head_ref",
|
||||
"description": "<p>The full ref of the merge group.</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "base_sha",
|
||||
"description": "<p>The SHA of the merge group's parent commit.</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "base_ref",
|
||||
"description": "<p>The full ref of the branch the merge group will be merged into.</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"name": "head_commit",
|
||||
"description": "<p>A commit.</p>",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "id",
|
||||
"description": "<p>SHA for the commit</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "tree_id",
|
||||
"description": "<p>SHA for the commit's tree</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "message",
|
||||
"description": "<p>Message describing the purpose of the commit</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "timestamp",
|
||||
"description": "<p>Timestamp of the commit</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "object or null",
|
||||
"name": "author",
|
||||
"description": "<p>Information about the Git author</p>",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "name",
|
||||
"description": "<p>Name of the commit's author</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "email",
|
||||
"description": "<p>Git email address of the commit's author</p>",
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "object or null",
|
||||
"name": "committer",
|
||||
"description": "<p>Information about the Git committer</p>",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "name",
|
||||
"description": "<p>Name of the commit's committer</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "email",
|
||||
"description": "<p>Git email address of the commit's committer</p>",
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"name": "organization",
|
||||
"in": "body",
|
||||
"description": "<p>A GitHub organization.</p>",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"name": "repository",
|
||||
"in": "body",
|
||||
"description": "<p>A repository on GitHub.</p>",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"name": "sender",
|
||||
"in": "body",
|
||||
"description": "<p>A GitHub user.</p>",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
],
|
||||
"availability": [
|
||||
"app"
|
||||
],
|
||||
"action": "destroyed",
|
||||
"category": "merge_group"
|
||||
}
|
||||
},
|
||||
"meta": {
|
||||
|
||||
Reference in New Issue
Block a user