mirrors
/
forgejo
mirror of
1
Fork 0
Code Issues Releases Activity

Document possible action types for the user activity feed API (#31196) 

Resolves #31131.

It uses the the go-swagger `enum` property to document the activity
action types.

(cherry picked from commit cb27c438a82fec9f2476f6058bc5dcda2617aab5)
This commit is contained in:
Kemal Zebari 2024-06-03 06:40:48 -07:00 committed by Earl Warren
parent 3befabead0
commit 90753a2c11
No known key found for this signature in database
GPG Key ID: 0579CB2928A78A00
2 changed files with 35 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
modules/structs/activity.go
View File

@ -6,8 +6,11 @@ package structs
import "time" import "time"
type Activity struct { type Activity struct {
ID int64 `json:"id"` ID int64 `json:"id"`
UserID int64 `json:"user_id"` // Receiver user 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"` OpType string `json:"op_type"`
ActUserID int64 `json:"act_user_id"` ActUserID int64 `json:"act_user_id"`
ActUser *User `json:"act_user"` ActUser *User `json:"act_user"`

30
templates/swagger/v1_json.tmpl generated
View File

@ -18537,7 +18537,37 @@
"x-go-name": "IsPrivate" "x-go-name": "IsPrivate"
}, },
"op_type": { "op_type": {
"description": "the type of action",
"type": "string", "type": "string",
"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"
],
"x-go-name": "OpType" "x-go-name": "OpType"
}, },
"ref_name": { "ref_name": {