doc-detective-common 3.4.0 → 3.4.1-dev.2

package/src/schemas/output_schemas/config_v3.schema.json

@@ -121,6 +121,11 @@
       "type": "boolean",
       "description": "Whether or not to run potentially unsafe steps, such as those that might modify files or system state."
     },
+    "crawl": {
+      "description": "If `true`, crawls sitemap.xml files specified by URL to find additional files to test.",
+      "type": "boolean",
+      "default": false
+    },
     "processDitaMaps": {
       "description": "If `true`, processes DITA maps and includes generated files as inputs.",
       "type": "boolean",
@@ -2684,6 +2689,14 @@
                                                               }
                                                             ],
                                                             "default": {}
+                                                          },
+                                                          "required": {
+                                                            "type": "array",
+                                                            "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+                                                            "items": {
+                                                              "type": "string"
+                                                            },
+                                                            "default": []
                                                           }
                                                         },
                                                         "title": "Response"
@@ -3075,6 +3088,14 @@
                                                                 }
                                                               ],
                                                               "default": {}
+                                                            },
+                                                            "required": {
+                                                              "type": "array",
+                                                              "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+                                                              "items": {
+                                                                "type": "string"
+                                                              },
+                                                              "default": []
                                                             }
                                                           },
                                                           "title": "Response"
@@ -3256,6 +3277,52 @@
                                                     "request": {
                                                       "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
                                                     }
+                                                  },
+                                                  {
+                                                    "url": "https://api.example.com/users/123",
+                                                    "response": {
+                                                      "required": [
+                                                        "id",
+                                                        "email",
+                                                        "createdAt"
+                                                      ]
+                                                    }
+                                                  },
+                                                  {
+                                                    "url": "https://api.example.com/users/123",
+                                                    "response": {
+                                                      "required": [
+                                                        "user.profile.name",
+                                                        "user.profile.avatar",
+                                                        "user.settings.notifications"
+                                                      ]
+                                                    }
+                                                  },
+                                                  {
+                                                    "url": "https://api.example.com/orders",
+                                                    "response": {
+                                                      "required": [
+                                                        "orders[0].id",
+                                                        "orders[0].total",
+                                                        "orders[0].items[0].productId"
+                                                      ]
+                                                    }
+                                                  },
+                                                  {
+                                                    "url": "https://api.example.com/users",
+                                                    "response": {
+                                                      "required": [
+                                                        "sessionToken",
+                                                        "expiresAt",
+                                                        "user.id"
+                                                      ],
+                                                      "body": {
+                                                        "status": "success",
+                                                        "user": {
+                                                          "role": "admin"
+                                                        }
+                                                      }
+                                                    }
                                                   }
                                                 ]
                                               }
@@ -6754,6 +6821,18 @@
               }
             ]
           }
+        },
+        "docDetectiveApi": {
+          "type": "object",
+          "description": "Configuration for Doc Detective Orchestration API integration.",
+          "additionalProperties": false,
+          "properties": {
+            "apiKey": {
+              "type": "string",
+              "description": "API key for authenticating with the Doc Detective Orchestration API."
+            }
+          },
+          "title": "Doc Detective Orchestration API"
         }
       },
       "title": "Integrations options"
@@ -8865,6 +8944,14 @@
                                                 }
                                               ],
                                               "default": {}
+                                            },
+                                            "required": {
+                                              "type": "array",
+                                              "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+                                              "items": {
+                                                "type": "string"
+                                              },
+                                              "default": []
                                             }
                                           },
                                           "title": "Response"
@@ -9256,6 +9343,14 @@
                                                   }
                                                 ],
                                                 "default": {}
+                                              },
+                                              "required": {
+                                                "type": "array",
+                                                "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+                                                "items": {
+                                                  "type": "string"
+                                                },
+                                                "default": []
                                               }
                                             },
                                             "title": "Response"
@@ -9437,6 +9532,52 @@
                                       "request": {
                                         "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
                                       }
+                                    },
+                                    {
+                                      "url": "https://api.example.com/users/123",
+                                      "response": {
+                                        "required": [
+                                          "id",
+                                          "email",
+                                          "createdAt"
+                                        ]
+                                      }
+                                    },
+                                    {
+                                      "url": "https://api.example.com/users/123",
+                                      "response": {
+                                        "required": [
+                                          "user.profile.name",
+                                          "user.profile.avatar",
+                                          "user.settings.notifications"
+                                        ]
+                                      }
+                                    },
+                                    {
+                                      "url": "https://api.example.com/orders",
+                                      "response": {
+                                        "required": [
+                                          "orders[0].id",
+                                          "orders[0].total",
+                                          "orders[0].items[0].productId"
+                                        ]
+                                      }
+                                    },
+                                    {
+                                      "url": "https://api.example.com/users",
+                                      "response": {
+                                        "required": [
+                                          "sessionToken",
+                                          "expiresAt",
+                                          "user.id"
+                                        ],
+                                        "body": {
+                                          "status": "success",
+                                          "user": {
+                                            "role": "admin"
+                                          }
+                                        }
+                                      }
                                     }
                                   ]
                                 }
@@ -12702,6 +12843,16 @@
     },
     {
       "debug": "stepThrough"
+    },
+    {
+      "integrations": {
+        "docDetectiveApi": {
+          "apiKey": "your-api-key-here"
+        }
+      }
+    },
+    {
+      "crawl": true
     }
   ]
 }

package/src/schemas/output_schemas/httpRequest_v3.schema.json

@@ -355,6 +355,14 @@
                 }
               ],
               "default": {}
+            },
+            "required": {
+              "type": "array",
+              "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+              "items": {
+                "type": "string"
+              },
+              "default": []
             }
           },
           "title": "Response"
@@ -746,6 +754,14 @@
                   }
                 ],
                 "default": {}
+              },
+              "required": {
+                "type": "array",
+                "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+                "items": {
+                  "type": "string"
+                },
+                "default": []
               }
             },
             "title": "Response"
@@ -927,6 +943,52 @@
       "request": {
         "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
       }
+    },
+    {
+      "url": "https://api.example.com/users/123",
+      "response": {
+        "required": [
+          "id",
+          "email",
+          "createdAt"
+        ]
+      }
+    },
+    {
+      "url": "https://api.example.com/users/123",
+      "response": {
+        "required": [
+          "user.profile.name",
+          "user.profile.avatar",
+          "user.settings.notifications"
+        ]
+      }
+    },
+    {
+      "url": "https://api.example.com/orders",
+      "response": {
+        "required": [
+          "orders[0].id",
+          "orders[0].total",
+          "orders[0].items[0].productId"
+        ]
+      }
+    },
+    {
+      "url": "https://api.example.com/users",
+      "response": {
+        "required": [
+          "sessionToken",
+          "expiresAt",
+          "user.id"
+        ],
+        "body": {
+          "status": "success",
+          "user": {
+            "role": "admin"
+          }
+        }
+      }
     }
   ]
 }

package/src/schemas/output_schemas/report_v3.schema.json

@@ -3122,6 +3122,14 @@
                                                       }
                                                     ],
                                                     "default": {}
+                                                  },
+                                                  "required": {
+                                                    "type": "array",
+                                                    "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+                                                    "items": {
+                                                      "type": "string"
+                                                    },
+                                                    "default": []
                                                   }
                                                 },
                                                 "title": "Response"
@@ -3513,6 +3521,14 @@
                                                         }
                                                       ],
                                                       "default": {}
+                                                    },
+                                                    "required": {
+                                                      "type": "array",
+                                                      "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+                                                      "items": {
+                                                        "type": "string"
+                                                      },
+                                                      "default": []
                                                     }
                                                   },
                                                   "title": "Response"
@@ -3694,6 +3710,52 @@
                                             "request": {
                                               "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
                                             }
+                                          },
+                                          {
+                                            "url": "https://api.example.com/users/123",
+                                            "response": {
+                                              "required": [
+                                                "id",
+                                                "email",
+                                                "createdAt"
+                                              ]
+                                            }
+                                          },
+                                          {
+                                            "url": "https://api.example.com/users/123",
+                                            "response": {
+                                              "required": [
+                                                "user.profile.name",
+                                                "user.profile.avatar",
+                                                "user.settings.notifications"
+                                              ]
+                                            }
+                                          },
+                                          {
+                                            "url": "https://api.example.com/orders",
+                                            "response": {
+                                              "required": [
+                                                "orders[0].id",
+                                                "orders[0].total",
+                                                "orders[0].items[0].productId"
+                                              ]
+                                            }
+                                          },
+                                          {
+                                            "url": "https://api.example.com/users",
+                                            "response": {
+                                              "required": [
+                                                "sessionToken",
+                                                "expiresAt",
+                                                "user.id"
+                                              ],
+                                              "body": {
+                                                "status": "success",
+                                                "user": {
+                                                  "role": "admin"
+                                                }
+                                              }
+                                            }
                                           }
                                         ]
                                       }
@@ -8884,6 +8946,14 @@
                                                             }
                                                           ],
                                                           "default": {}
+                                                        },
+                                                        "required": {
+                                                          "type": "array",
+                                                          "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+                                                          "items": {
+                                                            "type": "string"
+                                                          },
+                                                          "default": []
                                                         }
                                                       },
                                                       "title": "Response"
@@ -9275,6 +9345,14 @@
                                                               }
                                                             ],
                                                             "default": {}
+                                                          },
+                                                          "required": {
+                                                            "type": "array",
+                                                            "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+                                                            "items": {
+                                                              "type": "string"
+                                                            },
+                                                            "default": []
                                                           }
                                                         },
                                                         "title": "Response"
@@ -9456,6 +9534,52 @@
                                                   "request": {
                                                     "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
                                                   }
+                                                },
+                                                {
+                                                  "url": "https://api.example.com/users/123",
+                                                  "response": {
+                                                    "required": [
+                                                      "id",
+                                                      "email",
+                                                      "createdAt"
+                                                    ]
+                                                  }
+                                                },
+                                                {
+                                                  "url": "https://api.example.com/users/123",
+                                                  "response": {
+                                                    "required": [
+                                                      "user.profile.name",
+                                                      "user.profile.avatar",
+                                                      "user.settings.notifications"
+                                                    ]
+                                                  }
+                                                },
+                                                {
+                                                  "url": "https://api.example.com/orders",
+                                                  "response": {
+                                                    "required": [
+                                                      "orders[0].id",
+                                                      "orders[0].total",
+                                                      "orders[0].items[0].productId"
+                                                    ]
+                                                  }
+                                                },
+                                                {
+                                                  "url": "https://api.example.com/users",
+                                                  "response": {
+                                                    "required": [
+                                                      "sessionToken",
+                                                      "expiresAt",
+                                                      "user.id"
+                                                    ],
+                                                    "body": {
+                                                      "status": "success",
+                                                      "user": {
+                                                        "role": "admin"
+                                                      }
+                                                    }
+                                                  }
                                                 }
                                               ]
                                             }