Update API spec

gchq · Nov 13, 2024 · 38c8a4f · 38c8a4f
1 parent e2e4b47
commit 38c8a4f
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/backend/src/routes/v2/model/postModel.ts b/backend/src/routes/v2/model/postModel.ts
@@ -11,9 +11,9 @@ import { parse } from '../../../utils/validate.js'
 
 export const postModelSchema = z.object({
   body: z.object({
-    name: z.string().min(1, 'You must provide a model name'),
-    kind: z.nativeEnum(EntryKind),
-    description: z.string().min(1, 'You must provide a model description'),
+    name: z.string().min(1, 'You must provide a model name').openapi({ example: 'Yolo v4' }),
+    kind: z.nativeEnum(EntryKind).openapi({ example: 'model' }),
+    description: z.string().min(1, 'You must provide a model description').openapi({ example: 'You only look once' }),
     visibility: z.nativeEnum(EntryVisibility).optional().default(EntryVisibility.Public),
     collaborators: z
       .array(