self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2025-07-16 00:14:34 +02:00
Code Issues Releases Activity

Api: Exclude deleted and conflicted notes when calling /notes

Browse Source
This commit is contained in:
Laurent Cozic
2024-05-03 16:14:04 +01:00
parent f1691b7743
commit 57c316a591
5 changed files with 49 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
packages/app-cli/app/command-apidoc.ts
View File

@ -239,11 +239,6 @@ async function fetchAllNotes() {
type: Database.enumId('fieldType', 'text'),
description: 'If an image is provided, you can also specify an optional rectangle that will be used to crop the image. In format `{ x: x, y: y, width: width, height: height }`',
});
// tableFields.push({
// name: 'tags',
// type: Database.enumId('fieldType', 'text'),
// description: 'Comma-separated list of tags. eg. `tag1,tag2`.',
// });
}
lines.push(`## ${toTitleCase(tableName)}`);
@ -269,6 +264,11 @@ async function fetchAllNotes() {
lines.push('');
}
if (model.type === BaseModel.TYPE_NOTE) {
lines.push('By default, this call will return the all notes **except** the notes in the trash folder and any conflict note. To include these too, you can specify `include_deleted=1` and `include_conflicts=1` as query parameters.');
lines.push('');
}
lines.push(`### GET /${tableName}/:id`);
lines.push('');
lines.push(`Gets ${singular} with ID :id`);