add missing properties in HLAPI

Author: cconard96

CHANGELOG.md

@@ -17,6 +17,7 @@ The present file will list all changes made to the project; according to the
 - New schemas/endpoints for Reminders, RSS Feeds, and Reservations in the High-Level API v2.1.
 - `date_password_change`, `location`, `authtype`, `last_login`, `default_profile` and `default_entity` properties for the User schema in the High-Level API v2.1.
 - New UserPreferences schema and endpoints in the High-Level API v2.1.
+- Some missing `completename` and `level` properties for some schemas in High-Level API v2.1.
 
 ### Changed
 - Fixed `id` property in dropdown/linked object properties in schemas in High-Level API showing as readOnly when they are writable.

src/Glpi/Api/HL/Controller/AssetController.php

@@ -550,6 +550,19 @@ class: User::class,
             }
         }
 
+        // Post v2 additions to general assets
+        $schemas['SoftwareLicense']['properties']['completename'] = [
+            'x-version-introduced' => '2.1.0',
+            'type' => Doc\Schema::TYPE_STRING,
+            'readOnly' => true,
+        ];
+        $schemas['SoftwareLicense']['properties']['level'] = [
+            'x-version-introduced' => '2.1.0',
+            'type' => Doc\Schema::TYPE_INTEGER,
+            'readOnly' => true,
+        ];
+
+        // Additional asset schemas
         $schemas['Cartridge'] = [
             'x-version-introduced' => '2.0',
             'x-itemtype' => Cartridge::class,

src/Glpi/Api/HL/Controller/ITILController.php

@@ -126,6 +126,11 @@ public static function getRawKnownSchemas(): array
                     'type' => Doc\Schema::TYPE_STRING,
                     'readOnly' => true,
                 ],
+                'level' => [
+                    'x-version-introduced' => '2.1.0',
+                    'type' => Doc\Schema::TYPE_INTEGER,
+                    'readOnly' => true,
+                ],
                 'comment' => ['type' => Doc\Schema::TYPE_STRING],
                 'entity' => self::getDropdownTypeSchema(class: Entity::class, full_schema: 'Entity'),
                 'is_recursive' => ['type' => Doc\Schema::TYPE_BOOLEAN],
@@ -697,6 +702,17 @@ public static function getRawKnownSchemas(): array
                 ],
                 'name' => ['type' => Doc\Schema::TYPE_STRING],
                 'is_active' => ['type' => Doc\Schema::TYPE_BOOLEAN],
+                'completename' => [
+                    'x-version-introduced' => '2.1.0',
+                    'type' => Doc\Schema::TYPE_STRING,
+                    'readOnly' => true,
+                ],
+                'parent' => self::getDropdownTypeSchema(class: TaskCategory::class, full_schema: 'TaskCategory') + ['x-version-introduced' => '2.1.0'],
+                'level' => [
+                    'x-version-introduced' => '2.1.0',
+                    'type' => Doc\Schema::TYPE_INTEGER,
+                    'readOnly' => true,
+                ],
             ],
         ];
 

src/Glpi/Api/HL/Controller/ManagementController.php

@@ -395,6 +395,23 @@ protected static function getRawKnownSchemas(): array
             ],
         ];
 
+        // Post v2 additions
+        $schemas['License']['properties']['is_recursive'] = [
+            'x-version-introduced' => '2.1.0',
+            'type' => Doc\Schema::TYPE_BOOLEAN,
+            'readOnly' => true,
+        ];
+        $schemas['License']['properties']['completename'] = [
+            'x-version-introduced' => '2.1.0',
+            'type' => Doc\Schema::TYPE_STRING,
+            'readOnly' => true,
+        ];
+        $schemas['License']['properties']['level'] = [
+            'x-version-introduced' => '2.1.0',
+            'type' => Doc\Schema::TYPE_INTEGER,
+            'readOnly' => true,
+        ];
+
         $schemas['Infocom'] = [
             'x-version-introduced' => '2.0',
             'type' => Doc\Schema::TYPE_OBJECT,

tests/functional/Glpi/Api/HL/RouterTest.php

@@ -87,6 +87,83 @@ public function testAllSchemasHaveVersioningInfo()
         $this->assertEmpty($schemas_missing_versions, 'Schemas missing versioning info: ' . implode(', ', $schemas_missing_versions));
     }
 
+    /**
+     * Ensure all schemas for CommonTreeDropdown itemtypes have the correct readonly properties such as completename and level
+     * @return void
+     */
+    public function testAllTreeSchemasHaveReadonlyProps()
+    {
+        $router = Router::getInstance();
+        $controllers = $router->getControllers();
+
+        $schemas_errors = [];
+        $required_readonly_props = ['completename', 'level'];
+        foreach ($controllers as $controller) {
+            $schemas = $controller::getKnownSchemas(null);
+            foreach ($schemas as $schema_name => $schema) {
+                if (!isset($schema['x-itemtype']) || !is_subclass_of($schema['x-itemtype'], \CommonTreeDropdown::class)) {
+                    continue;
+                }
+                foreach ($required_readonly_props as $prop) {
+                    if (!isset($schema['properties'][$prop])) {
+                        $schemas_errors[] = "Schema $schema_name in " . $controller::class . " is missing property '$prop'";
+                    } else {
+                        if (!isset($schema['properties'][$prop]['readOnly']) || $schema['properties'][$prop]['readOnly'] !== true) {
+                            $schemas_errors[] = "Property '$prop' in schema $schema_name in " . $controller::class . " is not marked as readOnly";
+                        }
+                    }
+                }
+            }
+        }
+        $this->assertEmpty($schemas_errors, "Tree schemas with errors: \n" . implode("\n", $schemas_errors));
+    }
+
+    /**
+     * Ensure there are not multiple schemas for the same itemtype (identified by x-itemtype).
+     * In some cases, like user preferences, we may have multiple schemas for the same itemtype, but those extra schemas
+     * should use x-table instead to point to the table directly.
+     * @return void
+     */
+    public function testNoDuplicateItemtypeSchemas()
+    {
+        $router = Router::getInstance();
+        $controllers = $router->getControllers();
+
+        $seen_itemtypes = [];
+        $duplicate_schemas = [];
+        $all_schemas = [];
+        foreach ($controllers as $controller) {
+            /** @noinspection SlowArrayOperationsInLoopInspection */
+            $all_schemas = array_merge($all_schemas, $controller::getKnownSchemas(null));
+        }
+        foreach ($all_schemas as $schema_name => $schema) {
+            // Ignore known duplicate. Cannot fix until v3
+            if ($schema_name === 'SoftwareLicense') {
+                continue;
+            }
+            if (isset($schema['x-itemtype'])) {
+                $itemtype = $schema['x-itemtype'];
+                if (isset($seen_itemtypes[$itemtype])) {
+                    $duplicate_schemas[] = "Itemtype $itemtype has multiple schemas: " . $seen_itemtypes[$itemtype] . " and $schema_name";
+                } else {
+                    $seen_itemtypes[$itemtype] = $schema_name;
+                }
+            }
+        }
+        ksort($all_schemas['SoftwareLicense']['properties']);
+        ksort($all_schemas['License']['properties']);
+        $this->assertEquals(
+            array_keys($all_schemas['SoftwareLicense']['properties']),
+            array_keys($all_schemas['License']['properties']),
+            'Schemas SoftwareLicense and License should have the same properties',
+        );
+        // Ensure the duplication gets removed in v3
+        if (version_compare(Router::API_VERSION, '3.0.0', '>=')) {
+            $this->assertNotContains('SoftwareLicense', $seen_itemtypes, 'Schema SoftwareLicense should be removed in v3');
+        }
+        $this->assertEmpty($duplicate_schemas, "Duplicate itemtype schemas found: \n" . implode("\n", $duplicate_schemas));
+    }
+
     public function testHLAPIDisabled()
     {
         global $CFG_GLPI;