github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-22 17:56:30 -05:00
Code Issues Projects Releases Packages Wiki Activity

Public API: Cleanup history schemas

Browse source 
Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
This commit is contained in:
David Mehren 2020-10-24 19:39:34 +02:00
parent cfe8169fc2
commit b7195c563c
No known key found for this signature in database
GPG key ID: 185982BA4C42B7C3
1 changed files with 8 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/dev/public_api.yml
View file

@ -47,6 +47,8 @@ paths:
content: content:
application/json: application/json:
schema: schema:
type: array
items:
"$ref": "#/components/schemas/History" "$ref": "#/components/schemas/History"
'401': '401':
"$ref": "#/components/responses/UnauthorizedError" "$ref": "#/components/responses/UnauthorizedError"
@ -60,11 +62,11 @@ paths:
description: JSON Object which contains id, title, tags, last visit time and pinned status description: JSON Object which contains id, title, tags, last visit time and pinned status
responses: responses:
'200': '200':
description: The list of recently viewed notes and pinned notes. description: Information about the history entry
content: content:
application/json: application/json:
schema: schema:
"$ref": "#/components/schemas/HistoryObject" "$ref": "#/components/schemas/History"
'401': '401':
"$ref": "#/components/responses/UnauthorizedError" "$ref": "#/components/responses/UnauthorizedError"
'404': '404':
@ -88,7 +90,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
"$ref": "#/components/schemas/HistoryUpdateObject" "$ref": "#/components/schemas/HistoryUpdate"
responses: responses:
'200': '200':
description: The new history. description: The new history.
@ -853,7 +855,7 @@ components:
type: boolean type: boolean
disconnectSocketQueueLength: disconnectSocketQueueLength:
type: integer type: integer
HistoryObject: History:
type: object type: object
properties: properties:
metadata: metadata:
@ -861,20 +863,12 @@ components:
pinned: pinned:
type: boolean type: boolean
description: Whether the user has pinned this note. description: Whether the user has pinned this note.
HistoryUpdateObject: HistoryUpdate:
type: object type: object
properties: properties:
pinned: pinned:
type: boolean type: boolean
description: Whether the user has pinned this note. description: Whether the user has pinned this note.
History:
type: object
properties:
history:
type: array
description: The array that contains history objects.
items:
"$ref": "#/components/schemas/HistoryObject"
examples: examples:
markdownExample: markdownExample:
value: '# Some header\nSome normal text. **Some bold text**' value: '# Some header\nSome normal text. **Some bold text**'