You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
787 lines
16 KiB
787 lines
16 KiB
{ |
|
"openapi": "3.1.0", |
|
"info": { |
|
"title": "Notes", |
|
"version": "4.6.0", |
|
"description": "Distraction-free notes and writing", |
|
"license": { |
|
"name": "agpl", |
|
"identifier": " AGPL-3.0" |
|
} |
|
}, |
|
"tags": [ |
|
{ |
|
"name": "notes" |
|
} |
|
], |
|
"paths": { |
|
"/apps/notes/notes": { |
|
"get": { |
|
"operationId": "notes-index-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"parameters": [ |
|
{ |
|
"name": "pruneBefore", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "integer", |
|
"default": 0 |
|
} |
|
} |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"post": { |
|
"operationId": "notes-create-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"parameters": [ |
|
{ |
|
"name": "category", |
|
"in": "query", |
|
"required": true, |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"/apps/notes/notes/dashboard": { |
|
"get": { |
|
"operationId": "notes-dashboard-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"/apps/notes/notes/{id}": { |
|
"parameters": [ |
|
{ |
|
"name": "id", |
|
"in": "path", |
|
"required": true, |
|
"schema": { |
|
"type": "integer" |
|
} |
|
} |
|
], |
|
"get": { |
|
"operationId": "notes-get-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"put": { |
|
"operationId": "notes-update-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"parameters": [ |
|
{ |
|
"name": "content", |
|
"in": "query", |
|
"required": true, |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"delete": { |
|
"operationId": "notes-destroy-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"/apps/notes/notes/undo": { |
|
"post": { |
|
"operationId": "notes-undo-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"parameters": [ |
|
{ |
|
"name": "id", |
|
"in": "query", |
|
"required": true, |
|
"schema": { |
|
"type": "integer" |
|
} |
|
}, |
|
{ |
|
"name": "title", |
|
"in": "query", |
|
"required": true, |
|
"schema": { |
|
"type": "string" |
|
} |
|
}, |
|
{ |
|
"name": "content", |
|
"in": "query", |
|
"required": true, |
|
"schema": { |
|
"type": "string" |
|
} |
|
}, |
|
{ |
|
"name": "category", |
|
"in": "query", |
|
"required": true, |
|
"schema": { |
|
"type": "string" |
|
} |
|
}, |
|
{ |
|
"name": "modified", |
|
"in": "query", |
|
"required": true, |
|
"schema": { |
|
"type": "integer" |
|
} |
|
}, |
|
{ |
|
"name": "favorite", |
|
"in": "query", |
|
"required": true, |
|
"schema": { |
|
"type": "integer" |
|
} |
|
} |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"/apps/notes/notes/{id}/autotitle": { |
|
"parameters": [ |
|
{ |
|
"name": "id", |
|
"in": "path", |
|
"required": true, |
|
"schema": { |
|
"type": "integer" |
|
} |
|
} |
|
], |
|
"put": { |
|
"operationId": "notes-autotitle-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"/apps/notes/notes/{id}/{property}": { |
|
"parameters": [ |
|
{ |
|
"name": "id", |
|
"in": "path", |
|
"required": true, |
|
"schema": { |
|
"type": "integer" |
|
} |
|
}, |
|
{ |
|
"name": "property", |
|
"in": "path", |
|
"required": true, |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
], |
|
"put": { |
|
"operationId": "notes-updateproperty-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"parameters": [ |
|
{ |
|
"name": "modified", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "integer" |
|
} |
|
}, |
|
{ |
|
"name": "title", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "string" |
|
} |
|
}, |
|
{ |
|
"name": "category", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "string" |
|
} |
|
}, |
|
{ |
|
"name": "favorite", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "integer" |
|
} |
|
} |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"/apps/notes/notes/{noteid}/attachment": { |
|
"parameters": [ |
|
{ |
|
"name": "noteid", |
|
"in": "path", |
|
"required": true, |
|
"schema": { |
|
"type": "integer" |
|
} |
|
} |
|
], |
|
"get": { |
|
"operationId": "notes-getattachment-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"parameters": [ |
|
{ |
|
"name": "path", |
|
"in": "query", |
|
"required": true, |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"post": { |
|
"operationId": "notes-uploadfile-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"/apps/notes/settings": { |
|
"get": { |
|
"operationId": "settings-get-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"put": { |
|
"operationId": "settings-set-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"/apps/notes/api/{apiVersion}/notes": { |
|
"parameters": [ |
|
{ |
|
"name": "apiVersion", |
|
"in": "path", |
|
"required": true, |
|
"schema": { |
|
"type": "TODO" |
|
} |
|
} |
|
], |
|
"get": { |
|
"operationId": "notes_api-index-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"parameters": [ |
|
{ |
|
"name": "category", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "string" |
|
} |
|
}, |
|
{ |
|
"name": "exclude", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "string", |
|
"default": "" |
|
} |
|
}, |
|
{ |
|
"name": "pruneBefore", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "integer", |
|
"default": 0 |
|
} |
|
}, |
|
{ |
|
"name": "chunkSize", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "integer", |
|
"default": 0 |
|
} |
|
}, |
|
{ |
|
"name": "chunkCursor", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"post": { |
|
"operationId": "notes_api-create-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"parameters": [ |
|
{ |
|
"name": "category", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "string", |
|
"default": "" |
|
} |
|
}, |
|
{ |
|
"name": "title", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "string", |
|
"default": "" |
|
} |
|
}, |
|
{ |
|
"name": "content", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "string", |
|
"default": "" |
|
} |
|
}, |
|
{ |
|
"name": "modified", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "integer", |
|
"default": 0 |
|
} |
|
}, |
|
{ |
|
"name": "favorite", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "integer", |
|
"default": 0 |
|
} |
|
} |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"/apps/notes/api/{apiVersion}/notes/{id}": { |
|
"parameters": [ |
|
{ |
|
"name": "apiVersion", |
|
"in": "path", |
|
"required": true, |
|
"schema": { |
|
"type": "TODO" |
|
} |
|
}, |
|
{ |
|
"name": "id", |
|
"in": "path", |
|
"required": true, |
|
"schema": { |
|
"type": "integer" |
|
} |
|
} |
|
], |
|
"get": { |
|
"operationId": "notes_api-get-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"parameters": [ |
|
{ |
|
"name": "exclude", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "string", |
|
"default": "" |
|
} |
|
} |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"put": { |
|
"operationId": "notes_api-update-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"parameters": [ |
|
{ |
|
"name": "content", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "string" |
|
} |
|
}, |
|
{ |
|
"name": "modified", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "integer" |
|
} |
|
}, |
|
{ |
|
"name": "title", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "string" |
|
} |
|
}, |
|
{ |
|
"name": "category", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "string" |
|
} |
|
}, |
|
{ |
|
"name": "favorite", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "integer" |
|
} |
|
} |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"delete": { |
|
"operationId": "notes_api-destroy-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"/apps/notes/api/{apiVersion}/settings": { |
|
"parameters": [ |
|
{ |
|
"name": "apiVersion", |
|
"in": "path", |
|
"required": true, |
|
"schema": { |
|
"type": "TODO" |
|
} |
|
} |
|
], |
|
"get": { |
|
"operationId": "notes_api-getsettings-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"put": { |
|
"operationId": "notes_api-setsettings-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"/apps/notes/api/{catchAll}": { |
|
"parameters": [ |
|
{ |
|
"name": "catchAll", |
|
"in": "path", |
|
"required": true, |
|
"schema": { |
|
"type": "TODO" |
|
} |
|
} |
|
], |
|
"get": { |
|
"operationId": "notes_api-fail-TODO", |
|
"tags": [ |
|
"notes" |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |