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

Fixed Typos, removed unnecessary type: object

Browse source 
and fixed copy paste errors in descriptions

Signed-off-by: Yannick Bungers <git@innay.de>
This commit is contained in:
Yannick Bungers 2020-08-17 23:14:38 +02:00 committed by David Mehren
parent ea82479050
commit fb29ab85bd
No known key found for this signature in database
GPG key ID: 185982BA4C42B7C3
1 changed files with 7 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/dev/public_api.yml
View file

@ -116,7 +116,7 @@ paths:
operationId: deleteHistoryObject operationId: deleteHistoryObject
responses: responses:
'204': '204':
"$ref": "#/components/responses/SuccesfullyDeleted" "$ref": "#/components/responses/SuccessfullyDeleted"
'401': '401':
"$ref": "#/components/responses/UnauthorizedError" "$ref": "#/components/responses/UnauthorizedError"
'404': '404':
@ -203,7 +203,7 @@ paths:
- name: note - name: note
in: path in: path
required: true required: true
description: The note for which the info should be shown. description: The name of the note which is used to address it.
content: content:
text/plain: text/plain:
example: my-note example: my-note
@ -240,18 +240,18 @@ paths:
- name: note - name: note
in: path in: path
required: true required: true
description: The note for which the info should be shown. description: The name of the note which is used to address it.
content: content:
text/plain: text/plain:
example: my-note example: my-note
delete: delete:
tags: tags:
- note - note
summary: Remove the note summary: Remove the note
operationId: deleteNote operationId: deleteNote
responses: responses:
'204': '204':
"$ref": "#/components/responses/SuccesfullyDeleted" "$ref": "#/components/responses/SuccessfullyDeleted"
'401': '401':
"$ref": "#/components/responses/UnauthorizedError" "$ref": "#/components/responses/UnauthorizedError"
'403': '403':
@ -516,7 +516,6 @@ components:
properties: properties:
userName: userName:
type: string type: string
format: UUIDv4
displayName: displayName:
type: string type: string
photo: photo:
@ -638,14 +637,13 @@ components:
type: string type: string
description: The markdown content of the note description: The markdown content of the note
metadata: metadata:
type: object
$ref: "#/components/schemas/NoteMetadata" $ref: "#/components/schemas/NoteMetadata"
editedByAtPosition: editedByAtPosition:
type: array type: array
description: Data which gives insights about who worked where on the note. description: Data which gives insights about who worked where on the note.
items: items:
type: integer type: integer
description: Unique user ids and additional data description: Unique user ids and additional data
NoteMetadata: NoteMetadata:
type: object type: object
properties: properties:
@ -690,7 +688,6 @@ components:
items: items:
type: string type: string
permissions: permissions:
type: object
$ref: "#/components/schemas/NotePermissions" $ref: "#/components/schemas/NotePermissions"
NotePermissions: NotePermissions:
type: object type: object
@ -828,7 +825,6 @@ components:
type: object type: object
properties: properties:
metadata: metadata:
type: object
$ref: "#/components/schemas/NoteMetadata" $ref: "#/components/schemas/NoteMetadata"
pinned: pinned:
type: boolean type: boolean
@ -856,5 +852,5 @@ components:
description: Access to the requested resource is not permitted. description: Access to the requested resource is not permitted.
NotFoundError: NotFoundError:
description: The requested resource was not found. description: The requested resource was not found.
SuccesfullyDeleted: SuccessfullyDeleted:
description: The requested resource was sucessfully deleted. description: The requested resource was sucessfully deleted.