Support query params and missing headers / response headers in capture (

#2478)
opticdev · Nov 2, 2023 · f4fec04 · f4fec04
1 parent 371fcb1
commit f4fec04
Show file tree

Hide file tree

Showing 36 changed files with 6,654 additions and 5,763 deletions.
diff --git a/projects/optic/src/__tests__/integration/__snapshots__/capture.test.ts.snap b/projects/optic/src/__tests__/integration/__snapshots__/capture.test.ts.snap
@@ -315,6 +315,17 @@ paths:
     get:
       responses:
         {}
+      parameters:
+        - schema:
+            type: string
+          in: query
+          name: foo1
+          required: true
+        - schema:
+            type: string
+          in: query
+          name: foo2
+          required: true
   /cookies:
     get:
       responses:
@@ -377,6 +388,17 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/GetGet200ResponseBody"
+      parameters:
+        - schema:
+            type: string
+          in: query
+          name: foo1
+          required: true
+        - schema:
+            type: string
+          in: query
+          name: foo2
+          required: true
   /gzip:
     get:
       responses:
@@ -451,6 +473,27 @@ paths:
             text/html:
               schema:
                 type: string
+      parameters:
+        - schema:
+            type: string
+          in: query
+          name: foo1
+          required: true
+        - schema:
+            type: string
+          in: query
+          name: foo2
+          required: true
+        - schema:
+            type: string
+          in: query
+          name: Content-Type
+          required: true
+        - schema:
+            type: string
+          in: query
+          name: test
+          required: true
   /status/{status}:
     parameters:
       - in: path
@@ -494,6 +537,42 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/GetTimeTime200ResponseBody"
+      parameters:
+        - schema:
+            type: string
+          in: query
+          name: timestamp
+          required: false
+        - schema:
+            type: string
+          in: query
+          name: format
+          required: true
+        - schema:
+            type: string
+          in: query
+          name: unit
+          required: true
+        - schema:
+            type: string
+          in: query
+          name: years
+          required: true
+        - schema:
+            type: string
+          in: query
+          name: target
+          required: true
+        - schema:
+            type: string
+          in: query
+          name: start
+          required: true
+        - schema:
+            type: string
+          in: query
+          name: end
+          required: true
   /transform/collection:
     post:
       responses:
@@ -508,6 +587,17 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/PostTransformCollectionRequestBody"
+      parameters:
+        - schema:
+            type: string
+          in: query
+          name: from
+          required: true
+        - schema:
+            type: string
+          in: query
+          name: to
+          required: true
 components:
   schemas:
     GetBooks200ResponseBody:
@@ -1861,16 +1951,12 @@ GET /books/{bookId}
   [31m[200 response body] 'status' is not documented (/properties)[39m
   [31m[200 response body] 'price' is not documented (/properties)[39m
 GET /books
-  [31m× [39m200 response
-  [31m[200 response body] 'name' is not documented (/properties/books/items/properties)[39m
-  [31m[200 response body] 'author_id' is not documented (/properties/books/items/properties)[39m
-  [31m[200 response body] 'status' is not documented (/properties/books/items/properties)[39m
-  [31m[200 response body] 'price' is not documented (/properties/books/items/properties)[39m
-  [31m[200 response body] 'created_at' is not documented (/properties/books/items/properties)[39m
-  [31m[200 response body] 'updated_at' is not documented (/properties/books/items/properties)[39m
+  200 response
+  [31m[404 response body] body is not documented[39m
+  [31m[query parameter] list is not documented[39m
 
-100.0% coverage of your documented operations. 2 requests did not match a documented path (6 total requests).
-8 diffs detected in documented operations
+83.3% coverage of your documented operations. 2 requests did not match a documented path (6 total requests).
+4 diffs detected in documented operations
 
 [33mNew endpoints are only added in interactive mode. Run 'optic capture openapi-with-overlapping-paths.yml --update interactive' to add new endpoints[39m
 "

diff --git a/projects/optic/src/__tests__/integration/workspaces/capture/with-server/optic.yml b/projects/optic/src/__tests__/integration/workspaces/capture/with-server/optic.yml
@@ -6,7 +6,7 @@ capture:
       ready_endpoint: /healthcheck
     requests:
       send:
-        - path: /books
+        - path: /books?list=all
           method: GET
         - path: /books/asd
           method: GET

diff --git a/projects/optic/src/commands/capture/actions/documented.ts b/projects/optic/src/commands/capture/actions/documented.ts
@@ -1,5 +1,4 @@
 import chalk from 'chalk';
-import path from 'path';
 import { jsonPointerHelpers } from '@useoptic/json-pointer-helpers';
 import { ParseResult } from '../../../utils/spec-loaders';
 import {
@@ -63,6 +62,7 @@ function summarizePatch(
   const { jsonLike: spec, sourcemap } = parseResult;
   const pointerLogger = jsonPointerLogger(sourcemap);
   const { diff, path, groupedOperations } = patch;
+  const color = options.mode === 'update' ? chalk.green : chalk.red;
   if (!diff || groupedOperations.length === 0) return [];
   if (
     diff.kind === 'UnmatchdResponseBody' ||
@@ -75,8 +75,30 @@ function summarizePatch(
         : `[${diff.statusCode} response body]`;
     const action =
       options.mode === 'update' ? 'has been added' : 'is not documented';
-    const color = options.mode === 'update' ? chalk.green : chalk.red;
     return [color(`${location} body ${action}`)];
+  } else if (
+    diff.kind === 'UnmatchedRequestParameter' ||
+    diff.kind === 'UnmatchedResponseHeader'
+  ) {
+    const location =
+      diff.kind === 'UnmatchedRequestParameter'
+        ? `[${diff.in} parameter]`
+        : `[${diff.statusCode} response header]`;
+
+    const action =
+      options.mode === 'update' ? 'has been added' : 'is not documented';
+    return [color(`${location} ${diff.name} ${action}`)];
+  } else if (
+    diff.kind === 'MissingRequiredRequiredParameter' ||
+    diff.kind === 'MissingRequiredResponseHeader'
+  ) {
+    const location =
+      diff.kind === 'MissingRequiredRequiredParameter'
+        ? `[${diff.in} parameter]`
+        : `[${diff.statusCode} response header]`;
+    const action =
+      options.mode === 'update' ? 'is now optional' : 'is required and missing';
+    return [color(`${location} ${diff.name} ${action}`)];
   } else {
     const location = locationFromPath(path);
 
@@ -92,7 +114,6 @@ function summarizePatch(
 
       const action =
         options.mode === 'update' ? 'has been added' : 'is not documented';
-      const color = options.mode === 'update' ? chalk.green : chalk.red;
       const propertyLocation =
         options.mode === 'update'
           ? `(${diff.propertyPath})`