From cae430f25fc9d7c7b5887069694d2b93093d9da7 Mon Sep 17 00:00:00 2001 From: David Mehren Date: Sat, 3 Oct 2020 14:51:22 +0200 Subject: [PATCH] Public API: Update description of /notes/{note} POST and PUT routes. Signed-off-by: David Mehren Co-authored-by: Yannick Bungers --- docs/dev/public_api.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/dev/public_api.yml b/docs/dev/public_api.yml index 3bf91f60a..dbba734b9 100644 --- a/docs/dev/public_api.yml +++ b/docs/dev/public_api.yml @@ -226,7 +226,7 @@ paths: - note summary: Imports some markdown data into a new note with a given alias operationId: createNoteWithAlias - description: This endpoint equals to the above one except that the alias from the url will be assigned to the note if [FreeURL-mode](https://github.com/codimd/server/tree/master/docs/configuration-env-vars.md#users-and-privileges) is enabled. + description: This endpoint creates a new note with the content of the HTTP request body and the alias from the URL parameter. requestBody: required: true description: The content of the note to be imported as markdown. @@ -285,7 +285,7 @@ paths: - note summary: Imports some markdown data into an existing note, creating a new revision operationId: createNewRevisionForNote - description: This endpoint equals to the above one except that the alias from the url will be assigned to the note if [FreeURL-mode](https://github.com/codimd/server/tree/master/docs/configuration-env-vars.md#users-and-privileges) is enabled. + description: This endpoint updates the note content of an existing note. The old content is completely replaced and a new revision is created. requestBody: required: true description: The content of the note to be imported as markdown.