fix(directory-service): adjust swagger criteria param definition

Also encoding tags link href to handle slashes in resource urn.
GovAlta · Jan 23, 2025 · f57320f · f57320f
1 parent db4c02b
commit f57320f
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 12 deletions.
diff --git a/apps/directory-service/src/directory/mapper.ts b/apps/directory-service/src/directory/mapper.ts
@@ -34,7 +34,7 @@ export function mapResource(apiId: AdspId, resource: Resource) {
             href: resource.urn.toString(),
           },
           tags: {
-            href: `${apiId}:/resources/${resource.urn}/tags`,
+            href: `${apiId}:/resources/${encodeURIComponent(resource.urn.toString())}/tags`,
           },
         },
         _embedded: resource.data && {

diff --git a/apps/directory-service/src/directory/router/resource.swagger.yml b/apps/directory-service/src/directory/router/resource.swagger.yml
@@ -203,11 +203,13 @@ components:
         description: Criteria for the resources to return.
         in: query
         required: false
-        schema:
-          type: object
-          properties:
-            typeEquals:
-              type: string
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                typeEquals:
+                  type: string
       - name: tag
         description: Value of the tag.
         in: path
@@ -258,11 +260,13 @@ components:
         description: Criteria for the resources to return.
         in: query
         required: false
-        schema:
-          type: object
-          properties:
-            typeEquals:
-              type: string
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                typeEquals:
+                  type: string
     responses:
       200:
         description: Request completed successfully

diff --git a/apps/directory-service/src/mongo/repository.ts b/apps/directory-service/src/mongo/repository.ts
@@ -409,7 +409,7 @@ export class MongoDirectoryRepository implements DirectoryRepository {
     }
 
     if (criteria.typeEquals) {
-      query.type = criteria.typeEquals.toString();
+      query.type = criteria.typeEquals;
     }
 
     const docs = await this.resourceModel.find(query).skip(skip).limit(top).exec();