From 67f33120905e474e2a4bb7ed1dffc3f919bfe1ee Mon Sep 17 00:00:00 2001 From: Finn Stutzenstein Date: Tue, 8 Dec 2020 10:05:00 +0100 Subject: [PATCH] Update mediaservice interface --- docs/interfaces/media-service.txt | 33 ++++++++++++++++++++++++------- 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/docs/interfaces/media-service.txt b/docs/interfaces/media-service.txt index 95ef96a4b..1ced8b67f 100644 --- a/docs/interfaces/media-service.txt +++ b/docs/interfaces/media-service.txt @@ -1,16 +1,35 @@ /** - * Saves a file (encoded as base64) into this service. + * Saves a mediafile (encoded as base64) into this service. * * Technical: - * POST to /internal/media/upload/ with JSON payload. - * Returns 200 on success, 4xx on Errors with a message in the payload. + * POST to /internal/media/upload_mediafile/ with JSON payload. + * Returns 200 on success, 4xx on errors with a message in the payload. */ -upload(file: string, id: Id, mimetype: string): {message: string} | void +upload_mediafile(file: string, id: Id, mimetype: string): {message: string} | void /** - * Retrieves a mediafile given by the meeting and the path of the file. + * Saves a resource (encoded as base64) into this service. * * Technical: - * GET to /system/media/get// + * POST to /internal/media/upload_resource/ with JSON payload. + * Returns 200 on success, 4xx on errors with a message in the payload. */ -get(meeting_id: Id, path: string): Blob +upload_resource(file: string, id: Id, mimetype: string): {message: string} | void + +/** + * Retrieves a mediafile given by it's id. + * + * Technical: + * GET to /system/media/get/ + * Returns 200 on success and 404, if the resource does not exist + */ +get(mediafile_id: Id): Blob + +/** + * Retrieves a resource given by it's id. + * + * Technical: + * GET to /system/media/get_resource/ + * Returns 200 on success and 404, if the resource does not exist + */ +get(resource_id: Id): Blob \ No newline at end of file