Merge pull request #66 from directus/connorwinston/web-392-add-descri…

…ption-field-to-backend-and-frontend feat: Add Description from backend
directus · Dec 2, 2024 · 7ad4705 · 7ad4705
2 parents 141118e + 837e630
commit 7ad4705
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 1 deletion.
diff --git a/nuxt.config.ts b/nuxt.config.ts
@@ -65,7 +65,7 @@ export default defineNuxtConfig({
 			},
 		},
 		navigation: {
-			fields: ['root', 'tags', 'additional_paths', 'expandable'],
+			fields: ['root', 'tags', 'additional_paths', 'expandable', 'description'],
 		},
 	},
 	runtimeConfig: {

diff --git a/server/remoteContent/index.ts b/server/remoteContent/index.ts
@@ -37,6 +37,7 @@ export const docPages = async () => {
 								'id',
 								'slug',
 								'title',
+								'description',
 								'content',
 								'sort',
 								{ tags: [{ tag: ['id', 'icon', 'name'] }] },
@@ -140,6 +141,7 @@ export const buildPages = async (dir: string) => {
 							additional_paths: page.additional_paths?.map(path => path.path),
 							content: undefined,
 							authors: page.authors?.map(author => author.author),
+							...(page.description ? { description: page.description } : { description: undefined }),
 						},
 						page.content,
 					);

diff --git a/types/directus.ts b/types/directus.ts
@@ -90,6 +90,7 @@ interface DocumentationPage {
 	additional_paths: DocumentationAdditionalPath[]; // Array of Documentation
 	authors: DocumentationPageAuthor[]; // Array of DocumentationPageAuthor
 	title: string; // String
+	description?: string; // String
 	content: string; // String
 	sort?: number; // Optional Integer
 	user_created?: string; // Optional UUID