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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from
Jun 3, 2024

Conversation

kemzeb
Copy link
Contributor

@kemzeb kemzeb commented May 31, 2024

Resolves #31131.

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

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label May 31, 2024
@pull-request-size pull-request-size bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 31, 2024
@github-actions github-actions bot added modifies/api This PR adds API routes or modifies them modifies/go Pull requests that update Go code labels May 31, 2024
@kemzeb
Copy link
Contributor Author

kemzeb commented May 31, 2024

An example:

Screenshot 2024-05-30 220042

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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does add some duplication and takes a lot of horizontal space, but haven't found better ways of handling both of these concerns yet. Open to other ideas

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Normally inside a JSON schema, one would use $ref to deduplicate, but I'm almost sure go-swagger does not support ref definition in source annotations, at least I could not find anything regarding it on http://goswagger.io/go-swagger/.

@GiteaBot GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels May 31, 2024
@GiteaBot GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels May 31, 2024
@lunny lunny added the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Jun 3, 2024
@lunny lunny enabled auto-merge (squash) June 3, 2024 13:09
@lunny lunny merged commit cb27c43 into go-gitea:main Jun 3, 2024
26 checks passed
@GiteaBot GiteaBot added this to the 1.23.0 milestone Jun 3, 2024
@GiteaBot GiteaBot removed the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Jun 3, 2024
@kemzeb kemzeb deleted the api-add-action-types-to-user-feed-api branch June 3, 2024 17:45
zjjhot added a commit to zjjhot/gitea that referenced this pull request Jun 4, 2024
* giteaofficial/main:
  Add option for mailer to override mail headers (go-gitea#27860)
  Move custom `tw-` helpers to tailwind plugin (go-gitea#31184)
  Remove unnecessary inline style for tab-size (go-gitea#31224)
  Document possible action types for the user activity feed API (go-gitea#31196)
  Remove sqlite-viewer and using database client (go-gitea#31223)
  Update golangci-lint to v1.59.0 (go-gitea#31221)
@go-gitea go-gitea locked as resolved and limited conversation to collaborators Sep 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. modifies/api This PR adds API routes or modifies them modifies/go Pull requests that update Go code size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

What values can the op_type field take about the API /users/{username}/activities/feeds
5 participants