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

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

@@ -134,6 +134,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",
@@ -2697,6 +2702,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"
@@ -3088,6 +3101,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"
@@ -3269,6 +3290,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"
+                                                            }
+                                                          }
+                                                        }
                                                       }
                                                     ]
                                                   }
@@ -6767,6 +6834,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"
@@ -8878,6 +8957,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"
@@ -9269,6 +9356,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"
@@ -9450,6 +9545,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"
+                                              }
+                                            }
+                                          }
                                         }
                                       ]
                                     }
@@ -12715,6 +12856,16 @@
         },
         {
           "debug": "stepThrough"
+        },
+        {
+          "integrations": {
+            "docDetectiveApi": {
+              "apiKey": "your-api-key-here"
+            }
+          }
+        },
+        {
+          "crawl": true
         }
       ]
     },
@@ -15830,6 +15981,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"
@@ -16221,6 +16380,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"
@@ -16402,6 +16569,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"
+                                                }
+                                              }
+                                            }
                                           }
                                         ]
                                       }
@@ -21592,6 +21805,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"
@@ -21983,6 +22204,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"
@@ -22164,6 +22393,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/spec_v3.schema.json

@@ -3104,6 +3104,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"
@@ -3495,6 +3503,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"
@@ -3676,6 +3692,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"
+                                      }
+                                    }
+                                  }
                                 }
                               ]
                             }
@@ -8866,6 +8928,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"
@@ -9257,6 +9327,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"
@@ -9438,6 +9516,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/step_v3.schema.json

@@ -1904,6 +1904,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"
@@ -2295,6 +2303,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"
@@ -2476,6 +2492,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"
+                      }
+                    }
+                  }
                 }
               ]
             }