Fix path params (#94)

* oas3-chow-chow never sets validRequest.path.params * added changeset Co-authored-by: Chris Olson <[email protected]>
atlassian · Sep 26, 2021 · 7b113c2 · 7b113c2
1 parent f0fa68b
commit 7b113c2
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 2 deletions.
diff --git a/.changeset/rude-ducks-tickle.md b/.changeset/rude-ducks-tickle.md
@@ -0,0 +1,5 @@
+---
+"koa-oas3": patch
+---
+
+Fix setting of ctx.oas.request.path
diff --git a/__tests__/index.spec.ts b/__tests__/index.spec.ts
@@ -372,7 +372,7 @@ describe('Koa Oas3 with ChowOptions', () => {
       file: path.resolve('./__tests__/fixtures/pet-store.json'),
       endpoint: '/openapi',
       uiEndpoint: '/openapi.html',
-      validatePaths: ['/pets'],
+      validatePaths: ['/'],
       validationOptions: { requestBodyAjvOptions: { allErrors: true } } as ChowOptions
     });
   })
@@ -407,4 +407,20 @@ describe('Koa Oas3 with ChowOptions', () => {
     return expect(mw(ctx, next)).rejects.toThrow();
   })
 
+  test('ctx.oas.request.params populated with path param if validation passed', async () => {
+    const pathParam = 345;
+
+    const ctx = createContext({
+      url: `/pets/${pathParam}`,
+      headers: {
+        'accept': 'application/json'
+      },
+      method: 'GET'
+    });
+    const next = jest.fn();
+    await mw(ctx, next);
+    console.log(`ctx.oas: ${JSON.stringify(ctx.oas)}`)
+    expect(ctx.oas!.request.params.petId).toBe(pathParam);
+  });
+
 })
diff --git a/src/index.ts b/src/index.ts
@@ -53,7 +53,7 @@ export async function oas(cfg: Partial<Config>): Promise<koa.Middleware> {
       ctx.oas = {
         request: {
           query: validRequest.query,
-          params: validRequest.path && validRequest.path.params,
+          params: validRequest.path,
           header: validRequest.header,
         },
         operationId: validRequest.operationId