Skip to content

Commit

Permalink
feat: description updates for the push event for GHES and GitHub.AE (…
Browse files Browse the repository at this point in the history 
…#574)
  • Loading branch information
@octokitbot
octokitbot committed Oct 7, 2021
1 parent 2f77c8a commit ff720a3
Show file tree
Hide file tree
Showing 4 changed files with 88 additions and 8 deletions.
24 changes: 22 additions & 2 deletions payload-examples/ghes-222/index.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19721,7 +19721,7 @@
"properties": {
"ref": {
"type": "string",
"description": "The full [`git ref`](https://docs.github.com/en/enterprise-server@2.22/rest/reference/git#refs) that was pushed. Example: `refs/heads/main`."
"description": "The full [`git ref`](https://docs.github.com/en/enterprise-server@2.22/rest/reference/git#refs) that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`."
},
"before": {
"type": "string",
Expand All @@ -19731,9 +19731,29 @@
"type": "string",
"description": "The SHA of the most recent commit on `ref` after the push."
},
"created": {
"type": "boolean",
"description": "Whether this push created the `ref`."
},
"deleted": {
"type": "boolean",
"description": "Whether this push deleted the `ref`."
},
"forced": {
"type": "boolean",
"description": "Whether this push was a force push of the `ref`."
},
"head_commit": {
"type": "object",
"description": "For pushes where `after` is or points to a commit object, an expanded representation of that commit. For pushes where `after` refers to an annotated tag object, an expanded representation of the commit pointed to by the annotated tag."
},
"compare": {
"type": "string",
"description": "URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit."
},
"commits": {
"type": "array",
"description": "An array of commit objects describing the pushed commits. (The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/en/enterprise-server@2.22/rest/reference/repos#commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.)"
"description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/en/enterprise-server@2.22/rest/reference/repos#commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries."
},
"commits[][id]": {
"type": "string",
Expand Down
24 changes: 22 additions & 2 deletions payload-examples/ghes-30/index.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19721,7 +19721,7 @@
"properties": {
"ref": {
"type": "string",
"description": "The full [`git ref`](https://docs.github.com/en/enterprise-server@3.0/rest/reference/git#refs) that was pushed. Example: `refs/heads/main`."
"description": "The full [`git ref`](https://docs.github.com/en/enterprise-server@3.0/rest/reference/git#refs) that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`."
},
"before": {
"type": "string",
Expand All @@ -19731,9 +19731,29 @@
"type": "string",
"description": "The SHA of the most recent commit on `ref` after the push."
},
"created": {
"type": "boolean",
"description": "Whether this push created the `ref`."
},
"deleted": {
"type": "boolean",
"description": "Whether this push deleted the `ref`."
},
"forced": {
"type": "boolean",
"description": "Whether this push was a force push of the `ref`."
},
"head_commit": {
"type": "object",
"description": "For pushes where `after` is or points to a commit object, an expanded representation of that commit. For pushes where `after` refers to an annotated tag object, an expanded representation of the commit pointed to by the annotated tag."
},
"compare": {
"type": "string",
"description": "URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit."
},
"commits": {
"type": "array",
"description": "An array of commit objects describing the pushed commits. (The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/en/enterprise-server@3.0/rest/reference/repos#commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.)"
"description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/en/enterprise-server@3.0/rest/reference/repos#commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries."
},
"commits[][id]": {
"type": "string",
Expand Down
24 changes: 22 additions & 2 deletions payload-examples/ghes-31/index.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7366,7 +7366,7 @@
"properties": {
"ref": {
"type": "string",
"description": "The full [`git ref`](https://docs.github.com/en/enterprise-server@3.1/rest/reference/git#refs) that was pushed. Example: `refs/heads/main`."
"description": "The full [`git ref`](https://docs.github.com/en/enterprise-server@3.1/rest/reference/git#refs) that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`."
},
"before": {
"type": "string",
Expand All @@ -7376,9 +7376,29 @@
"type": "string",
"description": "The SHA of the most recent commit on `ref` after the push."
},
"created": {
"type": "boolean",
"description": "Whether this push created the `ref`."
},
"deleted": {
"type": "boolean",
"description": "Whether this push deleted the `ref`."
},
"forced": {
"type": "boolean",
"description": "Whether this push was a force push of the `ref`."
},
"head_commit": {
"type": "object",
"description": "For pushes where `after` is or points to a commit object, an expanded representation of that commit. For pushes where `after` refers to an annotated tag object, an expanded representation of the commit pointed to by the annotated tag."
},
"compare": {
"type": "string",
"description": "URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit."
},
"commits": {
"type": "array",
"description": "An array of commit objects describing the pushed commits. (The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/en/enterprise-server@3.1/rest/reference/repos#commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.)"
"description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/en/enterprise-server@3.1/rest/reference/repos#commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries."
},
"commits[][id]": {
"type": "string",
Expand Down
24 changes: 22 additions & 2 deletions payload-examples/github.ae/index.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19746,7 +19746,7 @@
"properties": {
"ref": {
"type": "string",
"description": "The full [`git ref`](https://docs.github.com/en/github-ae@latest/rest/reference/git#refs) that was pushed. Example: `refs/heads/main`."
"description": "The full [`git ref`](https://docs.github.com/en/github-ae@latest/rest/reference/git#refs) that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`."
},
"before": {
"type": "string",
Expand All @@ -19756,9 +19756,29 @@
"type": "string",
"description": "The SHA of the most recent commit on `ref` after the push."
},
"created": {
"type": "boolean",
"description": "Whether this push created the `ref`."
},
"deleted": {
"type": "boolean",
"description": "Whether this push deleted the `ref`."
},
"forced": {
"type": "boolean",
"description": "Whether this push was a force push of the `ref`."
},
"head_commit": {
"type": "object",
"description": "For pushes where `after` is or points to a commit object, an expanded representation of that commit. For pushes where `after` refers to an annotated tag object, an expanded representation of the commit pointed to by the annotated tag."
},
"compare": {
"type": "string",
"description": "URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit."
},
"commits": {
"type": "array",
"description": "An array of commit objects describing the pushed commits. (The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/en/github-ae@latest/rest/reference/repos#commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.)"
"description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/en/github-ae@latest/rest/reference/repos#commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries."
},
"commits[][id]": {
"type": "string",
Expand Down

0 comments on commit ff720a3

Please sign in to comment.