From f51cc4b333bb4ae7a001e33cc793beca7428fb04 Mon Sep 17 00:00:00 2001 From: "liad.shachoach" Date: Tue, 14 Jan 2025 10:21:16 +0200 Subject: [PATCH] removing function export from report.api.md and updating changeset Signed-off-by: liad.shachoach --- .changeset/chilled-rocks-rule.md | 2 +- .../report.api.md | 158 +++++++++++++----- 2 files changed, 117 insertions(+), 43 deletions(-) diff --git a/.changeset/chilled-rocks-rule.md b/.changeset/chilled-rocks-rule.md index bb2aad2a47..1f8439462c 100644 --- a/.changeset/chilled-rocks-rule.md +++ b/.changeset/chilled-rocks-rule.md @@ -2,4 +2,4 @@ '@backstage/plugin-scaffolder-backend-module-bitbucket-cloud': patch --- -Added bitbucketCloud:branchRestriction:create to allow users to create bitbucket cloud branch restrictions in templates +Added `bitbucketCloud:branchRestriction:create` to allow users to create bitbucket cloud branch restrictions in templates diff --git a/plugins/scaffolder-backend-module-bitbucket-cloud/report.api.md b/plugins/scaffolder-backend-module-bitbucket-cloud/report.api.md index 67c05a4ea5..34bb643d31 100644 --- a/plugins/scaffolder-backend-module-bitbucket-cloud/report.api.md +++ b/plugins/scaffolder-backend-module-bitbucket-cloud/report.api.md @@ -1,13 +1,17 @@ -## API Report File for "@backstage/plugin-scaffolder-backend-module-bitbucket-cloud" +## API Report File for "@backstage/plugin-user-settings" > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeature } from '@backstage/backend-plugin-api'; -import { Config } from '@backstage/config'; -import { JsonObject } from '@backstage/types'; -import { ScmIntegrationRegistry } from '@backstage/integration'; -import { TemplateAction } from '@backstage/plugin-scaffolder-node'; +import { AnyRouteRefParams } from '@backstage/frontend-plugin-api'; +import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api'; +import { ExtensionDefinition } from '@backstage/frontend-plugin-api'; +import { ExtensionInput } from '@backstage/frontend-plugin-api'; +import { FrontendPlugin } from '@backstage/frontend-plugin-api'; +import { IconComponent } from '@backstage/core-plugin-api'; +import { default as React_2 } from 'react'; +import { RouteRef } from '@backstage/frontend-plugin-api'; +import { TranslationRef } from '@backstage/core-plugin-api/alpha'; // @public const bitbucketCloudModule: BackendFeature; @@ -36,46 +40,116 @@ export const createBitbucketPipelinesRunAction: (options: { integrations: ScmIntegrationRegistry; }) => TemplateAction< { - workspace: string; - repo_slug: string; - body?: object | undefined; - token?: string | undefined; + root: RouteRef; }, - JsonObject ->; - -// @public -export function createPublishBitbucketCloudAction(options: { - integrations: ScmIntegrationRegistry; - config: Config; -}): TemplateAction< + {}, { - repoUrl: string; - description?: string | undefined; - defaultBranch?: string | undefined; - repoVisibility?: 'private' | 'public' | undefined; - gitCommitMessage?: string | undefined; - sourcePath?: string | undefined; - token?: string | undefined; - }, - JsonObject + 'nav-item:user-settings': ExtensionDefinition<{ + kind: 'nav-item'; + name: undefined; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + { + title: string; + icon: IconComponent; + routeRef: RouteRef; + }, + 'core.nav-item.target', + {} + >; + inputs: {}; + params: { + title: string; + icon: IconComponent; + routeRef: RouteRef; + }; + }>; + 'page:user-settings': ExtensionDefinition<{ + config: { + path: string | undefined; + }; + configInput: { + path?: string | undefined; + }; + output: + | ConfigurableExtensionDataRef< + React_2.JSX.Element, + 'core.reactElement', + {} + > + | ConfigurableExtensionDataRef + | ConfigurableExtensionDataRef< + RouteRef, + 'core.routing.ref', + { + optional: true; + } + >; + inputs: { + providerSettings: ExtensionInput< + ConfigurableExtensionDataRef< + React_2.JSX.Element, + 'core.reactElement', + {} + >, + { + singleton: true; + optional: true; + } + >; + }; + kind: 'page'; + name: undefined; + params: { + defaultPath: string; + loader: () => Promise; + routeRef?: RouteRef | undefined; + }; + }>; + } >; +export default _default; -// @public -export function createPublishBitbucketCloudPullRequestAction(options: { - integrations: ScmIntegrationRegistry; - config: Config; -}): TemplateAction< - { - repoUrl: string; +// @alpha (undocumented) +export const settingsNavItem: ExtensionDefinition<{ + kind: 'nav-item'; + name: undefined; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + { + title: string; + icon: IconComponent; + routeRef: RouteRef; + }, + 'core.nav-item.target', + {} + >; + inputs: {}; + params: { title: string; - description?: string | undefined; - targetBranch?: string | undefined; - sourceBranch: string; - token?: string | undefined; - gitAuthorName?: string | undefined; - gitAuthorEmail?: string | undefined; - }, - JsonObject + icon: IconComponent; + routeRef: RouteRef; + }; +}>; + +// @alpha (undocumented) +export const userSettingsTranslationRef: TranslationRef< + 'user-settings', + { + readonly 'languageToggle.description': 'Change the language'; + readonly 'languageToggle.select': 'Select language {{language}}'; + readonly 'languageToggle.title': 'Language'; + readonly 'themeToggle.description': 'Change the theme mode'; + readonly 'themeToggle.select': 'Select theme {{theme}}'; + readonly 'themeToggle.title': 'Theme'; + readonly 'themeToggle.names.light': 'Light'; + readonly 'themeToggle.names.dark': 'Dark'; + readonly 'themeToggle.names.auto': 'Auto'; + readonly 'themeToggle.selectAuto': 'Select Auto Theme'; + } >; + +// (No @packageDocumentation comment for this package) ```