diff options
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/swagger.yaml | 61 | 
1 files changed, 61 insertions, 0 deletions
diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml index 7fb3efe76..f9512b719 100644 --- a/docs/api/swagger.yaml +++ b/docs/api/swagger.yaml @@ -6745,6 +6745,67 @@ paths:              summary: Update a media attachment.              tags:                  - media +    /api/v1/mutes: +        get: +            description: |- +                NOT IMPLEMENTED YET: Will currently always return an array of length 0. + +                The next and previous queries can be parsed from the returned Link header. +                Example: + +                ``` +                <https://example.org/api/v1/mutes?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/mutes?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev" +                ```` +            operationId: mutesGet +            parameters: +                - description: 'Return only muted accounts *OLDER* than the given max ID. The muted account with the specified ID will not be included in the response. NOTE: the ID is of the internal mute, NOT any of the returned accounts.' +                  in: query +                  name: max_id +                  type: string +                - description: 'Return only muted accounts *NEWER* than the given since ID. The muted account with the specified ID will not be included in the response. NOTE: the ID is of the internal mute, NOT any of the returned accounts.' +                  in: query +                  name: since_id +                  type: string +                - description: 'Return only muted accounts *IMMEDIATELY NEWER* than the given min ID. The muted account with the specified ID will not be included in the response. NOTE: the ID is of the internal mute, NOT any of the returned accounts.' +                  in: query +                  name: min_id +                  type: string +                - default: 40 +                  description: Number of muted accounts to return. +                  in: query +                  maximum: 80 +                  minimum: 1 +                  name: limit +                  type: integer +            produces: +                - application/json +            responses: +                "200": +                    description: "" +                    headers: +                        Link: +                            description: Links to the next and previous queries. +                            type: string +                    schema: +                        items: +                            $ref: '#/definitions/account' +                        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: +                    - read:mutes +            summary: Get an array of accounts that requesting account has muted. +            tags: +                - mutes      /api/v1/notification/{id}:          get:              operationId: notification  | 
