diff --git a/plugins/api-docs/README.md b/plugins/api-docs/README.md index f74fc19e92..30c09ec483 100644 --- a/plugins/api-docs/README.md +++ b/plugins/api-docs/README.md @@ -246,12 +246,15 @@ createApiFactory({ return req; }; const definitionWidgets = defaultDefinitionWidgets(); - definitionWidgets[definitionWidgets.findIndex(obj => obj.type === 'openapi')] = { - type: 'openapi', - title: 'OpenAPI', - rawLanguage: 'yaml', - component: (definition) => , - }; + definitionWidgets.map(obj => { + if (obj.type === 'openapi') { + return { + ...obj, + component: (definition) => , + } + } + return obj; + }); return { getApiDefinitionWidget: (apiEntity: ApiEntity) => { diff --git a/plugins/api-docs/api-report.md b/plugins/api-docs/api-report.md index fb9fe48621..84e6344325 100644 --- a/plugins/api-docs/api-report.md +++ b/plugins/api-docs/api-report.md @@ -163,7 +163,7 @@ export const OpenApiDefinitionWidget: ( // @public (undocumented) export type OpenApiDefinitionWidgetProps = { definition: string; - requestInterceptor?: (req: Request_2) => Request_2 | Promise; + requestInterceptor?: (req: any) => any | Promise; }; // @public (undocumented) @@ -188,13 +188,6 @@ export const ProvidingComponentsCard: (props: { variant?: InfoCardVariants; }) => JSX.Element; -// @public (undocumented) -interface Request_2 { - // (undocumented) - [k: string]: any; -} -export { Request_2 as Request }; - // @public (undocumented) export const TrpcApiDefinitionWidget: ( props: TrpcApiDefinitionWidgetProps, diff --git a/plugins/api-docs/src/components/OpenApiDefinitionWidget/OpenApiDefinition.tsx b/plugins/api-docs/src/components/OpenApiDefinitionWidget/OpenApiDefinition.tsx index 624f99e4a1..a2ebbbc7e3 100644 --- a/plugins/api-docs/src/components/OpenApiDefinitionWidget/OpenApiDefinition.tsx +++ b/plugins/api-docs/src/components/OpenApiDefinitionWidget/OpenApiDefinition.tsx @@ -18,7 +18,6 @@ import { makeStyles } from '@material-ui/core/styles'; import React, { useEffect, useState } from 'react'; import SwaggerUI from 'swagger-ui-react'; import 'swagger-ui-react/swagger-ui.css'; -import { Request } from './'; const useStyles = makeStyles(theme => ({ root: { @@ -137,7 +136,7 @@ const useStyles = makeStyles(theme => ({ export type OpenApiDefinitionProps = { definition: string; - requestInterceptor?: (req: Request) => Request | Promise; + requestInterceptor?: (req: any) => any | Promise; }; export const OpenApiDefinition = ({ diff --git a/plugins/api-docs/src/components/OpenApiDefinitionWidget/OpenApiDefinitionWidget.tsx b/plugins/api-docs/src/components/OpenApiDefinitionWidget/OpenApiDefinitionWidget.tsx index 809934ee11..152f1fd089 100644 --- a/plugins/api-docs/src/components/OpenApiDefinitionWidget/OpenApiDefinitionWidget.tsx +++ b/plugins/api-docs/src/components/OpenApiDefinitionWidget/OpenApiDefinitionWidget.tsx @@ -16,7 +16,6 @@ import { Progress } from '@backstage/core-components'; import React, { Suspense } from 'react'; -import { Request } from './'; // The swagger-ui component and related CSS has a significant size, only load it // if the element is actually used. @@ -29,7 +28,7 @@ const LazyOpenApiDefinition = React.lazy(() => /** @public */ export type OpenApiDefinitionWidgetProps = { definition: string; - requestInterceptor?: (req: Request) => Request | Promise; + requestInterceptor?: (req: any) => any | Promise; }; /** @public */ diff --git a/plugins/api-docs/src/components/OpenApiDefinitionWidget/index.ts b/plugins/api-docs/src/components/OpenApiDefinitionWidget/index.ts index 631a96c047..e317d42a59 100644 --- a/plugins/api-docs/src/components/OpenApiDefinitionWidget/index.ts +++ b/plugins/api-docs/src/components/OpenApiDefinitionWidget/index.ts @@ -16,8 +16,3 @@ export { OpenApiDefinitionWidget } from './OpenApiDefinitionWidget'; export type { OpenApiDefinitionWidgetProps } from './OpenApiDefinitionWidget'; - -/** @public */ -export interface Request { - [k: string]: any; -}