fix required request body missing not rendering (#2644)

Author: niclim

package.json

@@ -2,7 +2,7 @@
   "name": "openapi-workspaces",
   "license": "MIT",
   "private": true,
-  "version": "0.53.19",
+  "version": "0.53.20",
   "workspaces": [
     "projects/json-pointer-helpers",
     "projects/openapi-io",

projects/fastify-capture/package.json

@@ -2,7 +2,7 @@
   "name": "@useoptic/fastify-capture",
   "license": "MIT",
   "packageManager": "[email protected]",
-  "version": "0.53.19",
+  "version": "0.53.20",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [

projects/json-pointer-helpers/package.json

@@ -2,7 +2,7 @@
   "name": "@useoptic/json-pointer-helpers",
   "license": "MIT",
   "packageManager": "[email protected]",
-  "version": "0.53.19",
+  "version": "0.53.20",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [

projects/openapi-io/package.json

@@ -2,7 +2,7 @@
   "name": "@useoptic/openapi-io",
   "license": "MIT",
   "packageManager": "[email protected]",
-  "version": "0.53.19",
+  "version": "0.53.20",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [

projects/openapi-utilities/package.json

@@ -2,7 +2,7 @@
   "name": "@useoptic/openapi-utilities",
   "license": "MIT",
   "packageManager": "[email protected]",
-  "version": "0.53.19",
+  "version": "0.53.20",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [

projects/optic/package.json

@@ -2,7 +2,7 @@
   "name": "@useoptic/optic",
   "license": "MIT",
   "packageManager": "[email protected]",
-  "version": "0.53.19",
+  "version": "0.53.20",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [

projects/optic/src/__tests__/integration/__snapshots__/capture.test.ts.snap

@@ -1869,11 +1869,12 @@ GET /books
   [200 response body] 'author_id' is now type number (/properties/books/items/properties/author_id)
   [200 response body] 'status' now has enum value 'hold' (/properties/books/items/properties/status/enum)
   [200 response body] schema (/properties/books/items/properties/price/maximum) with keyword 'maximum' and parameters {"comparison":"<=","limit":6} received invalid values 10, 15
-  [31m ⛔️ schema could not be automatically updated. Update the schema manually at [4mopenapi.yml:55:1281[24m[39m
+  [31m ⛔️ schema could not be automatically updated. Update the schema manually at [4mopenapi.yml:56:1304[24m[39m
 POST /books
   ✓ Request Body, ✓ 200 response
   [200 response body] body has been added
   [request body] 'price' is now type string (/properties/price)
+  [request body] body is now optional
 
 Learning path patterns for unmatched requests...
 Documenting new operations:
@@ -1893,6 +1894,7 @@ paths:
   /books:
     post:
       requestBody:
+        required: false
         content:
           application/json:
             schema:
@@ -2083,11 +2085,12 @@ GET /books
   [200 response body] 'author_id' is now type number (/properties/books/items/properties/author_id)
   [200 response body] 'status' now has enum value 'hold' (/properties/books/items/properties/status/enum)
   [200 response body] schema (/properties/books/items/properties/price/maximum) with keyword 'maximum' and parameters {"comparison":"<=","limit":6} received invalid values 10, 15
-  [31m ⛔️ schema could not be automatically updated. Update the schema manually at [4mopenapi.yml:55:1281[24m[39m
+  [31m ⛔️ schema could not be automatically updated. Update the schema manually at [4mopenapi.yml:56:1304[24m[39m
 POST /books
   ✓ Request Body, ✓ 200 response
   [200 response body] body has been added
   [request body] 'price' is now type string (/properties/price)
+  [request body] body is now optional
 
 4 unmatched requests
 
@@ -2105,6 +2108,7 @@ paths:
   /books:
     post:
       requestBody:
+        required: false
         content:
           application/json:
             schema:
@@ -2233,54 +2237,55 @@ GET /books
   [200 response body] 'updated_at' is not documented (/properties/books/items/properties)
   [200 response body] 'author_id' does not match type number. Received 6nTxAFM5ck4Hob77hGQoL (/properties/books/items/properties/author_id)
     Diff   'author_id' did not match schema
-[90m43 |[39m properties:
-[90m44 |[39m   id:
-[90m45 |[39m     type: string
-[90m46 |[39m [1m[33m  author_id:  [41m[Actual] "6nTxAFM5ck4Hob77hGQoL"[49m[39m[22m
-[90m47 |[39m     type: number
-[90m48 |[39m   status:
-[90m49 |[39m     type: string
+[90m44 |[39m properties:
+[90m45 |[39m   id:
+[90m46 |[39m     type: string
+[90m47 |[39m [1m[33m  author_id:  [41m[Actual] "6nTxAFM5ck4Hob77hGQoL"[49m[39m[22m
+[90m48 |[39m     type: number
+[90m49 |[39m   status:
+[90m50 |[39m     type: string
 $workspace$/openapi.yml
 
   [200 response body] 'status' missing enum value 'hold' (/properties/books/items/properties/status/enum)
     Diff   'status' does not have enum value hold
-[90m47 |[39m   type: number
-[90m48 |[39m status:
-[90m49 |[39m   type: string
-[90m50 |[39m [1m[33m  enum:  [41mmissing enum value 'hold'[49m[39m[22m
-[90m51 |[39m     - ready
-[90m52 |[39m     - not_ready
-[90m53 |[39m price:
+[90m48 |[39m   type: number
+[90m49 |[39m status:
+[90m50 |[39m   type: string
+[90m51 |[39m [1m[33m  enum:  [41mmissing enum value 'hold'[49m[39m[22m
+[90m52 |[39m     - ready
+[90m53 |[39m     - not_ready
+[90m54 |[39m price:
 $workspace$/openapi.yml
 
   [200 response body] schema (/properties/books/items/properties/price/maximum) with keyword 'maximum' and parameters {"comparison":"<=","limit":6} received invalid values 10, 15
     Diff   interaction did not match schema
-[90m52 |[39m       - not_ready
-[90m53 |[39m   price:
-[90m54 |[39m     type: number
-[90m55 |[39m [1m[33m    maximum: 6  [41m[Actual] 10, 15[49m[39m[22m
-[90m56 |[39m     minimum: 2
-[90m57 |[39m required:
-[90m58 |[39m   - id
+[90m53 |[39m       - not_ready
+[90m54 |[39m   price:
+[90m55 |[39m     type: number
+[90m56 |[39m [1m[33m    maximum: 6  [41m[Actual] 10, 15[49m[39m[22m
+[90m57 |[39m     minimum: 2
+[90m58 |[39m required:
+[90m59 |[39m   - id
 $workspace$/openapi.yml
 
 POST /books
   × Request Body
   [200 response body] body is not documented
   [request body] 'price' does not match type string. Received 1 (/properties/price)
     Diff   'price' did not match schema
-[90m15 |[39m properties:
-[90m16 |[39m   name:
-[90m17 |[39m     type: string
-[90m18 |[39m [1m[33m  price:  [41m[Actual] 1[49m[39m[22m
-[90m19 |[39m     type: string
-[90m20 |[39m   author_id:
-[90m21 |[39m     type: string
+[90m16 |[39m properties:
+[90m17 |[39m   name:
+[90m18 |[39m     type: string
+[90m19 |[39m [1m[33m  price:  [41m[Actual] 1[49m[39m[22m
+[90m20 |[39m     type: string
+[90m21 |[39m   author_id:
+[90m22 |[39m     type: string
 $workspace$/openapi.yml
 
+  [request body] body is required and missing
 
-100.0% coverage of your documented operations. 4 requests did not match a documented path (6 total requests).
-12 diffs detected in documented operations
+100.0% coverage of your documented operations. 4 requests did not match a documented path (7 total requests).
+13 diffs detected in documented operations
 
 New endpoints are only added in interactive mode. Run 'optic capture openapi.yml --update interactive' to add new endpoints
 "
@@ -2300,9 +2305,10 @@ POST /books
   × Request Body
   [200 response body] body is not documented
   [request body] 'price' does not match type string. Received 1 (/properties/price)
+  [request body] body is required and missing
 
-100.0% coverage of your documented operations. 4 requests did not match a documented path (6 total requests).
-8 diffs detected in documented operations
+100.0% coverage of your documented operations. 4 requests did not match a documented path (7 total requests).
+9 diffs detected in documented operations
 
 New endpoints are only added in interactive mode. Run 'optic capture openapi.yml --update interactive' to add new endpoints
 "

projects/optic/src/__tests__/integration/workspaces/capture/with-server/openapi.yml

@@ -7,6 +7,7 @@ paths:
   /books:
     post:
       requestBody:
+        required: true
         content:
           application/json:
             schema:

projects/optic/src/__tests__/integration/workspaces/capture/with-server/optic.yml

@@ -42,6 +42,8 @@ capture:
             name: asd
             price: 1
             author_id: 6nTxAFM5ck4Hob77hGQoL
+        - path: /books
+          method: POST
         - path: /authors
           method: GET
   openapi-prefixed-url.yml:

projects/optic/src/commands/capture/actions/documented.ts

@@ -64,7 +64,11 @@ function summarizePatch(
   const { diff, path, groupedOperations } = patch;
   const color = options.mode === 'update' ? chalk.green : chalk.red;
   if (!diff || groupedOperations.length === 0) return [];
-  if (
+  if (diff.kind === 'MissingRequestBody') {
+    const action =
+      options.mode === 'update' ? 'is now optional' : 'is required and missing';
+    return [color(`[request body] body ${action}`)];
+  } else if (
     diff.kind === 'UnmatchdResponseBody' ||
     diff.kind === 'UnmatchedRequestBody' ||
     diff.kind === 'UnmatchedResponseStatusCode'