@defra/forms-model 3.0.430 → 3.0.432

package/schemas/sorting-options-schema.json

@@ -0,0 +1,28 @@
+{
+  "type": "object",
+  "properties": {
+    "sortBy": {
+      "type": "string",
+      "description": "Field to sort results by",
+      "enum": [
+        "updatedAt",
+        "title"
+      ],
+      "title": "Sort By"
+    },
+    "order": {
+      "type": "string",
+      "description": "Sort order (ascending or descending)",
+      "enum": [
+        "asc",
+        "desc"
+      ],
+      "title": "Order"
+    }
+  },
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Sorting Options Schema",
+  "description": "JSON Schema for validating Sorting Options Schema in Defra forms",
+  "$id": "@defra/forms-model/schemas/sorting-options-schema.json"
+}

package/schemas/written-answer-sub-schema.json

@@ -0,0 +1,12 @@
+{
+  "type": "string",
+  "description": "Subtype for written answer questions",
+  "enum": [
+    "TextField",
+    "MultilineTextField",
+    "NumberField"
+  ],
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Written Answer Sub Schema",
+  "$id": "@defra/forms-model/schemas/written-answer-sub-schema.json"
+}

package/src/common/pagination/index.ts

@@ -6,7 +6,13 @@ import { type PaginationOptions } from '~/src/common/pagination/types.js'
  * Field definitions for pagination options.
  */
 export const paginationOptionFields = {
-  page: Joi.number().positive().integer().default(1).min(1).optional(),
+  page: Joi.number()
+    .positive()
+    .integer()
+    .default(1)
+    .min(1)
+    .optional()
+    .description('Current page number, starting from 1'),
   perPage: Joi.number()
     .positive()
     .integer()
@@ -14,6 +20,7 @@ export const paginationOptionFields = {
     .min(1)
     .max(200)
     .optional()
+    .description('Number of items to display per page, between 1 and 200')
 }
 
 /**

package/src/common/search/index.ts

@@ -7,18 +7,32 @@ import { organisations } from '~/src/form/form-metadata/index.js'
  * Field definitions for search options.
  */
 export const searchOptionFields = {
-  title: Joi.string().trim().allow('').max(255).optional().default(''),
-  author: Joi.string().trim().allow('').max(100).optional().default(''),
+  title: Joi.string()
+    .trim()
+    .allow('')
+    .max(255)
+    .optional()
+    .default('')
+    .description('Search by form title, empty string matches all'),
+  author: Joi.string()
+    .trim()
+    .allow('')
+    .max(100)
+    .optional()
+    .default('')
+    .description('Search by form author, empty string matches all'),
   organisations: Joi.array()
     .items(Joi.string().valid(...organisations))
     .single()
     .optional()
-    .default([]),
+    .default([])
+    .description('Filter by organisation(s), empty array matches all'),
   status: Joi.array()
     .items(Joi.string().valid('draft', 'live'))
     .single()
     .optional()
     .default([])
+    .description('Filter by form status(es), empty array matches all')
 }
 
 /**

package/src/common/sorting/index.ts

@@ -6,8 +6,14 @@ import { type SortingOptions } from '~/src/common/sorting/types.js'
  * Field definitions for sorting options.
  */
 export const sortingOptionFields = {
-  sortBy: Joi.string().valid('updatedAt', 'title').optional(),
-  order: Joi.string().valid('asc', 'desc').optional()
+  sortBy: Joi.string()
+    .valid('updatedAt', 'title')
+    .optional()
+    .description('Field to sort results by'),
+  order: Joi.string()
+    .valid('asc', 'desc')
+    .optional()
+    .description('Sort order (ascending or descending)')
 }
 
 /**