fix: fix the type parameter issue

frameless · Nov 15, 2024 · 45a8a7d · 45a8a7d
1 parent bbeadfb
commit 45a8a7d
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 29 deletions.
diff --git a/apps/overige-objecten-api/src/controllers/objects/index.ts b/apps/overige-objecten-api/src/controllers/objects/index.ts
@@ -82,7 +82,9 @@ export const getAllObjectsController: RequestHandler = async (req, res, next) =>
     if (type.endsWith('kennisartikel')) return res.status(200).json({ ...pagination, results: kennisartikel });
 
     if (type.endsWith('vac')) return res.status(200).json({ results: vac });
-
+    // If no specific type, return empty array
+    if (!!type && !type.endsWith('kennisartikel') && !type.endsWith('vac'))
+      return res.status(200).json({ ...pagination, results: [] });
     // If no specific type, return both kennisartikel and vac objects
     if (vac.length > 0 && kennisartikel.length > 0)
       return res.status(200).json({ ...pagination, results: [...kennisartikel, ...vac] });

diff --git a/apps/overige-objecten-api/src/controllers/openapi/index.test.ts b/apps/overige-objecten-api/src/controllers/openapi/index.test.ts
@@ -16,21 +16,4 @@ describe('openAPIController', () => {
     expect(response.text).toEqual(JSON.stringify({ message: 'An unexpected error occurred.' }));
     spy.mockRestore();
   });
-  it('GET api/v2/openapi.json return 200 and json with updated type parameter schema enum contains the correct URLs', async () => {
-    const spy = jest
-      .spyOn(require('../../utils/getTheServerURL'), 'getTheServerURL')
-      .mockImplementation(() => 'https://example.com/');
-    const response = await request(app).get('/api/v2/openapi.json');
-    const body = response.body as OpenAPI;
-    expect(response.status).toBe(200);
-    expect(body).toBeDefined();
-    expect(body.paths['/objects'].get.parameters).toBeDefined();
-    const typeParameter = body.paths['/objects'].get.parameters.find((parameter) => parameter.name === 'type');
-    expect(typeParameter).toBeDefined();
-    expect(typeParameter?.schema.enum).toEqual([
-      'https://example.com/api/v2/objecttypes/kennisartikel',
-      'https://example.com/api/v2/objecttypes/vac',
-    ]);
-    spy.mockRestore();
-  });
 });
diff --git a/apps/overige-objecten-api/src/controllers/openapi/index.ts b/apps/overige-objecten-api/src/controllers/openapi/index.ts
@@ -8,7 +8,6 @@ import { getTheServerURL, readFile } from '../../utils';
 export const openAPIController: RequestHandler = async (req, res, next) => {
   try {
     const url = new URL('api/v2', getTheServerURL(req)).href;
-    const OBJECT_TYPE_ENUM = [`${url}/objecttypes/kennisartikel`, `${url}/objecttypes/vac`];
     const OPEN_API_YAML = readFile(path.join(__dirname, '../../docs/openapi.yaml'));
 
     if (!OPEN_API_YAML) throw new Error('openapi.yaml file not found');
@@ -19,13 +18,6 @@ export const openAPIController: RequestHandler = async (req, res, next) => {
       url,
       description: server.description,
     }));
-    // Update enum for specific endpoint parameter
-    const typeParameter = openAPIDocument.paths['/objects']?.get?.parameters?.find(
-      (parameter) => parameter.name === 'type',
-    );
-    if (typeParameter?.schema) {
-      typeParameter.schema.enum = OBJECT_TYPE_ENUM;
-    }
 
     res.setHeader('Content-Type', 'application/json');
     res.setHeader('Access-Control-Allow-Origin', '*');

diff --git a/apps/overige-objecten-api/src/docs/openapi.yaml b/apps/overige-objecten-api/src/docs/openapi.yaml
@@ -21,10 +21,8 @@ paths:
           schema:
             type: string
             format: uri
-            enum:
-              - "http://localhost:4001/api/v2/objecttypes/kennisartikel"
-              - "http://localhost:4001/api/v2/objecttypes/vac"
           description: Optional parameter to filter by object type. If not specified, both types will be returned.
+          example: "http://localhost:4001/api/v2/objecttypes/kennisartikel"
         - in: query
           name: page
           required: false