Feature/http api new approach #348

Jan-Schuppik · 2025-08-22T13:51:53Z

Initial setup for the new approach of the http-api with openapi description.

Resolves:

require:

nilmerg

This review covers only the early parts of routing and dispatching.

nilmerg · 2025-08-26T07:50:16Z

run.php

+$this->addRoute('notifications/api-v1-contacts', new Zend_Controller_Router_Route_Regex(
+    'notifications/api/v1/contacts(?:\/(.+)|\?(.+))?',
+    [
+        'controller'    => 'api-v1-contacts',
+        'action'        => 'index',
+        'module'        => 'notifications',
+        'identifier'    => null
+    ],
+    [
+        1 => 'identifier'
+    ]
+));
+
+$this->addRoute('notifications/api-v1-contactgroups', new Zend_Controller_Router_Route_Regex(
+    'notifications/api/v1/contactgroups(?:\/(.+)|\?(.+))?',
+    [
+        'controller'    => 'api-v1-contactgroups',
+        'action'        => 'index',
+        'module'        => 'notifications',
+        'identifier'    => null
+    ],
+    [
+        1 => 'identifier'
+    ]
+));
+
+$this->addRoute('notifications/api-v1-channels', new Zend_Controller_Router_Route_Regex(
+    'notifications/api/v1/channels(?:\/(.+)|\?(.+))?',
+    [
+        'controller'    => 'api-v1-channels',
+        'action'        => 'index',
+        'module'        => 'notifications',
+        'identifier'    => null
+    ],
+    [
+        1 => 'identifier'
+    ]
+));
+
+$this->addRoute('notifications/api-v1-channels', new Zend_Controller_Router_Route_Regex(
+    'notifications/api(?:\/(v[0-9\.]+))(?:\/([^\/\?]+))?(?:[\/\?]([^\/\?]+))?',
+    [
+        'controller'    => 'api',
+        'action'        => 'index',
+        'version'     => 'v1',
+        'module'        => 'notifications',
+        'endpoint'     => null,
+        'identifier'    => null
+    ],
+    [
+        1 => 'version',
+        2 => 'endpoint',
+        3 =>  'identifier'
+    ]
+));


Please replace this with:

Suggested change

$this->addRoute('notifications/api-v1-contacts', new Zend_Controller_Router_Route_Regex(

'notifications/api/v1/contacts(?:\/(.+)|\?(.+))?',

[

'controller' => 'api-v1-contacts',

'action' => 'index',

'module' => 'notifications',

'identifier' => null

],

[

1 => 'identifier'

]

));

$this->addRoute('notifications/api-v1-contactgroups', new Zend_Controller_Router_Route_Regex(

'notifications/api/v1/contactgroups(?:\/(.+)|\?(.+))?',

[

'controller' => 'api-v1-contactgroups',

'action' => 'index',

'module' => 'notifications',

'identifier' => null

],

[

1 => 'identifier'

]

));

$this->addRoute('notifications/api-v1-channels', new Zend_Controller_Router_Route_Regex(

'notifications/api/v1/channels(?:\/(.+)|\?(.+))?',

[

'controller' => 'api-v1-channels',

'action' => 'index',

'module' => 'notifications',

'identifier' => null

],

[

1 => 'identifier'

]

));

$this->addRoute('notifications/api-v1-channels', new Zend_Controller_Router_Route_Regex(

'notifications/api(?:\/(v[0-9\.]+))(?:\/([^\/\?]+))?(?:[\/\?]([^\/\?]+))?',

[

'controller' => 'api',

'action' => 'index',

'version' => 'v1',

'module' => 'notifications',

'endpoint' => null,

'identifier' => null

],

[

1 => 'version',

2 => 'endpoint',

3 => 'identifier'

]

));

$this->addRoute('notifications/api-plural', new Zend_Controller_Router_Route(

'notifications/api/:version/:endpoint',

[

'module' => 'notifications',

'controller' => 'api',

'action' => 'index'

]

));

$this->addRoute('notifications/api-single', new Zend_Controller_Router_Route(

'notifications/api/:version/:endpoint/:identifier',

[

'module' => 'notifications',

'controller' => 'api',

'action' => 'index'

]

));

Note that Zend processes routes in reverse order. So notifications/api-single will be processed first. It cannot match without an identifier, because there is no forward slash in our endpoint names. notifications/api-plural on the other hand cannot match with an identifier, because notifications/api-single is processed first. 😉

nilmerg · 2025-08-26T07:55:45Z

application/controllers/ApiController.php

+     */
+    public function indexAction(): never
+    {
+        $this->assertPermission('notifications/api/v1');


I know the issues requires this. But now I'm not sure anymore, whether it makes sense to have the api version in the permission's name. Why would someone, permitted to use v1, not be able to use v2?

Though, do not change anything yet. Leave this for later.

nilmerg · 2025-08-26T08:38:09Z

application/controllers/ApiController.php

+     * @throws HttpBadRequestException If the request is not valid.
+     * @throws SecurityException
+     * @throws HttpException|HttpNotFoundException
+     * @throws Zend_Controller_Request_Exception


The return type is missing

nilmerg · 2025-08-26T08:39:14Z

application/controllers/ApiController.php

+        $version = StringHelper::cname($params['version'] ?? null, '-');
+        $endpoint = StringHelper::cname($params['endpoint'] ?? null, '-');


Please use ipl-stdlib's Str::camel here.

nilmerg · 2025-08-26T08:40:16Z

application/controllers/ApiController.php

+        if (empty($version) || empty($endpoint)) {
+            throw new HttpException(404, "Version and endpoint are required parameters.");
+        }


The routes I suggested should verify this and make this check obsolete.

nilmerg · 2025-08-26T08:41:17Z

application/controllers/ApiController.php

+            throw new HttpException(404, "Version and endpoint are required parameters.");
+        }
+
+        $module = ($moduleName !== null) ? 'Module\\' . StringHelper::cname($moduleName, '-') . '\\' : '';


None of our modules use dashes in their name.

nilmerg · 2025-08-26T08:42:55Z

application/controllers/ApiController.php

+        }
+
+        $module = ($moduleName !== null) ? 'Module\\' . StringHelper::cname($moduleName, '-') . '\\' : '';
+        $className = sprintf('Icinga\\%sApi\\%s\\%s', $module, $version, $endpoint);


I like that this may already be compatible with an Icinga Web API 😃

nilmerg · 2025-08-26T08:44:43Z

application/controllers/ApiController.php

+        $className = sprintf('Icinga\\%sApi\\%s\\%s', $module, $version, $endpoint);
+
+        // Check if the required class and method are available and valid
+        if (! class_exists($className) || (new ReflectionClass($className))->isAbstract()) {


Not sure why the abstract check is required. If an abstract class matches an endpoint, this should result in a server error, not a not found.

nilmerg · 2025-08-26T09:00:44Z

application/controllers/ApiController.php

+        // TODO: move this to an api core or version class?
+        $parsedMethodName = ($method === 'GET' && empty($identifier)) ? $methodName . 'Any' : $methodName;
+
+        if (! in_array($parsedMethodName, get_class_methods($className))) {
+            if ($method === 'GET' && in_array($methodName, get_class_methods($className))) {
+                $parsedMethodName = $methodName;
+            } else {
+                throw new HttpException(405, "Method $method does not exist.");
+            }
+        }
+
+        // Choose the correct constructor call based on the endpoint
+        if (in_array($method, ['POST', 'PUT'])) {
+            $data = $this->getValidatedJsonContent($request);
+            (new $className($request, $response))->$parsedMethodName($data);
+        } else {
+            (new $className($request, $response))->$parsedMethodName();
+        }


Please do this without depending on any Zend objects. Including request and response.

Once you've identified a class using the endpoint, instantiate it and interact with it by expecting it to be of type RequestHandlerInterface.

The identifier should be part of the request object in the form of an attribute (The last paragraph of the linked section).

The end result should be that this controller is the last part in the chain that is built on top of Zend routing and dispatching. Everything else is PSR7/15 compliant and can then easily migrated to an alternative in the future.

nilmerg · 2025-08-26T09:11:02Z

library/Notifications/Api/V1/ApiV1.php

+        $this->version = 'v1';
+        $this->validateIdentifier();
+        $method = $this->getRequest()->getMethod();
+        $filterStr = Url::fromRequest()->getQueryString();


Get the query string from the request please, do not use a url object for this. Once this is PSR15 compliant, everything should be inferred from the request. Singletons are not an option.

nilmerg · 2025-08-26T09:14:23Z

Oh, and I got the postgres tests working in my environment. Please get back to me for this.

ICINGA_NOTIFICATIONS_SCHEMA=/path/to/notifications/schema.sql ICINGAWEB_PATH=/icingaweb2 /usr/share/icinga-php/ipl/vendor/bin/phpunit --bootstrap test/php/bootstrap.php Note that you will need a database for this, and propagate this via env as well: * Name | Description * ----------------- | ------------------------ * *_TESTDB | The database to use * *_TESTDB_HOST | The server to connect to * *_TESTDB_PORT | The port to connect to * *_TESTDB_USER | The user to connect with * *_TESTDB_PASSWORD | The password of the user

sukhwinder33445 · 2025-09-08T13:09:29Z

test/php/application/controllers/ApiV1ChannelsTest.php

+        $this->assertSame(404, $response->getStatusCode(), $content);
+        $this->assertSame('{"status":"error","message":"Channel not found"}', $content);
+    }
+}


Please add the following test cases:

The POST, PUT and DELETE methods should respond with an HTTP code 400: "Method (POST|PUT|DELETE) is not supported"

If an invalid UUID is specified, the response should be HTTP code 400.

If an invalid filter is specified, the response should be HTTP code 400.

If the JSON is valid, but a required field is missing or invalid, use the code 422

sukhwinder33445 · 2025-09-08T13:24:50Z

test/php/application/controllers/ApiV1ContactsTest.php

+        // missing username
+        $response = $this->sendRequest('POST', 'contacts', [
+            'id' => '0817d973-398e-41d7-9ef2-61cdb7ef41a1',
+            'full_name' => 'Test',
+            'default_channel' => BaseApiV1TestCase::CHANNEL_UUID,
+            'groups' => [],
+            'addresses' => []
+        ]);
+        $content = $response->getBody()->getContents();
+
+        $this->assertEquals(201, $response->getStatusCode(), $content);
+
+        // missing groups
+        $response = $this->sendRequest('POST', 'contacts', [
+            'id' => '0817d973-398e-41d7-9ef2-61cdb7ef41a2',
+            'full_name' => 'Test',
+            'username' => 'test',
+            'default_channel' => BaseApiV1TestCase::CHANNEL_UUID
+        ]);
+        $content = $response->getBody()->getContents();
+
+        $this->assertEquals(201, $response->getStatusCode(), $content);


These are optional columns and are valid. Please move them to a separate test.

sukhwinder33445 · 2025-09-08T13:25:15Z

test/php/application/controllers/ApiV1ContactsTest.php

+        // missing addresses
+        $response = $this->sendRequest('POST', 'contacts', [
+            'id' => '0817d973-398e-41d7-9ef2-61cdb7ef41a4',
+            'full_name' => 'Test',
+            'default_channel' => BaseApiV1TestCase::CHANNEL_UUID,
+            'groups' => []
+        ]);
+        $content = $response->getBody()->getContents();
+
+        $this->assertEquals(201, $response->getStatusCode(), $content);


sukhwinder33445 · 2025-09-08T13:51:20Z

test/php/application/controllers/ApiV1ContactsTest.php

+        // missing id
+        $response = $this->sendRequest('POST', 'contacts/0817d973-398e-41d7-9ef2-61cdb7ef41a2', [
+            'full_name' => 'Test',
+            'default_channel' => BaseApiV1TestCase::CHANNEL_UUID
+        ]);
+        $content = $response->getBody()->getContents();
+
+        $this->assertSame(400, $response->getStatusCode(), $content);
+        $this->assertSame(
+            '{"status":"error","message":"Invalid request body: '
+            . 'the fields id, full_name and default_channel must be present and of type string"}',
+            $content
+        );
+
+        // missing name
+        $response = $this->sendRequest('POST', 'contacts/0817d973-398e-41d7-9ef2-61cdb7ef41a2', [
+            'id' => '0817d973-398e-41d7-9ef2-61cdb7ef41a2',
+            'default_channel' => BaseApiV1TestCase::CHANNEL_UUID
+        ]);
+        $content = $response->getBody()->getContents();
+
+        $this->assertSame(400, $response->getStatusCode(), $content);
+        $this->assertSame(
+            '{"status":"error","message":"Invalid request body: '
+            . 'the fields id, full_name and default_channel must be present and of type string"}',
+            $content
+        );


You have the similar test cases in the test method above. I would suggest adding one separate test instead, e.g.: testPostWithMissingRequiredField.

sukhwinder33445 · 2025-09-08T14:20:20Z

test/php/application/controllers/ApiV1ContactsTest.php

+            'default_channel' => BaseApiV1TestCase::CHANNEL_UUID,
+        ]);
+
+        $this->assertSame(201, $response->getStatusCode(), $response->getBody()->getContents());


Please also check the contents.

sukhwinder33445 · 2025-09-08T14:35:14Z

test/php/application/controllers/ApiV1ContactsTest.php

+        $this->sendRequest('PUT', 'contacts/0817d973-398e-41d7-9ef2-61cdb7ef41a2', [
+            'id' => '0817d973-398e-41d7-9ef2-61cdb7ef41a2',
+            'full_name' => 'Test',
+            'default_channel' => BaseApiV1TestCase::CHANNEL_UUID
+        ]);
+        $this->sendRequest('PUT', 'contacts/0817d973-398e-41d7-9ef2-61cdb7ef41a3', [
+            'id' => '0817d973-398e-41d7-9ef2-61cdb7ef41a3',
+            'full_name' => 'Test (2)',
+            'default_channel' => BaseApiV1TestCase::CHANNEL_UUID
+        ]);


Please use the POST method to create contacts here. PUT should mainly be used for update or replace.

sukhwinder33445 · 2025-09-08T14:36:22Z

test/php/application/controllers/ApiV1ContactsTest.php

+     */
+    public function testGetWithMatchingIdentifier(): void
+    {
+        $this->sendRequest('PUT', 'contacts/0817d973-398e-41d7-9ef2-61cdb7ef41a2', [


Again, use POST please.

sukhwinder33445 · 2025-09-08T14:36:49Z

test/php/application/controllers/ApiV1ContactsTest.php

+     */
+    public function testGetWithMatchingFilter(): void
+    {
+        $this->sendRequest('PUT', 'contacts/0817d973-398e-41d7-9ef2-61cdb7ef41a2', [


Again, use POST please.

sukhwinder33445 · 2025-09-08T14:37:45Z

test/php/application/controllers/ApiV1ContactsTest.php

+     */
+    public function testGetWithNonMatchingFilter(): void
+    {
+        $this->sendRequest('PUT', 'contacts/0817d973-398e-41d7-9ef2-61cdb7ef41a2', [


Again, use POST please.

Since you are not retrieving this contact anyway, this is superfluous. GET is sufficient here.

sukhwinder33445 · 2025-09-08T14:41:34Z

test/php/application/controllers/ApiV1ContactsTest.php

@@ -0,0 +1,863 @@
+<?php


Please fix the phpDoc.

sukhwinder33445 · 2025-09-09T08:26:41Z

library/Notifications/Api/ApiCore.php

+
+    public function __construct()
+    {
+        $this->setResponse((new HttpFactory())->createResponse());


Instead, please use new Response(), as used internally by (new HttpFactory())->createResponse().

sukhwinder33445 · 2025-09-09T08:28:09Z

library/Notifications/Api/ApiCore.php

+     * @param Connection $db
+     * @return void
+     */
+    protected function setDB(Connection $db): void


Please let the setter return the class (: static) instead.
Apply this to all setter.

sukhwinder33445 · 2025-09-09T08:33:42Z

library/Notifications/Api/ApiCore.php

+     */
+    protected function setVersion(string $version): void
+    {
+        if (! isset($this->version)) {


Why is this isset check necessary? If the code is not allowed to overwrite the version, please use a constant instead of a setter.

sukhwinder33445 · 2025-09-09T08:35:35Z

library/Notifications/Api/ApiCore.php

+     * @return array
+     * @throws ProgrammingError
+     */
+    protected function getFilesIncludingDocs(string $fileFilter = '*'): array


This appears to be specific to OpenApi, so please move it there.

sukhwinder33445 · 2025-09-09T08:53:52Z

library/Notifications/Api/ApiCore.php

+     *
+     * @var string
+     */
+    public const OPENAPI_ENDPOINT = 'openapi';


Move this to the OpenApi please.

sukhwinder33445 · 2025-09-09T09:57:06Z

library/Notifications/Api/V1/ApiV1.php

+            'status' => $statusCode,
+            'body' => $body,
+            'headers' => $additionalHeaders,
+        ], static fn($v) => $v !== null);


This callback is superfluous, as this is the default for array_filter.

This method can be removed, please create an array manually instead.

sukhwinder33445 · 2025-09-09T10:02:19Z

library/Notifications/Api/V1/ApiV1.php

+            $response = $response->withStatus($responseData['status']);
+        }
+        if (isset($responseData['headers']) && is_array($responseData['headers'])) {
+            foreach ($responseData['headers'] as $name => $values) {
+                if (is_array($values)) {
+                    foreach ($values as $value) {
+                        $response = $response->withHeader($name, $value);
+                    }
+                } else {
+                    $response = $response->withHeader($name, $values);
+                }


Each call on $response creates a clone. Change it as discussed offline, please.

sukhwinder33445 · 2025-09-09T10:11:57Z

library/Notifications/Api/V1/Channels.php

+        $result = $this->getDB()->fetchOne($stmt);
+
+        if (empty($result)) {
+            throw HttpNotFoundException::create(['Channel not found']);


HttpNotFoundException::create() requires an array, use new HttpNotFoundException('Channel not found') instead.

sukhwinder33445 · 2025-09-09T10:23:54Z

library/Notifications/Api/V1/Channels.php

+
+        $this->createGETRowFinalizer()($result);
+
+        return $this->createArrayOfResponseData(body: Json::sanitize($result));


As commented above, this method can be removed. Use return ['body' => Json::sanitize($result)].

sukhwinder33445 · 2025-09-09T10:31:08Z

library/Notifications/Api/V1/Contacts.php

+            throw HttpBadRequestException::create(['Identifier is required']);
+        }
+
+        $data = $this->getValidatedRequestBodyData($requestBody);


This method only validates the given $requestBody and does not change it. It can be void. Please change the name to : assertValidRequestBody(): void

sukhwinder33445

I have looked at channels and contact tests so far, next I will look at contactgroup tests.

sukhwinder33445 · 2025-09-11T09:25:20Z

library/Notifications/Api/V1/ApiV1.php

+            try {
+                $methodName = HttpMethod::from($httpMethod)->name;
+            } catch (ValueError $e) {
+                throw new HttpException(405, "HTTP method $httpMethod is not supported");


Allow header is required for 405.

See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Allow

sukhwinder33445 · 2025-09-11T10:19:44Z

test/php/application/controllers/ApiV1ContactsTest.php

+        $this->assertSame('{"status":"success","message":"Contact created successfully"}', $content);
+    }
+
+    // TODO: send 409 instead of 422?


Yes, 409 please

sukhwinder33445 · 2025-09-11T10:20:22Z

test/php/application/controllers/ApiV1ContactsTest.php

+
+    // TODO: additional POST tests
+    // TODO: send 422 instead of 400?
+    /**


Yes, 422 please.

sukhwinder33445 · 2025-09-11T10:21:08Z

test/php/application/controllers/ApiV1ContactsTest.php

+     */
+    public function testPostWithInvalidData(): void
+    {
+        // TODO: send 409 or 422?


sukhwinder33445 · 2025-09-11T10:21:45Z

test/php/application/controllers/ApiV1ContactsTest.php

+        );
+    }
+
+    // TODO: send 422 instead of 400?


sukhwinder33445 · 2025-09-11T10:52:46Z

test/php/application/controllers/ApiV1ContactsTest.php

+        );
+    }
+
+    // TODO: send 422 instead of 400?


Yes pelase.

sukhwinder33445 · 2025-09-11T10:53:15Z

test/php/application/controllers/ApiV1ContactsTest.php

+        $response = $this->sendRequest('DELETE', 'contacts');
+        $content = $response->getBody()->getContents();
+
+        $this->assertSame(400, $response->getStatusCode(), $content);


This should be 422.

sukhwinder33445 · 2025-09-11T10:56:19Z

test/php/application/controllers/ApiV1ContactsTest.php

+        $response = $this->sendRequest('PATCH', 'contacts');
+        $content = $response->getBody()->getContents();
+
+        $this->assertSame(405, $response->getStatusCode(), $content);


Please check if the required header allow is set.

sukhwinder33445 · 2025-09-11T10:58:52Z

test/php/application/controllers/ApiV1ChannelsTest.php

+        $response = $this->sendRequest('PATCH', 'channels');
+        $content = $response->getBody()->getContents();
+
+        $this->assertSame(405, $response->getStatusCode(), $content);


Error code 405 always requires an allow header, as mentioned in the comment above. Please check whether this is present.

sukhwinder33445 · 2025-09-11T11:01:10Z

test/php/application/controllers/ApiV1ChannelsTest.php

+        $this->assertSame(404, $response->getStatusCode(), $content);
+        $this->assertSame('{"status":"error","message":"Channel not found"}', $content);
+    }
+}


If the JSON is valid, but a required field is missing or invalid, use the code 422

sukhwinder33445 · 2025-09-11T13:06:05Z

test/php/application/controllers/ApiV1ContactGroupsTest.php

+     *
+     * @dataProvider databases
+     */
+    public function testPostWithInvalidContent(): void


This is a general test that is not really related to the specified endpoint. This test could be moved to a class that tests basic API functions.

Since the basic API implementation may be moved anyway, we can look at this later, once everything else is working as expected.

sukhwinder33445 · 2025-09-11T13:07:15Z

test/php/application/controllers/ApiV1ContactGroupsTest.php

+     *
+     * @dataProvider databases
+     */
+    public function testPostWithInvalidContentType(): void


Same here and the same applies to other test classes.

sukhwinder33445 · 2025-09-11T13:15:52Z

test/php/application/controllers/ApiV1ContactGroupsTest.php

+     * @dataProvider databases
+     */
+    public function testPostWithFilter(): void
+    {


sukhwinder33445 · 2025-09-11T13:22:59Z

test/php/application/controllers/ApiV1ContactGroupsTest.php

+        $this->assertCount(1, $response->getHeader('Location'));
+        $this->assertSame(
+            'notifications/api/v1/contactgroups/0817d973-398e-41d7-9ef2-61cdb7ef41a3',
+            $response->getHeader('Location')[0]
+        );


Instead, you can do the following, which makes assertCount superfluous:

$this->assertSame( ['notifications/api/v1/contactgroups/0817d973-398e-41d7-9ef2-61cdb7ef41a3'], $$response->getHeader('Location') );

sukhwinder33445 · 2025-09-11T13:25:26Z

test/php/application/controllers/ApiV1ContactGroupsTest.php

+        ]);
+        $content = $response->getBody()->getContents();
+
+        $this->assertSame(422, $response->getStatusCode(), $content);


You are reusing theid here, so this is a ‘409 conflict’.

sukhwinder33445 · 2025-09-11T13:55:28Z

test/php/application/controllers/ApiV1ContactGroupsTest.php

+        $this->assertSame(
+            '',
+            $content
+        );


Oneline please.

sukhwinder33445 · 2025-09-11T13:57:07Z

test/php/application/controllers/ApiV1ContactGroupsTest.php

+        $response = $this->sendRequest('DELETE', 'contactgroups');
+        $content = $response->getBody()->getContents();
+
+        $this->assertSame(400, $response->getStatusCode(), $content);


This should be 422.

sukhwinder33445 · 2025-09-11T13:57:56Z

test/php/application/controllers/ApiV1ContactGroupsTest.php

+     *
+     * @dataProvider databases
+     */
+    public function testPutWithNonMatchingIdentifierAndMissingRequiredFields(): void


Status code should be 422 here.

sukhwinder33445 · 2025-09-11T14:03:34Z

test/php/application/controllers/ApiV1ContactGroupsTest.php

+        ]);
+        $content = $response->getBody()->getContents();
+
+        $this->assertEquals(400, $response->getStatusCode(), $content);


This should be 422.

sukhwinder33445 · 2025-09-11T14:03:51Z

test/php/application/controllers/ApiV1ContactGroupsTest.php

+        $this->assertSame(
+            '',
+            $content
+        );


Oneline please.

Jan-Schuppik requested a review from nilmerg August 22, 2025 13:51

Jan-Schuppik self-assigned this Aug 22, 2025

cla-bot bot added the cla/signed CLA is signed by all contributors of a PR label Aug 22, 2025

Jan-Schuppik force-pushed the feature/http-api-new-approach branch from 9a3a6aa to aa2b625 Compare August 25, 2025 12:48

nilmerg requested changes Aug 26, 2025

View reviewed changes

This was referenced Sep 3, 2025

Add column external_uuid to contact/contactgroup table Icinga/icinga-notifications#216

Open

HTTP API to configure contacts and contactgroups #199

Closed

Jan-Schuppik force-pushed the feature/http-api-new-approach branch from f53b374 to 1705125 Compare September 3, 2025 10:49

Jan-Schuppik and others added 17 commits September 3, 2025 12:51

Add: column external_uuid & missing column changed_at

6132474

Introduce: PSR Logger

f67dc8c

Fix: test-setup for MySQL compatibility (PostgreSQL tests still failing)

efce1f9

Adjust: unit tests

be015b6

Add: route for new api controller

e6fac6a

Introduce: new API srtucture (starting with Contact GET)

47dcb8e

Add: initial openapi docs

bed7f05

Adjust: give the request object to ApiCore

a1e1d4f

Fix: lint-errors & moduleName fetching

ed824d1

Remove: Icinga Web 2 BaseTestCase dependency

5c15181

Adjust: add small review suggestions

f3999ce

Rework: implements psr-15 RequestHandlerInterface

6bd5cbc

Adjust: api-version handling

0dc1def

Fix: request validation & plural-GET result name & test permissions

5ee193a

Adjust: openapi documentation creating & storing

9116e17

Fix: Psr-Logger exception-handling

fe816f8

Jan-Schuppik force-pushed the feature/http-api-new-approach branch from 1705125 to fe816f8 Compare September 3, 2025 10:58

Jan-Schuppik added 3 commits September 3, 2025 13:22

Introduce: PUT method handling

64912d8

Adjust: Openapi Attributes (+ fix strings)

7a86078

Introduce: POST method handling

3510235

Jan-Schuppik added 12 commits September 3, 2025 15:57

Fix: phpdocs of endpoint-methods

282485d

Introduce: DELETE method handling

fece5c1

WIP: introduce psr15 pipeline & validation middleware

a256cdc

Fix: contact tests (enable POST with identifier)

115207b

Fix: CodeSniffer Errors

e5b8b3d

Add: contactgroup endpoint methods

4e0a22c

Fix: contactgroup tests

e68863b

Adjust: enriching of get-result-rows

f00c61b

Add: channel GET-methods

46619f3

Fix: wrong Uuid-class & filterString fetching

3a9fc09

Add: channel tests (+ adjust channel filters)

ae926b4

Fix: add missing escape-signs in tests

acb091c

Jan-Schuppik mentioned this pull request Sep 5, 2025

Feature/notifications api Icinga/icinga-php-thirdparty#58

Draft

Jan-Schuppik added 4 commits September 5, 2025 15:19

Fix: CodeSniffer Errors

5d0d954

Remove: error abstraction

4d6dedc

Adjust: channel-tests add second default channel

4582a73

Remove: middleware & middleware-pipeline

27ad56a

sukhwinder33445 reviewed Sep 8, 2025

View reviewed changes

sukhwinder33445 reviewed Sep 9, 2025

View reviewed changes

Jan-Schuppik added 7 commits September 10, 2025 11:25

Fix: channel-tests

b90041f

Fix: contact-tests

d1d9368

Fix: contacgroup-tests & contact-tests

5a49d86

Adjust: parse all exceptions in error response (temporary workaround)

16df14d

Fix: CodeSniffer Errors

0f39baf

Adjust: create response only if necessary

d36ec70

Fix: general request-body-validation

e2db760

sukhwinder33445 reviewed Sep 11, 2025

View reviewed changes

		$version = StringHelper::cname($params['version'] ?? null, '-');
		$endpoint = StringHelper::cname($params['endpoint'] ?? null, '-');


		$this->createGETRowFinalizer()($result);

		return $this->createArrayOfResponseData(body: Json::sanitize($result));

Feature/http api new approach #348

Are you sure you want to change the base?

Feature/http api new approach #348

Uh oh!

Conversation

Jan-Schuppik commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Resolves:

require:

Uh oh!

nilmerg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nilmerg commented Aug 26, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Jan-Schuppik commented Aug 22, 2025 •

edited

Loading