doc-detective-common 3.6.0-dev.1 → 3.6.0-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.
- package/dist/schemas/config_v3.schema.json +249 -0
- package/dist/schemas/report_v3.schema.json +200 -0
- package/dist/schemas/resolvedTests_v3.schema.json +449 -0
- package/dist/schemas/screenshot_v3.schema.json +100 -0
- package/dist/schemas/sourceIntegration_v3.schema.json +50 -0
- package/dist/schemas/spec_v3.schema.json +200 -0
- package/dist/schemas/step_v3.schema.json +100 -0
- package/dist/schemas/test_v3.schema.json +200 -0
- package/package.json +3 -3
- package/src/resolvePaths.js +5 -4
- package/src/schemas/build/config_v3.schema.json +49 -0
- package/src/schemas/build/screenshot_v3.schema.json +4 -0
- package/src/schemas/build/sourceIntegration_v3.schema.json +51 -0
- package/src/schemas/dereferenceSchemas.js +1 -0
- package/src/schemas/output_schemas/config_v3.schema.json +249 -0
- package/src/schemas/output_schemas/report_v3.schema.json +200 -0
- package/src/schemas/output_schemas/resolvedTests_v3.schema.json +449 -0
- package/src/schemas/output_schemas/screenshot_v3.schema.json +100 -0
- package/src/schemas/output_schemas/sourceIntegration_v3.schema.json +50 -0
- package/src/schemas/output_schemas/spec_v3.schema.json +200 -0
- package/src/schemas/output_schemas/step_v3.schema.json +100 -0
- package/src/schemas/output_schemas/test_v3.schema.json +200 -0
- package/src/schemas/schemas.json +1548 -0
- package/src/schemas/src_schemas/config_v3.schema.json +49 -0
- package/src/schemas/src_schemas/screenshot_v3.schema.json +4 -0
- package/src/schemas/src_schemas/sourceIntegration_v3.schema.json +45 -0
|
@@ -5584,6 +5584,56 @@
|
|
|
5584
5584
|
}
|
|
5585
5585
|
}
|
|
5586
5586
|
]
|
|
5587
|
+
},
|
|
5588
|
+
"sourceIntegration": {
|
|
5589
|
+
"description": "Information about the source integration for this screenshot, enabling upload of changed files back to the source CMS. Set automatically during test resolution for files from integrations.",
|
|
5590
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
5591
|
+
"title": "sourceIntegration",
|
|
5592
|
+
"type": "object",
|
|
5593
|
+
"additionalProperties": false,
|
|
5594
|
+
"required": [
|
|
5595
|
+
"type",
|
|
5596
|
+
"integrationName"
|
|
5597
|
+
],
|
|
5598
|
+
"properties": {
|
|
5599
|
+
"type": {
|
|
5600
|
+
"type": "string",
|
|
5601
|
+
"description": "The type of integration. Currently supported: 'heretto'. Additional types may be added in the future.",
|
|
5602
|
+
"enum": [
|
|
5603
|
+
"heretto"
|
|
5604
|
+
]
|
|
5605
|
+
},
|
|
5606
|
+
"integrationName": {
|
|
5607
|
+
"type": "string",
|
|
5608
|
+
"description": "The name of the integration configuration in the config file. Used to look up authentication credentials."
|
|
5609
|
+
},
|
|
5610
|
+
"fileId": {
|
|
5611
|
+
"type": "string",
|
|
5612
|
+
"description": "The unique identifier (UUID) of the file in the source CMS. If not provided, the file will be looked up by path."
|
|
5613
|
+
},
|
|
5614
|
+
"filePath": {
|
|
5615
|
+
"type": "string",
|
|
5616
|
+
"description": "The path of the file in the source CMS. Used for lookup if fileId is not available."
|
|
5617
|
+
},
|
|
5618
|
+
"contentPath": {
|
|
5619
|
+
"type": "string",
|
|
5620
|
+
"description": "The local path to the file that references this source. Used for resolving relative paths."
|
|
5621
|
+
}
|
|
5622
|
+
},
|
|
5623
|
+
"examples": [
|
|
5624
|
+
{
|
|
5625
|
+
"type": "heretto",
|
|
5626
|
+
"integrationName": "my-heretto",
|
|
5627
|
+
"fileId": "8f3ed200-cbba-11e1-ac51-c82a1446d15c",
|
|
5628
|
+
"filePath": "/db/organizations/example/repositories/docs/images/screenshot.png"
|
|
5629
|
+
},
|
|
5630
|
+
{
|
|
5631
|
+
"type": "heretto",
|
|
5632
|
+
"integrationName": "my-heretto",
|
|
5633
|
+
"filePath": "images/screenshot.png",
|
|
5634
|
+
"contentPath": "/tmp/doc-detective/heretto_abc123/topic.dita"
|
|
5635
|
+
}
|
|
5636
|
+
]
|
|
5587
5637
|
}
|
|
5588
5638
|
},
|
|
5589
5639
|
"title": "Capture screenshot (detailed)"
|
|
@@ -5780,6 +5830,56 @@
|
|
|
5780
5830
|
}
|
|
5781
5831
|
}
|
|
5782
5832
|
]
|
|
5833
|
+
},
|
|
5834
|
+
"sourceIntegration": {
|
|
5835
|
+
"description": "Information about the source integration for this screenshot, enabling upload of changed files back to the source CMS. Set automatically during test resolution for files from integrations.",
|
|
5836
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
5837
|
+
"title": "sourceIntegration",
|
|
5838
|
+
"type": "object",
|
|
5839
|
+
"additionalProperties": false,
|
|
5840
|
+
"required": [
|
|
5841
|
+
"type",
|
|
5842
|
+
"integrationName"
|
|
5843
|
+
],
|
|
5844
|
+
"properties": {
|
|
5845
|
+
"type": {
|
|
5846
|
+
"type": "string",
|
|
5847
|
+
"description": "The type of integration. Currently supported: 'heretto'. Additional types may be added in the future.",
|
|
5848
|
+
"enum": [
|
|
5849
|
+
"heretto"
|
|
5850
|
+
]
|
|
5851
|
+
},
|
|
5852
|
+
"integrationName": {
|
|
5853
|
+
"type": "string",
|
|
5854
|
+
"description": "The name of the integration configuration in the config file. Used to look up authentication credentials."
|
|
5855
|
+
},
|
|
5856
|
+
"fileId": {
|
|
5857
|
+
"type": "string",
|
|
5858
|
+
"description": "The unique identifier (UUID) of the file in the source CMS. If not provided, the file will be looked up by path."
|
|
5859
|
+
},
|
|
5860
|
+
"filePath": {
|
|
5861
|
+
"type": "string",
|
|
5862
|
+
"description": "The path of the file in the source CMS. Used for lookup if fileId is not available."
|
|
5863
|
+
},
|
|
5864
|
+
"contentPath": {
|
|
5865
|
+
"type": "string",
|
|
5866
|
+
"description": "The local path to the file that references this source. Used for resolving relative paths."
|
|
5867
|
+
}
|
|
5868
|
+
},
|
|
5869
|
+
"examples": [
|
|
5870
|
+
{
|
|
5871
|
+
"type": "heretto",
|
|
5872
|
+
"integrationName": "my-heretto",
|
|
5873
|
+
"fileId": "8f3ed200-cbba-11e1-ac51-c82a1446d15c",
|
|
5874
|
+
"filePath": "/db/organizations/example/repositories/docs/images/screenshot.png"
|
|
5875
|
+
},
|
|
5876
|
+
{
|
|
5877
|
+
"type": "heretto",
|
|
5878
|
+
"integrationName": "my-heretto",
|
|
5879
|
+
"filePath": "images/screenshot.png",
|
|
5880
|
+
"contentPath": "/tmp/doc-detective/heretto_abc123/topic.dita"
|
|
5881
|
+
}
|
|
5882
|
+
]
|
|
5783
5883
|
}
|
|
5784
5884
|
},
|
|
5785
5885
|
"title": "Capture screenshot (detailed)"
|
|
@@ -8527,6 +8627,55 @@
|
|
|
8527
8627
|
"type": "string",
|
|
8528
8628
|
"description": "Local path where Heretto content was downloaded. Set automatically during processing.",
|
|
8529
8629
|
"readOnly": true
|
|
8630
|
+
},
|
|
8631
|
+
"fileMapping": {
|
|
8632
|
+
"type": "object",
|
|
8633
|
+
"description": "Mapping of local file paths to Heretto file metadata. Set automatically during content loading.",
|
|
8634
|
+
"readOnly": true,
|
|
8635
|
+
"additionalProperties": {
|
|
8636
|
+
"type": "object",
|
|
8637
|
+
"properties": {
|
|
8638
|
+
"fileId": {
|
|
8639
|
+
"type": "string",
|
|
8640
|
+
"description": "The UUID of the file in Heretto."
|
|
8641
|
+
},
|
|
8642
|
+
"filePath": {
|
|
8643
|
+
"type": "string",
|
|
8644
|
+
"description": "The path of the file in Heretto."
|
|
8645
|
+
}
|
|
8646
|
+
}
|
|
8647
|
+
}
|
|
8648
|
+
},
|
|
8649
|
+
"uploadOnChange": {
|
|
8650
|
+
"type": "boolean",
|
|
8651
|
+
"description": "If `true`, uploads changed screenshots and other media files back to Heretto CMS after test execution.",
|
|
8652
|
+
"default": false
|
|
8653
|
+
},
|
|
8654
|
+
"resourceDependencies": {
|
|
8655
|
+
"type": "object",
|
|
8656
|
+
"description": "Mapping of Heretto file paths to their UUIDs and metadata. Set automatically during content loading by fetching ditamap resource dependencies.",
|
|
8657
|
+
"readOnly": true,
|
|
8658
|
+
"additionalProperties": {
|
|
8659
|
+
"type": "object",
|
|
8660
|
+
"properties": {
|
|
8661
|
+
"uuid": {
|
|
8662
|
+
"type": "string",
|
|
8663
|
+
"description": "The UUID of the file in Heretto."
|
|
8664
|
+
},
|
|
8665
|
+
"fullPath": {
|
|
8666
|
+
"type": "string",
|
|
8667
|
+
"description": "The full xmldb path of the file in Heretto."
|
|
8668
|
+
},
|
|
8669
|
+
"name": {
|
|
8670
|
+
"type": "string",
|
|
8671
|
+
"description": "The file name."
|
|
8672
|
+
},
|
|
8673
|
+
"parentFolderId": {
|
|
8674
|
+
"type": "string",
|
|
8675
|
+
"description": "The UUID of the parent folder in Heretto."
|
|
8676
|
+
}
|
|
8677
|
+
}
|
|
8678
|
+
}
|
|
8530
8679
|
}
|
|
8531
8680
|
},
|
|
8532
8681
|
"title": "Heretto CMS integration"
|
|
@@ -13538,6 +13687,56 @@
|
|
|
13538
13687
|
}
|
|
13539
13688
|
}
|
|
13540
13689
|
]
|
|
13690
|
+
},
|
|
13691
|
+
"sourceIntegration": {
|
|
13692
|
+
"description": "Information about the source integration for this screenshot, enabling upload of changed files back to the source CMS. Set automatically during test resolution for files from integrations.",
|
|
13693
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
13694
|
+
"title": "sourceIntegration",
|
|
13695
|
+
"type": "object",
|
|
13696
|
+
"additionalProperties": false,
|
|
13697
|
+
"required": [
|
|
13698
|
+
"type",
|
|
13699
|
+
"integrationName"
|
|
13700
|
+
],
|
|
13701
|
+
"properties": {
|
|
13702
|
+
"type": {
|
|
13703
|
+
"type": "string",
|
|
13704
|
+
"description": "The type of integration. Currently supported: 'heretto'. Additional types may be added in the future.",
|
|
13705
|
+
"enum": [
|
|
13706
|
+
"heretto"
|
|
13707
|
+
]
|
|
13708
|
+
},
|
|
13709
|
+
"integrationName": {
|
|
13710
|
+
"type": "string",
|
|
13711
|
+
"description": "The name of the integration configuration in the config file. Used to look up authentication credentials."
|
|
13712
|
+
},
|
|
13713
|
+
"fileId": {
|
|
13714
|
+
"type": "string",
|
|
13715
|
+
"description": "The unique identifier (UUID) of the file in the source CMS. If not provided, the file will be looked up by path."
|
|
13716
|
+
},
|
|
13717
|
+
"filePath": {
|
|
13718
|
+
"type": "string",
|
|
13719
|
+
"description": "The path of the file in the source CMS. Used for lookup if fileId is not available."
|
|
13720
|
+
},
|
|
13721
|
+
"contentPath": {
|
|
13722
|
+
"type": "string",
|
|
13723
|
+
"description": "The local path to the file that references this source. Used for resolving relative paths."
|
|
13724
|
+
}
|
|
13725
|
+
},
|
|
13726
|
+
"examples": [
|
|
13727
|
+
{
|
|
13728
|
+
"type": "heretto",
|
|
13729
|
+
"integrationName": "my-heretto",
|
|
13730
|
+
"fileId": "8f3ed200-cbba-11e1-ac51-c82a1446d15c",
|
|
13731
|
+
"filePath": "/db/organizations/example/repositories/docs/images/screenshot.png"
|
|
13732
|
+
},
|
|
13733
|
+
{
|
|
13734
|
+
"type": "heretto",
|
|
13735
|
+
"integrationName": "my-heretto",
|
|
13736
|
+
"filePath": "images/screenshot.png",
|
|
13737
|
+
"contentPath": "/tmp/doc-detective/heretto_abc123/topic.dita"
|
|
13738
|
+
}
|
|
13739
|
+
]
|
|
13541
13740
|
}
|
|
13542
13741
|
},
|
|
13543
13742
|
"title": "Capture screenshot (detailed)"
|
|
@@ -13734,6 +13933,56 @@
|
|
|
13734
13933
|
}
|
|
13735
13934
|
}
|
|
13736
13935
|
]
|
|
13936
|
+
},
|
|
13937
|
+
"sourceIntegration": {
|
|
13938
|
+
"description": "Information about the source integration for this screenshot, enabling upload of changed files back to the source CMS. Set automatically during test resolution for files from integrations.",
|
|
13939
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
13940
|
+
"title": "sourceIntegration",
|
|
13941
|
+
"type": "object",
|
|
13942
|
+
"additionalProperties": false,
|
|
13943
|
+
"required": [
|
|
13944
|
+
"type",
|
|
13945
|
+
"integrationName"
|
|
13946
|
+
],
|
|
13947
|
+
"properties": {
|
|
13948
|
+
"type": {
|
|
13949
|
+
"type": "string",
|
|
13950
|
+
"description": "The type of integration. Currently supported: 'heretto'. Additional types may be added in the future.",
|
|
13951
|
+
"enum": [
|
|
13952
|
+
"heretto"
|
|
13953
|
+
]
|
|
13954
|
+
},
|
|
13955
|
+
"integrationName": {
|
|
13956
|
+
"type": "string",
|
|
13957
|
+
"description": "The name of the integration configuration in the config file. Used to look up authentication credentials."
|
|
13958
|
+
},
|
|
13959
|
+
"fileId": {
|
|
13960
|
+
"type": "string",
|
|
13961
|
+
"description": "The unique identifier (UUID) of the file in the source CMS. If not provided, the file will be looked up by path."
|
|
13962
|
+
},
|
|
13963
|
+
"filePath": {
|
|
13964
|
+
"type": "string",
|
|
13965
|
+
"description": "The path of the file in the source CMS. Used for lookup if fileId is not available."
|
|
13966
|
+
},
|
|
13967
|
+
"contentPath": {
|
|
13968
|
+
"type": "string",
|
|
13969
|
+
"description": "The local path to the file that references this source. Used for resolving relative paths."
|
|
13970
|
+
}
|
|
13971
|
+
},
|
|
13972
|
+
"examples": [
|
|
13973
|
+
{
|
|
13974
|
+
"type": "heretto",
|
|
13975
|
+
"integrationName": "my-heretto",
|
|
13976
|
+
"fileId": "8f3ed200-cbba-11e1-ac51-c82a1446d15c",
|
|
13977
|
+
"filePath": "/db/organizations/example/repositories/docs/images/screenshot.png"
|
|
13978
|
+
},
|
|
13979
|
+
{
|
|
13980
|
+
"type": "heretto",
|
|
13981
|
+
"integrationName": "my-heretto",
|
|
13982
|
+
"filePath": "images/screenshot.png",
|
|
13983
|
+
"contentPath": "/tmp/doc-detective/heretto_abc123/topic.dita"
|
|
13984
|
+
}
|
|
13985
|
+
]
|
|
13737
13986
|
}
|
|
13738
13987
|
},
|
|
13739
13988
|
"title": "Capture screenshot (detailed)"
|
|
@@ -6017,6 +6017,56 @@
|
|
|
6017
6017
|
}
|
|
6018
6018
|
}
|
|
6019
6019
|
]
|
|
6020
|
+
},
|
|
6021
|
+
"sourceIntegration": {
|
|
6022
|
+
"description": "Information about the source integration for this screenshot, enabling upload of changed files back to the source CMS. Set automatically during test resolution for files from integrations.",
|
|
6023
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
6024
|
+
"title": "sourceIntegration",
|
|
6025
|
+
"type": "object",
|
|
6026
|
+
"additionalProperties": false,
|
|
6027
|
+
"required": [
|
|
6028
|
+
"type",
|
|
6029
|
+
"integrationName"
|
|
6030
|
+
],
|
|
6031
|
+
"properties": {
|
|
6032
|
+
"type": {
|
|
6033
|
+
"type": "string",
|
|
6034
|
+
"description": "The type of integration. Currently supported: 'heretto'. Additional types may be added in the future.",
|
|
6035
|
+
"enum": [
|
|
6036
|
+
"heretto"
|
|
6037
|
+
]
|
|
6038
|
+
},
|
|
6039
|
+
"integrationName": {
|
|
6040
|
+
"type": "string",
|
|
6041
|
+
"description": "The name of the integration configuration in the config file. Used to look up authentication credentials."
|
|
6042
|
+
},
|
|
6043
|
+
"fileId": {
|
|
6044
|
+
"type": "string",
|
|
6045
|
+
"description": "The unique identifier (UUID) of the file in the source CMS. If not provided, the file will be looked up by path."
|
|
6046
|
+
},
|
|
6047
|
+
"filePath": {
|
|
6048
|
+
"type": "string",
|
|
6049
|
+
"description": "The path of the file in the source CMS. Used for lookup if fileId is not available."
|
|
6050
|
+
},
|
|
6051
|
+
"contentPath": {
|
|
6052
|
+
"type": "string",
|
|
6053
|
+
"description": "The local path to the file that references this source. Used for resolving relative paths."
|
|
6054
|
+
}
|
|
6055
|
+
},
|
|
6056
|
+
"examples": [
|
|
6057
|
+
{
|
|
6058
|
+
"type": "heretto",
|
|
6059
|
+
"integrationName": "my-heretto",
|
|
6060
|
+
"fileId": "8f3ed200-cbba-11e1-ac51-c82a1446d15c",
|
|
6061
|
+
"filePath": "/db/organizations/example/repositories/docs/images/screenshot.png"
|
|
6062
|
+
},
|
|
6063
|
+
{
|
|
6064
|
+
"type": "heretto",
|
|
6065
|
+
"integrationName": "my-heretto",
|
|
6066
|
+
"filePath": "images/screenshot.png",
|
|
6067
|
+
"contentPath": "/tmp/doc-detective/heretto_abc123/topic.dita"
|
|
6068
|
+
}
|
|
6069
|
+
]
|
|
6020
6070
|
}
|
|
6021
6071
|
},
|
|
6022
6072
|
"title": "Capture screenshot (detailed)"
|
|
@@ -6213,6 +6263,56 @@
|
|
|
6213
6263
|
}
|
|
6214
6264
|
}
|
|
6215
6265
|
]
|
|
6266
|
+
},
|
|
6267
|
+
"sourceIntegration": {
|
|
6268
|
+
"description": "Information about the source integration for this screenshot, enabling upload of changed files back to the source CMS. Set automatically during test resolution for files from integrations.",
|
|
6269
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
6270
|
+
"title": "sourceIntegration",
|
|
6271
|
+
"type": "object",
|
|
6272
|
+
"additionalProperties": false,
|
|
6273
|
+
"required": [
|
|
6274
|
+
"type",
|
|
6275
|
+
"integrationName"
|
|
6276
|
+
],
|
|
6277
|
+
"properties": {
|
|
6278
|
+
"type": {
|
|
6279
|
+
"type": "string",
|
|
6280
|
+
"description": "The type of integration. Currently supported: 'heretto'. Additional types may be added in the future.",
|
|
6281
|
+
"enum": [
|
|
6282
|
+
"heretto"
|
|
6283
|
+
]
|
|
6284
|
+
},
|
|
6285
|
+
"integrationName": {
|
|
6286
|
+
"type": "string",
|
|
6287
|
+
"description": "The name of the integration configuration in the config file. Used to look up authentication credentials."
|
|
6288
|
+
},
|
|
6289
|
+
"fileId": {
|
|
6290
|
+
"type": "string",
|
|
6291
|
+
"description": "The unique identifier (UUID) of the file in the source CMS. If not provided, the file will be looked up by path."
|
|
6292
|
+
},
|
|
6293
|
+
"filePath": {
|
|
6294
|
+
"type": "string",
|
|
6295
|
+
"description": "The path of the file in the source CMS. Used for lookup if fileId is not available."
|
|
6296
|
+
},
|
|
6297
|
+
"contentPath": {
|
|
6298
|
+
"type": "string",
|
|
6299
|
+
"description": "The local path to the file that references this source. Used for resolving relative paths."
|
|
6300
|
+
}
|
|
6301
|
+
},
|
|
6302
|
+
"examples": [
|
|
6303
|
+
{
|
|
6304
|
+
"type": "heretto",
|
|
6305
|
+
"integrationName": "my-heretto",
|
|
6306
|
+
"fileId": "8f3ed200-cbba-11e1-ac51-c82a1446d15c",
|
|
6307
|
+
"filePath": "/db/organizations/example/repositories/docs/images/screenshot.png"
|
|
6308
|
+
},
|
|
6309
|
+
{
|
|
6310
|
+
"type": "heretto",
|
|
6311
|
+
"integrationName": "my-heretto",
|
|
6312
|
+
"filePath": "images/screenshot.png",
|
|
6313
|
+
"contentPath": "/tmp/doc-detective/heretto_abc123/topic.dita"
|
|
6314
|
+
}
|
|
6315
|
+
]
|
|
6216
6316
|
}
|
|
6217
6317
|
},
|
|
6218
6318
|
"title": "Capture screenshot (detailed)"
|
|
@@ -13494,6 +13594,56 @@
|
|
|
13494
13594
|
}
|
|
13495
13595
|
}
|
|
13496
13596
|
]
|
|
13597
|
+
},
|
|
13598
|
+
"sourceIntegration": {
|
|
13599
|
+
"description": "Information about the source integration for this screenshot, enabling upload of changed files back to the source CMS. Set automatically during test resolution for files from integrations.",
|
|
13600
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
13601
|
+
"title": "sourceIntegration",
|
|
13602
|
+
"type": "object",
|
|
13603
|
+
"additionalProperties": false,
|
|
13604
|
+
"required": [
|
|
13605
|
+
"type",
|
|
13606
|
+
"integrationName"
|
|
13607
|
+
],
|
|
13608
|
+
"properties": {
|
|
13609
|
+
"type": {
|
|
13610
|
+
"type": "string",
|
|
13611
|
+
"description": "The type of integration. Currently supported: 'heretto'. Additional types may be added in the future.",
|
|
13612
|
+
"enum": [
|
|
13613
|
+
"heretto"
|
|
13614
|
+
]
|
|
13615
|
+
},
|
|
13616
|
+
"integrationName": {
|
|
13617
|
+
"type": "string",
|
|
13618
|
+
"description": "The name of the integration configuration in the config file. Used to look up authentication credentials."
|
|
13619
|
+
},
|
|
13620
|
+
"fileId": {
|
|
13621
|
+
"type": "string",
|
|
13622
|
+
"description": "The unique identifier (UUID) of the file in the source CMS. If not provided, the file will be looked up by path."
|
|
13623
|
+
},
|
|
13624
|
+
"filePath": {
|
|
13625
|
+
"type": "string",
|
|
13626
|
+
"description": "The path of the file in the source CMS. Used for lookup if fileId is not available."
|
|
13627
|
+
},
|
|
13628
|
+
"contentPath": {
|
|
13629
|
+
"type": "string",
|
|
13630
|
+
"description": "The local path to the file that references this source. Used for resolving relative paths."
|
|
13631
|
+
}
|
|
13632
|
+
},
|
|
13633
|
+
"examples": [
|
|
13634
|
+
{
|
|
13635
|
+
"type": "heretto",
|
|
13636
|
+
"integrationName": "my-heretto",
|
|
13637
|
+
"fileId": "8f3ed200-cbba-11e1-ac51-c82a1446d15c",
|
|
13638
|
+
"filePath": "/db/organizations/example/repositories/docs/images/screenshot.png"
|
|
13639
|
+
},
|
|
13640
|
+
{
|
|
13641
|
+
"type": "heretto",
|
|
13642
|
+
"integrationName": "my-heretto",
|
|
13643
|
+
"filePath": "images/screenshot.png",
|
|
13644
|
+
"contentPath": "/tmp/doc-detective/heretto_abc123/topic.dita"
|
|
13645
|
+
}
|
|
13646
|
+
]
|
|
13497
13647
|
}
|
|
13498
13648
|
},
|
|
13499
13649
|
"title": "Capture screenshot (detailed)"
|
|
@@ -13690,6 +13840,56 @@
|
|
|
13690
13840
|
}
|
|
13691
13841
|
}
|
|
13692
13842
|
]
|
|
13843
|
+
},
|
|
13844
|
+
"sourceIntegration": {
|
|
13845
|
+
"description": "Information about the source integration for this screenshot, enabling upload of changed files back to the source CMS. Set automatically during test resolution for files from integrations.",
|
|
13846
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
13847
|
+
"title": "sourceIntegration",
|
|
13848
|
+
"type": "object",
|
|
13849
|
+
"additionalProperties": false,
|
|
13850
|
+
"required": [
|
|
13851
|
+
"type",
|
|
13852
|
+
"integrationName"
|
|
13853
|
+
],
|
|
13854
|
+
"properties": {
|
|
13855
|
+
"type": {
|
|
13856
|
+
"type": "string",
|
|
13857
|
+
"description": "The type of integration. Currently supported: 'heretto'. Additional types may be added in the future.",
|
|
13858
|
+
"enum": [
|
|
13859
|
+
"heretto"
|
|
13860
|
+
]
|
|
13861
|
+
},
|
|
13862
|
+
"integrationName": {
|
|
13863
|
+
"type": "string",
|
|
13864
|
+
"description": "The name of the integration configuration in the config file. Used to look up authentication credentials."
|
|
13865
|
+
},
|
|
13866
|
+
"fileId": {
|
|
13867
|
+
"type": "string",
|
|
13868
|
+
"description": "The unique identifier (UUID) of the file in the source CMS. If not provided, the file will be looked up by path."
|
|
13869
|
+
},
|
|
13870
|
+
"filePath": {
|
|
13871
|
+
"type": "string",
|
|
13872
|
+
"description": "The path of the file in the source CMS. Used for lookup if fileId is not available."
|
|
13873
|
+
},
|
|
13874
|
+
"contentPath": {
|
|
13875
|
+
"type": "string",
|
|
13876
|
+
"description": "The local path to the file that references this source. Used for resolving relative paths."
|
|
13877
|
+
}
|
|
13878
|
+
},
|
|
13879
|
+
"examples": [
|
|
13880
|
+
{
|
|
13881
|
+
"type": "heretto",
|
|
13882
|
+
"integrationName": "my-heretto",
|
|
13883
|
+
"fileId": "8f3ed200-cbba-11e1-ac51-c82a1446d15c",
|
|
13884
|
+
"filePath": "/db/organizations/example/repositories/docs/images/screenshot.png"
|
|
13885
|
+
},
|
|
13886
|
+
{
|
|
13887
|
+
"type": "heretto",
|
|
13888
|
+
"integrationName": "my-heretto",
|
|
13889
|
+
"filePath": "images/screenshot.png",
|
|
13890
|
+
"contentPath": "/tmp/doc-detective/heretto_abc123/topic.dita"
|
|
13891
|
+
}
|
|
13892
|
+
]
|
|
13693
13893
|
}
|
|
13694
13894
|
},
|
|
13695
13895
|
"title": "Capture screenshot (detailed)"
|