doc-detective-common 3.0.7 → 3.0.8

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.
Files changed (17) hide show
  1. package/dist/schemas/config_v3.schema.json +90 -36
  2. package/dist/schemas/httpRequest_v3.schema.json +45 -18
  3. package/dist/schemas/report_v3.schema.json +90 -36
  4. package/dist/schemas/resolvedTests_v3.schema.json +180 -72
  5. package/dist/schemas/spec_v3.schema.json +90 -36
  6. package/dist/schemas/step_v3.schema.json +45 -18
  7. package/dist/schemas/test_v3.schema.json +90 -36
  8. package/package.json +1 -1
  9. package/src/schemas/output_schemas/config_v3.schema.json +90 -36
  10. package/src/schemas/output_schemas/httpRequest_v3.schema.json +45 -18
  11. package/src/schemas/output_schemas/report_v3.schema.json +90 -36
  12. package/src/schemas/output_schemas/resolvedTests_v3.schema.json +180 -72
  13. package/src/schemas/output_schemas/spec_v3.schema.json +90 -36
  14. package/src/schemas/output_schemas/step_v3.schema.json +45 -18
  15. package/src/schemas/output_schemas/test_v3.schema.json +90 -36
  16. package/src/schemas/schemas.json +630 -252
  17. package/src/schemas/src_schemas/httpRequest_v3.schema.json +38 -53
package/dist/schemas/config_v3.schema.json CHANGED
@@ -2504,12 +2504,22 @@
2504
2504
  "additionalProperties": false,
2505
2505
  "properties": {
2506
2506
  "headers": {
2507
- "description": "Headers to include in the HTTP request, in key/value format.",
2508
- "type": "object",
2509
- "additionalProperties": true,
2510
- "properties": {},
2507
+ "description": "Headers to include in the HTTP request.",
2511
2508
  "default": {},
2512
- "title": "Request headers"
2509
+ "anyOf": [
2510
+ {
2511
+ "title": "Request headers (object)",
2512
+ "description": "Headers to include in the HTTP request, in key/value format.",
2513
+ "type": "object",
2514
+ "additionalProperties": true,
2515
+ "properties": {}
2516
+ },
2517
+ {
2518
+ "title": "Request headers (string)",
2519
+ "description": "Headers to include in the HTTP request, as return-separated values. For example, `Content-Type: application/json\nAuthorization: Bearer token`.",
2520
+ "type": "string"
2521
+ }
2522
+ ]
2513
2523
  },
2514
2524
  "parameters": {
2515
2525
  "description": "URL parameters to include in the HTTP request, in key/value format.",
@@ -2520,23 +2530,23 @@
2520
2530
  "title": "Request parameters"
2521
2531
  },
2522
2532
  "body": {
2523
- "description": "JSON object to include as the body of the HTTP request.",
2533
+ "description": "The body of the HTTP request.",
2524
2534
  "anyOf": [
2525
2535
  {
2526
- "title": "Request body object",
2536
+ "title": "Request body (object)",
2527
2537
  "description": "JSON object to include as the body of the HTTP request.",
2528
2538
  "type": "object",
2529
2539
  "additionalProperties": true,
2530
2540
  "properties": {}
2531
2541
  },
2532
2542
  {
2533
- "title": "Request body array",
2543
+ "title": "Request body (array)",
2534
2544
  "description": "JSON array to include as the body of the HTTP request.",
2535
2545
  "type": "array",
2536
2546
  "items": {}
2537
2547
  },
2538
2548
  {
2539
- "title": "Request body string",
2549
+ "title": "Request body (string)",
2540
2550
  "description": "String to include as the body of the HTTP request.",
2541
2551
  "type": "string"
2542
2552
  }
@@ -2885,12 +2895,22 @@
2885
2895
  "additionalProperties": false,
2886
2896
  "properties": {
2887
2897
  "headers": {
2888
- "description": "Headers to include in the HTTP request, in key/value format.",
2889
- "type": "object",
2890
- "additionalProperties": true,
2891
- "properties": {},
2898
+ "description": "Headers to include in the HTTP request.",
2892
2899
  "default": {},
2893
- "title": "Request headers"
2900
+ "anyOf": [
2901
+ {
2902
+ "title": "Request headers (object)",
2903
+ "description": "Headers to include in the HTTP request, in key/value format.",
2904
+ "type": "object",
2905
+ "additionalProperties": true,
2906
+ "properties": {}
2907
+ },
2908
+ {
2909
+ "title": "Request headers (string)",
2910
+ "description": "Headers to include in the HTTP request, as return-separated values. For example, `Content-Type: application/json\nAuthorization: Bearer token`.",
2911
+ "type": "string"
2912
+ }
2913
+ ]
2894
2914
  },
2895
2915
  "parameters": {
2896
2916
  "description": "URL parameters to include in the HTTP request, in key/value format.",
@@ -2901,23 +2921,23 @@
2901
2921
  "title": "Request parameters"
2902
2922
  },
2903
2923
  "body": {
2904
- "description": "JSON object to include as the body of the HTTP request.",
2924
+ "description": "The body of the HTTP request.",
2905
2925
  "anyOf": [
2906
2926
  {
2907
- "title": "Request body object",
2927
+ "title": "Request body (object)",
2908
2928
  "description": "JSON object to include as the body of the HTTP request.",
2909
2929
  "type": "object",
2910
2930
  "additionalProperties": true,
2911
2931
  "properties": {}
2912
2932
  },
2913
2933
  {
2914
- "title": "Request body array",
2934
+ "title": "Request body (array)",
2915
2935
  "description": "JSON array to include as the body of the HTTP request.",
2916
2936
  "type": "array",
2917
2937
  "items": {}
2918
2938
  },
2919
2939
  {
2920
- "title": "Request body string",
2940
+ "title": "Request body (string)",
2921
2941
  "description": "String to include as the body of the HTTP request.",
2922
2942
  "type": "string"
2923
2943
  }
@@ -3136,6 +3156,13 @@
3136
3156
  "Authorization": "Bearer $TOKEN"
3137
3157
  }
3138
3158
  }
3159
+ },
3160
+ {
3161
+ "url": "https://www.api-server.com",
3162
+ "method": "post",
3163
+ "request": {
3164
+ "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
3165
+ }
3139
3166
  }
3140
3167
  ]
3141
3168
  }
@@ -7526,12 +7553,22 @@
7526
7553
  "additionalProperties": false,
7527
7554
  "properties": {
7528
7555
  "headers": {
7529
- "description": "Headers to include in the HTTP request, in key/value format.",
7530
- "type": "object",
7531
- "additionalProperties": true,
7532
- "properties": {},
7556
+ "description": "Headers to include in the HTTP request.",
7533
7557
  "default": {},
7534
- "title": "Request headers"
7558
+ "anyOf": [
7559
+ {
7560
+ "title": "Request headers (object)",
7561
+ "description": "Headers to include in the HTTP request, in key/value format.",
7562
+ "type": "object",
7563
+ "additionalProperties": true,
7564
+ "properties": {}
7565
+ },
7566
+ {
7567
+ "title": "Request headers (string)",
7568
+ "description": "Headers to include in the HTTP request, as return-separated values. For example, `Content-Type: application/json\nAuthorization: Bearer token`.",
7569
+ "type": "string"
7570
+ }
7571
+ ]
7535
7572
  },
7536
7573
  "parameters": {
7537
7574
  "description": "URL parameters to include in the HTTP request, in key/value format.",
@@ -7542,23 +7579,23 @@
7542
7579
  "title": "Request parameters"
7543
7580
  },
7544
7581
  "body": {
7545
- "description": "JSON object to include as the body of the HTTP request.",
7582
+ "description": "The body of the HTTP request.",
7546
7583
  "anyOf": [
7547
7584
  {
7548
- "title": "Request body object",
7585
+ "title": "Request body (object)",
7549
7586
  "description": "JSON object to include as the body of the HTTP request.",
7550
7587
  "type": "object",
7551
7588
  "additionalProperties": true,
7552
7589
  "properties": {}
7553
7590
  },
7554
7591
  {
7555
- "title": "Request body array",
7592
+ "title": "Request body (array)",
7556
7593
  "description": "JSON array to include as the body of the HTTP request.",
7557
7594
  "type": "array",
7558
7595
  "items": {}
7559
7596
  },
7560
7597
  {
7561
- "title": "Request body string",
7598
+ "title": "Request body (string)",
7562
7599
  "description": "String to include as the body of the HTTP request.",
7563
7600
  "type": "string"
7564
7601
  }
@@ -7907,12 +7944,22 @@
7907
7944
  "additionalProperties": false,
7908
7945
  "properties": {
7909
7946
  "headers": {
7910
- "description": "Headers to include in the HTTP request, in key/value format.",
7911
- "type": "object",
7912
- "additionalProperties": true,
7913
- "properties": {},
7947
+ "description": "Headers to include in the HTTP request.",
7914
7948
  "default": {},
7915
- "title": "Request headers"
7949
+ "anyOf": [
7950
+ {
7951
+ "title": "Request headers (object)",
7952
+ "description": "Headers to include in the HTTP request, in key/value format.",
7953
+ "type": "object",
7954
+ "additionalProperties": true,
7955
+ "properties": {}
7956
+ },
7957
+ {
7958
+ "title": "Request headers (string)",
7959
+ "description": "Headers to include in the HTTP request, as return-separated values. For example, `Content-Type: application/json\nAuthorization: Bearer token`.",
7960
+ "type": "string"
7961
+ }
7962
+ ]
7916
7963
  },
7917
7964
  "parameters": {
7918
7965
  "description": "URL parameters to include in the HTTP request, in key/value format.",
@@ -7923,23 +7970,23 @@
7923
7970
  "title": "Request parameters"
7924
7971
  },
7925
7972
  "body": {
7926
- "description": "JSON object to include as the body of the HTTP request.",
7973
+ "description": "The body of the HTTP request.",
7927
7974
  "anyOf": [
7928
7975
  {
7929
- "title": "Request body object",
7976
+ "title": "Request body (object)",
7930
7977
  "description": "JSON object to include as the body of the HTTP request.",
7931
7978
  "type": "object",
7932
7979
  "additionalProperties": true,
7933
7980
  "properties": {}
7934
7981
  },
7935
7982
  {
7936
- "title": "Request body array",
7983
+ "title": "Request body (array)",
7937
7984
  "description": "JSON array to include as the body of the HTTP request.",
7938
7985
  "type": "array",
7939
7986
  "items": {}
7940
7987
  },
7941
7988
  {
7942
- "title": "Request body string",
7989
+ "title": "Request body (string)",
7943
7990
  "description": "String to include as the body of the HTTP request.",
7944
7991
  "type": "string"
7945
7992
  }
@@ -8158,6 +8205,13 @@
8158
8205
  "Authorization": "Bearer $TOKEN"
8159
8206
  }
8160
8207
  }
8208
+ },
8209
+ {
8210
+ "url": "https://www.api-server.com",
8211
+ "method": "post",
8212
+ "request": {
8213
+ "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
8214
+ }
8161
8215
  }
8162
8216
  ]
8163
8217
  }
package/dist/schemas/httpRequest_v3.schema.json CHANGED
@@ -268,12 +268,22 @@
268
268
  "additionalProperties": false,
269
269
  "properties": {
270
270
  "headers": {
271
- "description": "Headers to include in the HTTP request, in key/value format.",
272
- "type": "object",
273
- "additionalProperties": true,
274
- "properties": {},
271
+ "description": "Headers to include in the HTTP request.",
275
272
  "default": {},
276
- "title": "Request headers"
273
+ "anyOf": [
274
+ {
275
+ "title": "Request headers (object)",
276
+ "description": "Headers to include in the HTTP request, in key/value format.",
277
+ "type": "object",
278
+ "additionalProperties": true,
279
+ "properties": {}
280
+ },
281
+ {
282
+ "title": "Request headers (string)",
283
+ "description": "Headers to include in the HTTP request, as return-separated values. For example, `Content-Type: application/json\nAuthorization: Bearer token`.",
284
+ "type": "string"
285
+ }
286
+ ]
277
287
  },
278
288
  "parameters": {
279
289
  "description": "URL parameters to include in the HTTP request, in key/value format.",
@@ -284,23 +294,23 @@
284
294
  "title": "Request parameters"
285
295
  },
286
296
  "body": {
287
- "description": "JSON object to include as the body of the HTTP request.",
297
+ "description": "The body of the HTTP request.",
288
298
  "anyOf": [
289
299
  {
290
- "title": "Request body object",
300
+ "title": "Request body (object)",
291
301
  "description": "JSON object to include as the body of the HTTP request.",
292
302
  "type": "object",
293
303
  "additionalProperties": true,
294
304
  "properties": {}
295
305
  },
296
306
  {
297
- "title": "Request body array",
307
+ "title": "Request body (array)",
298
308
  "description": "JSON array to include as the body of the HTTP request.",
299
309
  "type": "array",
300
310
  "items": {}
301
311
  },
302
312
  {
303
- "title": "Request body string",
313
+ "title": "Request body (string)",
304
314
  "description": "String to include as the body of the HTTP request.",
305
315
  "type": "string"
306
316
  }
@@ -649,12 +659,22 @@
649
659
  "additionalProperties": false,
650
660
  "properties": {
651
661
  "headers": {
652
- "description": "Headers to include in the HTTP request, in key/value format.",
653
- "type": "object",
654
- "additionalProperties": true,
655
- "properties": {},
662
+ "description": "Headers to include in the HTTP request.",
656
663
  "default": {},
657
- "title": "Request headers"
664
+ "anyOf": [
665
+ {
666
+ "title": "Request headers (object)",
667
+ "description": "Headers to include in the HTTP request, in key/value format.",
668
+ "type": "object",
669
+ "additionalProperties": true,
670
+ "properties": {}
671
+ },
672
+ {
673
+ "title": "Request headers (string)",
674
+ "description": "Headers to include in the HTTP request, as return-separated values. For example, `Content-Type: application/json\nAuthorization: Bearer token`.",
675
+ "type": "string"
676
+ }
677
+ ]
658
678
  },
659
679
  "parameters": {
660
680
  "description": "URL parameters to include in the HTTP request, in key/value format.",
@@ -665,23 +685,23 @@
665
685
  "title": "Request parameters"
666
686
  },
667
687
  "body": {
668
- "description": "JSON object to include as the body of the HTTP request.",
688
+ "description": "The body of the HTTP request.",
669
689
  "anyOf": [
670
690
  {
671
- "title": "Request body object",
691
+ "title": "Request body (object)",
672
692
  "description": "JSON object to include as the body of the HTTP request.",
673
693
  "type": "object",
674
694
  "additionalProperties": true,
675
695
  "properties": {}
676
696
  },
677
697
  {
678
- "title": "Request body array",
698
+ "title": "Request body (array)",
679
699
  "description": "JSON array to include as the body of the HTTP request.",
680
700
  "type": "array",
681
701
  "items": {}
682
702
  },
683
703
  {
684
- "title": "Request body string",
704
+ "title": "Request body (string)",
685
705
  "description": "String to include as the body of the HTTP request.",
686
706
  "type": "string"
687
707
  }
@@ -900,6 +920,13 @@
900
920
  "Authorization": "Bearer $TOKEN"
901
921
  }
902
922
  }
923
+ },
924
+ {
925
+ "url": "https://www.api-server.com",
926
+ "method": "post",
927
+ "request": {
928
+ "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
929
+ }
903
930
  }
904
931
  ]
905
932
  }