Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Linguist] Marked createRouter, createRouterFromConfig, RouterOptions, and PluginOptions as deprecated #1198

Merged
merged 1 commit into from
Sep 17, 2024
Merged

[Linguist] Marked createRouter, createRouterFromConfig, RouterOptions, and PluginOptions as deprecated #1198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions workspaces/linguist/.changeset/chilly-readers-own.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@backstage-community/plugin-linguist-backend': patch
---

Marked `createRouter`, `createRouterFromConfig`, `RouterOptions`, and `PluginOptions` as deprecated, to be removed soon after the Backstage `1.32.0` release in October
8 changes: 4 additions & 4 deletions workspaces/linguist/plugins/linguist-backend/api-report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ import { SchedulerService } from '@backstage/backend-plugin-api';
import { SchedulerServiceTaskScheduleDefinition } from '@backstage/backend-plugin-api';
import { UrlReaderService } from '@backstage/backend-plugin-api';

// @public (undocumented)
// @public @deprecated (undocumented)
export function createRouter(
pluginOptions: PluginOptions,
routerOptions: RouterOptions,
): Promise<express.Router>;

// @public (undocumented)
// @public @deprecated (undocumented)
export function createRouterFromConfig(
routerOptions: RouterOptions,
): Promise<express.Router>;
Expand All @@ -40,7 +40,7 @@ export interface LinguistBackendApi {
const linguistPlugin: BackendFeatureCompat;
export default linguistPlugin;

// @public (undocumented)
// @public @deprecated (undocumented)
export interface PluginOptions {
// (undocumented)
age?: HumanDuration;
Expand All @@ -56,7 +56,7 @@ export interface PluginOptions {
useSourceLocation?: boolean;
}

// @public (undocumented)
// @public @deprecated (undocumented)
export interface RouterOptions {
// (undocumented)
auth?: AuthService;
Expand Down
20 changes: 16 additions & 4 deletions workspaces/linguist/plugins/linguist-backend/src/service/router.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,10 @@ import {
} from '@backstage/backend-plugin-api';
import { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';

/** @public */
/**
* @deprecated Please migrate to the new backend system as this will be removed in the future.
* @public
* */
export interface PluginOptions {
schedule?: SchedulerServiceTaskScheduleDefinition;
age?: HumanDuration;
Expand All @@ -48,7 +51,10 @@ export interface PluginOptions {
kind?: string[];
}

/** @public */
/**
* @deprecated Please migrate to the new backend system as this will be removed in the future.
* @public
* */
export interface RouterOptions {
linguistBackendApi?: LinguistBackendApi;
logger: LoggerService;
Expand All @@ -61,7 +67,10 @@ export interface RouterOptions {
httpAuth?: HttpAuthService;
}

/** @public */
/**
* @deprecated Please migrate to the new backend system as this will be removed in the future.
* @public
* */
export async function createRouter(
pluginOptions: PluginOptions,
routerOptions: RouterOptions,
Expand Down Expand Up @@ -149,7 +158,10 @@ export async function createRouter(
return router;
}

/** @public */
/**
* @deprecated Please migrate to the new backend system as this will be removed in the future.
* @public
* */
export async function createRouterFromConfig(routerOptions: RouterOptions) {
const { config } = routerOptions;
const pluginOptions: PluginOptions = {};
Expand Down
Loading