mirrors/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-05-13 06:34:39 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

response codes are strings now

Browse source 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
This commit is contained in:
Philip Molares 2020-05-28 22:19:15 +02:00 • committed by David Mehren
parent 83e8331b3e
commit b8ccc800ad
No known key found for this signature in database
GPG key ID: 185982BA4C42B7C3
1 changed files with 35 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

70
docs/dev/openapi.yml
View file

@ -29,7 +29,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/EmailLogin' $ref: '#/components/schemas/EmailLogin'
responses: responses:
200: '200':
description: login succesful description: login succesful
headers: headers:
Set-Cookie: Set-Cookie:
@ -48,7 +48,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/LdapLogin' $ref: '#/components/schemas/LdapLogin'
responses: responses:
200: '200':
description: login succesful description: login succesful
headers: headers:
Set-Cookie: Set-Cookie:
@ -67,7 +67,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/OpenIdLogin' $ref: '#/components/schemas/OpenIdLogin'
responses: responses:
200: '200':
description: login succesful description: login succesful
headers: headers:
Set-Cookie: Set-Cookie:
@ -80,13 +80,13 @@ paths:
summary: Get the user information of the currently logged in user summary: Get the user information of the currently logged in user
operationId: getMe operationId: getMe
responses: responses:
200: '200':
description: the user information description: the user information
content: content:
application/json: application/json:
schema: schema:
"$ref": "#/components/schemas/UserInfo" "$ref": "#/components/schemas/UserInfo"
401: '401':
description: the user is not logged in description: the user is not logged in
content: {} content: {}
/me/export: /me/export:
@ -95,7 +95,7 @@ paths:
- user - user
summary: Exports a zip-archive with all notes of the current user. summary: Exports a zip-archive with all notes of the current user.
responses: responses:
200: '200':
description: The zip-archive with all notes description: The zip-archive with all notes
/status: /status:
get: get:
@ -105,7 +105,7 @@ paths:
operationId: getStatus 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. description: The data is returned as a JSON object containing the number of notes stored on the server, (distinct) online users and more.
responses: responses:
200: '200':
description: The server info description: The server info
content: content:
application/json: application/json:
@ -129,7 +129,7 @@ paths:
markdownExample: markdownExample:
"$ref": '#/components/examples/markdownExample' "$ref": '#/components/examples/markdownExample'
responses: responses:
200: '200':
description: Get information about the newly created note description: Get information about the newly created note
content: content:
application/json: application/json:
@ -143,13 +143,13 @@ paths:
operationId: getNote operationId: getNote
description: This includes all metadata and the content of the note. description: This includes all metadata and the content of the note.
responses: responses:
200: '200':
description: All data of the note description: All data of the note
content: content:
application/json: application/json:
schema: schema:
"$ref": "#/components/schemas/Note" "$ref": "#/components/schemas/Note"
404: '404':
description: Note does not exist description: Note does not exist
parameters: parameters:
- name: note - name: note
@ -176,13 +176,13 @@ paths:
markdownExample: markdownExample:
"$ref": '#/components/examples/markdownExample' "$ref": '#/components/examples/markdownExample'
responses: responses:
200: '200':
description: Get information about the newly created note description: Get information about the newly created note
content: content:
application/json: application/json:
schema: schema:
"$ref": "#/components/schemas/Note" "$ref": "#/components/schemas/Note"
409: '409':
description: This alias is already in use description: This alias is already in use
parameters: parameters:
- name: note - name: note
@ -205,7 +205,7 @@ paths:
schema: schema:
"$ref": "#/components/schemas/NotePermissions" "$ref": "#/components/schemas/NotePermissions"
responses: responses:
200: '200':
description: The updated permissions of the note description: The updated permissions of the note
content: content:
application/json: application/json:
@ -225,7 +225,7 @@ paths:
summary: Get the permissions of a note summary: Get the permissions of a note
operationId: getNotePermissions operationId: getNotePermissions
responses: responses:
200: '200':
description: The permissions of the note description: The permissions of the note
content: content:
application/json: application/json:
@ -246,7 +246,7 @@ paths:
summary: Returns the websocket of a note. summary: Returns the websocket of a note.
operationId: getNoteWebsocket operationId: getNoteWebsocket
responses: responses:
200: '200':
description: The websocket of the note description: The websocket of the note
content: {} content: {}
parameters: parameters:
@ -265,14 +265,14 @@ paths:
summary: Returns the raw markdown content of a note. summary: Returns the raw markdown content of a note.
operationId: getNoteContent operationId: getNoteContent
responses: responses:
200: '200':
description: The raw markdown content of the note description: The raw markdown content of the note
content: content:
'text/markdown': 'text/markdown':
schema: schema:
type: string type: string
format: binary format: binary
404: '404':
description: Note does not exist description: Note does not exist
parameters: parameters:
- name: note - name: note
@ -290,14 +290,14 @@ paths:
summary: Returns the content of a note as HTML. summary: Returns the content of a note as HTML.
operationId: getNoteContentAsHTML operationId: getNoteContentAsHTML
responses: responses:
200: '200':
description: The raw html content of the note description: The raw html content of the note
content: content:
'text/html': 'text/html':
schema: schema:
type: string type: string
format: binary format: binary
404: '404':
description: Note does not exist description: Note does not exist
parameters: parameters:
- name: note - name: note
@ -315,13 +315,13 @@ paths:
summary: Exports the content of a note to a gist. summary: Exports the content of a note to a gist.
operationId: exportNoteToGist operationId: exportNoteToGist
responses: responses:
200: '200':
description: The link to Gist of the note description: The link to Gist of the note
content: content:
application/json: application/json:
schema: schema:
"$ref": '#/components/schemas/GistLink' "$ref": '#/components/schemas/GistLink'
404: '404':
description: Note does not exist description: Note does not exist
parameters: parameters:
- name: note - name: note
@ -339,13 +339,13 @@ paths:
summary: Exports the content of a note to dropbox. summary: Exports the content of a note to dropbox.
operationId: exportNoteToDropbox operationId: exportNoteToDropbox
responses: responses:
200: '200':
description: The dropbox link of the note description: The dropbox link of the note
content: content:
application/json: application/json:
schema: schema:
"$ref": '#/components/schemas/DropboxLink' "$ref": '#/components/schemas/DropboxLink'
404: '404':
description: Note does not exist description: Note does not exist
parameters: parameters:
- name: note - name: note
@ -363,14 +363,14 @@ paths:
summary: Exports the content of a note as PDF. summary: Exports the content of a note as PDF.
operationId: exportNoteToPDF operationId: exportNoteToPDF
responses: responses:
200: '200':
description: The note as an PDF description: The note as an PDF
content: content:
application/pdf: application/pdf:
schema: schema:
type: string type: string
format: binary format: binary
404: '404':
description: Note does not exist description: Note does not exist
parameters: parameters:
- name: note - name: note
@ -388,13 +388,13 @@ paths:
operationId: getAllRevisionsOfNote operationId: getAllRevisionsOfNote
description: The list is returned as a JSON object with an array of revision-id and length associations. The revision-id equals to the timestamp when the revision was saved. description: The list is returned as a JSON object with an array of revision-id and length associations. The revision-id equals to the timestamp when the revision was saved.
responses: responses:
200: '200':
description: Revisions of the note description: Revisions of the note
content: content:
application/json: application/json:
schema: schema:
"$ref": "#/components/schemas/NoteRevisionsMetadata" "$ref": "#/components/schemas/NoteRevisionsMetadata"
404: '404':
description: Note does not exist description: Note does not exist
parameters: parameters:
- name: note - name: note
@ -413,13 +413,13 @@ paths:
operationId: getSpecificRevisionOfNote operationId: getSpecificRevisionOfNote
description: The revision is returned as a JSON object with the content of the note and the authorship. description: The revision is returned as a JSON object with the content of the note and the authorship.
responses: responses:
200: '200':
description: Revision of the note for the given timestamp description: Revision of the note for the given timestamp
content: content:
application/json: application/json:
schema: schema:
"$ref": "#/components/schemas/NoteRevision" "$ref": "#/components/schemas/NoteRevision"
404: '404':
description: Note does not exist description: Note does not exist
parameters: parameters:
- name: note - name: note
@ -444,7 +444,7 @@ paths:
operationId: getHistory 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. 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: responses:
200: '200':
description: The list of recently viewed notes and pinned notes description: The list of recently viewed notes and pinned notes
content: content:
application/json: application/json:
@ -462,7 +462,7 @@ paths:
schema: schema:
"$ref": "#/components/schemas/History" "$ref": "#/components/schemas/History"
responses: responses:
200: '200':
description: The new history description: The new history
content: content:
application/json: application/json:
@ -474,7 +474,7 @@ paths:
summary: Clear the users history summary: Clear the users history
operationId: deleteHistory operationId: deleteHistory
responses: responses:
200: '200':
description: Deleted the history description: Deleted the history
content: {} content: {}
/history/{note}/: /history/{note}/:
@ -490,7 +490,7 @@ paths:
schema: schema:
"$ref": "#/components/schemas/HistoryObject" "$ref": "#/components/schemas/HistoryObject"
responses: responses:
200: '200':
description: The new history description: The new history
content: content:
application/json: application/json:
@ -510,7 +510,7 @@ paths:
summary: remove the history object of the note summary: remove the history object of the note
operationId: deleteHistoryObject operationId: deleteHistoryObject
responses: responses:
200: '200':
description: The new history description: The new history
content: {} content: {}
parameters: parameters:
@ -528,7 +528,7 @@ paths:
summary: The config of the backend summary: The config of the backend
operationId: getConfig operationId: getConfig
responses: responses:
200: '200':
description: The config description: The config
content: content:
application/json: application/json: