paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 36 Packages Projects Releases Wiki Activity

Merge pull request #33916 from backstage/rugvip/remove-dead-actions-service-definitions

Browse Source 
backend-plugin-api: 🧹
This commit is contained in:
Patrik Oldsberg
2026-04-16 17:02:44 +02:00
committed by GitHub
parent 7b4ea63b38 5f80e77714
commit ebfa023123
2 changed files with 0 additions and 142 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/backend-plugin-api/src/services/definitions/ActionsRegistryService.ts
-85
View File
@@ -1,85 +0,0 @@
/*
* Copyright 2025 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { z, AnyZodObject } from 'zod/v3';
import { BasicPermission } from '@backstage/plugin-permission-common';
import { LoggerService } from './LoggerService';
import { BackstageCredentials } from './AuthService';
/**
* @public
*/
export type ActionsRegistryActionContext<TInputSchema extends AnyZodObject> = {
input: z.infer<TInputSchema>;
logger: LoggerService;
credentials: BackstageCredentials;
};
/**
* An example of how to use an action registered in the actions registry.
*
* @public
*/
export type ActionsRegistryActionExample<
TInputSchema extends AnyZodObject,
TOutputSchema extends AnyZodObject,
> = {
title: string;
description?: string;
input: z.infer<TInputSchema>;
output?: z.infer<TOutputSchema>;
};
/**
* @public
*/
export type ActionsRegistryActionOptions<
TInputSchema extends AnyZodObject,
TOutputSchema extends AnyZodObject,
> = {
name: string;
title: string;
description: string;
schema: {
input: (zod: typeof z) => TInputSchema;
output: (zod: typeof z) => TOutputSchema;
};
examples?: Array<ActionsRegistryActionExample<TInputSchema, TOutputSchema>>;
visibilityPermission?: BasicPermission;
attributes?: {
destructive?: boolean;
idempotent?: boolean;
readOnly?: boolean;
};
action: (
context: ActionsRegistryActionContext<TInputSchema>,
) => Promise<
z.infer<TOutputSchema> extends void
? void
: { output: z.infer<TOutputSchema> }
>;
};
/**
* @public
*/
export interface ActionsRegistryService {
register<
TInputSchema extends AnyZodObject,
TOutputSchema extends AnyZodObject,
>(
options: ActionsRegistryActionOptions<TInputSchema, TOutputSchema>,
): void;
}
packages/backend-plugin-api/src/services/definitions/ActionsService.ts
-57
View File
@@ -1,57 +0,0 @@
/*
* Copyright 2025 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { JsonObject, JsonValue } from '@backstage/types';
import { JSONSchema7 } from 'json-schema';
import { BackstageCredentials } from './AuthService';
/**
* @public
*/
export type ActionsServiceAction = {
id: string;
name: string;
title: string;
description: string;
schema: {
input: JSONSchema7;
output: JSONSchema7;
};
examples?: Array<{
title: string;
description?: string;
input: JsonObject;
output?: JsonObject;
}>;
attributes: {
readOnly: boolean;
destructive: boolean;
idempotent: boolean;
};
};
/**
* @public
*/
export interface ActionsService {
list: (opts: {
credentials: BackstageCredentials;
}) => Promise<{ actions: ActionsServiceAction[] }>;
invoke(opts: {
id: string;
input?: JsonObject;
credentials: BackstageCredentials;
}): Promise<{ output: JsonValue }>;
}