Merge pull request #2447 from automatisch/aut-1537

feat(api): add get-app endpoint

packages/backend/src/controllers/api/v1/apps/get-app.ee.js

@@ -0,0 +1,8 @@
+import App from '../../../../models/app.js';
+import { renderObject } from '../../../../helpers/renderer.js';
+
+export default async (request, response) => {
+  const app = await App.findOneByKey(request.params.appKey);
+
+  renderObject(response, app, { serializer: 'App' });
+};

packages/backend/src/controllers/api/v1/apps/get-app.ee.test.js

@@ -0,0 +1,36 @@
+import { vi, describe, it, expect, beforeEach } from 'vitest';
+import request from 'supertest';
+import App from '../../../../models/app.js';
+import app from '../../../../app.js';
+import { createApiToken } from '../../../../../test/factories/api-token.js';
+import getAppMock from '../../../../../test/mocks/rest/internal/api/v1/apps/get-app.js';
+import * as license from '../../../../helpers/license.ee.js';
+
+describe('GET /api/v1/apps/:appKey', () => {
+  let token;
+
+  beforeEach(async () => {
+    vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
+
+    token = (await createApiToken()).token;
+  });
+
+  it('should return the app info', async () => {
+    const exampleApp = await App.findOneByKey('github');
+
+    const response = await request(app)
+      .get(`/api/v1/apps/${exampleApp.key}`)
+      .set('x-api-token', token)
+      .expect(200);
+
+    const expectedPayload = getAppMock(exampleApp);
+    expect(response.body).toStrictEqual(expectedPayload);
+  });
+
+  it('should return not found response for invalid app key', async () => {
+    await request(app)
+      .get('/api/v1/apps/invalid-app-key')
+      .set('x-api-token', token)
+      .expect(404);
+  });
+});

packages/backend/src/controllers/api/v1/apps/get-apps.ee.test.js

@@ -11,6 +11,7 @@ describe('GET /api/v1/apps', () => {
 
   beforeEach(async () => {
     vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
+
     token = (await createApiToken()).token;
     apps = await App.findAll();
   });

packages/backend/src/routes/api/v1/apps.js

@@ -1,8 +1,10 @@
 import { Router } from 'express';
+import getAppAction from '../../../controllers/api/v1/apps/get-app.ee.js';
 import getAppsAction from '../../../controllers/api/v1/apps/get-apps.ee.js';
 
 const router = Router();
 
 router.get('/', getAppsAction);
+router.get('/:appKey', getAppAction);
 
 export default router;