@backstage/plugin-catalog-backend-module-azure 0.3.18 → 0.3.19-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 CHANGED
@@ -1,5 +1,14 @@
1
1
  # @backstage/plugin-catalog-backend-module-azure
2
2
 
3
+ ## 0.3.19-next.0
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+ - @backstage/backend-plugin-api@1.9.3-next.0
9
+ - @backstage/plugin-catalog-node@2.2.3-next.0
10
+ - @backstage/plugin-events-node@0.4.24-next.0
11
+
3
12
  ## 0.3.18
4
13
 
5
14
  ### Patch Changes
@@ -0,0 +1,564 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "catalog": {
6
+ "type": "object",
7
+ "properties": {
8
+ "providers": {
9
+ "type": "object",
10
+ "properties": {
11
+ "azureDevOps": {
12
+ "type": "object",
13
+ "additionalProperties": {
14
+ "type": "object",
15
+ "properties": {
16
+ "host": {
17
+ "type": "string",
18
+ "description": "(Optional) The DevOps host; defaults to `dev.azure.com` if left empty, otherwise set to your self-hosted instance host."
19
+ },
20
+ "organization": {
21
+ "type": "string",
22
+ "description": "(Required) Your organization slug."
23
+ },
24
+ "project": {
25
+ "type": "string",
26
+ "description": "(Required) Your project slug."
27
+ },
28
+ "repository": {
29
+ "type": "string",
30
+ "description": "(Optional) The repository name. Wildcards are supported as show on the examples above. If not set, all repositories will be searched."
31
+ },
32
+ "branch": {
33
+ "type": "string",
34
+ "description": "(Optional) The name of a branch to use. If not set, defaults to the default branch of the repository."
35
+ },
36
+ "path": {
37
+ "type": "string",
38
+ "description": "(Optional) Where to find catalog-info.yaml files. Wildcards are supported. If not set, defaults to /catalog-info.yaml."
39
+ },
40
+ "schedule": {
41
+ "type": "object",
42
+ "properties": {
43
+ "frequency": {
44
+ "anyOf": [
45
+ {
46
+ "type": "object",
47
+ "properties": {
48
+ "cron": {
49
+ "type": "string",
50
+ "description": "A crontab style string."
51
+ }
52
+ },
53
+ "required": [
54
+ "cron"
55
+ ]
56
+ },
57
+ {
58
+ "type": "string"
59
+ },
60
+ {
61
+ "type": "object",
62
+ "properties": {
63
+ "years": {
64
+ "type": "number"
65
+ },
66
+ "months": {
67
+ "type": "number"
68
+ },
69
+ "weeks": {
70
+ "type": "number"
71
+ },
72
+ "days": {
73
+ "type": "number"
74
+ },
75
+ "hours": {
76
+ "type": "number"
77
+ },
78
+ "minutes": {
79
+ "type": "number"
80
+ },
81
+ "seconds": {
82
+ "type": "number"
83
+ },
84
+ "milliseconds": {
85
+ "type": "number"
86
+ }
87
+ },
88
+ "description": "Human friendly durations object."
89
+ },
90
+ {
91
+ "type": "object",
92
+ "properties": {
93
+ "trigger": {
94
+ "type": "string",
95
+ "const": "manual"
96
+ }
97
+ },
98
+ "required": [
99
+ "trigger"
100
+ ]
101
+ }
102
+ ],
103
+ "description": "How often you want the task to run. The system does its best to avoid overlapping invocations."
104
+ },
105
+ "timeout": {
106
+ "anyOf": [
107
+ {
108
+ "type": "string"
109
+ },
110
+ {
111
+ "type": "object",
112
+ "properties": {
113
+ "years": {
114
+ "type": "number"
115
+ },
116
+ "months": {
117
+ "type": "number"
118
+ },
119
+ "weeks": {
120
+ "type": "number"
121
+ },
122
+ "days": {
123
+ "type": "number"
124
+ },
125
+ "hours": {
126
+ "type": "number"
127
+ },
128
+ "minutes": {
129
+ "type": "number"
130
+ },
131
+ "seconds": {
132
+ "type": "number"
133
+ },
134
+ "milliseconds": {
135
+ "type": "number"
136
+ }
137
+ },
138
+ "description": "Human friendly durations object."
139
+ }
140
+ ],
141
+ "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)."
142
+ },
143
+ "initialDelay": {
144
+ "anyOf": [
145
+ {
146
+ "type": "string"
147
+ },
148
+ {
149
+ "type": "object",
150
+ "properties": {
151
+ "years": {
152
+ "type": "number"
153
+ },
154
+ "months": {
155
+ "type": "number"
156
+ },
157
+ "weeks": {
158
+ "type": "number"
159
+ },
160
+ "days": {
161
+ "type": "number"
162
+ },
163
+ "hours": {
164
+ "type": "number"
165
+ },
166
+ "minutes": {
167
+ "type": "number"
168
+ },
169
+ "seconds": {
170
+ "type": "number"
171
+ },
172
+ "milliseconds": {
173
+ "type": "number"
174
+ }
175
+ },
176
+ "description": "Human friendly durations object."
177
+ }
178
+ ],
179
+ "description": "The amount of time that should pass before the first invocation happens."
180
+ },
181
+ "scope": {
182
+ "type": "string",
183
+ "enum": [
184
+ "global",
185
+ "local"
186
+ ],
187
+ "description": "Sets the scope of concurrency control / locking to apply for invocations of this task."
188
+ }
189
+ },
190
+ "required": [
191
+ "frequency",
192
+ "timeout"
193
+ ],
194
+ "description": "(Optional) TaskScheduleDefinition for the refresh."
195
+ }
196
+ },
197
+ "required": [
198
+ "organization",
199
+ "project"
200
+ ]
201
+ },
202
+ "description": "AzureDevopsEntityProvider configuration"
203
+ },
204
+ "azureBlob": {
205
+ "anyOf": [
206
+ {
207
+ "type": "object",
208
+ "additionalProperties": {
209
+ "type": "object",
210
+ "properties": {
211
+ "containerName": {
212
+ "type": "string",
213
+ "description": "(Required) The Azure Blob Storage container name."
214
+ },
215
+ "accountName": {
216
+ "type": "string",
217
+ "description": "(Required) The Azure Storage account name."
218
+ },
219
+ "schedule": {
220
+ "type": "object",
221
+ "properties": {
222
+ "frequency": {
223
+ "anyOf": [
224
+ {
225
+ "type": "object",
226
+ "properties": {
227
+ "cron": {
228
+ "type": "string",
229
+ "description": "A crontab style string."
230
+ }
231
+ },
232
+ "required": [
233
+ "cron"
234
+ ]
235
+ },
236
+ {
237
+ "type": "string"
238
+ },
239
+ {
240
+ "type": "object",
241
+ "properties": {
242
+ "years": {
243
+ "type": "number"
244
+ },
245
+ "months": {
246
+ "type": "number"
247
+ },
248
+ "weeks": {
249
+ "type": "number"
250
+ },
251
+ "days": {
252
+ "type": "number"
253
+ },
254
+ "hours": {
255
+ "type": "number"
256
+ },
257
+ "minutes": {
258
+ "type": "number"
259
+ },
260
+ "seconds": {
261
+ "type": "number"
262
+ },
263
+ "milliseconds": {
264
+ "type": "number"
265
+ }
266
+ },
267
+ "description": "Human friendly durations object."
268
+ },
269
+ {
270
+ "type": "object",
271
+ "properties": {
272
+ "trigger": {
273
+ "type": "string",
274
+ "const": "manual"
275
+ }
276
+ },
277
+ "required": [
278
+ "trigger"
279
+ ]
280
+ }
281
+ ],
282
+ "description": "How often you want the task to run. The system does its best to avoid overlapping invocations."
283
+ },
284
+ "timeout": {
285
+ "anyOf": [
286
+ {
287
+ "type": "string"
288
+ },
289
+ {
290
+ "type": "object",
291
+ "properties": {
292
+ "years": {
293
+ "type": "number"
294
+ },
295
+ "months": {
296
+ "type": "number"
297
+ },
298
+ "weeks": {
299
+ "type": "number"
300
+ },
301
+ "days": {
302
+ "type": "number"
303
+ },
304
+ "hours": {
305
+ "type": "number"
306
+ },
307
+ "minutes": {
308
+ "type": "number"
309
+ },
310
+ "seconds": {
311
+ "type": "number"
312
+ },
313
+ "milliseconds": {
314
+ "type": "number"
315
+ }
316
+ },
317
+ "description": "Human friendly durations object."
318
+ }
319
+ ],
320
+ "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)."
321
+ },
322
+ "initialDelay": {
323
+ "anyOf": [
324
+ {
325
+ "type": "string"
326
+ },
327
+ {
328
+ "type": "object",
329
+ "properties": {
330
+ "years": {
331
+ "type": "number"
332
+ },
333
+ "months": {
334
+ "type": "number"
335
+ },
336
+ "weeks": {
337
+ "type": "number"
338
+ },
339
+ "days": {
340
+ "type": "number"
341
+ },
342
+ "hours": {
343
+ "type": "number"
344
+ },
345
+ "minutes": {
346
+ "type": "number"
347
+ },
348
+ "seconds": {
349
+ "type": "number"
350
+ },
351
+ "milliseconds": {
352
+ "type": "number"
353
+ }
354
+ },
355
+ "description": "Human friendly durations object."
356
+ }
357
+ ],
358
+ "description": "The amount of time that should pass before the first invocation happens."
359
+ },
360
+ "scope": {
361
+ "type": "string",
362
+ "enum": [
363
+ "global",
364
+ "local"
365
+ ],
366
+ "description": "Sets the scope of concurrency control / locking to apply for invocations of this task."
367
+ }
368
+ },
369
+ "required": [
370
+ "frequency",
371
+ "timeout"
372
+ ],
373
+ "description": "(Optional) TaskScheduleDefinition for the refresh."
374
+ }
375
+ },
376
+ "required": [
377
+ "containerName",
378
+ "accountName"
379
+ ]
380
+ }
381
+ },
382
+ {
383
+ "type": "object",
384
+ "properties": {
385
+ "containerName": {
386
+ "type": "string",
387
+ "description": "(Required) The Azure Blob Storage container name."
388
+ },
389
+ "accountName": {
390
+ "type": "string",
391
+ "description": "(Required) The Azure Storage account name."
392
+ },
393
+ "schedule": {
394
+ "type": "object",
395
+ "properties": {
396
+ "frequency": {
397
+ "anyOf": [
398
+ {
399
+ "type": "object",
400
+ "properties": {
401
+ "cron": {
402
+ "type": "string",
403
+ "description": "A crontab style string."
404
+ }
405
+ },
406
+ "required": [
407
+ "cron"
408
+ ]
409
+ },
410
+ {
411
+ "type": "string"
412
+ },
413
+ {
414
+ "type": "object",
415
+ "properties": {
416
+ "years": {
417
+ "type": "number"
418
+ },
419
+ "months": {
420
+ "type": "number"
421
+ },
422
+ "weeks": {
423
+ "type": "number"
424
+ },
425
+ "days": {
426
+ "type": "number"
427
+ },
428
+ "hours": {
429
+ "type": "number"
430
+ },
431
+ "minutes": {
432
+ "type": "number"
433
+ },
434
+ "seconds": {
435
+ "type": "number"
436
+ },
437
+ "milliseconds": {
438
+ "type": "number"
439
+ }
440
+ },
441
+ "description": "Human friendly durations object."
442
+ },
443
+ {
444
+ "type": "object",
445
+ "properties": {
446
+ "trigger": {
447
+ "type": "string",
448
+ "const": "manual"
449
+ }
450
+ },
451
+ "required": [
452
+ "trigger"
453
+ ]
454
+ }
455
+ ],
456
+ "description": "How often you want the task to run. The system does its best to avoid overlapping invocations."
457
+ },
458
+ "timeout": {
459
+ "anyOf": [
460
+ {
461
+ "type": "string"
462
+ },
463
+ {
464
+ "type": "object",
465
+ "properties": {
466
+ "years": {
467
+ "type": "number"
468
+ },
469
+ "months": {
470
+ "type": "number"
471
+ },
472
+ "weeks": {
473
+ "type": "number"
474
+ },
475
+ "days": {
476
+ "type": "number"
477
+ },
478
+ "hours": {
479
+ "type": "number"
480
+ },
481
+ "minutes": {
482
+ "type": "number"
483
+ },
484
+ "seconds": {
485
+ "type": "number"
486
+ },
487
+ "milliseconds": {
488
+ "type": "number"
489
+ }
490
+ },
491
+ "description": "Human friendly durations object."
492
+ }
493
+ ],
494
+ "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)."
495
+ },
496
+ "initialDelay": {
497
+ "anyOf": [
498
+ {
499
+ "type": "string"
500
+ },
501
+ {
502
+ "type": "object",
503
+ "properties": {
504
+ "years": {
505
+ "type": "number"
506
+ },
507
+ "months": {
508
+ "type": "number"
509
+ },
510
+ "weeks": {
511
+ "type": "number"
512
+ },
513
+ "days": {
514
+ "type": "number"
515
+ },
516
+ "hours": {
517
+ "type": "number"
518
+ },
519
+ "minutes": {
520
+ "type": "number"
521
+ },
522
+ "seconds": {
523
+ "type": "number"
524
+ },
525
+ "milliseconds": {
526
+ "type": "number"
527
+ }
528
+ },
529
+ "description": "Human friendly durations object."
530
+ }
531
+ ],
532
+ "description": "The amount of time that should pass before the first invocation happens."
533
+ },
534
+ "scope": {
535
+ "type": "string",
536
+ "enum": [
537
+ "global",
538
+ "local"
539
+ ],
540
+ "description": "Sets the scope of concurrency control / locking to apply for invocations of this task."
541
+ }
542
+ },
543
+ "required": [
544
+ "frequency",
545
+ "timeout"
546
+ ],
547
+ "description": "(Optional) TaskScheduleDefinition for the refresh."
548
+ }
549
+ },
550
+ "required": [
551
+ "containerName",
552
+ "accountName"
553
+ ]
554
+ }
555
+ ],
556
+ "description": "AzureBlobEntityProvider configuration"
557
+ }
558
+ },
559
+ "description": "List of provider-specific options and attributes"
560
+ }
561
+ }
562
+ }
563
+ }
564
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-catalog-backend-module-azure",
3
- "version": "0.3.18",
3
+ "version": "0.3.19-next.0",
4
4
  "description": "A Backstage catalog backend module that helps integrate towards Azure",
5
5
  "backstage": {
6
6
  "role": "backend-plugin-module",
@@ -52,7 +52,7 @@
52
52
  }
53
53
  },
54
54
  "files": [
55
- "config.d.ts",
55
+ "config.schema.json",
56
56
  "dist"
57
57
  ],
58
58
  "scripts": {
@@ -67,18 +67,18 @@
67
67
  "dependencies": {
68
68
  "@azure/identity": "^4.0.0",
69
69
  "@azure/storage-blob": "^12.5.0",
70
- "@backstage/backend-plugin-api": "^1.9.2",
71
- "@backstage/config": "^1.3.8",
72
- "@backstage/errors": "^1.3.1",
73
- "@backstage/integration": "^2.0.3",
74
- "@backstage/plugin-catalog-common": "^1.1.10",
75
- "@backstage/plugin-catalog-node": "^2.2.2",
76
- "@backstage/plugin-events-node": "^0.4.23"
70
+ "@backstage/backend-plugin-api": "1.9.3-next.0",
71
+ "@backstage/config": "1.3.8",
72
+ "@backstage/errors": "1.3.1",
73
+ "@backstage/integration": "2.0.3",
74
+ "@backstage/plugin-catalog-common": "1.1.10",
75
+ "@backstage/plugin-catalog-node": "2.2.3-next.0",
76
+ "@backstage/plugin-events-node": "0.4.24-next.0"
77
77
  },
78
78
  "devDependencies": {
79
- "@backstage/backend-test-utils": "^1.11.4",
80
- "@backstage/cli": "^0.36.3",
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.d.ts"
83
+ "configSchema": "config.schema.json"
84
84
  }
package/config.d.ts DELETED
@@ -1,98 +0,0 @@
1
- /*
2
- * Copyright 2020 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
- catalog?: {
21
- /**
22
- * List of provider-specific options and attributes
23
- */
24
- providers?: {
25
- /**
26
- * AzureDevopsEntityProvider configuration
27
- */
28
- azureDevOps?: {
29
- [name: string]: {
30
- /**
31
- * (Optional) The DevOps host; defaults to `dev.azure.com` if left empty, otherwise set to your self-hosted instance host.
32
- */
33
- host?: string;
34
- /**
35
- * (Required) Your organization slug.
36
- */
37
- organization: string;
38
- /**
39
- * (Required) Your project slug.
40
- */
41
- project: string;
42
- /**
43
- * (Optional) The repository name. Wildcards are supported as show on the examples above.
44
- * If not set, all repositories will be searched.
45
- */
46
- repository?: string;
47
- /**
48
- * (Optional) The name of a branch to use. If not set, defaults to the default branch of the repository.
49
- */
50
- branch?: string;
51
- /**
52
- * (Optional) Where to find catalog-info.yaml files. Wildcards are supported.
53
- * If not set, defaults to /catalog-info.yaml.
54
- */
55
- path?: string;
56
- /**
57
- * (Optional) TaskScheduleDefinition for the refresh.
58
- */
59
- schedule?: SchedulerServiceTaskScheduleDefinitionConfig;
60
- };
61
- };
62
- /**
63
- * AzureBlobEntityProvider configuration
64
- */
65
- azureBlob?:
66
- | {
67
- [name: string]: {
68
- /**
69
- * (Required) The Azure Blob Storage container name.
70
- */
71
- containerName: string;
72
- /**
73
- * (Required) The Azure Storage account name.
74
- */
75
- accountName: string;
76
- /**
77
- * (Optional) TaskScheduleDefinition for the refresh.
78
- */
79
- schedule?: SchedulerServiceTaskScheduleDefinitionConfig;
80
- };
81
- }
82
- | {
83
- /**
84
- * (Required) The Azure Blob Storage container name.
85
- */
86
- containerName: string;
87
- /**
88
- * (Required) The Azure Storage account name.
89
- */
90
- accountName: string;
91
- /**
92
- * (Optional) TaskScheduleDefinition for the refresh.
93
- */
94
- schedule?: SchedulerServiceTaskScheduleDefinitionConfig;
95
- };
96
- };
97
- };
98
- }