add tables Description to createTable

Signed-off-by: grnd-alt <salimbelakkaf@outlook.de>
nextcloud · Apr 17, 2024 · 4472313 · 4472313
1 parent 91bc7d0
commit 4472313
Show file tree

Hide file tree

Showing 8 changed files with 44 additions and 25 deletions.
diff --git a/lib/Controller/ApiTablesController.php b/lib/Controller/ApiTablesController.php
@@ -78,15 +78,16 @@ public function show(int $id): DataResponse {
 	 *
 	 * @param string $title Title of the table
 	 * @param string|null $emoji Emoji for the table
+	 * @param string|null $description Description for the table
 	 * @param string $template Template to use if wanted
 	 *
 	 * @return DataResponse<Http::STATUS_OK, TablesTable, array{}>|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
 	 *
 	 * 200: Tables returned
 	 */
-	public function create(string $title, ?string $emoji, string $template = 'custom'): DataResponse {
+	public function create(string $title, ?string $emoji, ?string $description, string $template = 'custom'): DataResponse {
 		try {
-			return new DataResponse($this->service->create($title, $template, $emoji)->jsonSerialize());
+			return new DataResponse($this->service->create($title, $template, $emoji, $description)->jsonSerialize());
 		} catch (InternalError|Exception $e) {
 			return $this->handleError($e);
 		}

diff --git a/lib/Migration/Version000000Date20210921000000.php b/lib/Migration/Version000000Date20210921000000.php
@@ -54,6 +54,10 @@ public function changeSchema(IOutput $output, Closure $schemaClosure, array $opt
 			$table->addColumn('last_edit_at', Types::DATETIME, [
 				'notnull' => true,
 			]);
+			$table->addColumn('description', Types::TEXT, [
+				'default' => '',
+				'notnull' => false,
+			]);
 			$table->setPrimaryKey(['id']);
 		}
 

diff --git a/lib/Migration/Version000900Date20240314000000.php b/lib/Migration/Version000900Date20240314000000.php
@@ -27,13 +27,14 @@ public function changeSchema(IOutput $output, Closure $schemaClosure, array $opt
 
 		if ($schema->hasTable('tables_tables')) {
 			$table = $schema->getTable('tables_tables');
-			$table->addColumn('description', Types::TEXT, [
-				'default' => '',
-				'notnull' => false,
-			]);
+			if (!$table->hasColumn('description')) {
+				$table->addColumn('description', Types::TEXT, [
+					'default' => '',
+					'notnull' => false,
+				]);
+			}
 			return $schema;
 		}
 		return null;
 	}
-
 }
diff --git a/lib/Service/TableService.php b/lib/Service/TableService.php
@@ -255,12 +255,13 @@ public function find(int $id, bool $skipTableEnhancement = false, ?string $userI
 	 * @throws InternalError
 	 * @noinspection DuplicatedCode
 	 */
-	public function create(string $title, string $template, ?string $emoji, ?string $userId = null): Table {
+	public function create(string $title, string $template, ?string $emoji, ?string $description = '', ?string $userId = null): Table {
 		$userId = $this->permissionsService->preCheckUserId($userId, false); // we can assume that the $userId is set
 
 		$time = new DateTime();
 		$item = new Table();
 		$item->setTitle($title);
+		$item->setDescription($description);
 		if($emoji) {
 			$item->setEmoji($emoji);
 		}

diff --git a/openapi.json b/openapi.json
@@ -5077,6 +5077,15 @@
                             "nullable": true
                         }
                     },
+                    {
+                        "name": "description",
+                        "in": "query",
+                        "description": "Description for the table",
+                        "schema": {
+                            "type": "string",
+                            "nullable": true
+                        }
+                    },
                     {
                         "name": "template",
                         "in": "query",

diff --git a/src/modules/modals/CreateTable.vue b/src/modules/modals/CreateTable.vue
@@ -28,6 +28,14 @@
 						@input="titleChangedManually">
 				</div>
 			</div>
+			<div class="row">
+				<div class="col-4 mandatory">
+					{{ t('tables', 'Description') }}
+				</div>
+				<div class="col-4">
+					<TableDescription :description.sync="description" :read-only="false" />
+				</div>
+			</div>
 			<div class="row space-T">
 				<div class="col-2 block space-R space-B">
 					<NcTile
@@ -65,6 +73,7 @@ import axios from '@nextcloud/axios'
 import { generateUrl } from '@nextcloud/router'
 import NcTile from '../../shared/components/ncTile/NcTile.vue'
 import displayError from '../../shared/utils/displayError.js'
+import TableDescription from '../../modules/main/sections/TableDescription.vue'
 
 export default {
 	name: 'CreateTable',
@@ -73,6 +82,7 @@ export default {
 		NcEmojiPicker,
 		NcButton,
 		NcTile,
+		TableDescription,
 	},
 	props: {
 		showModal: {
@@ -84,6 +94,7 @@ export default {
 		return {
 			title: '',
 			icon: '',
+			description: '',
 			errorTitle: false,
 			templates: null,
 			templateChoice: 'custom',
@@ -159,6 +170,7 @@ export default {
 		async sendNewTableToBE(template) {
 			const data = {
 				title: this.title,
+				description: this.description,
 				emoji: this.icon,
 				template,
 			}
@@ -190,6 +202,11 @@ export default {
 </script>
 <style lang="scss" scoped>
 
+:deep(.element-description) {
+	padding-inline: 0 !important;
+	max-width: 100%;
+}
+
 .modal__content {
 	padding-right: 0 !important;
 }

diff --git a/src/store/store.js b/src/store/store.js
@@ -142,7 +142,7 @@ export default new Vuex.Store({
 			let res = null
 
 			try {
-				res = await axios.post(generateUrl('/apps/tables/table'), data)
+				res = (await axios.post(generateOcsUrl('/apps/tables/api/2/tables'), data)).data.ocs
 			} catch (e) {
 				displayError(e, t('tables', 'Could not insert table.'))
 				return false
@@ -262,22 +262,6 @@ export default new Vuex.Store({
 			}
 			return true
 		},
-		async updateTableProperty({ state, commit, dispatch }, { id, data, property }) {
-			let res = null
-
-			try {
-				res = (await axios.put(generateOcsUrl('/apps/tables/api/2/tables/' + id), data)).data.ocs
-			} catch (e) {
-				displayError(e, t('tables', 'Could not update table.'))
-				return false
-			}
-
-			const table = res.data
-			const tables = state.tables
-			const index = tables.findIndex(t => t.id === table.id)
-			Vue.set(state.tables[index], property, data[property])
-			return true
-		},
 		async updateTable({ state, commit, dispatch }, { id, data }) {
 			let res = null
 

diff --git a/src/types/openapi/openapi.ts b/src/types/openapi/openapi.ts
@@ -2052,6 +2052,8 @@ export type operations = {
         title: string;
         /** @description Emoji for the table */
         emoji?: string | null;
+        /** @description Description for the table */
+        description?: string | null;
         /** @description Template to use if wanted */
         template?: string;
       };