GraphQL wrapper for HL API

Author: cconard96

composer.json

@@ -81,7 +81,8 @@
         "twig/markdown-extra": "^3.7",
         "twig/string-extra": "^3.7",
         "twig/twig": "^3.7",
-        "wapmorgan/unified-archive": "^1.2"
+        "wapmorgan/unified-archive": "^1.2",
+        "webonyx/graphql-php": "^15.5"
     },
     "require-dev": {
         "ext-xml": "*",

composer.lock

@@ -103,3 +103,56 @@ For example, if an endpoint returns a collection of items and each item has an `
 
 For specific documentation on each endpoint, see the Swagger documentation at `/api.php/doc`.
 You may also make a request to `/api.php/doc` to get the raw Swagger JSON document if you set the `Content-Type` header to `application/json` or add `.json` to the end of the URL.
+
+## GraphQL
+
+The GLPI API is also available via a GraphQL wrapper at `/api.php/GraphQL`. Like all compliant GraphQL implementations, it is self documenting and accepts only POST requests.
+Since it is a wrapper around the REST API, that means that any object schema defined and available through the REST API is also available via GraphQL.
+It also means that authentication is the exact same as the rest of the API.
+The only difference is that you can access more properties in some cases via the GraphQL API.
+For example, when you request a list of cartridge models (`CartridgeItem`) via the REST API it returns the `id`, `name`, and `comment` properties for the associated printer models.
+When you request the data for cartridge models via GraphQL, it unlocks access to all the properties of the `PrinterModal` schema.
+This can reduce the number of requests that need to be made to the API in some cases.
+
+The implementation of the GraphQL does not include any mutators. It is read-only.
+
+The GraphQL API supports the same parameters as the REST API for filtering, sorting, and pagination.
+
+Example:
+```graphql
+query {
+    Ticket(limit: 1, filter: "name=ilike=test") {
+        id
+        name
+        status {
+            id
+            name
+        }
+    }
+}
+```
+
+You can explore the schemas using standard GraphQL requests like:
+```graphql
+query {
+    __schema {
+        types {
+            name
+            description
+            fields {
+                description
+                type {
+                    name
+                    description
+                }
+            }
+        }
+    }
+}
+```
+
+Alternatively, a REST API interface is available for the raw GraphQL type declarations at `/api.php/GraphQL/Schema` using a GET request.
+
+As is standard with GraphQL, you MUST specify each property that you want to be returned.
+
+For more information about GraphQL, see the [GraphQL documentation](https://graphql.org/learn/).

resources/api_doc.MD

@@ -951,8 +951,8 @@ private static function getGlobalAssetSchema($asset_schemas)
                 'schema_name' => $schema_name,
                 'itemtype' => $itemtype,
             ];
-            if ($shared_properties === []) {
-                $shared_properties = Doc\Schema::flattenProperties($schema['properties']);
+            if (empty($shared_properties)) {
+                $shared_properties = $schema['properties'];
                 // Remove array properties (complex handling may be required. No support added for now)
                 $shared_properties = array_filter($shared_properties, static function ($property) {
                     return !isset($property['type']) || $property['type'] !== Doc\Schema::TYPE_ARRAY;

src/Api/HL/Controller/AssetController.php

@@ -0,0 +1,69 @@
+<?php
+
+/**
+ * ---------------------------------------------------------------------
+ *
+ * GLPI - Gestionnaire Libre de Parc Informatique
+ *
+ * http://glpi-project.org
+ *
+ * @copyright 2015-2023 Teclib' and contributors.
+ * @copyright 2003-2014 by the INDEPNET Development Team.
+ * @licence   https://www.gnu.org/licenses/gpl-3.0.html
+ *
+ * ---------------------------------------------------------------------
+ *
+ * LICENSE
+ *
+ * This file is part of GLPI.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * ---------------------------------------------------------------------
+ */
+
+namespace Glpi\Api\HL\Controller;
+
+use Glpi\Api\HL\Doc as Doc;
+use Glpi\Api\HL\GraphQL;
+use Glpi\Api\HL\GraphQLGenerator;
+use Glpi\Api\HL\Middleware\CookieAuthMiddleware;
+use Glpi\Api\HL\Route;
+use Glpi\Api\HL\Router;
+use Glpi\Http\JSONResponse;
+use Glpi\Http\Request;
+use Glpi\Http\Response;
+
+#[Route(path: '/GraphQL', priority: 1, tags: ['GraphQL'])]
+final class GraphQLController extends AbstractController
+{
+    #[Route(path: '/', methods: ['POST'], security_level: Route::SECURITY_AUTHENTICATED)]
+    #[Doc\Route(
+        description: 'GraphQL API',
+    )]
+    public function index(Request $request): Response
+    {
+        return new JSONResponse(GraphQL::processRequest($request));
+    }
+
+    #[Route(path: '/Schema', methods: ['GET'], security_level: Route::SECURITY_AUTHENTICATED)]
+    #[Doc\Route(
+        description: 'GraphQL API Schema',
+    )]
+    public function getSchema(Request $request): Response
+    {
+        $graphql_generator = new GraphQLGenerator();
+        return new Response(200, [], $graphql_generator->getSchema());
+    }
+}