fix(api): default option type to choice for non-grid questions (#3504)

* fix(api): default option type to choice for non-grid questions

Creating an option through POST .../questions/{id}/options without an
optionType stored the option with a null type. Such options are saved
but never rendered, so the question shows up with no selectable answers.

The option_type migration (Version050300Date20250914000000) already
backfills null types to 'choice', and DataStructure.md documents 'choice'
as the default for normal option lists. newOption() just never applied
that default to new inserts.

Default optionType to 'choice' for any non-grid question when the caller
omits it. Grid questions are left untouched, as their options require an
explicit row/column type. Adds the missing Option::OPTION_TYPE_CHOICE
constant alongside the existing row/column ones.

Signed-off-by: Josef Behr <code@josef-behr.de>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* fix(api): apply option-type default after ordering lookup

Addresses review feedback on the placement of the default.

Moving the default before findByQuestion() changed the ordering: the
lookup filters by option type, so a freshly defaulted 'choice' no longer
matched existing options that predate the option_type migration (or were
inserted without a type), resetting the order to 1.

Apply the default after the ordering lookup instead. findByQuestion()
keeps the caller-provided type (null means "all options of the question"),
so option order is unchanged, and the inserted option still gets 'choice'.

Signed-off-by: Josef Behr <code@josef-behr.de>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* fix(api): default option_type via column default and migration

Follow-up to review: move the default out of the controller logic and
into the schema, as suggested.

- New migration gives the option_type column a 'choice' default and
  backfills rows still stored without a type.
- newOption() no longer writes an explicit null, so the column default
  applies for normal option lists, and re-reads the inserted option so
  the response reflects the stored value.
- Grid options are unaffected, as callers always pass an explicit
  row/column type.

Removes the earlier controller-side default and the OPTION_TYPE_CHOICE
constant. Integration fixtures now receive 'choice' from the column
default, so the affected expectations are updated.

Signed-off-by: Josef Behr <code@josef-behr.de>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* fix(api): apply review suggestions for option_type default

- Set the newOption() signature default to 'choice' instead of resolving
  it in the method body, now that the migration guarantees stored options
  carry a type.
- Drop the explicit-null guard and the post-insert re-read; they are no
  longer needed with the signature default in place.
- Return early from the migration schema change when nothing is altered.
- Document the 'choice' default on the optionType parameter.

Signed-off-by: Josef Behr <code@josef-behr.de>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* chore(openapi): regenerate for option_type default change

Reflects the 'choice' default now declared on the newOption optionType
parameter. The reorder-options parameter is unchanged.

Signed-off-by: Josef Behr <code@josef-behr.de>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Signed-off-by: Josef Behr <code@josef-behr.de>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Author: josefbehr

lib/Controller/ApiController.php

@@ -894,7 +894,7 @@ public function reorderQuestions(int $formId, array $newOrder): DataResponse {
 	 * @param int $formId id of the form
 	 * @param int $questionId id of the question
 	 * @param list<string> $optionTexts the new option text
-	 * @param string|null $optionType the new option type (e.g. 'row')
+	 * @param string|null $optionType the new option type (e.g. 'row'), defaults to 'choice'
 	 * @return DataResponse<Http::STATUS_CREATED, list<FormsOption>, array{}> Returns a DataResponse containing the added options
 	 * @throws OCSBadRequestException This question is not part ot the given form
 	 * @throws OCSForbiddenException This form is archived and can not be modified
@@ -908,7 +908,7 @@ public function reorderQuestions(int $formId, array $newOrder): DataResponse {
 	#[NoAdminRequired()]
 	#[BruteForceProtection(action: 'form')]
 	#[ApiRoute(verb: 'POST', url: '/api/v3/forms/{formId}/questions/{questionId}/options')]
-	public function newOption(int $formId, int $questionId, array $optionTexts, ?string $optionType = null): DataResponse {
+	public function newOption(int $formId, int $questionId, array $optionTexts, ?string $optionType = 'choice'): DataResponse {
 		$this->logger->debug('Adding new options: formId: {formId}, questionId: {questionId}, text: {text}, optionType: {optionType}', [
 			'formId' => $formId,
 			'questionId' => $questionId,

lib/Migration/Version050300Date20260716000000.php

@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Forms\Migration;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\IDBConnection;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+
+/**
+ * Gives the option_type column a 'choice' default and backfills existing
+ * rows that were stored without a type. Options created through the API
+ * without an explicit optionType previously kept a null type, which the
+ * frontend does not render.
+ */
+class Version050300Date20260716000000 extends SimpleMigrationStep {
+
+	public function __construct(
+		protected IDBConnection $db,
+	) {
+	}
+
+	/**
+	 * @param IOutput $output
+	 * @param Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
+	 * @param array $options
+	 * @return null|ISchemaWrapper
+	 */
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+		$table = $schema->getTable('forms_v2_options');
+		$changed = false;
+
+		if ($table->hasColumn('option_type')) {
+			$column = $table->getColumn('option_type');
+			if ($column->getDefault() === null) {
+				$column->setDefault('choice');
+				$changed = true;
+			}
+		}
+
+		return $changed ? $schema : null;
+	}
+
+	/**
+	 * @param IOutput $output
+	 * @param Closure(): ISchemaWrapper $schemaClosure
+	 * @param array $options
+	 */
+	public function postSchemaChange(IOutput $output, Closure $schemaClosure, array $options): void {
+		$qbUpdate = $this->db->getQueryBuilder();
+
+		$qbUpdate->update('forms_v2_options')
+			->set('option_type', $qbUpdate->createNamedParameter('choice'))
+			->where($qbUpdate->expr()->isNull('option_type'))
+			->executeStatement();
+	}
+}

openapi.json

@@ -2702,8 +2702,8 @@
                                     "optionType": {
                                         "type": "string",
                                         "nullable": true,
-                                        "default": null,
-                                        "description": "the new option type (e.g. 'row')"
+                                        "default": "choice",
+                                        "description": "the new option type (e.g. 'row'), defaults to 'choice'"
                                     }
                                 }
                             }

tests/Integration/Api/ApiV3Test.php

@@ -497,17 +497,17 @@ public static function dataGetFullForm() {
 								[
 									'text' => 'Option 1',
 									'order' => 1,
-									'optionType' => null,
+									'optionType' => 'choice',
 								],
 								[
 									'text' => 'Option 2',
 									'order' => 2,
-									'optionType' => null,
+									'optionType' => 'choice',
 								],
 								[
 									'text' => '',
 									'order' => 3,
-									'optionType' => null,
+									'optionType' => 'choice',
 								]
 							],
 							'accept' => [],
@@ -1027,7 +1027,9 @@ public static function dataCreateNewOption() {
 					// 'questionId' => Done dynamically below.
 					'text' => 'A new Option.',
 					'order' => 4,
-					'optionType' => null,
+					// Non-grid questions default to the 'choice' option type
+					// when none is provided.
+					'optionType' => 'choice',
 				]
 			]
 		];