@backstage/backend-app-api 1.7.1 → 1.7.2-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.
Files changed (4) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/config.schema.json +95 -0
  3. package/package.json +11 -11
  4. package/config.d.ts +0 -74
package/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # @backstage/backend-app-api
2
2
 
3
+ ## 1.7.2-next.0
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+ - @backstage/backend-plugin-api@1.9.3-next.0
9
+ - @backstage/connections@0.1.1-next.0
10
+
3
11
  ## 1.7.1
4
12
 
5
13
  ### Patch Changes
package/config.schema.json ADDED
@@ -0,0 +1,95 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "backend": {
6
+ "type": "object",
7
+ "properties": {
8
+ "packages": {
9
+ "anyOf": [
10
+ {
11
+ "type": "string",
12
+ "const": "all"
13
+ },
14
+ {
15
+ "type": "object",
16
+ "properties": {
17
+ "include": {
18
+ "type": "array",
19
+ "items": {
20
+ "type": "string"
21
+ }
22
+ },
23
+ "exclude": {
24
+ "type": "array",
25
+ "items": {
26
+ "type": "string"
27
+ }
28
+ }
29
+ }
30
+ }
31
+ ],
32
+ "description": "Used by the feature discovery service"
33
+ },
34
+ "startup": {
35
+ "type": "object",
36
+ "properties": {
37
+ "default": {
38
+ "type": "object",
39
+ "properties": {
40
+ "onPluginBootFailure": {
41
+ "type": "string",
42
+ "enum": [
43
+ "continue",
44
+ "abort"
45
+ ],
46
+ "description": "The default value for `onPluginBootFailure` if not specified for a particular plugin. This defaults to 'abort', which means `onPluginBootFailure: continue` must be specified for backend startup to continue on plugin boot failure. This can also be set to 'continue', which flips the logic for individual plugins so that they must be set to `onPluginBootFailure: abort` to be required."
47
+ },
48
+ "onPluginModuleBootFailure": {
49
+ "type": "string",
50
+ "enum": [
51
+ "continue",
52
+ "abort"
53
+ ],
54
+ "description": "The default value for `onPluginModuleBootFailure` if not specified for a particular plugin module. This defaults to 'abort', which means `onPluginModuleBootFailure: continue` must be specified for backend startup to continue on plugin module boot failure. This can also be set to 'continue', which flips the logic for individual plugin modules so that they must be set to `onPluginModuleBootFailure: abort` to be required."
55
+ }
56
+ }
57
+ },
58
+ "plugins": {
59
+ "type": "object",
60
+ "additionalProperties": {
61
+ "type": "object",
62
+ "properties": {
63
+ "onPluginBootFailure": {
64
+ "type": "string",
65
+ "enum": [
66
+ "continue",
67
+ "abort"
68
+ ],
69
+ "description": "Used to control backend startup behavior when this plugin fails to boot up. Setting this to `continue` allows the backend to continue starting up, even if this plugin fails. This can enable leaving a crashing plugin installed, but still permit backend startup, which may help troubleshoot data-dependent issues. Plugin failures for plugins set to `abort` are fatal (this is the default unless overridden by the `default` setting)."
70
+ },
71
+ "modules": {
72
+ "type": "object",
73
+ "additionalProperties": {
74
+ "type": "object",
75
+ "properties": {
76
+ "onPluginModuleBootFailure": {
77
+ "type": "string",
78
+ "enum": [
79
+ "continue",
80
+ "abort"
81
+ ],
82
+ "description": "Used to control backend startup behavior when this plugin module fails to boot up. Setting this to `continue` allows the backend to continue starting up, even if this plugin module fails. This can enable leaving a crashing plugin installed, but still permit backend startup, which may help troubleshoot data-dependent issues. Plugin module failures for plugin modules set to `abort` are fatal (this is the default unless overridden by the `default` setting)."
83
+ }
84
+ }
85
+ }
86
+ }
87
+ }
88
+ }
89
+ }
90
+ }
91
+ }
92
+ }
93
+ }
94
+ }
95
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/backend-app-api",
3
- "version": "1.7.1",
3
+ "version": "1.7.2-next.0",
4
4
  "description": "Core API used by Backstage backend apps",
5
5
  "backstage": {
6
6
  "role": "node-library"
@@ -37,7 +37,7 @@
37
37
  },
38
38
  "files": [
39
39
  "dist",
40
- "config.d.ts",
40
+ "config.schema.json",
41
41
  "migrations/**/*.{js,d.ts}"
42
42
  ],
43
43
  "scripts": {
@@ -50,16 +50,16 @@
50
50
  "test": "backstage-cli package test"
51
51
  },
52
52
  "dependencies": {
53
- "@backstage/backend-plugin-api": "^1.9.2",
54
- "@backstage/config": "^1.3.8",
55
- "@backstage/connections": "^0.1.0",
56
- "@backstage/errors": "^1.3.1"
53
+ "@backstage/backend-plugin-api": "1.9.3-next.0",
54
+ "@backstage/config": "1.3.8",
55
+ "@backstage/connections": "0.1.1-next.0",
56
+ "@backstage/errors": "1.3.1"
57
57
  },
58
58
  "devDependencies": {
59
- "@backstage/backend-defaults": "^0.17.3",
60
- "@backstage/backend-test-utils": "^1.11.4",
61
- "@backstage/cli": "^0.36.3",
62
- "@backstage/types": "^1.2.2"
59
+ "@backstage/backend-defaults": "0.17.4-next.0",
60
+ "@backstage/backend-test-utils": "1.11.5-next.0",
61
+ "@backstage/cli": "0.36.4-next.0",
62
+ "@backstage/types": "1.2.2"
63
63
  },
64
- "configSchema": "config.d.ts"
64
+ "configSchema": "config.schema.json"
65
65
  }
package/config.d.ts DELETED
@@ -1,74 +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
- export interface Config {
18
- backend?: {
19
- /** Used by the feature discovery service */
20
- packages?:
21
- | 'all'
22
- | {
23
- include?: string[];
24
- exclude?: string[];
25
- };
26
-
27
- startup?: {
28
- default?: {
29
- /**
30
- * The default value for `onPluginBootFailure` if not specified for a particular plugin.
31
- * This defaults to 'abort', which means `onPluginBootFailure: continue` must be specified
32
- * for backend startup to continue on plugin boot failure. This can also be set to
33
- * 'continue', which flips the logic for individual plugins so that they must be set to
34
- * `onPluginBootFailure: abort` to be required.
35
- */
36
- onPluginBootFailure?: 'continue' | 'abort';
37
- /**
38
- * The default value for `onPluginModuleBootFailure` if not specified for a particular plugin module.
39
- * This defaults to 'abort', which means `onPluginModuleBootFailure: continue` must be specified
40
- * for backend startup to continue on plugin module boot failure. This can also be set to
41
- * 'continue', which flips the logic for individual plugin modules so that they must be set to
42
- * `onPluginModuleBootFailure: abort` to be required.
43
- */
44
- onPluginModuleBootFailure?: 'continue' | 'abort';
45
- };
46
- plugins?: {
47
- [pluginId: string]: {
48
- /**
49
- * Used to control backend startup behavior when this plugin fails to boot up. Setting
50
- * this to `continue` allows the backend to continue starting up, even if this plugin
51
- * fails. This can enable leaving a crashing plugin installed, but still permit backend
52
- * startup, which may help troubleshoot data-dependent issues. Plugin failures for plugins
53
- * set to `abort` are fatal (this is the default unless overridden by the `default`
54
- * setting).
55
- */
56
- onPluginBootFailure?: 'continue' | 'abort';
57
- modules?: {
58
- [moduleId: string]: {
59
- /**
60
- * Used to control backend startup behavior when this plugin module fails to boot up. Setting
61
- * this to `continue` allows the backend to continue starting up, even if this plugin
62
- * module fails. This can enable leaving a crashing plugin installed, but still permit backend
63
- * startup, which may help troubleshoot data-dependent issues. Plugin module failures for plugin modules
64
- * set to `abort` are fatal (this is the default unless overridden by the `default`
65
- * setting).
66
- */
67
- onPluginModuleBootFailure?: 'continue' | 'abort';
68
- };
69
- };
70
- };
71
- };
72
- };
73
- };
74
- }