doc-detective-common 1.21.0-openapi.9 → 1.21.1-dev.0

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 (24) hide show
  1. package/README.md +4 -0
  2. package/package.json +10 -6
  3. package/src/files.js +64 -0
  4. package/src/index.js +7 -3
  5. package/src/resolvePaths.js +9 -9
  6. package/src/schemas/dereferenceSchemas.js +115 -115
  7. package/src/schemas/output_schemas/config_v2.schema.json +2581 -2577
  8. package/src/schemas/output_schemas/httpRequest_v2.schema.json +8 -6
  9. package/src/schemas/output_schemas/openApi_v2.schema.json +4 -2
  10. package/src/schemas/output_schemas/spec_v2.schema.json +2034 -1797
  11. package/src/schemas/output_schemas/test_v2.schema.json +123 -6
  12. package/src/schemas/schemas.json +7829 -7467
  13. package/src/schemas/src_schemas/checkLink_v2.schema.json +65 -65
  14. package/src/schemas/src_schemas/config_v2.schema.json +2 -2
  15. package/src/schemas/src_schemas/goTo_v2.schema.json +57 -57
  16. package/src/schemas/src_schemas/httpRequest_v2.schema.json +4 -4
  17. package/src/schemas/src_schemas/openApi_v2.schema.json +5 -2
  18. package/src/schemas/src_schemas/setVariables_v2.schema.json +37 -37
  19. package/src/schemas/src_schemas/spec_v2.schema.json +45 -0
  20. package/src/schemas/src_schemas/stopRecording_v2.schema.json +31 -31
  21. package/src/schemas/src_schemas/test_v2.schema.json +199 -159
  22. package/src/schemas/src_schemas/typeKeys_v2.schema.json +63 -63
  23. package/test/files.test.js +107 -0
  24. package/test/schema.test.js +24 -14
package/src/schemas/output_schemas/httpRequest_v2.schema.json CHANGED
@@ -27,6 +27,8 @@
27
27
  "openApi": {
28
28
  "allOf": [
29
29
  {
30
+ "version": "1.0.0",
31
+ "$schema": "http://json-schema.org/draft-07/schema#",
30
32
  "title": "openApi",
31
33
  "type": "object",
32
34
  "description": "OpenAPI definition and configuration.",
@@ -36,7 +38,7 @@
36
38
  "type": "string",
37
39
  "description": "Name of the OpenAPI definition, as defined in your configuration."
38
40
  },
39
- "definitionPath": {
41
+ "descriptionPath": {
40
42
  "type": "string",
41
43
  "description": "URL or local path to the OpenAPI definition."
42
44
  },
@@ -95,7 +97,7 @@
95
97
  },
96
98
  "examples": [
97
99
  {
98
- "definitionPath": "https://petstore.swagger.io/v2/swagger.json"
100
+ "descriptionPath": "https://petstore.swagger.io/v2/swagger.json"
99
101
  }
100
102
  ]
101
103
  },
@@ -350,7 +352,7 @@
350
352
  {
351
353
  "action": "httpRequest",
352
354
  "openApi": {
353
- "definitionPath": "https://api.example.com/openapi.json",
355
+ "descriptionPath": "https://api.example.com/openapi.json",
354
356
  "operationId": "getUserById"
355
357
  },
356
358
  "requestParams": {
@@ -360,7 +362,7 @@
360
362
  {
361
363
  "action": "httpRequest",
362
364
  "openApi": {
363
- "definitionPath": "https://api.example.com/openapi.json",
365
+ "descriptionPath": "https://api.example.com/openapi.json",
364
366
  "operationId": "createUser",
365
367
  "useExample": "both"
366
368
  }
@@ -368,7 +370,7 @@
368
370
  {
369
371
  "action": "httpRequest",
370
372
  "openApi": {
371
- "definitionPath": "https://api.example.com/openapi.json",
373
+ "descriptionPath": "https://api.example.com/openapi.json",
372
374
  "operationId": "updateUser",
373
375
  "useExample": "request",
374
376
  "exampleKey": "acme"
@@ -377,7 +379,7 @@
377
379
  {
378
380
  "action": "httpRequest",
379
381
  "openApi": {
380
- "definitionPath": "https://api.example.com/openapi.json",
382
+ "descriptionPath": "https://api.example.com/openapi.json",
381
383
  "operationId": "updateUser",
382
384
  "useExample": "request",
383
385
  "exampleKey": "acme",
package/src/schemas/output_schemas/openApi_v2.schema.json CHANGED
@@ -1,4 +1,6 @@
1
1
  {
2
+ "version": "1.0.0",
3
+ "$schema": "http://json-schema.org/draft-07/schema#",
2
4
  "title": "openApi",
3
5
  "type": "object",
4
6
  "description": "OpenAPI definition and configuration.",
@@ -8,7 +10,7 @@
8
10
  "type": "string",
9
11
  "description": "Name of the OpenAPI definition, as defined in your configuration."
10
12
  },
11
- "definitionPath": {
13
+ "descriptionPath": {
12
14
  "type": "string",
13
15
  "description": "URL or local path to the OpenAPI definition."
14
16
  },
@@ -67,7 +69,7 @@
67
69
  },
68
70
  "examples": [
69
71
  {
70
- "definitionPath": "https://petstore.swagger.io/v2/swagger.json"
72
+ "descriptionPath": "https://petstore.swagger.io/v2/swagger.json"
71
73
  }
72
74
  ]
73
75
  }