@backstage/backend-plugin-api 1.10.0-next.0 → 1.10.0-next.1

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,11 @@
1
1
  # @backstage/backend-plugin-api
2
2
 
3
+ ## 1.10.0-next.1
4
+
5
+ ### Patch Changes
6
+
7
+ - b1b6c80: Documented the default destructive and read-only action attribute values.
8
+
3
9
  ## 1.10.0-next.0
4
10
 
5
11
  ### Minor Changes
package/dist/alpha.d.ts CHANGED
@@ -42,8 +42,13 @@ type ActionsRegistryActionOptions<TInputSchema extends AnyZodObject, TOutputSche
42
42
  examples?: Array<ActionsRegistryActionExample<TInputSchema, TOutputSchema>>;
43
43
  visibilityPermission?: BasicPermission;
44
44
  attributes?: {
45
+ /**
46
+ * Whether the action may perform destructive updates. Defaults to `false`
47
+ * when `readOnly` is `true`, and `true` otherwise.
48
+ */
45
49
  destructive?: boolean;
46
50
  idempotent?: boolean;
51
+ /** Whether the action only reads from its environment. Defaults to `false`. */
47
52
  readOnly?: boolean;
48
53
  };
49
54
  action: (context: ActionsRegistryActionContext<TInputSchema, TSecretsSchema>) => Promise<z.infer<TOutputSchema> extends void ? void : {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/backend-plugin-api",
3
- "version": "1.10.0-next.0",
3
+ "version": "1.10.0-next.1",
4
4
  "description": "Core API used by Backstage backend plugins",
5
5
  "backstage": {
6
6
  "role": "node-library"
@@ -80,8 +80,8 @@
80
80
  "zod": "^3.25.76 || ^4.0.0"
81
81
  },
82
82
  "devDependencies": {
83
- "@backstage/backend-test-utils": "1.11.6-next.0",
84
- "@backstage/cli": "0.36.4"
83
+ "@backstage/backend-test-utils": "1.11.6-next.1",
84
+ "@backstage/cli": "0.36.5-next.1"
85
85
  },
86
86
  "configSchema": "config.schema.json"
87
87
  }