From e9747247d58a0423d5e40fda5c5b37b4b4526495 Mon Sep 17 00:00:00 2001
From: tobi <31960611+tsmethurst@users.noreply.github.com>
Date: Mon, 23 Jan 2023 13:14:21 +0100
Subject: [feature] Implement `/api/v1/reports` endpoints on client API (#1330)
* start adding report client api
* route + test reports get
* start report create endpoint
* you can create reports now babyy
* stub account report processor
* add single reportGet endpoint
* fix test
* add more filtering params to /api/v1/reports GET
* update swagger
* use marshalIndent in tests
* add + test missing Link info
---
internal/api/client/reports/reportsget.go | 173 ++++++++++++++++++++++++++++++
1 file changed, 173 insertions(+)
create mode 100644 internal/api/client/reports/reportsget.go
(limited to 'internal/api/client/reports/reportsget.go')
diff --git a/internal/api/client/reports/reportsget.go b/internal/api/client/reports/reportsget.go
new file mode 100644
index 000000000..be2e01222
--- /dev/null
+++ b/internal/api/client/reports/reportsget.go
@@ -0,0 +1,173 @@
+/*
+ GoToSocial
+ Copyright (C) 2021-2023 GoToSocial Authors admin@gotosocial.org
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see .
+*/
+
+package reports
+
+import (
+ "fmt"
+ "net/http"
+ "strconv"
+
+ "github.com/gin-gonic/gin"
+ apiutil "github.com/superseriousbusiness/gotosocial/internal/api/util"
+ "github.com/superseriousbusiness/gotosocial/internal/gtserror"
+ "github.com/superseriousbusiness/gotosocial/internal/oauth"
+)
+
+// ReportsGETHandler swagger:operation GET /api/v1/reports reports
+//
+// See reports created by the requesting account.
+//
+// The reports will be returned in descending chronological order (newest first), with sequential IDs (bigger = newer).
+//
+// The next and previous queries can be parsed from the returned Link header.
+//
+// Example:
+//
+// ```
+// ; rel="next", ; rel="prev"
+// ````
+//
+// ---
+// tags:
+// - reports
+//
+// produces:
+// - application/json
+//
+// parameters:
+// -
+// name: resolved
+// type: boolean
+// description: >-
+// If set to true, only resolved reports will be returned.
+// If false, only unresolved reports will be returned.
+// If unset, reports will not be filtered on their resolved status.
+// in: query
+// -
+// name: target_account_id
+// type: string
+// description: Return only reports that target the given account id.
+// in: query
+// -
+// name: max_id
+// type: string
+// description: >-
+// Return only reports *OLDER* than the given max ID.
+// The report with the specified ID will not be included in the response.
+// in: query
+// -
+// name: since_id
+// type: string
+// description: >-
+// Return only reports *NEWER* than the given since ID.
+// The report with the specified ID will not be included in the response.
+// This parameter is functionally equivalent to min_id.
+// in: query
+// -
+// name: min_id
+// type: string
+// description: >-
+// Return only reports *NEWER* than the given min ID.
+// The report with the specified ID will not be included in the response.
+// This parameter is functionally equivalent to since_id.
+// in: query
+// -
+// name: limit
+// type: integer
+// description: >-
+// Number of reports to return.
+// If less than 1, will be clamped to 1.
+// If more than 100, will be clamped to 100.
+// default: 20
+// in: query
+//
+// security:
+// - OAuth2 Bearer:
+// - read:reports
+//
+// responses:
+// '200':
+// name: reports
+// description: Array of reports.
+// schema:
+// type: array
+// items:
+// "$ref": "#/definitions/report"
+// '400':
+// description: bad request
+// '401':
+// description: unauthorized
+// '404':
+// description: not found
+// '406':
+// description: not acceptable
+// '500':
+// description: internal server error
+func (m *Module) ReportsGETHandler(c *gin.Context) {
+ authed, err := oauth.Authed(c, true, true, true, true)
+ if err != nil {
+ apiutil.ErrorHandler(c, gtserror.NewErrorUnauthorized(err, err.Error()), m.processor.InstanceGet)
+ return
+ }
+
+ if _, err := apiutil.NegotiateAccept(c, apiutil.JSONAcceptHeaders...); err != nil {
+ apiutil.ErrorHandler(c, gtserror.NewErrorNotAcceptable(err, err.Error()), m.processor.InstanceGet)
+ return
+ }
+
+ var resolved *bool
+ if resolvedString := c.Query(ResolvedKey); resolvedString != "" {
+ i, err := strconv.ParseBool(resolvedString)
+ if err != nil {
+ err := fmt.Errorf("error parsing %s: %s", ResolvedKey, err)
+ apiutil.ErrorHandler(c, gtserror.NewErrorBadRequest(err, err.Error()), m.processor.InstanceGet)
+ return
+ }
+ resolved = &i
+ }
+
+ limit := 20
+ if limitString := c.Query(LimitKey); limitString != "" {
+ i, err := strconv.Atoi(limitString)
+ if err != nil {
+ err := fmt.Errorf("error parsing %s: %s", LimitKey, err)
+ apiutil.ErrorHandler(c, gtserror.NewErrorBadRequest(err, err.Error()), m.processor.InstanceGet)
+ return
+ }
+
+ // normalize
+ if i <= 0 {
+ i = 1
+ } else if i >= 100 {
+ i = 100
+ }
+ limit = i
+ }
+
+ resp, errWithCode := m.processor.ReportsGet(c.Request.Context(), authed, resolved, c.Query(TargetAccountIDKey), c.Query(MaxIDKey), c.Query(SinceIDKey), c.Query(MinIDKey), limit)
+ if errWithCode != nil {
+ apiutil.ErrorHandler(c, errWithCode, m.processor.InstanceGet)
+ return
+ }
+
+ if resp.LinkHeader != "" {
+ c.Header("Link", resp.LinkHeader)
+ }
+ c.JSON(http.StatusOK, resp.Items)
+}
--
cgit v1.2.3