github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-25 11:16:31 -05:00
Code Issues Projects Releases Packages Wiki Activity

Public API: Simplify PUT /me/history/{note}

Browse source 
Previously, one had to send a complete `NoteMetadata` object when updating the pinned status of a note. A new `HistoryUpdateObject` type was introduced, that only contains the pinned status boolean.

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-03 12:49:50 +02:00
parent 2c9ccad8e5
commit ee0d85bc85
No known key found for this signature in database
GPG key ID: 185982BA4C42B7C3
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/dev/public_api.yml
View file

@ -88,7 +88,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
"$ref": "#/components/schemas/HistoryObject" "$ref": "#/components/schemas/HistoryUpdateObject"
responses: responses:
'200': '200':
description: The new history. description: The new history.
@ -936,6 +936,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:
type: object
properties:
pinned:
type: boolean
description: Whether the user has pinned this note.
History: History:
type: object type: object
properties: properties: