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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -383,6 +383,11 @@
383
383
  "type": "boolean",
384
384
  "description": "Whether or not to run potentially unsafe steps, such as those that might modify files or system state."
385
385
  },
386
+ "crawl": {
387
+ "description": "If `true`, crawls sitemap.xml files specified by URL to find additional files to test.",
388
+ "type": "boolean",
389
+ "default": false
390
+ },
386
391
  "processDitaMaps": {
387
392
  "description": "If `true`, processes DITA maps and includes generated files as inputs.",
388
393
  "type": "boolean",
@@ -2946,6 +2951,14 @@
2946
2951
  }
2947
2952
  ],
2948
2953
  "default": {}
2954
+ },
2955
+ "required": {
2956
+ "type": "array",
2957
+ "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.",
2958
+ "items": {
2959
+ "type": "string"
2960
+ },
2961
+ "default": []
2949
2962
  }
2950
2963
  },
2951
2964
  "title": "Response"
@@ -3337,6 +3350,14 @@
3337
3350
  }
3338
3351
  ],
3339
3352
  "default": {}
3353
+ },
3354
+ "required": {
3355
+ "type": "array",
3356
+ "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.",
3357
+ "items": {
3358
+ "type": "string"
3359
+ },
3360
+ "default": []
3340
3361
  }
3341
3362
  },
3342
3363
  "title": "Response"
@@ -3518,6 +3539,52 @@
3518
3539
  "request": {
3519
3540
  "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
3520
3541
  }
3542
+ },
3543
+ {
3544
+ "url": "https://api.example.com/users/123",
3545
+ "response": {
3546
+ "required": [
3547
+ "id",
3548
+ "email",
3549
+ "createdAt"
3550
+ ]
3551
+ }
3552
+ },
3553
+ {
3554
+ "url": "https://api.example.com/users/123",
3555
+ "response": {
3556
+ "required": [
3557
+ "user.profile.name",
3558
+ "user.profile.avatar",
3559
+ "user.settings.notifications"
3560
+ ]
3561
+ }
3562
+ },
3563
+ {
3564
+ "url": "https://api.example.com/orders",
3565
+ "response": {
3566
+ "required": [
3567
+ "orders[0].id",
3568
+ "orders[0].total",
3569
+ "orders[0].items[0].productId"
3570
+ ]
3571
+ }
3572
+ },
3573
+ {
3574
+ "url": "https://api.example.com/users",
3575
+ "response": {
3576
+ "required": [
3577
+ "sessionToken",
3578
+ "expiresAt",
3579
+ "user.id"
3580
+ ],
3581
+ "body": {
3582
+ "status": "success",
3583
+ "user": {
3584
+ "role": "admin"
3585
+ }
3586
+ }
3587
+ }
3521
3588
  }
3522
3589
  ]
3523
3590
  }
@@ -7016,6 +7083,18 @@
7016
7083
  }
7017
7084
  ]
7018
7085
  }
7086
+ },
7087
+ "docDetectiveApi": {
7088
+ "type": "object",
7089
+ "description": "Configuration for Doc Detective Orchestration API integration.",
7090
+ "additionalProperties": false,
7091
+ "properties": {
7092
+ "apiKey": {
7093
+ "type": "string",
7094
+ "description": "API key for authenticating with the Doc Detective Orchestration API."
7095
+ }
7096
+ },
7097
+ "title": "Doc Detective Orchestration API"
7019
7098
  }
7020
7099
  },
7021
7100
  "title": "Integrations options"
@@ -9127,6 +9206,14 @@
9127
9206
  }
9128
9207
  ],
9129
9208
  "default": {}
9209
+ },
9210
+ "required": {
9211
+ "type": "array",
9212
+ "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.",
9213
+ "items": {
9214
+ "type": "string"
9215
+ },
9216
+ "default": []
9130
9217
  }
9131
9218
  },
9132
9219
  "title": "Response"
@@ -9518,6 +9605,14 @@
9518
9605
  }
9519
9606
  ],
9520
9607
  "default": {}
9608
+ },
9609
+ "required": {
9610
+ "type": "array",
9611
+ "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.",
9612
+ "items": {
9613
+ "type": "string"
9614
+ },
9615
+ "default": []
9521
9616
  }
9522
9617
  },
9523
9618
  "title": "Response"
@@ -9699,6 +9794,52 @@
9699
9794
  "request": {
9700
9795
  "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
9701
9796
  }
9797
+ },
9798
+ {
9799
+ "url": "https://api.example.com/users/123",
9800
+ "response": {
9801
+ "required": [
9802
+ "id",
9803
+ "email",
9804
+ "createdAt"
9805
+ ]
9806
+ }
9807
+ },
9808
+ {
9809
+ "url": "https://api.example.com/users/123",
9810
+ "response": {
9811
+ "required": [
9812
+ "user.profile.name",
9813
+ "user.profile.avatar",
9814
+ "user.settings.notifications"
9815
+ ]
9816
+ }
9817
+ },
9818
+ {
9819
+ "url": "https://api.example.com/orders",
9820
+ "response": {
9821
+ "required": [
9822
+ "orders[0].id",
9823
+ "orders[0].total",
9824
+ "orders[0].items[0].productId"
9825
+ ]
9826
+ }
9827
+ },
9828
+ {
9829
+ "url": "https://api.example.com/users",
9830
+ "response": {
9831
+ "required": [
9832
+ "sessionToken",
9833
+ "expiresAt",
9834
+ "user.id"
9835
+ ],
9836
+ "body": {
9837
+ "status": "success",
9838
+ "user": {
9839
+ "role": "admin"
9840
+ }
9841
+ }
9842
+ }
9702
9843
  }
9703
9844
  ]
9704
9845
  }
@@ -12964,6 +13105,16 @@
12964
13105
  },
12965
13106
  {
12966
13107
  "debug": "stepThrough"
13108
+ },
13109
+ {
13110
+ "integrations": {
13111
+ "docDetectiveApi": {
13112
+ "apiKey": "your-api-key-here"
13113
+ }
13114
+ }
13115
+ },
13116
+ {
13117
+ "crawl": true
12967
13118
  }
12968
13119
  ]
12969
13120
  },
@@ -14980,6 +15131,14 @@
14980
15131
  }
14981
15132
  ],
14982
15133
  "default": {}
15134
+ },
15135
+ "required": {
15136
+ "type": "array",
15137
+ "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.",
15138
+ "items": {
15139
+ "type": "string"
15140
+ },
15141
+ "default": []
14983
15142
  }
14984
15143
  },
14985
15144
  "title": "Response"
@@ -15371,6 +15530,14 @@
15371
15530
  }
15372
15531
  ],
15373
15532
  "default": {}
15533
+ },
15534
+ "required": {
15535
+ "type": "array",
15536
+ "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.",
15537
+ "items": {
15538
+ "type": "string"
15539
+ },
15540
+ "default": []
15374
15541
  }
15375
15542
  },
15376
15543
  "title": "Response"
@@ -15552,6 +15719,52 @@
15552
15719
  "request": {
15553
15720
  "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
15554
15721
  }
15722
+ },
15723
+ {
15724
+ "url": "https://api.example.com/users/123",
15725
+ "response": {
15726
+ "required": [
15727
+ "id",
15728
+ "email",
15729
+ "createdAt"
15730
+ ]
15731
+ }
15732
+ },
15733
+ {
15734
+ "url": "https://api.example.com/users/123",
15735
+ "response": {
15736
+ "required": [
15737
+ "user.profile.name",
15738
+ "user.profile.avatar",
15739
+ "user.settings.notifications"
15740
+ ]
15741
+ }
15742
+ },
15743
+ {
15744
+ "url": "https://api.example.com/orders",
15745
+ "response": {
15746
+ "required": [
15747
+ "orders[0].id",
15748
+ "orders[0].total",
15749
+ "orders[0].items[0].productId"
15750
+ ]
15751
+ }
15752
+ },
15753
+ {
15754
+ "url": "https://api.example.com/users",
15755
+ "response": {
15756
+ "required": [
15757
+ "sessionToken",
15758
+ "expiresAt",
15759
+ "user.id"
15760
+ ],
15761
+ "body": {
15762
+ "status": "success",
15763
+ "user": {
15764
+ "role": "admin"
15765
+ }
15766
+ }
15767
+ }
15555
15768
  }
15556
15769
  ]
15557
15770
  },
@@ -15954,6 +16167,11 @@
15954
16167
  "type": "boolean",
15955
16168
  "description": "Whether or not to run potentially unsafe steps, such as those that might modify files or system state."
15956
16169
  },
16170
+ "crawl": {
16171
+ "description": "If `true`, crawls sitemap.xml files specified by URL to find additional files to test.",
16172
+ "type": "boolean",
16173
+ "default": false
16174
+ },
15957
16175
  "processDitaMaps": {
15958
16176
  "description": "If `true`, processes DITA maps and includes generated files as inputs.",
15959
16177
  "type": "boolean",
@@ -18517,6 +18735,14 @@
18517
18735
  }
18518
18736
  ],
18519
18737
  "default": {}
18738
+ },
18739
+ "required": {
18740
+ "type": "array",
18741
+ "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.",
18742
+ "items": {
18743
+ "type": "string"
18744
+ },
18745
+ "default": []
18520
18746
  }
18521
18747
  },
18522
18748
  "title": "Response"
@@ -18908,6 +19134,14 @@
18908
19134
  }
18909
19135
  ],
18910
19136
  "default": {}
19137
+ },
19138
+ "required": {
19139
+ "type": "array",
19140
+ "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.",
19141
+ "items": {
19142
+ "type": "string"
19143
+ },
19144
+ "default": []
18911
19145
  }
18912
19146
  },
18913
19147
  "title": "Response"
@@ -19089,6 +19323,52 @@
19089
19323
  "request": {
19090
19324
  "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
19091
19325
  }
19326
+ },
19327
+ {
19328
+ "url": "https://api.example.com/users/123",
19329
+ "response": {
19330
+ "required": [
19331
+ "id",
19332
+ "email",
19333
+ "createdAt"
19334
+ ]
19335
+ }
19336
+ },
19337
+ {
19338
+ "url": "https://api.example.com/users/123",
19339
+ "response": {
19340
+ "required": [
19341
+ "user.profile.name",
19342
+ "user.profile.avatar",
19343
+ "user.settings.notifications"
19344
+ ]
19345
+ }
19346
+ },
19347
+ {
19348
+ "url": "https://api.example.com/orders",
19349
+ "response": {
19350
+ "required": [
19351
+ "orders[0].id",
19352
+ "orders[0].total",
19353
+ "orders[0].items[0].productId"
19354
+ ]
19355
+ }
19356
+ },
19357
+ {
19358
+ "url": "https://api.example.com/users",
19359
+ "response": {
19360
+ "required": [
19361
+ "sessionToken",
19362
+ "expiresAt",
19363
+ "user.id"
19364
+ ],
19365
+ "body": {
19366
+ "status": "success",
19367
+ "user": {
19368
+ "role": "admin"
19369
+ }
19370
+ }
19371
+ }
19092
19372
  }
19093
19373
  ]
19094
19374
  }
@@ -22587,6 +22867,18 @@
22587
22867
  }
22588
22868
  ]
22589
22869
  }
22870
+ },
22871
+ "docDetectiveApi": {
22872
+ "type": "object",
22873
+ "description": "Configuration for Doc Detective Orchestration API integration.",
22874
+ "additionalProperties": false,
22875
+ "properties": {
22876
+ "apiKey": {
22877
+ "type": "string",
22878
+ "description": "API key for authenticating with the Doc Detective Orchestration API."
22879
+ }
22880
+ },
22881
+ "title": "Doc Detective Orchestration API"
22590
22882
  }
22591
22883
  },
22592
22884
  "title": "Integrations options"
@@ -24698,6 +24990,14 @@
24698
24990
  }
24699
24991
  ],
24700
24992
  "default": {}
24993
+ },
24994
+ "required": {
24995
+ "type": "array",
24996
+ "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.",
24997
+ "items": {
24998
+ "type": "string"
24999
+ },
25000
+ "default": []
24701
25001
  }
24702
25002
  },
24703
25003
  "title": "Response"
@@ -25089,6 +25389,14 @@
25089
25389
  }
25090
25390
  ],
25091
25391
  "default": {}
25392
+ },
25393
+ "required": {
25394
+ "type": "array",
25395
+ "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.",
25396
+ "items": {
25397
+ "type": "string"
25398
+ },
25399
+ "default": []
25092
25400
  }
25093
25401
  },
25094
25402
  "title": "Response"
@@ -25270,6 +25578,52 @@
25270
25578
  "request": {
25271
25579
  "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
25272
25580
  }
25581
+ },
25582
+ {
25583
+ "url": "https://api.example.com/users/123",
25584
+ "response": {
25585
+ "required": [
25586
+ "id",
25587
+ "email",
25588
+ "createdAt"
25589
+ ]
25590
+ }
25591
+ },
25592
+ {
25593
+ "url": "https://api.example.com/users/123",
25594
+ "response": {
25595
+ "required": [
25596
+ "user.profile.name",
25597
+ "user.profile.avatar",
25598
+ "user.settings.notifications"
25599
+ ]
25600
+ }
25601
+ },
25602
+ {
25603
+ "url": "https://api.example.com/orders",
25604
+ "response": {
25605
+ "required": [
25606
+ "orders[0].id",
25607
+ "orders[0].total",
25608
+ "orders[0].items[0].productId"
25609
+ ]
25610
+ }
25611
+ },
25612
+ {
25613
+ "url": "https://api.example.com/users",
25614
+ "response": {
25615
+ "required": [
25616
+ "sessionToken",
25617
+ "expiresAt",
25618
+ "user.id"
25619
+ ],
25620
+ "body": {
25621
+ "status": "success",
25622
+ "user": {
25623
+ "role": "admin"
25624
+ }
25625
+ }
25626
+ }
25273
25627
  }
25274
25628
  ]
25275
25629
  }
@@ -28535,6 +28889,16 @@
28535
28889
  },
28536
28890
  {
28537
28891
  "debug": "stepThrough"
28892
+ },
28893
+ {
28894
+ "integrations": {
28895
+ "docDetectiveApi": {
28896
+ "apiKey": "your-api-key-here"
28897
+ }
28898
+ }
28899
+ },
28900
+ {
28901
+ "crawl": true
28538
28902
  }
28539
28903
  ]
28540
28904
  },
@@ -31650,6 +32014,14 @@
31650
32014
  }
31651
32015
  ],
31652
32016
  "default": {}
32017
+ },
32018
+ "required": {
32019
+ "type": "array",
32020
+ "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.",
32021
+ "items": {
32022
+ "type": "string"
32023
+ },
32024
+ "default": []
31653
32025
  }
31654
32026
  },
31655
32027
  "title": "Response"
@@ -32041,6 +32413,14 @@
32041
32413
  }
32042
32414
  ],
32043
32415
  "default": {}
32416
+ },
32417
+ "required": {
32418
+ "type": "array",
32419
+ "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.",
32420
+ "items": {
32421
+ "type": "string"
32422
+ },
32423
+ "default": []
32044
32424
  }
32045
32425
  },
32046
32426
  "title": "Response"
@@ -32222,6 +32602,52 @@
32222
32602
  "request": {
32223
32603
  "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
32224
32604
  }
32605
+ },
32606
+ {
32607
+ "url": "https://api.example.com/users/123",
32608
+ "response": {
32609
+ "required": [
32610
+ "id",
32611
+ "email",
32612
+ "createdAt"
32613
+ ]
32614
+ }
32615
+ },
32616
+ {
32617
+ "url": "https://api.example.com/users/123",
32618
+ "response": {
32619
+ "required": [
32620
+ "user.profile.name",
32621
+ "user.profile.avatar",
32622
+ "user.settings.notifications"
32623
+ ]
32624
+ }
32625
+ },
32626
+ {
32627
+ "url": "https://api.example.com/orders",
32628
+ "response": {
32629
+ "required": [
32630
+ "orders[0].id",
32631
+ "orders[0].total",
32632
+ "orders[0].items[0].productId"
32633
+ ]
32634
+ }
32635
+ },
32636
+ {
32637
+ "url": "https://api.example.com/users",
32638
+ "response": {
32639
+ "required": [
32640
+ "sessionToken",
32641
+ "expiresAt",
32642
+ "user.id"
32643
+ ],
32644
+ "body": {
32645
+ "status": "success",
32646
+ "user": {
32647
+ "role": "admin"
32648
+ }
32649
+ }
32650
+ }
32225
32651
  }
32226
32652
  ]
32227
32653
  }
@@ -37412,6 +37838,14 @@
37412
37838
  }
37413
37839
  ],
37414
37840
  "default": {}
37841
+ },
37842
+ "required": {
37843
+ "type": "array",
37844
+ "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.",
37845
+ "items": {
37846
+ "type": "string"
37847
+ },
37848
+ "default": []
37415
37849
  }
37416
37850
  },
37417
37851
  "title": "Response"
@@ -37803,6 +38237,14 @@
37803
38237
  }
37804
38238
  ],
37805
38239
  "default": {}
38240
+ },
38241
+ "required": {
38242
+ "type": "array",
38243
+ "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.",
38244
+ "items": {
38245
+ "type": "string"
38246
+ },
38247
+ "default": []
37806
38248
  }
37807
38249
  },
37808
38250
  "title": "Response"
@@ -37984,6 +38426,52 @@
37984
38426
  "request": {
37985
38427
  "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
37986
38428
  }
38429
+ },
38430
+ {
38431
+ "url": "https://api.example.com/users/123",
38432
+ "response": {
38433
+ "required": [
38434
+ "id",
38435
+ "email",
38436
+ "createdAt"
38437
+ ]
38438
+ }
38439
+ },
38440
+ {
38441
+ "url": "https://api.example.com/users/123",
38442
+ "response": {
38443
+ "required": [
38444
+ "user.profile.name",
38445
+ "user.profile.avatar",
38446
+ "user.settings.notifications"
38447
+ ]
38448
+ }
38449
+ },
38450
+ {
38451
+ "url": "https://api.example.com/orders",
38452
+ "response": {
38453
+ "required": [
38454
+ "orders[0].id",
38455
+ "orders[0].total",
38456
+ "orders[0].items[0].productId"
38457
+ ]
38458
+ }
38459
+ },
38460
+ {
38461
+ "url": "https://api.example.com/users",
38462
+ "response": {
38463
+ "required": [
38464
+ "sessionToken",
38465
+ "expiresAt",
38466
+ "user.id"
38467
+ ],
38468
+ "body": {
38469
+ "status": "success",
38470
+ "user": {
38471
+ "role": "admin"
38472
+ }
38473
+ }
38474
+ }
37987
38475
  }
37988
38476
  ]
37989
38477
  }
@@ -44884,6 +45372,14 @@
44884
45372
  }
44885
45373
  ],
44886
45374
  "default": {}
45375
+ },
45376
+ "required": {
45377
+ "type": "array",
45378
+ "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.",
45379
+ "items": {
45380
+ "type": "string"
45381
+ },
45382
+ "default": []
44887
45383
  }
44888
45384
  },
44889
45385
  "title": "Response"
@@ -45275,6 +45771,14 @@
45275
45771
  }
45276
45772
  ],
45277
45773
  "default": {}
45774
+ },
45775
+ "required": {
45776
+ "type": "array",
45777
+ "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.",
45778
+ "items": {
45779
+ "type": "string"
45780
+ },
45781
+ "default": []
45278
45782
  }
45279
45783
  },
45280
45784
  "title": "Response"
@@ -45456,6 +45960,52 @@
45456
45960
  "request": {
45457
45961
  "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
45458
45962
  }
45963
+ },
45964
+ {
45965
+ "url": "https://api.example.com/users/123",
45966
+ "response": {
45967
+ "required": [
45968
+ "id",
45969
+ "email",
45970
+ "createdAt"
45971
+ ]
45972
+ }
45973
+ },
45974
+ {
45975
+ "url": "https://api.example.com/users/123",
45976
+ "response": {
45977
+ "required": [
45978
+ "user.profile.name",
45979
+ "user.profile.avatar",
45980
+ "user.settings.notifications"
45981
+ ]
45982
+ }
45983
+ },
45984
+ {
45985
+ "url": "https://api.example.com/orders",
45986
+ "response": {
45987
+ "required": [
45988
+ "orders[0].id",
45989
+ "orders[0].total",
45990
+ "orders[0].items[0].productId"
45991
+ ]
45992
+ }
45993
+ },
45994
+ {
45995
+ "url": "https://api.example.com/users",
45996
+ "response": {
45997
+ "required": [
45998
+ "sessionToken",
45999
+ "expiresAt",
46000
+ "user.id"
46001
+ ],
46002
+ "body": {
46003
+ "status": "success",
46004
+ "user": {
46005
+ "role": "admin"
46006
+ }
46007
+ }
46008
+ }
45459
46009
  }
45460
46010
  ]
45461
46011
  }
@@ -50646,6 +51196,14 @@
50646
51196
  }
50647
51197
  ],
50648
51198
  "default": {}
51199
+ },
51200
+ "required": {
51201
+ "type": "array",
51202
+ "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.",
51203
+ "items": {
51204
+ "type": "string"
51205
+ },
51206
+ "default": []
50649
51207
  }
50650
51208
  },
50651
51209
  "title": "Response"
@@ -51037,6 +51595,14 @@
51037
51595
  }
51038
51596
  ],
51039
51597
  "default": {}
51598
+ },
51599
+ "required": {
51600
+ "type": "array",
51601
+ "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.",
51602
+ "items": {
51603
+ "type": "string"
51604
+ },
51605
+ "default": []
51040
51606
  }
51041
51607
  },
51042
51608
  "title": "Response"
@@ -51218,6 +51784,52 @@
51218
51784
  "request": {
51219
51785
  "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
51220
51786
  }
51787
+ },
51788
+ {
51789
+ "url": "https://api.example.com/users/123",
51790
+ "response": {
51791
+ "required": [
51792
+ "id",
51793
+ "email",
51794
+ "createdAt"
51795
+ ]
51796
+ }
51797
+ },
51798
+ {
51799
+ "url": "https://api.example.com/users/123",
51800
+ "response": {
51801
+ "required": [
51802
+ "user.profile.name",
51803
+ "user.profile.avatar",
51804
+ "user.settings.notifications"
51805
+ ]
51806
+ }
51807
+ },
51808
+ {
51809
+ "url": "https://api.example.com/orders",
51810
+ "response": {
51811
+ "required": [
51812
+ "orders[0].id",
51813
+ "orders[0].total",
51814
+ "orders[0].items[0].productId"
51815
+ ]
51816
+ }
51817
+ },
51818
+ {
51819
+ "url": "https://api.example.com/users",
51820
+ "response": {
51821
+ "required": [
51822
+ "sessionToken",
51823
+ "expiresAt",
51824
+ "user.id"
51825
+ ],
51826
+ "body": {
51827
+ "status": "success",
51828
+ "user": {
51829
+ "role": "admin"
51830
+ }
51831
+ }
51832
+ }
51221
51833
  }
51222
51834
  ]
51223
51835
  }
@@ -59146,6 +59758,14 @@
59146
59758
  }
59147
59759
  ],
59148
59760
  "default": {}
59761
+ },
59762
+ "required": {
59763
+ "type": "array",
59764
+ "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.",
59765
+ "items": {
59766
+ "type": "string"
59767
+ },
59768
+ "default": []
59149
59769
  }
59150
59770
  },
59151
59771
  "title": "Response"
@@ -59537,6 +60157,14 @@
59537
60157
  }
59538
60158
  ],
59539
60159
  "default": {}
60160
+ },
60161
+ "required": {
60162
+ "type": "array",
60163
+ "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.",
60164
+ "items": {
60165
+ "type": "string"
60166
+ },
60167
+ "default": []
59540
60168
  }
59541
60169
  },
59542
60170
  "title": "Response"
@@ -59718,6 +60346,52 @@
59718
60346
  "request": {
59719
60347
  "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
59720
60348
  }
60349
+ },
60350
+ {
60351
+ "url": "https://api.example.com/users/123",
60352
+ "response": {
60353
+ "required": [
60354
+ "id",
60355
+ "email",
60356
+ "createdAt"
60357
+ ]
60358
+ }
60359
+ },
60360
+ {
60361
+ "url": "https://api.example.com/users/123",
60362
+ "response": {
60363
+ "required": [
60364
+ "user.profile.name",
60365
+ "user.profile.avatar",
60366
+ "user.settings.notifications"
60367
+ ]
60368
+ }
60369
+ },
60370
+ {
60371
+ "url": "https://api.example.com/orders",
60372
+ "response": {
60373
+ "required": [
60374
+ "orders[0].id",
60375
+ "orders[0].total",
60376
+ "orders[0].items[0].productId"
60377
+ ]
60378
+ }
60379
+ },
60380
+ {
60381
+ "url": "https://api.example.com/users",
60382
+ "response": {
60383
+ "required": [
60384
+ "sessionToken",
60385
+ "expiresAt",
60386
+ "user.id"
60387
+ ],
60388
+ "body": {
60389
+ "status": "success",
60390
+ "user": {
60391
+ "role": "admin"
60392
+ }
60393
+ }
60394
+ }
59721
60395
  }
59722
60396
  ]
59723
60397
  }
@@ -64908,6 +65582,14 @@
64908
65582
  }
64909
65583
  ],
64910
65584
  "default": {}
65585
+ },
65586
+ "required": {
65587
+ "type": "array",
65588
+ "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.",
65589
+ "items": {
65590
+ "type": "string"
65591
+ },
65592
+ "default": []
64911
65593
  }
64912
65594
  },
64913
65595
  "title": "Response"
@@ -65299,6 +65981,14 @@
65299
65981
  }
65300
65982
  ],
65301
65983
  "default": {}
65984
+ },
65985
+ "required": {
65986
+ "type": "array",
65987
+ "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.",
65988
+ "items": {
65989
+ "type": "string"
65990
+ },
65991
+ "default": []
65302
65992
  }
65303
65993
  },
65304
65994
  "title": "Response"
@@ -65480,6 +66170,52 @@
65480
66170
  "request": {
65481
66171
  "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
65482
66172
  }
66173
+ },
66174
+ {
66175
+ "url": "https://api.example.com/users/123",
66176
+ "response": {
66177
+ "required": [
66178
+ "id",
66179
+ "email",
66180
+ "createdAt"
66181
+ ]
66182
+ }
66183
+ },
66184
+ {
66185
+ "url": "https://api.example.com/users/123",
66186
+ "response": {
66187
+ "required": [
66188
+ "user.profile.name",
66189
+ "user.profile.avatar",
66190
+ "user.settings.notifications"
66191
+ ]
66192
+ }
66193
+ },
66194
+ {
66195
+ "url": "https://api.example.com/orders",
66196
+ "response": {
66197
+ "required": [
66198
+ "orders[0].id",
66199
+ "orders[0].total",
66200
+ "orders[0].items[0].productId"
66201
+ ]
66202
+ }
66203
+ },
66204
+ {
66205
+ "url": "https://api.example.com/users",
66206
+ "response": {
66207
+ "required": [
66208
+ "sessionToken",
66209
+ "expiresAt",
66210
+ "user.id"
66211
+ ],
66212
+ "body": {
66213
+ "status": "success",
66214
+ "user": {
66215
+ "role": "admin"
66216
+ }
66217
+ }
66218
+ }
65483
66219
  }
65484
66220
  ]
65485
66221
  }
@@ -70950,6 +71686,14 @@
70950
71686
  }
70951
71687
  ],
70952
71688
  "default": {}
71689
+ },
71690
+ "required": {
71691
+ "type": "array",
71692
+ "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.",
71693
+ "items": {
71694
+ "type": "string"
71695
+ },
71696
+ "default": []
70953
71697
  }
70954
71698
  },
70955
71699
  "title": "Response"
@@ -71341,6 +72085,14 @@
71341
72085
  }
71342
72086
  ],
71343
72087
  "default": {}
72088
+ },
72089
+ "required": {
72090
+ "type": "array",
72091
+ "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.",
72092
+ "items": {
72093
+ "type": "string"
72094
+ },
72095
+ "default": []
71344
72096
  }
71345
72097
  },
71346
72098
  "title": "Response"
@@ -71522,6 +72274,52 @@
71522
72274
  "request": {
71523
72275
  "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
71524
72276
  }
72277
+ },
72278
+ {
72279
+ "url": "https://api.example.com/users/123",
72280
+ "response": {
72281
+ "required": [
72282
+ "id",
72283
+ "email",
72284
+ "createdAt"
72285
+ ]
72286
+ }
72287
+ },
72288
+ {
72289
+ "url": "https://api.example.com/users/123",
72290
+ "response": {
72291
+ "required": [
72292
+ "user.profile.name",
72293
+ "user.profile.avatar",
72294
+ "user.settings.notifications"
72295
+ ]
72296
+ }
72297
+ },
72298
+ {
72299
+ "url": "https://api.example.com/orders",
72300
+ "response": {
72301
+ "required": [
72302
+ "orders[0].id",
72303
+ "orders[0].total",
72304
+ "orders[0].items[0].productId"
72305
+ ]
72306
+ }
72307
+ },
72308
+ {
72309
+ "url": "https://api.example.com/users",
72310
+ "response": {
72311
+ "required": [
72312
+ "sessionToken",
72313
+ "expiresAt",
72314
+ "user.id"
72315
+ ],
72316
+ "body": {
72317
+ "status": "success",
72318
+ "user": {
72319
+ "role": "admin"
72320
+ }
72321
+ }
72322
+ }
71525
72323
  }
71526
72324
  ]
71527
72325
  }
@@ -77067,6 +77865,14 @@
77067
77865
  }
77068
77866
  ],
77069
77867
  "default": {}
77868
+ },
77869
+ "required": {
77870
+ "type": "array",
77871
+ "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.",
77872
+ "items": {
77873
+ "type": "string"
77874
+ },
77875
+ "default": []
77070
77876
  }
77071
77877
  },
77072
77878
  "title": "Response"
@@ -77458,6 +78264,14 @@
77458
78264
  }
77459
78265
  ],
77460
78266
  "default": {}
78267
+ },
78268
+ "required": {
78269
+ "type": "array",
78270
+ "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.",
78271
+ "items": {
78272
+ "type": "string"
78273
+ },
78274
+ "default": []
77461
78275
  }
77462
78276
  },
77463
78277
  "title": "Response"
@@ -77639,6 +78453,52 @@
77639
78453
  "request": {
77640
78454
  "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
77641
78455
  }
78456
+ },
78457
+ {
78458
+ "url": "https://api.example.com/users/123",
78459
+ "response": {
78460
+ "required": [
78461
+ "id",
78462
+ "email",
78463
+ "createdAt"
78464
+ ]
78465
+ }
78466
+ },
78467
+ {
78468
+ "url": "https://api.example.com/users/123",
78469
+ "response": {
78470
+ "required": [
78471
+ "user.profile.name",
78472
+ "user.profile.avatar",
78473
+ "user.settings.notifications"
78474
+ ]
78475
+ }
78476
+ },
78477
+ {
78478
+ "url": "https://api.example.com/orders",
78479
+ "response": {
78480
+ "required": [
78481
+ "orders[0].id",
78482
+ "orders[0].total",
78483
+ "orders[0].items[0].productId"
78484
+ ]
78485
+ }
78486
+ },
78487
+ {
78488
+ "url": "https://api.example.com/users",
78489
+ "response": {
78490
+ "required": [
78491
+ "sessionToken",
78492
+ "expiresAt",
78493
+ "user.id"
78494
+ ],
78495
+ "body": {
78496
+ "status": "success",
78497
+ "user": {
78498
+ "role": "admin"
78499
+ }
78500
+ }
78501
+ }
77642
78502
  }
77643
78503
  ]
77644
78504
  }
@@ -82829,6 +83689,14 @@
82829
83689
  }
82830
83690
  ],
82831
83691
  "default": {}
83692
+ },
83693
+ "required": {
83694
+ "type": "array",
83695
+ "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.",
83696
+ "items": {
83697
+ "type": "string"
83698
+ },
83699
+ "default": []
82832
83700
  }
82833
83701
  },
82834
83702
  "title": "Response"
@@ -83220,6 +84088,14 @@
83220
84088
  }
83221
84089
  ],
83222
84090
  "default": {}
84091
+ },
84092
+ "required": {
84093
+ "type": "array",
84094
+ "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.",
84095
+ "items": {
84096
+ "type": "string"
84097
+ },
84098
+ "default": []
83223
84099
  }
83224
84100
  },
83225
84101
  "title": "Response"
@@ -83401,6 +84277,52 @@
83401
84277
  "request": {
83402
84278
  "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
83403
84279
  }
84280
+ },
84281
+ {
84282
+ "url": "https://api.example.com/users/123",
84283
+ "response": {
84284
+ "required": [
84285
+ "id",
84286
+ "email",
84287
+ "createdAt"
84288
+ ]
84289
+ }
84290
+ },
84291
+ {
84292
+ "url": "https://api.example.com/users/123",
84293
+ "response": {
84294
+ "required": [
84295
+ "user.profile.name",
84296
+ "user.profile.avatar",
84297
+ "user.settings.notifications"
84298
+ ]
84299
+ }
84300
+ },
84301
+ {
84302
+ "url": "https://api.example.com/orders",
84303
+ "response": {
84304
+ "required": [
84305
+ "orders[0].id",
84306
+ "orders[0].total",
84307
+ "orders[0].items[0].productId"
84308
+ ]
84309
+ }
84310
+ },
84311
+ {
84312
+ "url": "https://api.example.com/users",
84313
+ "response": {
84314
+ "required": [
84315
+ "sessionToken",
84316
+ "expiresAt",
84317
+ "user.id"
84318
+ ],
84319
+ "body": {
84320
+ "status": "success",
84321
+ "user": {
84322
+ "role": "admin"
84323
+ }
84324
+ }
84325
+ }
83404
84326
  }
83405
84327
  ]
83406
84328
  }