diff --git a/.changelogs/abilities-meta-empty-properties.yml b/.changelogs/abilities-meta-empty-properties.yml new file mode 100644 index 0000000000..b5c06a9a48 --- /dev/null +++ b/.changelogs/abilities-meta-empty-properties.yml @@ -0,0 +1,5 @@ +significance: patch +type: fixed +entry: "Fixed the create and update course and lesson abilities being rejected by MCP clients because the `meta` input schema encoded its empty `properties` as a JSON list." +links: + - "#3484" diff --git a/libraries/lifterlms-rest/includes/abilities/class-llms-rest-ability-factory.php b/libraries/lifterlms-rest/includes/abilities/class-llms-rest-ability-factory.php index 698a8e64f7..d479cc2090 100644 --- a/libraries/lifterlms-rest/includes/abilities/class-llms-rest-ability-factory.php +++ b/libraries/lifterlms-rest/includes/abilities/class-llms-rest-ability-factory.php @@ -608,6 +608,7 @@ private static function sanitize_args_to_schema( $args ) { * `properties`, `items`, and `additionalProperties`. * * @since 10.1.0 + * @since [version] Omit `properties` when it would be empty so it isn't encoded as a JSON list. * * @param array $schema A JSON Schema node (or a WP REST arg definition). * @return array Sanitized schema node. @@ -663,6 +664,11 @@ private static function sanitize_schema( $schema ) { if ( ! empty( $required ) ) { $sanitized['required'] = array_values( array_unique( $required ) ); } + + // An empty PHP array encodes as a JSON list (`[]`), which is not a valid `properties` value. + if ( empty( $sanitized['properties'] ) ) { + unset( $sanitized['properties'] ); + } } if ( isset( $schema['additionalProperties'] ) && is_array( $schema['additionalProperties'] ) ) { diff --git a/tests/phpunit/unit-tests/libraries/lifterlms-rest/abilities/class-llms-rest-test-ability-factory.php b/tests/phpunit/unit-tests/libraries/lifterlms-rest/abilities/class-llms-rest-test-ability-factory.php index ffb22db83d..fbf34bf2a9 100644 --- a/tests/phpunit/unit-tests/libraries/lifterlms-rest/abilities/class-llms-rest-test-ability-factory.php +++ b/tests/phpunit/unit-tests/libraries/lifterlms-rest/abilities/class-llms-rest-test-ability-factory.php @@ -419,4 +419,37 @@ public function test_check_permission_denies_unauthorized() { $this->assertFalse( $allowed ); } + + /** + * Test that an object with no properties (e.g. `meta`) doesn't encode `properties` as a JSON list. + * + * @since [version] + * + * @link https://github.com/gocodebox/lifterlms/issues/3484 + * + * @return void + */ + public function test_input_schema_omits_empty_properties() { + + foreach ( array( 'LLMS_REST_Courses_Controller' => 'courses', 'LLMS_REST_Lessons_Controller' => 'lessons' ) as $controller => $route ) { + + $schema = LLMS_Unit_Test_Util::call_method( + 'LLMS_REST_Ability_Factory', + 'get_input_schema', + array( + array( + 'method' => 'POST', + 'route' => '/llms/v1/' . $route, + 'operation' => 'create', + 'controller' => $controller, + ), + ) + ); + + $this->assertArrayHasKey( 'meta', $schema['properties'] ); + $this->assertSame( 'object', $schema['properties']['meta']['type'] ); + $this->assertArrayNotHasKey( 'properties', $schema['properties']['meta'] ); + $this->assertStringNotContainsString( '"properties":[]', wp_json_encode( $schema ) ); + } + } }