From 364bd67a86f593de00fb226475c1ae85d270945f Mon Sep 17 00:00:00 2001 From: matu6968 Date: Thu, 21 Nov 2024 01:57:18 +0100 Subject: [PATCH] Update To edit app details --- To-edit-app-details.md | 75 +++++++++++++++++++++++++++++++----------- 1 file changed, 55 insertions(+), 20 deletions(-) diff --git a/To-edit-app-details.md b/To-edit-app-details.md index 4be7be4..804c719 100644 --- a/To-edit-app-details.md +++ b/To-edit-app-details.md @@ -33,39 +33,74 @@ If it is successful: Status code: 200 ``` -If there is no token or a invalid token: +If there is no token specified in header: ``` -Unauthorized +{ + "error": "No authorization header" +} Status code: 401 ``` -If there is no app ID specified: + +If there is a invalid token: ``` -App ID is required +{ + "error": "Invalid token" +} + +Status code: 401 +``` + +If there is no metadata in multipart body specified: +``` +{ + "error": "Metadata is required" +} Status code: 400 ``` -If there is a invalid app ID specified: + +If there metadata file in multipart body is invalid: ``` -App not found +{ + "error": "Invalid metadata format" +} + +Status code: 400 +``` + +If there is a problem while saving apps.json onto the host, while making a directory to the uploaded file or while saving the uploaded file: (likely cause is directory where the binary is located is set to read only) +``` +{ + "error": "Failed to save file" +} + +Status code: 500 +``` + +If there is a invalid multipart body: +``` +{ + "error": "Invalid request body" +} + +Status code: 400 +``` + +If there is no or invalid app ID specified: +``` +{ + "error": "App not found" +} Status code: 404 ``` -If there is a problem while saving the uploaded file: (likely cause is directory where the binary is located is set to read only) -``` -Failed to save file -Status code: 500 +If using a HTTP request other then `POST`: ``` -If there is a problem while saving apps.json onto the host: (likely cause is directory where the binary is located is set to read only) -``` -Failed to save app data +{ + "error": "Method not allowed. Only POST is supported for this endpoint." +} -Status code: 500 -``` -If there is invalid multipart body: -``` -Invalid form data - -Status code: 400 +Status code: 405 ``` \ No newline at end of file