Skip to content

Commit 07a392c

Browse files
bitwisemanbitwiseman
authored
Merge pull request #942 from seregamorph/feature/javadoc-references
Fix events javadoc references
2 parents bf67069 + 5b69de7 commit 07a392c

File tree

1 file changed

+72
-25
lines changed

1 file changed

+72
-25
lines changed

‎src/main/java/org/kohsuke/github/GHEventPayload.java‎

Lines changed: 72 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
*
1313
* @see GitHub#parseEventPayload(Reader, Class) GitHub#parseEventPayload(Reader, Class)
1414
* @see GHEventInfo#getPayload(Class) GHEventInfo#getPayload(Class)
15+
* @see <a href="https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads">Webhook events
16+
* and payloads</a>
1517
*/
1618
@SuppressWarnings("UnusedDeclaration")
1719
public abstract class GHEventPayload {
@@ -59,7 +61,9 @@ void wrapUp(GitHub root) {
5961
/**
6062
* A check run event has been created, rerequested, completed, or has a requested_action.
6163
*
62-
* @see <a href="https://developer.github.com/v3/activity/events/types/#checkrunevent">authoritative source</a>
64+
* @see <a href="https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#check_run">
65+
* check_run event</a>
66+
* @see <a href="https://docs.github.com/en/rest/reference/checks#check-runs">Check Runs</a>
6367
*/
6468
@SuppressFBWarnings(
6569
value = { "UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD" },
@@ -155,7 +159,9 @@ void wrapUp(GitHub root) {
155159
/**
156160
* A check suite event has been requested, rerequested or completed.
157161
*
158-
* @see <a href="https://developer.github.com/v3/activity/events/types/#checkrunevent">authoritative source</a>
162+
* @see <a href="https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#check_suite">
163+
* check_suite event</a>
164+
* @see <a href="https://docs.github.com/en/rest/reference/checks#check-suites">Check Suites</a>
159165
*/
160166
@SuppressFBWarnings(
161167
value = { "UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD" },
@@ -211,7 +217,10 @@ void wrapUp(GitHub root) {
211217
/**
212218
* An installation has been installed, uninstalled, or its permissions have been changed.
213219
*
214-
* @see <a href="https://developer.github.com/v3/activity/events/types/#installationevent">authoritative source</a>
220+
* @see <a href=
221+
* "https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#installation">
222+
* installation event</a>
223+
* @see <a href="https://docs.github.com/en/rest/reference/apps#installations">GitHub App Installation</a>
215224
*/
216225
@SuppressFBWarnings(value = { "UWF_UNWRITTEN_FIELD" }, justification = "JSON API")
217226
public static class Installation extends GHEventPayload {
@@ -271,8 +280,10 @@ void wrapUp(GitHub root) {
271280
/**
272281
* A repository has been added or removed from an installation.
273282
*
274-
* @see <a href="https://developer.github.com/v3/activity/events/types/#installationrepositoriesevent">authoritative
275-
* source</a>
283+
* @see <a href=
284+
* "https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#installation_repositories">
285+
* installation_repositories event</a>
286+
* @see <a href="https://docs.github.com/en/rest/reference/apps#installations">GitHub App installation</a>
276287
*/
277288
@SuppressFBWarnings(value = { "UWF_UNWRITTEN_FIELD" }, justification = "JSON API")
278289
public static class InstallationRepositories extends GHEventPayload {
@@ -358,7 +369,10 @@ void wrapUp(GitHub root) {
358369
/**
359370
* A pull request status has changed.
360371
*
361-
* @see <a href="http://developer.github.com/v3/activity/events/types/#pullrequestevent">authoritative source</a>
372+
* @see <a href=
373+
* "https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#pull_request">
374+
* pull_request event</a>
375+
* @see <a href="https://docs.github.com/en/rest/reference/pulls">Pull Requests</a>
362376
*/
363377
@SuppressFBWarnings(
364378
value = { "UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD" },
@@ -424,8 +438,10 @@ void wrapUp(GitHub root) {
424438
/**
425439
* A review was added to a pull request
426440
*
427-
* @see <a href="https://developer.github.com/v3/activity/events/types/#pullrequestreviewevent">authoritative
428-
* source</a>
441+
* @see <a href=
442+
* "https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#pull_request_review">
443+
* pull_request_review event</a>
444+
* @see <a href="https://docs.github.com/en/rest/reference/pulls#reviews">Pull Request Reviews</a>
429445
*/
430446
public static class PullRequestReview extends GHEventPayload {
431447
private String action;
@@ -490,8 +506,10 @@ void wrapUp(GitHub root) {
490506
/**
491507
* A review comment was added to a pull request
492508
*
493-
* @see <a href="https://developer.github.com/v3/activity/events/types/#pullrequestreviewcommentevent">authoritative
494-
* source</a>
509+
* @see <a href=
510+
* "https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#pull_request_review_comment">
511+
* pull_request_review_comment event</a>
512+
* @see <a href="https://docs.github.com/en/rest/reference/pulls#review-comments">Pull Request Review Comments</a>
495513
*/
496514
public static class PullRequestReviewComment extends GHEventPayload {
497515
private String action;
@@ -557,7 +575,9 @@ void wrapUp(GitHub root) {
557575
* A Issue has been assigned, unassigned, labeled, unlabeled, opened, edited, milestoned, demilestoned, closed, or
558576
* reopened.
559577
*
560-
* @see <a href="http://developer.github.com/v3/activity/events/types/#issueevent">authoritative source</a>
578+
* @see <a href="https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#issues">
579+
* issues events</a>
580+
* @see <a href="https://docs.github.com/en/rest/reference/issues#comments">Issues Comments</a>
561581
*/
562582
@SuppressFBWarnings(value = { "UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR", "NP_UNWRITTEN_FIELD" },
563583
justification = "Constructed by JSON deserialization")
@@ -629,7 +649,10 @@ void wrapUp(GitHub root) {
629649
/**
630650
* A comment was added to an issue
631651
*
632-
* @see <a href="http://developer.github.com/v3/activity/events/types/#issuecommentevent">authoritative source</a>
652+
* @see <a href=
653+
* "https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#issue_comment">
654+
* issue_comment event</a>
655+
* @see <a href="https://docs.github.com/en/rest/reference/issues#comments">Issue Comments</a>
633656
*/
634657
@SuppressFBWarnings(value = { "UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR", "NP_UNWRITTEN_FIELD" },
635658
justification = "Constructed by JSON deserialization")
@@ -722,7 +745,10 @@ void wrapUp(GitHub root) {
722745
/**
723746
* A comment was added to a commit
724747
*
725-
* @see <a href="http://developer.github.com/v3/activity/events/types/#commitcommentevent">authoritative source</a>
748+
* @see <a href=
749+
* "https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#commit_comment">
750+
* commit comment</a>
751+
* @see <a href="https://docs.github.com/en/rest/reference/repos#comments">Comments</a>
726752
*/
727753
@SuppressFBWarnings(value = { "UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR", "NP_UNWRITTEN_FIELD" },
728754
justification = "Constructed by JSON deserialization")
@@ -792,7 +818,9 @@ void wrapUp(GitHub root) {
792818
/**
793819
* A repository, branch, or tag was created
794820
*
795-
* @see <a href="http://developer.github.com/v3/activity/events/types/#createevent">authoritative source</a>
821+
* @see <a href="https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#create">
822+
* create event</a>
823+
* @see <a href="https://docs.github.com/en/rest/reference/git">Git data</a>
796824
*/
797825
@SuppressFBWarnings(value = { "UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR", "NP_UNWRITTEN_FIELD" },
798826
justification = "Constructed by JSON deserialization")
@@ -874,7 +902,9 @@ void wrapUp(GitHub root) {
874902
/**
875903
* A branch, or tag was deleted
876904
*
877-
* @see <a href="http://developer.github.com/v3/activity/events/types/#deleteevent">authoritative source</a>
905+
* @see <a href="https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#delete">
906+
* delete event</a>
907+
* @see <a href="https://docs.github.com/en/rest/reference/git">Git data</a>
878908
*/
879909
@SuppressFBWarnings(value = { "UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR", "NP_UNWRITTEN_FIELD" },
880910
justification = "Constructed by JSON deserialization")
@@ -934,7 +964,9 @@ void wrapUp(GitHub root) {
934964
/**
935965
* A deployment
936966
*
937-
* @see <a href="http://developer.github.com/v3/activity/events/types/#deploymentevent">authoritative source</a>
967+
* @see <a href="https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#deployment">
968+
* deployment event</a>
969+
* @see <a href="https://docs.github.com/en/rest/reference/repos#deployments">Deployments</a>
938970
*/
939971
@SuppressFBWarnings(value = { "UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR", "NP_UNWRITTEN_FIELD" },
940972
justification = "Constructed by JSON deserialization")
@@ -991,10 +1023,12 @@ void wrapUp(GitHub root) {
9911023
}
9921024

9931025
/**
994-
* A deployment
1026+
* A deployment status
9951027
*
996-
* @see <a href="http://developer.github.com/v3/activity/events/types/#deploymentstatusevent">authoritative
997-
* source</a>
1028+
* @see <a href=
1029+
* "https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#deployment_status">
1030+
* deployment_status event</a>
1031+
* @see <a href="https://docs.github.com/en/rest/reference/repos#deployments">Deployments</a>
9981032
*/
9991033
@SuppressFBWarnings(value = { "UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR", "NP_UNWRITTEN_FIELD" },
10001034
justification = "Constructed by JSON deserialization")
@@ -1074,7 +1108,9 @@ void wrapUp(GitHub root) {
10741108
/**
10751109
* A user forked a repository
10761110
*
1077-
* @see <a href="http://developer.github.com/v3/activity/events/types/#forkevent">authoritative source</a>
1111+
* @see <a href="https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#fork"> fork
1112+
* event</a>
1113+
* @see <a href="https://docs.github.com/en/rest/reference/repos#forks">Forks</a>
10781114
*/
10791115
@SuppressFBWarnings(value = { "UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR", "NP_UNWRITTEN_FIELD" },
10801116
justification = "Constructed by JSON deserialization")
@@ -1132,6 +1168,9 @@ void wrapUp(GitHub root) {
11321168

11331169
/**
11341170
* A ping.
1171+
*
1172+
* <a href="https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#ping"> ping
1173+
* event</a>
11351174
*/
11361175
public static class Ping extends GHEventPayload {
11371176
private GHRepository repository;
@@ -1190,7 +1229,8 @@ void wrapUp(GitHub root) {
11901229
/**
11911230
* A repository was made public.
11921231
*
1193-
* @see <a href="http://developer.github.com/v3/activity/events/types/#publicevent">authoritative source</a>
1232+
* @see <a href="https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#public">
1233+
* public event</a>
11941234
*/
11951235
public static class Public extends GHEventPayload {
11961236
private GHRepository repository;
@@ -1226,7 +1266,8 @@ void wrapUp(GitHub root) {
12261266
/**
12271267
* A commit was pushed.
12281268
*
1229-
* @see <a href="http://developer.github.com/v3/activity/events/types/#pushevent">authoritative source</a>
1269+
* @see <a href="https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#push"> push
1270+
* event</a>
12301271
*/
12311272
@SuppressFBWarnings(
12321273
value = { "UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR", "NP_UNWRITTEN_FIELD", "UUF_UNUSED_FIELD" },
@@ -1499,7 +1540,9 @@ public List<String> getModified() {
14991540
/**
15001541
* A release was added to the repo
15011542
*
1502-
* @see <a href="http://developer.github.com/v3/activity/events/types/#releaseevent">authoritative source</a>
1543+
* @see <a href="https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#release">
1544+
* release event</a>
1545+
* @see <a href="https://docs.github.com/en/rest/reference/repos#releases">Releases</a>
15031546
*/
15041547
@SuppressFBWarnings(value = { "UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR", "NP_UNWRITTEN_FIELD" },
15051548
justification = "Constructed by JSON deserialization")
@@ -1568,7 +1611,9 @@ void wrapUp(GitHub root) {
15681611
/**
15691612
* A repository was created, deleted, made public, or made private.
15701613
*
1571-
* @see <a href="http://developer.github.com/v3/activity/events/types/#repositoryevent">authoritative source</a>
1614+
* @see <a href="https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#repository">
1615+
* repository event</a>
1616+
* @see <a href="https://docs.github.com/en/rest/reference/repos">Repositories</a>
15721617
*/
15731618
@SuppressFBWarnings(
15741619
value = { "UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR", "NP_UNWRITTEN_FIELD", "UWF_UNWRITTEN_FIELD" },
@@ -1638,7 +1683,9 @@ void wrapUp(GitHub root) {
16381683
/**
16391684
* A git commit status was changed.
16401685
*
1641-
* @see <a href="https://developer.github.com/v3/activity/events/types/#statusevent">authoritative source</a>
1686+
* @see <a href="https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#status">
1687+
* status event</a>
1688+
* @see <a href="https://docs.github.com/en/rest/reference/repos#statuses">Repository Statuses</a>
16421689
*/
16431690
@SuppressFBWarnings(value = { "UWF_UNWRITTEN_FIELD" }, justification = "Constructed by JSON deserialization")
16441691
public static class Status extends GHEventPayload {

0 commit comments

Comments
 (0)