diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/swagger.yaml | 139 |
1 files changed, 69 insertions, 70 deletions
diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml index 839793f82..cbd68532f 100644 --- a/docs/api/swagger.yaml +++ b/docs/api/swagger.yaml @@ -4517,7 +4517,34 @@ paths: description: internal server error tags: - instance - /api/v1/list: + /api/v1/lists: + get: + operationId: lists + produces: + - application/json + responses: + "200": + description: Array of all lists owned by the requesting user. + schema: + items: + $ref: '#/definitions/list' + 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:lists + summary: Get all lists for owned by authorized user. + tags: + - lists post: consumes: - application/json @@ -4568,48 +4595,24 @@ paths: summary: Create a new list. tags: - lists - put: - consumes: - - application/json - - application/xml - - application/x-www-form-urlencoded - operationId: listUpdate + /api/v1/lists/{id}: + delete: + operationId: listDelete parameters: - description: ID of the list - example: Cool People in: path name: id required: true type: string - x-go-name: Title - - description: Title of this list. - example: Cool People - in: formData - name: title - type: string - x-go-name: RepliesPolicy - - description: |- - RepliesPolicy for this list. - followed = Show replies to any followed user - list = Show replies to members of the list - none = Show replies to no one - example: list - in: formData - name: replies_policy - type: string produces: - application/json responses: "200": - description: The newly updated list. - schema: - $ref: '#/definitions/list' + description: list deleted "400": description: bad request "401": description: unauthorized - "403": - description: forbidden "404": description: not found "406": @@ -4619,12 +4622,11 @@ paths: security: - OAuth2 Bearer: - write:lists - summary: Update an existing list. + summary: Delete a single list with the given ID. tags: - lists - /api/v1/list/{id}: - delete: - operationId: listDelete + get: + operationId: list parameters: - description: ID of the list in: path @@ -4635,7 +4637,9 @@ paths: - application/json responses: "200": - description: list deleted + description: Requested list. + schema: + $ref: '#/definitions/list' "400": description: bad request "401": @@ -4648,29 +4652,52 @@ paths: description: internal server error security: - OAuth2 Bearer: - - write:lists - summary: Delete a single list with the given ID. + - read:lists + summary: Get a single list with the given ID. tags: - lists - get: - operationId: list + put: + consumes: + - application/json + - application/xml + - application/x-www-form-urlencoded + operationId: listUpdate parameters: - description: ID of the list + example: Cool People in: path name: id required: true type: string + x-go-name: Title + - description: Title of this list. + example: Cool People + in: formData + name: title + type: string + x-go-name: RepliesPolicy + - description: |- + RepliesPolicy for this list. + followed = Show replies to any followed user + list = Show replies to members of the list + none = Show replies to no one + example: list + in: formData + name: replies_policy + type: string produces: - application/json responses: "200": - description: Requested list. + description: The newly updated list. schema: $ref: '#/definitions/list' "400": description: bad request "401": description: unauthorized + "403": + description: forbidden "404": description: not found "406": @@ -4679,11 +4706,11 @@ paths: description: internal server error security: - OAuth2 Bearer: - - read:lists - summary: Get a single list with the given ID. + - write:lists + summary: Update an existing list. tags: - lists - /api/v1/list/{id}/accounts: + /api/v1/lists/{id}/accounts: delete: consumes: - application/json @@ -4826,34 +4853,6 @@ paths: summary: Add one or more accounts to the given list. tags: - lists - /api/v1/lists: - get: - operationId: lists - produces: - - application/json - responses: - "200": - description: Array of all lists owned by the requesting user. - schema: - items: - $ref: '#/definitions/list' - 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:lists - summary: Get all lists for owned by authorized user. - tags: - - lists /api/v1/media/{id}: get: operationId: mediaGet |