@techdocs/cli 0.0.0-nightly-20240811022228 → 0.0.0-nightly-20240813022007
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/CHANGELOG.md +4 -4
- package/dist/embedded-app/.config-schema.json +131 -131
- package/package.json +5 -5
package/CHANGELOG.md
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# @techdocs/cli
|
|
2
2
|
|
|
3
|
-
## 0.0.0-nightly-
|
|
3
|
+
## 0.0.0-nightly-20240813022007
|
|
4
4
|
|
|
5
5
|
### Patch Changes
|
|
6
6
|
|
|
7
7
|
- Updated dependencies
|
|
8
|
-
- @backstage/backend-defaults@0.0.0-nightly-
|
|
9
|
-
- @backstage/plugin-techdocs-node@0.0.0-nightly-
|
|
10
|
-
- @backstage/catalog-model@0.0.0-nightly-
|
|
8
|
+
- @backstage/backend-defaults@0.0.0-nightly-20240813022007
|
|
9
|
+
- @backstage/plugin-techdocs-node@0.0.0-nightly-20240813022007
|
|
10
|
+
- @backstage/catalog-model@0.0.0-nightly-20240813022007
|
|
11
11
|
- @backstage/cli-common@0.1.14
|
|
12
12
|
- @backstage/config@1.2.0
|
|
13
13
|
|
|
@@ -354,51 +354,6 @@
|
|
|
354
354
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
355
355
|
}
|
|
356
356
|
},
|
|
357
|
-
{
|
|
358
|
-
"path": "../../plugins/techdocs/config.d.ts",
|
|
359
|
-
"value": {
|
|
360
|
-
"type": "object",
|
|
361
|
-
"properties": {
|
|
362
|
-
"techdocs": {
|
|
363
|
-
"description": "Configuration options for the techdocs plugin",
|
|
364
|
-
"type": "object",
|
|
365
|
-
"properties": {
|
|
366
|
-
"builder": {
|
|
367
|
-
"description": "Documentation building process depends on the builder attr",
|
|
368
|
-
"visibility": "frontend",
|
|
369
|
-
"enum": [
|
|
370
|
-
"external",
|
|
371
|
-
"local"
|
|
372
|
-
],
|
|
373
|
-
"type": "string"
|
|
374
|
-
},
|
|
375
|
-
"legacyUseCaseSensitiveTripletPaths": {
|
|
376
|
-
"description": "Allows fallback to case-sensitive triplets in case of migration issues.",
|
|
377
|
-
"visibility": "frontend",
|
|
378
|
-
"type": "boolean"
|
|
379
|
-
},
|
|
380
|
-
"sanitizer": {
|
|
381
|
-
"type": "object",
|
|
382
|
-
"properties": {
|
|
383
|
-
"allowedIframeHosts": {
|
|
384
|
-
"description": "Allows iframe tag only for listed hosts\nExample:\n allowedIframeHosts: [\"example.com\"]\n this will allow all iframes with the host `example.com` in the src attribute",
|
|
385
|
-
"visibility": "frontend",
|
|
386
|
-
"type": "array",
|
|
387
|
-
"items": {
|
|
388
|
-
"type": "string"
|
|
389
|
-
}
|
|
390
|
-
}
|
|
391
|
-
}
|
|
392
|
-
}
|
|
393
|
-
}
|
|
394
|
-
}
|
|
395
|
-
},
|
|
396
|
-
"required": [
|
|
397
|
-
"techdocs"
|
|
398
|
-
],
|
|
399
|
-
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
400
|
-
}
|
|
401
|
-
},
|
|
402
357
|
{
|
|
403
358
|
"path": "../core-components/config.d.ts",
|
|
404
359
|
"value": {
|
|
@@ -444,6 +399,51 @@
|
|
|
444
399
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
445
400
|
}
|
|
446
401
|
},
|
|
402
|
+
{
|
|
403
|
+
"path": "../../plugins/techdocs/config.d.ts",
|
|
404
|
+
"value": {
|
|
405
|
+
"type": "object",
|
|
406
|
+
"properties": {
|
|
407
|
+
"techdocs": {
|
|
408
|
+
"description": "Configuration options for the techdocs plugin",
|
|
409
|
+
"type": "object",
|
|
410
|
+
"properties": {
|
|
411
|
+
"builder": {
|
|
412
|
+
"description": "Documentation building process depends on the builder attr",
|
|
413
|
+
"visibility": "frontend",
|
|
414
|
+
"enum": [
|
|
415
|
+
"external",
|
|
416
|
+
"local"
|
|
417
|
+
],
|
|
418
|
+
"type": "string"
|
|
419
|
+
},
|
|
420
|
+
"legacyUseCaseSensitiveTripletPaths": {
|
|
421
|
+
"description": "Allows fallback to case-sensitive triplets in case of migration issues.",
|
|
422
|
+
"visibility": "frontend",
|
|
423
|
+
"type": "boolean"
|
|
424
|
+
},
|
|
425
|
+
"sanitizer": {
|
|
426
|
+
"type": "object",
|
|
427
|
+
"properties": {
|
|
428
|
+
"allowedIframeHosts": {
|
|
429
|
+
"description": "Allows iframe tag only for listed hosts\nExample:\n allowedIframeHosts: [\"example.com\"]\n this will allow all iframes with the host `example.com` in the src attribute",
|
|
430
|
+
"visibility": "frontend",
|
|
431
|
+
"type": "array",
|
|
432
|
+
"items": {
|
|
433
|
+
"type": "string"
|
|
434
|
+
}
|
|
435
|
+
}
|
|
436
|
+
}
|
|
437
|
+
}
|
|
438
|
+
}
|
|
439
|
+
}
|
|
440
|
+
},
|
|
441
|
+
"required": [
|
|
442
|
+
"techdocs"
|
|
443
|
+
],
|
|
444
|
+
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
445
|
+
}
|
|
446
|
+
},
|
|
447
447
|
{
|
|
448
448
|
"path": "../integration/config.d.ts",
|
|
449
449
|
"value": {
|
|
@@ -1707,7 +1707,7 @@
|
|
|
1707
1707
|
}
|
|
1708
1708
|
},
|
|
1709
1709
|
{
|
|
1710
|
-
"path": "../backend-
|
|
1710
|
+
"path": "../backend-defaults/config.d.ts",
|
|
1711
1711
|
"value": {
|
|
1712
1712
|
"type": "object",
|
|
1713
1713
|
"properties": {
|
|
@@ -1715,6 +1715,7 @@
|
|
|
1715
1715
|
"type": "object",
|
|
1716
1716
|
"properties": {
|
|
1717
1717
|
"auth": {
|
|
1718
|
+
"description": "Options used by the default auth, httpAuth and userInfo services.",
|
|
1718
1719
|
"type": "object",
|
|
1719
1720
|
"properties": {
|
|
1720
1721
|
"dangerouslyDisableDefaultAuthPolicy": {
|
|
@@ -2022,6 +2023,56 @@
|
|
|
2022
2023
|
"required": [
|
|
2023
2024
|
"url"
|
|
2024
2025
|
]
|
|
2026
|
+
},
|
|
2027
|
+
"accessRestrictions": {
|
|
2028
|
+
"description": "Restricts what types of access that are permitted for this access\nmethod. If no access restrictions are given, it'll have unlimited\naccess. This access restriction applies for the framework level;\nindividual plugins may have their own access control mechanisms\non top of this.",
|
|
2029
|
+
"type": "array",
|
|
2030
|
+
"items": {
|
|
2031
|
+
"type": "object",
|
|
2032
|
+
"properties": {
|
|
2033
|
+
"plugin": {
|
|
2034
|
+
"description": "Permit access to make requests to this plugin.\n\nCan be further refined by setting additional fields below.",
|
|
2035
|
+
"type": "string"
|
|
2036
|
+
},
|
|
2037
|
+
"permission": {
|
|
2038
|
+
"description": "If given, this method is limited to only performing actions\nwith these named permissions in this plugin.\n\nNote that this only applies where permissions checks are\nenabled in the first place. Endpoints that are not protected by\nthe permissions system at all, are not affected by this\nsetting.",
|
|
2039
|
+
"anyOf": [
|
|
2040
|
+
{
|
|
2041
|
+
"type": "array",
|
|
2042
|
+
"items": {
|
|
2043
|
+
"type": "string"
|
|
2044
|
+
}
|
|
2045
|
+
},
|
|
2046
|
+
{
|
|
2047
|
+
"type": "string"
|
|
2048
|
+
}
|
|
2049
|
+
]
|
|
2050
|
+
},
|
|
2051
|
+
"permissionAttribute": {
|
|
2052
|
+
"description": "If given, this method is limited to only performing actions\nwhose permissions have these attributes.\n\nNote that this only applies where permissions checks are\nenabled in the first place. Endpoints that are not protected by\nthe permissions system at all, are not affected by this\nsetting.",
|
|
2053
|
+
"type": "object",
|
|
2054
|
+
"properties": {
|
|
2055
|
+
"action": {
|
|
2056
|
+
"description": "One of more of 'create', 'read', 'update', or 'delete'.",
|
|
2057
|
+
"anyOf": [
|
|
2058
|
+
{
|
|
2059
|
+
"type": "array",
|
|
2060
|
+
"items": {
|
|
2061
|
+
"type": "string"
|
|
2062
|
+
}
|
|
2063
|
+
},
|
|
2064
|
+
{
|
|
2065
|
+
"type": "string"
|
|
2066
|
+
}
|
|
2067
|
+
]
|
|
2068
|
+
}
|
|
2069
|
+
}
|
|
2070
|
+
}
|
|
2071
|
+
},
|
|
2072
|
+
"required": [
|
|
2073
|
+
"plugin"
|
|
2074
|
+
]
|
|
2075
|
+
}
|
|
2025
2076
|
}
|
|
2026
2077
|
},
|
|
2027
2078
|
"required": [
|
|
@@ -2036,46 +2087,21 @@
|
|
|
2036
2087
|
"required": [
|
|
2037
2088
|
"externalAccess"
|
|
2038
2089
|
]
|
|
2039
|
-
},
|
|
2040
|
-
"packages": {
|
|
2041
|
-
"anyOf": [
|
|
2042
|
-
{
|
|
2043
|
-
"type": "object",
|
|
2044
|
-
"properties": {
|
|
2045
|
-
"include": {
|
|
2046
|
-
"type": "array",
|
|
2047
|
-
"items": {
|
|
2048
|
-
"type": "string"
|
|
2049
|
-
}
|
|
2050
|
-
},
|
|
2051
|
-
"exclude": {
|
|
2052
|
-
"type": "array",
|
|
2053
|
-
"items": {
|
|
2054
|
-
"type": "string"
|
|
2055
|
-
}
|
|
2056
|
-
}
|
|
2057
|
-
}
|
|
2058
|
-
},
|
|
2059
|
-
{
|
|
2060
|
-
"const": "all",
|
|
2061
|
-
"type": "string"
|
|
2062
|
-
}
|
|
2063
|
-
]
|
|
2064
2090
|
}
|
|
2065
2091
|
}
|
|
2066
2092
|
},
|
|
2067
2093
|
"discovery": {
|
|
2068
|
-
"description": "
|
|
2094
|
+
"description": "Options used by the default discovery service.",
|
|
2069
2095
|
"type": "object",
|
|
2070
2096
|
"properties": {
|
|
2071
2097
|
"endpoints": {
|
|
2072
|
-
"description": "
|
|
2098
|
+
"description": "A list of target baseUrls and the associated plugins.",
|
|
2073
2099
|
"type": "array",
|
|
2074
2100
|
"items": {
|
|
2075
2101
|
"type": "object",
|
|
2076
2102
|
"properties": {
|
|
2077
2103
|
"target": {
|
|
2078
|
-
"description": "The target
|
|
2104
|
+
"description": "The target base URL to use for the plugin.\n\nCan be either a string or an object with internal and external keys.\nTargets with `{{pluginId}}` or `{{ pluginId }} in the URL will be replaced with the plugin ID.",
|
|
2079
2105
|
"anyOf": [
|
|
2080
2106
|
{
|
|
2081
2107
|
"type": "object",
|
|
@@ -2098,7 +2124,7 @@
|
|
|
2098
2124
|
]
|
|
2099
2125
|
},
|
|
2100
2126
|
"plugins": {
|
|
2101
|
-
"description": "Array of plugins which use the target
|
|
2127
|
+
"description": "Array of plugins which use the target base URL.",
|
|
2102
2128
|
"type": "array",
|
|
2103
2129
|
"items": {
|
|
2104
2130
|
"type": "string"
|
|
@@ -2121,7 +2147,7 @@
|
|
|
2121
2147
|
}
|
|
2122
2148
|
},
|
|
2123
2149
|
{
|
|
2124
|
-
"path": "../backend-
|
|
2150
|
+
"path": "../backend-app-api/config.d.ts",
|
|
2125
2151
|
"value": {
|
|
2126
2152
|
"type": "object",
|
|
2127
2153
|
"properties": {
|
|
@@ -2129,7 +2155,6 @@
|
|
|
2129
2155
|
"type": "object",
|
|
2130
2156
|
"properties": {
|
|
2131
2157
|
"auth": {
|
|
2132
|
-
"description": "Options used by the default auth, httpAuth and userInfo services.",
|
|
2133
2158
|
"type": "object",
|
|
2134
2159
|
"properties": {
|
|
2135
2160
|
"dangerouslyDisableDefaultAuthPolicy": {
|
|
@@ -2437,56 +2462,6 @@
|
|
|
2437
2462
|
"required": [
|
|
2438
2463
|
"url"
|
|
2439
2464
|
]
|
|
2440
|
-
},
|
|
2441
|
-
"accessRestrictions": {
|
|
2442
|
-
"description": "Restricts what types of access that are permitted for this access\nmethod. If no access restrictions are given, it'll have unlimited\naccess. This access restriction applies for the framework level;\nindividual plugins may have their own access control mechanisms\non top of this.",
|
|
2443
|
-
"type": "array",
|
|
2444
|
-
"items": {
|
|
2445
|
-
"type": "object",
|
|
2446
|
-
"properties": {
|
|
2447
|
-
"plugin": {
|
|
2448
|
-
"description": "Permit access to make requests to this plugin.\n\nCan be further refined by setting additional fields below.",
|
|
2449
|
-
"type": "string"
|
|
2450
|
-
},
|
|
2451
|
-
"permission": {
|
|
2452
|
-
"description": "If given, this method is limited to only performing actions\nwith these named permissions in this plugin.\n\nNote that this only applies where permissions checks are\nenabled in the first place. Endpoints that are not protected by\nthe permissions system at all, are not affected by this\nsetting.",
|
|
2453
|
-
"anyOf": [
|
|
2454
|
-
{
|
|
2455
|
-
"type": "array",
|
|
2456
|
-
"items": {
|
|
2457
|
-
"type": "string"
|
|
2458
|
-
}
|
|
2459
|
-
},
|
|
2460
|
-
{
|
|
2461
|
-
"type": "string"
|
|
2462
|
-
}
|
|
2463
|
-
]
|
|
2464
|
-
},
|
|
2465
|
-
"permissionAttribute": {
|
|
2466
|
-
"description": "If given, this method is limited to only performing actions\nwhose permissions have these attributes.\n\nNote that this only applies where permissions checks are\nenabled in the first place. Endpoints that are not protected by\nthe permissions system at all, are not affected by this\nsetting.",
|
|
2467
|
-
"type": "object",
|
|
2468
|
-
"properties": {
|
|
2469
|
-
"action": {
|
|
2470
|
-
"description": "One of more of 'create', 'read', 'update', or 'delete'.",
|
|
2471
|
-
"anyOf": [
|
|
2472
|
-
{
|
|
2473
|
-
"type": "array",
|
|
2474
|
-
"items": {
|
|
2475
|
-
"type": "string"
|
|
2476
|
-
}
|
|
2477
|
-
},
|
|
2478
|
-
{
|
|
2479
|
-
"type": "string"
|
|
2480
|
-
}
|
|
2481
|
-
]
|
|
2482
|
-
}
|
|
2483
|
-
}
|
|
2484
|
-
}
|
|
2485
|
-
},
|
|
2486
|
-
"required": [
|
|
2487
|
-
"plugin"
|
|
2488
|
-
]
|
|
2489
|
-
}
|
|
2490
2465
|
}
|
|
2491
2466
|
},
|
|
2492
2467
|
"required": [
|
|
@@ -2501,21 +2476,46 @@
|
|
|
2501
2476
|
"required": [
|
|
2502
2477
|
"externalAccess"
|
|
2503
2478
|
]
|
|
2479
|
+
},
|
|
2480
|
+
"packages": {
|
|
2481
|
+
"anyOf": [
|
|
2482
|
+
{
|
|
2483
|
+
"type": "object",
|
|
2484
|
+
"properties": {
|
|
2485
|
+
"include": {
|
|
2486
|
+
"type": "array",
|
|
2487
|
+
"items": {
|
|
2488
|
+
"type": "string"
|
|
2489
|
+
}
|
|
2490
|
+
},
|
|
2491
|
+
"exclude": {
|
|
2492
|
+
"type": "array",
|
|
2493
|
+
"items": {
|
|
2494
|
+
"type": "string"
|
|
2495
|
+
}
|
|
2496
|
+
}
|
|
2497
|
+
}
|
|
2498
|
+
},
|
|
2499
|
+
{
|
|
2500
|
+
"const": "all",
|
|
2501
|
+
"type": "string"
|
|
2502
|
+
}
|
|
2503
|
+
]
|
|
2504
2504
|
}
|
|
2505
2505
|
}
|
|
2506
2506
|
},
|
|
2507
2507
|
"discovery": {
|
|
2508
|
-
"description": "
|
|
2508
|
+
"description": "Discovery options.",
|
|
2509
2509
|
"type": "object",
|
|
2510
2510
|
"properties": {
|
|
2511
2511
|
"endpoints": {
|
|
2512
|
-
"description": "
|
|
2512
|
+
"description": "Endpoints\n\nA list of target baseUrls and the associated plugins.",
|
|
2513
2513
|
"type": "array",
|
|
2514
2514
|
"items": {
|
|
2515
2515
|
"type": "object",
|
|
2516
2516
|
"properties": {
|
|
2517
2517
|
"target": {
|
|
2518
|
-
"description": "The target
|
|
2518
|
+
"description": "The target baseUrl to use for the plugin\n\nCan be either a string or an object with internal and external keys.\nTargets with `{{pluginId}}` or `{{ pluginId }} in the url will be replaced with the pluginId.",
|
|
2519
2519
|
"anyOf": [
|
|
2520
2520
|
{
|
|
2521
2521
|
"type": "object",
|
|
@@ -2538,7 +2538,7 @@
|
|
|
2538
2538
|
]
|
|
2539
2539
|
},
|
|
2540
2540
|
"plugins": {
|
|
2541
|
-
"description": "Array of plugins which use the target
|
|
2541
|
+
"description": "Array of plugins which use the target baseUrl.",
|
|
2542
2542
|
"type": "array",
|
|
2543
2543
|
"items": {
|
|
2544
2544
|
"type": "string"
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@techdocs/cli",
|
|
3
3
|
"description": "Utility CLI for managing TechDocs sites in Backstage.",
|
|
4
|
-
"version": "0.0.0-nightly-
|
|
4
|
+
"version": "0.0.0-nightly-20240813022007",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public"
|
|
7
7
|
},
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"techdocs-cli": "bin/techdocs-cli"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
|
-
"@backstage/cli": "^0.0.0-nightly-
|
|
38
|
+
"@backstage/cli": "^0.0.0-nightly-20240813022007",
|
|
39
39
|
"@types/commander": "^2.12.2",
|
|
40
40
|
"@types/fs-extra": "^11.0.0",
|
|
41
41
|
"@types/http-proxy": "^1.17.4",
|
|
@@ -56,11 +56,11 @@
|
|
|
56
56
|
"ext": "ts"
|
|
57
57
|
},
|
|
58
58
|
"dependencies": {
|
|
59
|
-
"@backstage/backend-defaults": "^0.0.0-nightly-
|
|
60
|
-
"@backstage/catalog-model": "^0.0.0-nightly-
|
|
59
|
+
"@backstage/backend-defaults": "^0.0.0-nightly-20240813022007",
|
|
60
|
+
"@backstage/catalog-model": "^0.0.0-nightly-20240813022007",
|
|
61
61
|
"@backstage/cli-common": "^0.1.14",
|
|
62
62
|
"@backstage/config": "^1.2.0",
|
|
63
|
-
"@backstage/plugin-techdocs-node": "^0.0.0-nightly-
|
|
63
|
+
"@backstage/plugin-techdocs-node": "^0.0.0-nightly-20240813022007",
|
|
64
64
|
"commander": "^12.0.0",
|
|
65
65
|
"fs-extra": "^11.0.0",
|
|
66
66
|
"global-agent": "^3.0.0",
|