diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/catalog/register.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/catalog/register.ts
index 7cf1ac2120..654b2c954d 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/catalog/register.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/catalog/register.ts
@@ -31,6 +31,7 @@ export function createCatalogRegisterAction(options: {
| { repoContentsUrl: string; catalogInfoPath?: string }
>({
id: 'catalog:register',
+ description: 'Registers entity in the software catalog.',
schema: {
input: {
oneOf: [
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/cookiecutter.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/cookiecutter.ts
index 2a04ed301d..32c374f659 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/cookiecutter.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/cookiecutter.ts
@@ -38,6 +38,8 @@ export function createFetchCookiecutterAction(options: {
values: JsonObject;
}>({
id: 'fetch:cookiecutter',
+ description:
+ "Downloads template from 'url' and templates with cookiecutter",
schema: {
input: {
type: 'object',
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/plain.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/plain.ts
index 1eb1a6dc82..cae7364255 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/plain.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/plain.ts
@@ -28,6 +28,8 @@ export function createFetchPlainAction(options: {
return createTemplateAction<{ url: string; targetPath?: string }>({
id: 'fetch:plain',
+ description:
+ "Downloads content and places it in the workspacePath or optionally in a subdirectory specified by the 'targetPath' input option.",
schema: {
input: {
type: 'object',
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/azure.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/azure.ts
index 5eaba05ea0..dc66c710fc 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/azure.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/azure.ts
@@ -32,6 +32,8 @@ export function createPublishAzureAction(options: {
description?: string;
}>({
id: 'publish:azure',
+ description:
+ 'Initializes a git repository of contents in workspacePath and publishes to Azure.',
schema: {
input: {
type: 'object',
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/bitbucket.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/bitbucket.ts
index 4c3cf30ecd..842dee0df9 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/bitbucket.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/bitbucket.ts
@@ -167,6 +167,8 @@ export function createPublishBitbucketAction(options: {
repoVisibility: 'private' | 'public';
}>({
id: 'publish:bitbucket',
+ description:
+ 'Initializes a git repository of contents in workspacePath and publishes to Bitbucket.',
schema: {
input: {
type: 'object',
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/github.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/github.ts
index be0820d0b1..258f0625ca 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/github.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/github.ts
@@ -43,6 +43,8 @@ export function createPublishGithubAction(options: {
repoVisibility: 'private' | 'internal' | 'public';
}>({
id: 'publish:github',
+ description:
+ 'Initializes a git repository of contents in workspacePath and publishes to GitHub.',
schema: {
input: {
type: 'object',
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlab.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlab.ts
index 9122c828a0..10113b324a 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlab.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlab.ts
@@ -31,6 +31,8 @@ export function createPublishGitlabAction(options: {
repoVisibility: 'private' | 'internal' | 'public';
}>({
id: 'publish:gitlab',
+ description:
+ 'Initializes a git repository of contents in workspacePath and publishes to GitLab.',
schema: {
input: {
type: 'object',
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/types.ts b/plugins/scaffolder-backend/src/scaffolder/actions/types.ts
index 20b7696d70..955cb72de9 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/types.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/types.ts
@@ -44,6 +44,7 @@ export type ActionContext = {
export type TemplateAction = {
id: string;
+ description?: string;
schema?: {
input?: Schema;
output?: Schema;
diff --git a/plugins/scaffolder-backend/src/service/router.ts b/plugins/scaffolder-backend/src/service/router.ts
index b77c832ca1..81be03730b 100644
--- a/plugins/scaffolder-backend/src/service/router.ts
+++ b/plugins/scaffolder-backend/src/service/router.ts
@@ -351,6 +351,7 @@ export async function createRouter(
const actionsList = actionRegistry.list().map(action => {
return {
id: action.id,
+ description: action.description,
schema: action.schema,
};
});
diff --git a/plugins/scaffolder/src/types.ts b/plugins/scaffolder/src/types.ts
index 886650859a..6a2c2eede4 100644
--- a/plugins/scaffolder/src/types.ts
+++ b/plugins/scaffolder/src/types.ts
@@ -58,6 +58,7 @@ export type ScaffolderTask = {
export type ListActionsResponse = Array<{
id: string;
+ description?: string;
schema?: {
input?: JSONSchema;
output?: JSONSchema;