@backstage/plugin-search-backend-module-techdocs 0.4.15-next.0 → 0.4.16-next.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.
- package/CHANGELOG.md +22 -0
- package/config.schema.json +190 -0
- package/package.json +10 -10
- package/config.d.ts +0 -53
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,27 @@
|
|
|
1
1
|
# @backstage/plugin-search-backend-module-techdocs
|
|
2
2
|
|
|
3
|
+
## 0.4.16-next.0
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
- @backstage/plugin-search-backend-node@1.4.6-next.0
|
|
9
|
+
- @backstage/backend-plugin-api@1.9.3-next.0
|
|
10
|
+
- @backstage/plugin-catalog-node@2.2.3-next.0
|
|
11
|
+
- @backstage/plugin-techdocs-node@1.15.2-next.0
|
|
12
|
+
- @backstage/catalog-client@1.16.1-next.0
|
|
13
|
+
|
|
14
|
+
## 0.4.15
|
|
15
|
+
|
|
16
|
+
### Patch Changes
|
|
17
|
+
|
|
18
|
+
- Updated dependencies
|
|
19
|
+
- @backstage/catalog-client@1.16.0
|
|
20
|
+
- @backstage/backend-plugin-api@1.9.2
|
|
21
|
+
- @backstage/plugin-catalog-node@2.2.2
|
|
22
|
+
- @backstage/plugin-search-backend-node@1.4.5
|
|
23
|
+
- @backstage/plugin-techdocs-node@1.15.1
|
|
24
|
+
|
|
3
25
|
## 0.4.15-next.0
|
|
4
26
|
|
|
5
27
|
### Patch Changes
|
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"search": {
|
|
6
|
+
"type": "object",
|
|
7
|
+
"properties": {
|
|
8
|
+
"collators": {
|
|
9
|
+
"type": "object",
|
|
10
|
+
"properties": {
|
|
11
|
+
"techdocs": {
|
|
12
|
+
"type": "object",
|
|
13
|
+
"properties": {
|
|
14
|
+
"schedule": {
|
|
15
|
+
"type": "object",
|
|
16
|
+
"properties": {
|
|
17
|
+
"frequency": {
|
|
18
|
+
"anyOf": [
|
|
19
|
+
{
|
|
20
|
+
"type": "object",
|
|
21
|
+
"properties": {
|
|
22
|
+
"cron": {
|
|
23
|
+
"type": "string",
|
|
24
|
+
"description": "A crontab style string."
|
|
25
|
+
}
|
|
26
|
+
},
|
|
27
|
+
"required": [
|
|
28
|
+
"cron"
|
|
29
|
+
]
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"type": "string"
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
"type": "object",
|
|
36
|
+
"properties": {
|
|
37
|
+
"years": {
|
|
38
|
+
"type": "number"
|
|
39
|
+
},
|
|
40
|
+
"months": {
|
|
41
|
+
"type": "number"
|
|
42
|
+
},
|
|
43
|
+
"weeks": {
|
|
44
|
+
"type": "number"
|
|
45
|
+
},
|
|
46
|
+
"days": {
|
|
47
|
+
"type": "number"
|
|
48
|
+
},
|
|
49
|
+
"hours": {
|
|
50
|
+
"type": "number"
|
|
51
|
+
},
|
|
52
|
+
"minutes": {
|
|
53
|
+
"type": "number"
|
|
54
|
+
},
|
|
55
|
+
"seconds": {
|
|
56
|
+
"type": "number"
|
|
57
|
+
},
|
|
58
|
+
"milliseconds": {
|
|
59
|
+
"type": "number"
|
|
60
|
+
}
|
|
61
|
+
},
|
|
62
|
+
"description": "Human friendly durations object."
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
"type": "object",
|
|
66
|
+
"properties": {
|
|
67
|
+
"trigger": {
|
|
68
|
+
"type": "string",
|
|
69
|
+
"const": "manual"
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
"required": [
|
|
73
|
+
"trigger"
|
|
74
|
+
]
|
|
75
|
+
}
|
|
76
|
+
],
|
|
77
|
+
"description": "How often you want the task to run. The system does its best to avoid overlapping invocations."
|
|
78
|
+
},
|
|
79
|
+
"timeout": {
|
|
80
|
+
"anyOf": [
|
|
81
|
+
{
|
|
82
|
+
"type": "string"
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"type": "object",
|
|
86
|
+
"properties": {
|
|
87
|
+
"years": {
|
|
88
|
+
"type": "number"
|
|
89
|
+
},
|
|
90
|
+
"months": {
|
|
91
|
+
"type": "number"
|
|
92
|
+
},
|
|
93
|
+
"weeks": {
|
|
94
|
+
"type": "number"
|
|
95
|
+
},
|
|
96
|
+
"days": {
|
|
97
|
+
"type": "number"
|
|
98
|
+
},
|
|
99
|
+
"hours": {
|
|
100
|
+
"type": "number"
|
|
101
|
+
},
|
|
102
|
+
"minutes": {
|
|
103
|
+
"type": "number"
|
|
104
|
+
},
|
|
105
|
+
"seconds": {
|
|
106
|
+
"type": "number"
|
|
107
|
+
},
|
|
108
|
+
"milliseconds": {
|
|
109
|
+
"type": "number"
|
|
110
|
+
}
|
|
111
|
+
},
|
|
112
|
+
"description": "Human friendly durations object."
|
|
113
|
+
}
|
|
114
|
+
],
|
|
115
|
+
"description": "The maximum amount of time that a single task invocation can take, before it's considered timed out and gets \"released\" such that a new invocation is permitted to take place (possibly, then, on a different worker)."
|
|
116
|
+
},
|
|
117
|
+
"initialDelay": {
|
|
118
|
+
"anyOf": [
|
|
119
|
+
{
|
|
120
|
+
"type": "string"
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"type": "object",
|
|
124
|
+
"properties": {
|
|
125
|
+
"years": {
|
|
126
|
+
"type": "number"
|
|
127
|
+
},
|
|
128
|
+
"months": {
|
|
129
|
+
"type": "number"
|
|
130
|
+
},
|
|
131
|
+
"weeks": {
|
|
132
|
+
"type": "number"
|
|
133
|
+
},
|
|
134
|
+
"days": {
|
|
135
|
+
"type": "number"
|
|
136
|
+
},
|
|
137
|
+
"hours": {
|
|
138
|
+
"type": "number"
|
|
139
|
+
},
|
|
140
|
+
"minutes": {
|
|
141
|
+
"type": "number"
|
|
142
|
+
},
|
|
143
|
+
"seconds": {
|
|
144
|
+
"type": "number"
|
|
145
|
+
},
|
|
146
|
+
"milliseconds": {
|
|
147
|
+
"type": "number"
|
|
148
|
+
}
|
|
149
|
+
},
|
|
150
|
+
"description": "Human friendly durations object."
|
|
151
|
+
}
|
|
152
|
+
],
|
|
153
|
+
"description": "The amount of time that should pass before the first invocation happens."
|
|
154
|
+
},
|
|
155
|
+
"scope": {
|
|
156
|
+
"type": "string",
|
|
157
|
+
"enum": [
|
|
158
|
+
"global",
|
|
159
|
+
"local"
|
|
160
|
+
],
|
|
161
|
+
"description": "Sets the scope of concurrency control / locking to apply for invocations of this task."
|
|
162
|
+
}
|
|
163
|
+
},
|
|
164
|
+
"required": [
|
|
165
|
+
"frequency",
|
|
166
|
+
"timeout"
|
|
167
|
+
],
|
|
168
|
+
"description": "The schedule for how often to run the collation job."
|
|
169
|
+
},
|
|
170
|
+
"locationTemplate": {
|
|
171
|
+
"type": "string",
|
|
172
|
+
"description": "A templating string with placeholders, to form the final location of the entity.\n\nDefaults to `'/docs/:namespace/:kind/:name/:path'`."
|
|
173
|
+
},
|
|
174
|
+
"parallelismLimit": {
|
|
175
|
+
"type": "number",
|
|
176
|
+
"description": "An abstract value that controls the concurrency level of the collation process. Increasing this value will both increase the number of entities fetched at a time from the catalog, as well as how many things are being processed concurrently.\n\nDefaults to `10`."
|
|
177
|
+
},
|
|
178
|
+
"legacyPathCasing": {
|
|
179
|
+
"type": "boolean",
|
|
180
|
+
"description": "Defaults to `false`."
|
|
181
|
+
}
|
|
182
|
+
},
|
|
183
|
+
"description": "Configuration options for `@backstage/plugin-search-backend-module-techdocs`"
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
}
|
|
187
|
+
}
|
|
188
|
+
}
|
|
189
|
+
}
|
|
190
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-search-backend-module-techdocs",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.16-next.0",
|
|
4
4
|
"description": "A module for the search backend that exports techdocs modules",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "backend-plugin-module",
|
|
@@ -50,7 +50,7 @@
|
|
|
50
50
|
},
|
|
51
51
|
"files": [
|
|
52
52
|
"dist",
|
|
53
|
-
"config.
|
|
53
|
+
"config.schema.json"
|
|
54
54
|
],
|
|
55
55
|
"scripts": {
|
|
56
56
|
"build": "backstage-cli package build",
|
|
@@ -62,23 +62,23 @@
|
|
|
62
62
|
"test": "backstage-cli package test"
|
|
63
63
|
},
|
|
64
64
|
"dependencies": {
|
|
65
|
-
"@backstage/backend-plugin-api": "1.9.
|
|
66
|
-
"@backstage/catalog-client": "1.16.
|
|
65
|
+
"@backstage/backend-plugin-api": "1.9.3-next.0",
|
|
66
|
+
"@backstage/catalog-client": "1.16.1-next.0",
|
|
67
67
|
"@backstage/catalog-model": "1.9.0",
|
|
68
68
|
"@backstage/config": "1.3.8",
|
|
69
69
|
"@backstage/plugin-catalog-common": "1.1.10",
|
|
70
|
-
"@backstage/plugin-catalog-node": "2.2.
|
|
70
|
+
"@backstage/plugin-catalog-node": "2.2.3-next.0",
|
|
71
71
|
"@backstage/plugin-permission-common": "0.9.9",
|
|
72
|
-
"@backstage/plugin-search-backend-node": "1.4.
|
|
72
|
+
"@backstage/plugin-search-backend-node": "1.4.6-next.0",
|
|
73
73
|
"@backstage/plugin-search-common": "1.2.24",
|
|
74
|
-
"@backstage/plugin-techdocs-node": "1.15.
|
|
74
|
+
"@backstage/plugin-techdocs-node": "1.15.2-next.0",
|
|
75
75
|
"lodash": "^4.17.21",
|
|
76
76
|
"p-limit": "^3.1.0"
|
|
77
77
|
},
|
|
78
78
|
"devDependencies": {
|
|
79
|
-
"@backstage/backend-test-utils": "1.11.
|
|
80
|
-
"@backstage/cli": "0.36.
|
|
79
|
+
"@backstage/backend-test-utils": "1.11.5-next.0",
|
|
80
|
+
"@backstage/cli": "0.36.4-next.0",
|
|
81
81
|
"msw": "^1.0.0"
|
|
82
82
|
},
|
|
83
|
-
"configSchema": "config.
|
|
83
|
+
"configSchema": "config.schema.json"
|
|
84
84
|
}
|
package/config.d.ts
DELETED
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright 2023 The Backstage Authors
|
|
3
|
-
*
|
|
4
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
-
* you may not use this file except in compliance with the License.
|
|
6
|
-
* You may obtain a copy of the License at
|
|
7
|
-
*
|
|
8
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
-
*
|
|
10
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
-
* See the License for the specific language governing permissions and
|
|
14
|
-
* limitations under the License.
|
|
15
|
-
*/
|
|
16
|
-
|
|
17
|
-
import { SchedulerServiceTaskScheduleDefinitionConfig } from '@backstage/backend-plugin-api';
|
|
18
|
-
|
|
19
|
-
export interface Config {
|
|
20
|
-
search?: {
|
|
21
|
-
collators?: {
|
|
22
|
-
/**
|
|
23
|
-
* Configuration options for `@backstage/plugin-search-backend-module-techdocs`
|
|
24
|
-
*/
|
|
25
|
-
techdocs?: {
|
|
26
|
-
/**
|
|
27
|
-
* The schedule for how often to run the collation job.
|
|
28
|
-
*/
|
|
29
|
-
schedule?: SchedulerServiceTaskScheduleDefinitionConfig;
|
|
30
|
-
/**
|
|
31
|
-
* A templating string with placeholders, to form the final location of
|
|
32
|
-
* the entity.
|
|
33
|
-
*
|
|
34
|
-
* Defaults to `'/docs/:namespace/:kind/:name/:path'`.
|
|
35
|
-
*/
|
|
36
|
-
locationTemplate?: string;
|
|
37
|
-
/**
|
|
38
|
-
* An abstract value that controls the concurrency level of the
|
|
39
|
-
* collation process. Increasing this value will both increase the
|
|
40
|
-
* number of entities fetched at a time from the catalog, as well as how
|
|
41
|
-
* many things are being processed concurrently.
|
|
42
|
-
*
|
|
43
|
-
* Defaults to `10`.
|
|
44
|
-
*/
|
|
45
|
-
parallelismLimit?: number;
|
|
46
|
-
/**
|
|
47
|
-
* Defaults to `false`.
|
|
48
|
-
*/
|
|
49
|
-
legacyPathCasing?: boolean;
|
|
50
|
-
};
|
|
51
|
-
};
|
|
52
|
-
};
|
|
53
|
-
}
|