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

[feature] Implement /api/v1/reports endpoints on client API #1330

Merged
merged 16 commits into from
Jan 23, 2023

Conversation

tsmethurst
Copy link
Contributor

@tsmethurst tsmethurst commented Jan 12, 2023

Description

If this is a code change, please include a summary of what you've coded, and link to the issue(s) it closes/implements.

If this is a documentation change, please briefly describe what you've changed and why.

This pull request implements the following client API endpoints, as part of our upcoming report/flag functionality:

GET /api/v1/reports -- view all reports submitted by authenticated user. Parameters are available to filter which reports are returned, based on the query parameters here: https://docs.joinmastodon.org/methods/admin/reports/
GET /api/v1/reports/{id} -- view report by authenticated user with given ID
POST /api/v1/reports -- create a new user report

Some design comments:

  • The mastodon api supports setting category when submitting reports. I don't think this is a concept we really need, so I didn't include it. Reports will always have the default 'other' category.
  • The mastodon api also support submitting an integer array of rules that have been violated, when submitting reports. Since we don't have rules yet, I didn't implement this. We can add it in the future if we implement lists of rules.

While these endpoints create reports in the database, the side effects (emails, federation) are not yet handled. Will do this in an upcoming PR.

relates to #1309

Checklist

Please put an x inside each checkbox to indicate that you've read and followed it: [ ] -> [x]

If this is a documentation change, only the first checkbox must be filled (you can delete the others if you want).

  • I/we have read the GoToSocial contribution guidelines.
  • I/we have discussed the proposed changes already, either in an issue on the repository, or in the Matrix chat.
  • I/we have performed a self-review of added code.
  • I/we have written code that is legible and maintainable by others.
  • I/we have commented the added code, particularly in hard-to-understand areas.
  • I/we have made any necessary changes to documentation.
  • I/we have added tests that cover new code.
  • I/we have run tests and they pass locally with the changes.
  • I/we have run go fmt ./... and golangci-lint run.

@tsmethurst tsmethurst changed the title Report client api [feature] Implement /api/v1/reports endpoints on client API Jan 12, 2023
@tsmethurst tsmethurst merged commit e974724 into main Jan 23, 2023
@tsmethurst tsmethurst deleted the report_client_api branch January 23, 2023 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant