Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add missing title to ProjectsV2Item schema, description updates #632

Merged
merged 7 commits into from
Jun 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 12 additions & 121 deletions cache/api.github.com/webhook-events-and-payloads.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,7 @@ <h1 class="border-bottom-0">Webhook events and payloads</h1>
</div>
</div>
<div
class="
Box-sc-1gh2r6s-0
sc-gsDKAQ
ehctan
iGLrsy
border-bottom border-xl-0
pb-4
mb-5
pb-xl-0
mb-xl-0
"
class="Box-sc-1gh2r6s-0 sc-gsDKAQ ehctan iGLrsy border-bottom border-xl-0 pb-4 mb-5 pb-xl-0 mb-xl-0"
>
<h2 id="in-this-article" class="Heading-sc-1irtotl-0 cTXFFN mb-1">
<a
Expand Down Expand Up @@ -1124,16 +1114,7 @@ <h2 id="webhook-payload-object-common-properties">
payload contains more detailed information.
</p>
<div
class="
extended-markdown
tip
border
rounded-1
mb-4
p-3
color-border-accent-emphasis color-bg-accent
f5
"
class="extended-markdown tip border rounded-1 mb-4 p-3 color-border-accent-emphasis color-bg-accent f5"
>
<p>
<strong>Note:</strong> Payloads are capped at 25 MB. If your event
Expand Down Expand Up @@ -1680,16 +1661,7 @@ <h2 id="check_run">
>" REST API.
</p>
<div
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-accent-emphasis color-bg-accent
f5
"
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-accent-emphasis color-bg-accent f5"
>
<p>
<strong>Note:</strong> The Checks API only looks for pushes in the
Expand Down Expand Up @@ -2323,16 +2295,7 @@ <h2 id="check_suite">
>" REST API.
</p>
<div
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-accent-emphasis color-bg-accent
f5
"
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-accent-emphasis color-bg-accent f5"
>
<p>
<strong>Note:</strong> The Checks API only looks for pushes in the
Expand Down Expand Up @@ -3560,16 +3523,7 @@ <h2 id="create">
>" REST API.
</p>
<div
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-accent-emphasis color-bg-accent
f5
"
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-accent-emphasis color-bg-accent f5"
>
<p>
<strong>Note:</strong> You will not receive a webhook for this event
Expand Down Expand Up @@ -3902,16 +3856,7 @@ <h2 id="delete">
>" REST API.
</p>
<div
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-accent-emphasis color-bg-accent
f5
"
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-accent-emphasis color-bg-accent f5"
>
<p>
<strong>Note:</strong> You will not receive a webhook for this event
Expand Down Expand Up @@ -5257,16 +5202,7 @@ <h2 id="discussion">
>discussion
</h2>
<div
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-accent-emphasis color-bg-accent
f5
"
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-accent-emphasis color-bg-accent f5"
>
<p>
<strong>Note:</strong> Webhook events for GitHub Discussions are
Expand Down Expand Up @@ -5639,16 +5575,7 @@ <h2 id="discussion_comment">
>discussion_comment
</h2>
<div
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-accent-emphasis color-bg-accent
f5
"
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-accent-emphasis color-bg-accent f5"
>
<p>
<strong>Note:</strong> Webhook events for GitHub Discussions are
Expand Down Expand Up @@ -11821,16 +11748,7 @@ <h3 id="availability-30">
</li>
</ul>
<div
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-accent-emphasis color-bg-accent
f5
"
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-accent-emphasis color-bg-accent f5"
>
<p>
<strong>Note</strong>: This event does not occur for Projects (beta).
Expand Down Expand Up @@ -12199,16 +12117,7 @@ <h3 id="availability-31">
</li>
</ul>
<div
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-accent-emphasis color-bg-accent
f5
"
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-accent-emphasis color-bg-accent f5"
>
<p>
<strong>Note</strong>: This event does not occur for Projects (beta).
Expand Down Expand Up @@ -12880,16 +12789,7 @@ <h2 id="projects_v2_item">
>projects_v2_item
</h2>
<div
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-accent-emphasis color-bg-accent
f5
"
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-accent-emphasis color-bg-accent f5"
>
<p>
<strong>Note:</strong> Webhook events for Projects (beta) are
Expand Down Expand Up @@ -16259,16 +16159,7 @@ <h2 id="push">
</h2>
<p>One or more commits are pushed to a repository branch or tag.</p>
<div
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-accent-emphasis color-bg-accent
f5
"
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-accent-emphasis color-bg-accent f5"
>
<p>
<strong>Note:</strong> You will not receive a webhook for this event
Expand Down
29 changes: 27 additions & 2 deletions payload-examples/ghes-31/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@
},
"ref_type": {
"type": "string",
"description": "The type of Git ref oject deleted in the repository. Can be `branch` or `tag`."
"description": "The type of Git ref object deleted in the repository. Can be either `branch` or `tag`."
},
"pusher_type": {
"type": "string",
Expand Down Expand Up @@ -1656,7 +1656,32 @@
{
"name": "workflow_dispatch",
"description": "This event occurs when someone triggers a workflow run on GitHub or sends a `POST` request to the \"[Create a workflow dispatch event](https://docs.github.com/en/enterprise-server@3.1/rest/reference/actions/#create-a-workflow-dispatch-event)\" endpoint. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/enterprise-server@3.1/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"",
"properties": {},
"properties": {
"inputs": {
"type": "object",
"description": "Inputs to the workflow. Each key represents the name of the input while it's value represents the value of that input."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.1/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"ref": {
"type": "string",
"description": "The branch ref from which the workflow was run."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.1/rest/reference/repos#get-a-repository) where the event occurred."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
},
"workflow": {
"type": "string",
"description": "Relative path to the workflow file which contains the workflow."
}
},
"actions": [],
"examples": []
},
Expand Down
29 changes: 27 additions & 2 deletions payload-examples/ghes-32/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@
},
"ref_type": {
"type": "string",
"description": "The type of Git ref oject deleted in the repository. Can be `branch` or `tag`."
"description": "The type of Git ref object deleted in the repository. Can be either `branch` or `tag`."
},
"pusher_type": {
"type": "string",
Expand Down Expand Up @@ -1656,7 +1656,32 @@
{
"name": "workflow_dispatch",
"description": "This event occurs when someone triggers a workflow run on GitHub or sends a `POST` request to the \"[Create a workflow dispatch event](https://docs.github.com/en/enterprise-server@3.2/rest/reference/actions/#create-a-workflow-dispatch-event)\" endpoint. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/enterprise-server@3.2/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"",
"properties": {},
"properties": {
"inputs": {
"type": "object",
"description": "Inputs to the workflow. Each key represents the name of the input while it's value represents the value of that input."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.2/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"ref": {
"type": "string",
"description": "The branch ref from which the workflow was run."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.2/rest/reference/repos#get-a-repository) where the event occurred."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
},
"workflow": {
"type": "string",
"description": "Relative path to the workflow file which contains the workflow."
}
},
"actions": [],
"examples": []
},
Expand Down
29 changes: 27 additions & 2 deletions payload-examples/ghes-33/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@
},
"ref_type": {
"type": "string",
"description": "The type of Git ref oject deleted in the repository. Can be `branch` or `tag`."
"description": "The type of Git ref object deleted in the repository. Can be either `branch` or `tag`."
},
"pusher_type": {
"type": "string",
Expand Down Expand Up @@ -1684,7 +1684,32 @@
{
"name": "workflow_dispatch",
"description": "This event occurs when someone triggers a workflow run on GitHub or sends a `POST` request to the \"[Create a workflow dispatch event](https://docs.github.com/en/enterprise-server@3.3/rest/reference/actions/#create-a-workflow-dispatch-event)\" endpoint. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/enterprise-server@3.3/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"",
"properties": {},
"properties": {
"inputs": {
"type": "object",
"description": "Inputs to the workflow. Each key represents the name of the input while it's value represents the value of that input."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"ref": {
"type": "string",
"description": "The branch ref from which the workflow was run."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
},
"workflow": {
"type": "string",
"description": "Relative path to the workflow file which contains the workflow."
}
},
"actions": [],
"examples": []
},
Expand Down
Loading