[docs] Fix swagger operation descriptions (#3830)

* Fix swagger operation descriptions

Signed-off-by: mkljczk <git@mkljczk.pl>

* generate a swagger file

Signed-off-by: mkljczk <git@mkljczk.pl>

---------

Signed-off-by: mkljczk <git@mkljczk.pl>

docs/api/swagger.yaml

@@ -6990,6 +6990,34 @@ paths:
             tags:
                 - admin
     /api/v1/admin/instance/rules:
+        get:
+            description: The rules will be returned in order (sorted by Order ascending).
+            operationId: adminsRuleGet
+            produces:
+                - application/json
+            responses:
+                "200":
+                    description: An array with all the rules for the local instance.
+                    schema:
+                        items:
+                            $ref: '#/definitions/instanceRule'
+                        type: array
+                "400":
+                    description: bad request
+                "401":
+                    description: unauthorized
+                "404":
+                    description: not found
+                "406":
+                    description: not acceptable
+                "500":
+                    description: internal server error
+            security:
+                - OAuth2 Bearer:
+                    - admin
+            summary: View instance rules, with IDs.
+            tags:
+                - admin
         post:
             consumes:
                 - multipart/form-data
@@ -7062,6 +7090,37 @@ paths:
             summary: Delete an existing instance rule.
             tags:
                 - admin
+        get:
+            operationId: adminRuleGet
+            parameters:
+                - description: The id of the rule.
+                  in: path
+                  name: id
+                  required: true
+                  type: string
+            produces:
+                - application/json
+            responses:
+                "200":
+                    description: The requested rule.
+                    schema:
+                        $ref: '#/definitions/instanceRule'
+                "400":
+                    description: bad request
+                "401":
+                    description: unauthorized
+                "404":
+                    description: not found
+                "406":
+                    description: not acceptable
+                "500":
+                    description: internal server error
+            security:
+                - OAuth2 Bearer:
+                    - admin
+            summary: View instance rule with the given id.
+            tags:
+                - admin
         patch:
             consumes:
                 - multipart/form-data
@@ -7326,67 +7385,6 @@ paths:
             summary: Mark a report as resolved.
             tags:
                 - admin
-    /api/v1/admin/rules:
-        get:
-            description: The rules will be returned in order (sorted by Order ascending).
-            operationId: adminsRuleGet
-            produces:
-                - application/json
-            responses:
-                "200":
-                    description: An array with all the rules for the local instance.
-                    schema:
-                        items:
-                            $ref: '#/definitions/instanceRule'
-                        type: array
-                "400":
-                    description: bad request
-                "401":
-                    description: unauthorized
-                "404":
-                    description: not found
-                "406":
-                    description: not acceptable
-                "500":
-                    description: internal server error
-            security:
-                - OAuth2 Bearer:
-                    - admin
-            summary: View instance rules, with IDs.
-            tags:
-                - admin
-    /api/v1/admin/rules/{id}:
-        get:
-            operationId: adminRuleGet
-            parameters:
-                - description: The id of the rule.
-                  in: path
-                  name: id
-                  required: true
-                  type: string
-            produces:
-                - application/json
-            responses:
-                "200":
-                    description: The requested rule.
-                    schema:
-                        $ref: '#/definitions/instanceRule'
-                "400":
-                    description: bad request
-                "401":
-                    description: unauthorized
-                "404":
-                    description: not found
-                "406":
-                    description: not acceptable
-                "500":
-                    description: internal server error
-            security:
-                - OAuth2 Bearer:
-                    - admin
-            summary: View instance rule with the given id.
-            tags:
-                - admin
     /api/v1/announcements:
         get:
             description: 'THIS ENDPOINT IS CURRENTLY NOT FULLY IMPLEMENTED: it will always return an empty array.'

internal/api/client/admin/ruleget.go

@@ -27,7 +27,7 @@ import (
 	"github.com/superseriousbusiness/gotosocial/internal/oauth"
 )
 
-// RuleGETHandler swagger:operation GET /api/v1/admin/rules/{id} adminRuleGet
+// RuleGETHandler swagger:operation GET /api/v1/admin/instance/rules/{id} adminRuleGet
 //
 // View instance rule with the given id.
 //

internal/api/client/admin/rulesget.go

@@ -27,7 +27,7 @@ import (
 	"github.com/superseriousbusiness/gotosocial/internal/oauth"
 )
 
-// RulesGETHandler swagger:operation GET /api/v1/admin/rules adminsRuleGet
+// RulesGETHandler swagger:operation GET /api/v1/admin/instance/rules adminsRuleGet
 //
 // View instance rules, with IDs.
 //