Skip to content

Commit

Permalink
style: sync remaining differences with 'merkl' API spec
Browse files Browse the repository at this point in the history
This also adds an "operation id" for `/merkl/categories`.

Refs: ZO-6181
  • Loading branch information
witsch committed Sep 9, 2024
1 parent 2fe7da1 commit 991a88d
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/api/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ paths:
$ref: "#/components/schemas/bookmark"
description: "Return list of bookmarks, optionally filtered by category"
"400":
description: "Something was wrong with the request to get bookmarks. Check the body for error messages."
description: "Something went wrong with the request to get bookmarks. Check the body for error messages."
"401":
description: "Unauthorized (to get bookmarks)"
"503":
Expand All @@ -99,7 +99,7 @@ paths:
tags:
- bookmarks
requestBody:
description: Save new bookmark bookmarks endpoint, UUID is required.
description: Add the given UUID to bookmarks
required: true
content:
application/json:
Expand Down Expand Up @@ -157,7 +157,7 @@ paths:
"403":
description: "Forbidden (to delete bookmark)"
"502":
description: "Bad gateway to delete a bookmark"
description: "Bad gateway (when deleting bookmark)"
"503":
description: "Service unavailable (when deleting bookmarks)"

Expand All @@ -166,7 +166,8 @@ paths:
security:
- cookieAuthProduction: []
- cookieAuthStaging: []
summary: "Returns the bookmark categories"
operationId: getCategories
description: Return list of all bookmark categories
tags:
- categories
responses:
Expand Down

0 comments on commit 991a88d

Please sign in to comment.