Skip to content

Commit

Permalink
Document possible action types for the user activity feed API (#31196)
Browse files Browse the repository at this point in the history
Resolves #31131.

It uses the the go-swagger `enum` property to document the activity
action types.
  • Loading branch information
kemzeb authored Jun 3, 2024
1 parent fc641b3 commit cb27c43
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 2 deletions.
7 changes: 5 additions & 2 deletions modules/structs/activity.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,11 @@ package structs
import "time"

type Activity struct {
ID int64 `json:"id"`
UserID int64 `json:"user_id"` // Receiver user
ID int64 `json:"id"`
UserID int64 `json:"user_id"` // Receiver user
// the type of action
//
// enum: create_repo,rename_repo,star_repo,watch_repo,commit_repo,create_issue,create_pull_request,transfer_repo,push_tag,comment_issue,merge_pull_request,close_issue,reopen_issue,close_pull_request,reopen_pull_request,delete_tag,delete_branch,mirror_sync_push,mirror_sync_create,mirror_sync_delete,approve_pull_request,reject_pull_request,comment_pull,publish_release,pull_review_dismissed,pull_request_ready_for_review,auto_merge_pull_request
OpType string `json:"op_type"`
ActUserID int64 `json:"act_user_id"`
ActUser *User `json:"act_user"`
Expand Down
30 changes: 30 additions & 0 deletions templates/swagger/v1_json.tmpl

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit cb27c43

Please sign in to comment.