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

moved the /history endpoints to /me/history

Browse source 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
This commit is contained in:
Philip Molares 2020-06-06 22:51:13 +02:00 committed by David Mehren
parent bbc6b45735
commit 10020ede69
No known key found for this signature in database
GPG key ID: 185982BA4C42B7C3
1 changed files with 78 additions and 92 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

170
docs/dev/openapi.yml
View file

@ -136,20 +136,91 @@ paths:
responses:
'200':
description: The password was changed
/status:
/me/history:
get:
tags:
- server
summary: Returns the current status of the CodiMD instance.
operationId: getStatus
description: The data is returned as a JSON object containing the number of notes stored on the server, (distinct) online users and more.
- history
summary: Returns a list of the last viewed notes.
operationId: getHistory
description: The list is returned as a JSON object with an array containing for each entry it's id, title, tags, last visit time and pinned status.
responses:
'200':
description: The server info
description: The list of recently viewed notes and pinned notes
content:
application/json:
schema:
"$ref": "#/components/schemas/ServerStatus"
"$ref": "#/components/schemas/History"
post:
tags:
- history
summary: Sets the history if none is already set
operationId: updateHistory
requestBody:
description: The history to update
content:
application/json:
schema:
"$ref": "#/components/schemas/History"
responses:
'200':
description: The new history
content:
application/json:
schema:
"$ref": "#/components/schemas/History"
delete:
tags:
- history
summary: Clear the currently logged-in users history
operationId: deleteHistory
responses:
'200':
description: Deleted the history
content: {}
/me/history/{note}:
put:
tags:
- history
summary: Update the history object of the note (e.g change it's pin status)
operationId: updateHistoryObject
requestBody:
description: The updated history object
content:
application/json:
schema:
"$ref": "#/components/schemas/HistoryObject"
responses:
'200':
description: The new history
content:
application/json:
schema:
"$ref": "#/components/schemas/HistoryObject"
parameters:
- name: note
in: path
required: true
description: The note for which the revision should be shown
content:
text/plain:
example: my-note
delete:
tags:
- history
summary: Remove the note from the currently logged-in user's history
operationId: deleteHistoryObject
responses:
'200':
description: The new history
content: {}
parameters:
- name: note
in: path
required: true
description: The note for which the revision should be shown
content:
text/plain:
example: my-note
/notes:
post:
tags:
@ -457,91 +528,6 @@ paths:
content:
text/plain:
example: 1570921051959
/history:
get:
tags:
- history
summary: Returns a list of the last viewed notes.
operationId: getHistory
description: The list is returned as a JSON object with an array containing for each entry it's id, title, tags, last visit time and pinned status.
responses:
'200':
description: The list of recently viewed notes and pinned notes
content:
application/json:
schema:
"$ref": "#/components/schemas/History"
post:
tags:
- history
summary: Sets the history if none is already set
operationId: updateHistory
requestBody:
description: The history to update
content:
application/json:
schema:
"$ref": "#/components/schemas/History"
responses:
'200':
description: The new history
content:
application/json:
schema:
"$ref": "#/components/schemas/History"
delete:
tags:
- history
summary: Clear the currently logged-in users history
operationId: deleteHistory
responses:
'200':
description: Deleted the history
content: {}
/history/{note}:
put:
tags:
- history
summary: Update the history object of the note (e.g change it's pin status)
operationId: updateHistoryObject
requestBody:
description: The updated history object
content:
application/json:
schema:
"$ref": "#/components/schemas/HistoryObject"
responses:
'200':
description: The new history
content:
application/json:
schema:
"$ref": "#/components/schemas/HistoryObject"
parameters:
- name: note
in: path
required: true
description: The note for which the revision should be shown
content:
text/plain:
example: my-note
delete:
tags:
- history
summary: Remove the history object of the note
operationId: deleteHistoryObject
responses:
'200':
description: The new history
content: {}
parameters:
- name: note
in: path
required: true
description: The note for which the revision should be shown
content:
text/plain:
example: my-note
/config:
get:
tags: