@backstage/plugin-api-docs 0.0.0-nightly-20260413031937 → 0.0.0-nightly-20260416031834
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +29 -10
- package/dist/alpha.d.ts +11 -7
- package/dist/components/ApiDefinitionCard/ApiDefinitionCard.esm.js +4 -4
- package/dist/components/ApiDefinitionCard/ApiDefinitionCard.esm.js.map +1 -1
- package/dist/components/ApiDefinitionDialog/ApiDefinitionDialog.esm.js +2 -1
- package/dist/components/ApiDefinitionDialog/ApiDefinitionDialog.esm.js.map +1 -1
- package/dist/package.json.esm.js +1 -1
- package/package.json +15 -15
package/CHANGELOG.md
CHANGED
|
@@ -1,20 +1,39 @@
|
|
|
1
1
|
# @backstage/plugin-api-docs
|
|
2
2
|
|
|
3
|
-
## 0.0.0-nightly-
|
|
3
|
+
## 0.0.0-nightly-20260416031834
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
- @backstage/ui@0.0.0-nightly-20260416031834
|
|
9
|
+
- @backstage/frontend-plugin-api@0.0.0-nightly-20260416031834
|
|
10
|
+
- @backstage/plugin-catalog-react@0.0.0-nightly-20260416031834
|
|
11
|
+
- @backstage/plugin-catalog@0.0.0-nightly-20260416031834
|
|
12
|
+
- @backstage/catalog-model@0.0.0-nightly-20260416031834
|
|
13
|
+
- @backstage/core-components@0.0.0-nightly-20260416031834
|
|
14
|
+
- @backstage/core-plugin-api@0.0.0-nightly-20260416031834
|
|
15
|
+
- @backstage/plugin-catalog-common@0.0.0-nightly-20260416031834
|
|
16
|
+
- @backstage/plugin-permission-react@0.0.0-nightly-20260416031834
|
|
17
|
+
|
|
18
|
+
## 0.14.0
|
|
19
|
+
|
|
20
|
+
### Minor Changes
|
|
21
|
+
|
|
22
|
+
- b871d4e: Use Entity Presentation API for entity display in api-docs plugin
|
|
4
23
|
|
|
5
24
|
### Patch Changes
|
|
6
25
|
|
|
7
26
|
- da17844: Update readme to add instructions for custom api base URL
|
|
8
27
|
- Updated dependencies
|
|
9
|
-
- @backstage/ui@0.
|
|
10
|
-
- @backstage/plugin-catalog@
|
|
11
|
-
- @backstage/
|
|
12
|
-
- @backstage/plugin-catalog-react@
|
|
13
|
-
- @backstage/frontend-plugin-api@0.
|
|
14
|
-
- @backstage/
|
|
15
|
-
- @backstage/
|
|
16
|
-
- @backstage/plugin-
|
|
17
|
-
- @backstage/plugin-
|
|
28
|
+
- @backstage/ui@0.14.0
|
|
29
|
+
- @backstage/plugin-catalog@2.0.2
|
|
30
|
+
- @backstage/catalog-model@1.8.0
|
|
31
|
+
- @backstage/plugin-catalog-react@2.1.2
|
|
32
|
+
- @backstage/frontend-plugin-api@0.16.0
|
|
33
|
+
- @backstage/core-components@0.18.9
|
|
34
|
+
- @backstage/plugin-permission-react@0.5.0
|
|
35
|
+
- @backstage/core-plugin-api@1.12.5
|
|
36
|
+
- @backstage/plugin-catalog-common@1.1.9
|
|
18
37
|
|
|
19
38
|
## 0.13.6-next.2
|
|
20
39
|
|
package/dist/alpha.d.ts
CHANGED
|
@@ -180,9 +180,9 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
|
|
|
180
180
|
icon: string | undefined;
|
|
181
181
|
};
|
|
182
182
|
configInput: {
|
|
183
|
-
filter?: _backstage_filter_predicates.FilterPredicate | undefined;
|
|
184
|
-
title?: string | undefined;
|
|
185
183
|
path?: string | undefined;
|
|
184
|
+
title?: string | undefined;
|
|
185
|
+
filter?: _backstage_filter_predicates.FilterPredicate | undefined;
|
|
186
186
|
group?: string | false | undefined;
|
|
187
187
|
icon?: string | undefined;
|
|
188
188
|
};
|
|
@@ -222,9 +222,9 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
|
|
|
222
222
|
icon: string | undefined;
|
|
223
223
|
};
|
|
224
224
|
configInput: {
|
|
225
|
-
filter?: _backstage_filter_predicates.FilterPredicate | undefined;
|
|
226
|
-
title?: string | undefined;
|
|
227
225
|
path?: string | undefined;
|
|
226
|
+
title?: string | undefined;
|
|
227
|
+
filter?: _backstage_filter_predicates.FilterPredicate | undefined;
|
|
228
228
|
group?: string | false | undefined;
|
|
229
229
|
icon?: string | undefined;
|
|
230
230
|
};
|
|
@@ -256,8 +256,12 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
|
|
|
256
256
|
"nav-item:api-docs": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
|
|
257
257
|
kind: "nav-item";
|
|
258
258
|
name: undefined;
|
|
259
|
-
config: {
|
|
260
|
-
|
|
259
|
+
config: {
|
|
260
|
+
title: string | undefined;
|
|
261
|
+
};
|
|
262
|
+
configInput: {
|
|
263
|
+
title?: string | undefined;
|
|
264
|
+
};
|
|
261
265
|
output: _backstage_frontend_plugin_api.ExtensionDataRef<{
|
|
262
266
|
title: string;
|
|
263
267
|
icon: _backstage_frontend_plugin_api.IconComponent;
|
|
@@ -278,8 +282,8 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
|
|
|
278
282
|
};
|
|
279
283
|
configInput: {
|
|
280
284
|
initiallySelectedFilter?: "all" | "owned" | "starred" | undefined;
|
|
281
|
-
title?: string | undefined;
|
|
282
285
|
path?: string | undefined;
|
|
286
|
+
title?: string | undefined;
|
|
283
287
|
};
|
|
284
288
|
output: _backstage_frontend_plugin_api.ExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
|
|
285
289
|
optional: true;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { jsx, jsxs } from 'react/jsx-runtime';
|
|
2
|
-
import { useEntity } from '@backstage/plugin-catalog-react';
|
|
2
|
+
import { useEntity, useEntityPresentation } from '@backstage/plugin-catalog-react';
|
|
3
3
|
import { TabbedCard, CardTab } from '@backstage/core-components';
|
|
4
4
|
import { useApi } from '@backstage/core-plugin-api';
|
|
5
5
|
import { useTranslationRef } from '@backstage/frontend-plugin-api';
|
|
@@ -13,13 +13,13 @@ const ApiDefinitionCard = () => {
|
|
|
13
13
|
const config = useApi(apiDocsConfigRef);
|
|
14
14
|
const { getApiDefinitionWidget } = config;
|
|
15
15
|
const { t } = useTranslationRef(apiDocsTranslationRef);
|
|
16
|
+
const { primaryTitle } = useEntityPresentation(entity);
|
|
16
17
|
if (!entity) {
|
|
17
18
|
return /* @__PURE__ */ jsx(Alert, { severity: "error", children: t("apiDefinitionCard.error.title") });
|
|
18
19
|
}
|
|
19
20
|
const definitionWidget = getApiDefinitionWidget(entity);
|
|
20
|
-
const entityTitle = entity.metadata.title ?? entity.metadata.name;
|
|
21
21
|
if (definitionWidget) {
|
|
22
|
-
return /* @__PURE__ */ jsxs(TabbedCard, { title:
|
|
22
|
+
return /* @__PURE__ */ jsxs(TabbedCard, { title: primaryTitle, children: [
|
|
23
23
|
/* @__PURE__ */ jsx(CardTab, { label: definitionWidget.title, children: definitionWidget.component(entity.spec.definition) }, "widget"),
|
|
24
24
|
/* @__PURE__ */ jsx(CardTab, { label: t("apiDefinitionCard.rawButtonTitle"), children: /* @__PURE__ */ jsx(
|
|
25
25
|
PlainApiDefinitionWidget,
|
|
@@ -33,7 +33,7 @@ const ApiDefinitionCard = () => {
|
|
|
33
33
|
return /* @__PURE__ */ jsx(
|
|
34
34
|
TabbedCard,
|
|
35
35
|
{
|
|
36
|
-
title:
|
|
36
|
+
title: primaryTitle,
|
|
37
37
|
children: [
|
|
38
38
|
// Has to be an array, otherwise typescript doesn't like that this has only a single child
|
|
39
39
|
/* @__PURE__ */ jsx(CardTab, { label: entity.spec.type, children: /* @__PURE__ */ jsx(
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiDefinitionCard.esm.js","sources":["../../../src/components/ApiDefinitionCard/ApiDefinitionCard.tsx"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ApiEntity } from '@backstage/catalog-model';\nimport {
|
|
1
|
+
{"version":3,"file":"ApiDefinitionCard.esm.js","sources":["../../../src/components/ApiDefinitionCard/ApiDefinitionCard.tsx"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ApiEntity } from '@backstage/catalog-model';\nimport {\n useEntity,\n useEntityPresentation,\n} from '@backstage/plugin-catalog-react';\nimport { CardTab, TabbedCard } from '@backstage/core-components';\nimport { useApi } from '@backstage/core-plugin-api';\nimport { useTranslationRef } from '@backstage/frontend-plugin-api';\nimport Alert from '@material-ui/lab/Alert';\nimport { apiDocsConfigRef } from '../../config';\nimport { apiDocsTranslationRef } from '../../translation';\nimport { PlainApiDefinitionWidget } from '../PlainApiDefinitionWidget';\n\n/** @public */\nexport const ApiDefinitionCard = () => {\n const { entity } = useEntity<ApiEntity>();\n const config = useApi(apiDocsConfigRef);\n const { getApiDefinitionWidget } = config;\n const { t } = useTranslationRef(apiDocsTranslationRef);\n const { primaryTitle } = useEntityPresentation(entity);\n\n if (!entity) {\n return <Alert severity=\"error\">{t('apiDefinitionCard.error.title')}</Alert>;\n }\n\n const definitionWidget = getApiDefinitionWidget(entity);\n\n if (definitionWidget) {\n return (\n <TabbedCard title={primaryTitle}>\n <CardTab label={definitionWidget.title} key=\"widget\">\n {definitionWidget.component(entity.spec.definition)}\n </CardTab>\n <CardTab label={t('apiDefinitionCard.rawButtonTitle')} key=\"raw\">\n <PlainApiDefinitionWidget\n definition={entity.spec.definition}\n language={definitionWidget.rawLanguage || entity.spec.type}\n />\n </CardTab>\n </TabbedCard>\n );\n }\n\n return (\n <TabbedCard\n title={primaryTitle}\n children={[\n // Has to be an array, otherwise typescript doesn't like that this has only a single child\n <CardTab label={entity.spec.type} key=\"raw\">\n <PlainApiDefinitionWidget\n definition={entity.spec.definition}\n language={entity.spec.type}\n />\n </CardTab>,\n ]}\n />\n );\n};\n"],"names":[],"mappings":";;;;;;;;;;AA8BO,MAAM,oBAAoB,MAAM;AACrC,EAAA,MAAM,EAAE,MAAA,EAAO,GAAI,SAAA,EAAqB;AACxC,EAAA,MAAM,MAAA,GAAS,OAAO,gBAAgB,CAAA;AACtC,EAAA,MAAM,EAAE,wBAAuB,GAAI,MAAA;AACnC,EAAA,MAAM,EAAE,CAAA,EAAE,GAAI,iBAAA,CAAkB,qBAAqB,CAAA;AACrD,EAAA,MAAM,EAAE,YAAA,EAAa,GAAI,qBAAA,CAAsB,MAAM,CAAA;AAErD,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,2BAAQ,KAAA,EAAA,EAAM,QAAA,EAAS,OAAA,EAAS,QAAA,EAAA,CAAA,CAAE,+BAA+B,CAAA,EAAE,CAAA;AAAA,EACrE;AAEA,EAAA,MAAM,gBAAA,GAAmB,uBAAuB,MAAM,CAAA;AAEtD,EAAA,IAAI,gBAAA,EAAkB;AACpB,IAAA,uBACE,IAAA,CAAC,UAAA,EAAA,EAAW,KAAA,EAAO,YAAA,EACjB,QAAA,EAAA;AAAA,sBAAA,GAAA,CAAC,OAAA,EAAA,EAAQ,KAAA,EAAO,gBAAA,CAAiB,KAAA,EAC9B,QAAA,EAAA,gBAAA,CAAiB,UAAU,MAAA,CAAO,IAAA,CAAK,UAAU,CAAA,EAAA,EADR,QAE5C,CAAA;AAAA,sBACA,GAAA,CAAC,OAAA,EAAA,EAAQ,KAAA,EAAO,CAAA,CAAE,kCAAkC,CAAA,EAClD,QAAA,kBAAA,GAAA;AAAA,QAAC,wBAAA;AAAA,QAAA;AAAA,UACC,UAAA,EAAY,OAAO,IAAA,CAAK,UAAA;AAAA,UACxB,QAAA,EAAU,gBAAA,CAAiB,WAAA,IAAe,MAAA,CAAO,IAAA,CAAK;AAAA;AAAA,WAHC,KAK3D;AAAA,KAAA,EACF,CAAA;AAAA,EAEJ;AAEA,EAAA,uBACE,GAAA;AAAA,IAAC,UAAA;AAAA,IAAA;AAAA,MACC,KAAA,EAAO,YAAA;AAAA,MACP,QAAA,EAAU;AAAA;AAAA,wBAER,GAAA,CAAC,OAAA,EAAA,EAAQ,KAAA,EAAO,MAAA,CAAO,KAAK,IAAA,EAC1B,QAAA,kBAAA,GAAA;AAAA,UAAC,wBAAA;AAAA,UAAA;AAAA,YACC,UAAA,EAAY,OAAO,IAAA,CAAK,UAAA;AAAA,YACxB,QAAA,EAAU,OAAO,IAAA,CAAK;AAAA;AAAA,aAHY,KAKtC;AAAA;AACF;AAAA,GACF;AAEJ;;;;"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { jsxs, jsx } from 'react/jsx-runtime';
|
|
2
2
|
import { useApi } from '@backstage/core-plugin-api';
|
|
3
|
+
import { EntityDisplayName } from '@backstage/plugin-catalog-react';
|
|
3
4
|
import Box from '@material-ui/core/Box';
|
|
4
5
|
import Button from '@material-ui/core/Button';
|
|
5
6
|
import Dialog from '@material-ui/core/Dialog';
|
|
@@ -98,7 +99,7 @@ function ApiDefinitionDialog(props) {
|
|
|
98
99
|
" ",
|
|
99
100
|
definitionWidget?.title ?? t("apiDefinitionDialog.rawButtonTitle")
|
|
100
101
|
] }),
|
|
101
|
-
/* @__PURE__ */ jsx(Typography, { className: classes.title, variant: "h1", children:
|
|
102
|
+
/* @__PURE__ */ jsx(Typography, { className: classes.title, variant: "h1", children: /* @__PURE__ */ jsx(EntityDisplayName, { entityRef: entity }) })
|
|
102
103
|
] }),
|
|
103
104
|
/* @__PURE__ */ jsxs(DialogContent, { dividers: true, className: classes.root, children: [
|
|
104
105
|
/* @__PURE__ */ jsxs(
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiDefinitionDialog.esm.js","sources":["../../../src/components/ApiDefinitionDialog/ApiDefinitionDialog.tsx"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ApiEntity } from '@backstage/catalog-model';\nimport { useApi } from '@backstage/core-plugin-api';\nimport Box from '@material-ui/core/Box';\nimport Button from '@material-ui/core/Button';\nimport Dialog from '@material-ui/core/Dialog';\nimport DialogActions from '@material-ui/core/DialogActions';\nimport DialogContent from '@material-ui/core/DialogContent';\nimport DialogTitle from '@material-ui/core/DialogTitle';\nimport Tab from '@material-ui/core/Tab';\nimport Tabs from '@material-ui/core/Tabs';\nimport Typography from '@material-ui/core/Typography';\nimport { makeStyles } from '@material-ui/core/styles';\nimport { ReactNode, useState, useEffect } from 'react';\nimport { apiDocsConfigRef } from '../../config';\nimport { PlainApiDefinitionWidget } from '../PlainApiDefinitionWidget';\nimport { useTranslationRef } from '@backstage/frontend-plugin-api';\nimport { apiDocsTranslationRef } from '../../translation';\n\nconst useStyles = makeStyles(theme => ({\n fullHeightDialog: {\n height: 'calc(100% - 64px)',\n },\n root: {\n display: 'flex',\n flexGrow: 1,\n width: '100%',\n height: '100%',\n },\n tabs: {\n borderRight: `1px solid ${theme.palette.divider}`,\n flexShrink: 0,\n },\n tabContents: {\n flexGrow: 1,\n overflowX: 'auto',\n },\n title: {\n color: theme.palette.text.primary,\n wordBreak: 'break-word',\n fontSize: theme.typography.h3.fontSize,\n marginBottom: 0,\n },\n type: {\n textTransform: 'uppercase',\n fontSize: 11,\n opacity: 0.8,\n marginBottom: theme.spacing(1),\n color: theme.palette.text.primary,\n },\n}));\n\nfunction TabPanel(props: {\n children?: ReactNode;\n index: number;\n value: number;\n}) {\n const { children, value, index, ...other } = props;\n const classes = useStyles();\n return (\n <div\n role=\"tabpanel\"\n hidden={value !== index}\n id={`vertical-tabpanel-${index}`}\n aria-labelledby={`vertical-tab-${index}`}\n className={classes.tabContents}\n {...other}\n >\n {value === index && (\n <Box pl={3} pr={3}>\n {children}\n </Box>\n )}\n </div>\n );\n}\n\nfunction a11yProps(index: number) {\n return {\n id: `vertical-tab-${index}`,\n 'aria-controls': `vertical-tabpanel-${index}`,\n };\n}\n\n/**\n * A dialog that lets users inspect the API definition.\n *\n * @public\n */\nexport function ApiDefinitionDialog(props: {\n open: boolean;\n entity: ApiEntity;\n onClose: () => void;\n}) {\n const { open, entity, onClose } = props;\n const [activeTab, setActiveTab] = useState(0);\n const classes = useStyles();\n const { t } = useTranslationRef(apiDocsTranslationRef);\n\n useEffect(() => {\n setActiveTab(0);\n }, [open]);\n\n const config = useApi(apiDocsConfigRef);\n const definitionWidget = config.getApiDefinitionWidget(entity);\n\n let tabIndex = 0;\n let tabPanelIndex = 0;\n\n return (\n <Dialog\n fullWidth\n maxWidth=\"xl\"\n open={open}\n onClose={onClose}\n aria-labelledby=\"api-definition-dialog-title\"\n PaperProps={{ className: classes.fullHeightDialog }}\n >\n <DialogTitle id=\"api-definition-dialog-title\" disableTypography>\n <Typography className={classes.type}>\n API -{' '}\n {definitionWidget?.title ?? t('apiDefinitionDialog.rawButtonTitle')}\n </Typography>\n <Typography className={classes.title} variant=\"h1\">\n {entity
|
|
1
|
+
{"version":3,"file":"ApiDefinitionDialog.esm.js","sources":["../../../src/components/ApiDefinitionDialog/ApiDefinitionDialog.tsx"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ApiEntity } from '@backstage/catalog-model';\nimport { useApi } from '@backstage/core-plugin-api';\nimport { EntityDisplayName } from '@backstage/plugin-catalog-react';\nimport Box from '@material-ui/core/Box';\nimport Button from '@material-ui/core/Button';\nimport Dialog from '@material-ui/core/Dialog';\nimport DialogActions from '@material-ui/core/DialogActions';\nimport DialogContent from '@material-ui/core/DialogContent';\nimport DialogTitle from '@material-ui/core/DialogTitle';\nimport Tab from '@material-ui/core/Tab';\nimport Tabs from '@material-ui/core/Tabs';\nimport Typography from '@material-ui/core/Typography';\nimport { makeStyles } from '@material-ui/core/styles';\nimport { ReactNode, useState, useEffect } from 'react';\nimport { apiDocsConfigRef } from '../../config';\nimport { PlainApiDefinitionWidget } from '../PlainApiDefinitionWidget';\nimport { useTranslationRef } from '@backstage/frontend-plugin-api';\nimport { apiDocsTranslationRef } from '../../translation';\n\nconst useStyles = makeStyles(theme => ({\n fullHeightDialog: {\n height: 'calc(100% - 64px)',\n },\n root: {\n display: 'flex',\n flexGrow: 1,\n width: '100%',\n height: '100%',\n },\n tabs: {\n borderRight: `1px solid ${theme.palette.divider}`,\n flexShrink: 0,\n },\n tabContents: {\n flexGrow: 1,\n overflowX: 'auto',\n },\n title: {\n color: theme.palette.text.primary,\n wordBreak: 'break-word',\n fontSize: theme.typography.h3.fontSize,\n marginBottom: 0,\n },\n type: {\n textTransform: 'uppercase',\n fontSize: 11,\n opacity: 0.8,\n marginBottom: theme.spacing(1),\n color: theme.palette.text.primary,\n },\n}));\n\nfunction TabPanel(props: {\n children?: ReactNode;\n index: number;\n value: number;\n}) {\n const { children, value, index, ...other } = props;\n const classes = useStyles();\n return (\n <div\n role=\"tabpanel\"\n hidden={value !== index}\n id={`vertical-tabpanel-${index}`}\n aria-labelledby={`vertical-tab-${index}`}\n className={classes.tabContents}\n {...other}\n >\n {value === index && (\n <Box pl={3} pr={3}>\n {children}\n </Box>\n )}\n </div>\n );\n}\n\nfunction a11yProps(index: number) {\n return {\n id: `vertical-tab-${index}`,\n 'aria-controls': `vertical-tabpanel-${index}`,\n };\n}\n\n/**\n * A dialog that lets users inspect the API definition.\n *\n * @public\n */\nexport function ApiDefinitionDialog(props: {\n open: boolean;\n entity: ApiEntity;\n onClose: () => void;\n}) {\n const { open, entity, onClose } = props;\n const [activeTab, setActiveTab] = useState(0);\n const classes = useStyles();\n const { t } = useTranslationRef(apiDocsTranslationRef);\n\n useEffect(() => {\n setActiveTab(0);\n }, [open]);\n\n const config = useApi(apiDocsConfigRef);\n const definitionWidget = config.getApiDefinitionWidget(entity);\n\n let tabIndex = 0;\n let tabPanelIndex = 0;\n\n return (\n <Dialog\n fullWidth\n maxWidth=\"xl\"\n open={open}\n onClose={onClose}\n aria-labelledby=\"api-definition-dialog-title\"\n PaperProps={{ className: classes.fullHeightDialog }}\n >\n <DialogTitle id=\"api-definition-dialog-title\" disableTypography>\n <Typography className={classes.type}>\n API -{' '}\n {definitionWidget?.title ?? t('apiDefinitionDialog.rawButtonTitle')}\n </Typography>\n <Typography className={classes.title} variant=\"h1\">\n <EntityDisplayName entityRef={entity} />\n </Typography>\n </DialogTitle>\n <DialogContent dividers className={classes.root}>\n <Tabs\n orientation=\"vertical\"\n variant=\"scrollable\"\n value={activeTab}\n onChange={(_, newValue) => setActiveTab(newValue)}\n aria-label={t('apiDefinitionDialog.tabsAriaLabel')}\n className={classes.tabs}\n >\n {definitionWidget ? (\n <Tab label={definitionWidget.title} {...a11yProps(tabIndex++)} />\n ) : null}\n <Tab\n label={t('apiDefinitionDialog.rawButtonTitle')}\n {...a11yProps(tabIndex++)}\n />\n </Tabs>\n\n {definitionWidget ? (\n <TabPanel value={activeTab} index={tabPanelIndex++}>\n {definitionWidget.component(entity.spec.definition)}\n </TabPanel>\n ) : null}\n <TabPanel value={activeTab} index={tabPanelIndex++}>\n <PlainApiDefinitionWidget\n definition={entity.spec.definition}\n language={definitionWidget?.rawLanguage ?? entity.spec.type}\n />\n </TabPanel>\n </DialogContent>\n <DialogActions>\n <Button onClick={onClose} color=\"primary\">\n {t('apiDefinitionDialog.closeButtonTitle')}\n </Button>\n </DialogActions>\n </Dialog>\n );\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAmCA,MAAM,SAAA,GAAY,WAAW,CAAA,KAAA,MAAU;AAAA,EACrC,gBAAA,EAAkB;AAAA,IAChB,MAAA,EAAQ;AAAA,GACV;AAAA,EACA,IAAA,EAAM;AAAA,IACJ,OAAA,EAAS,MAAA;AAAA,IACT,QAAA,EAAU,CAAA;AAAA,IACV,KAAA,EAAO,MAAA;AAAA,IACP,MAAA,EAAQ;AAAA,GACV;AAAA,EACA,IAAA,EAAM;AAAA,IACJ,WAAA,EAAa,CAAA,UAAA,EAAa,KAAA,CAAM,OAAA,CAAQ,OAAO,CAAA,CAAA;AAAA,IAC/C,UAAA,EAAY;AAAA,GACd;AAAA,EACA,WAAA,EAAa;AAAA,IACX,QAAA,EAAU,CAAA;AAAA,IACV,SAAA,EAAW;AAAA,GACb;AAAA,EACA,KAAA,EAAO;AAAA,IACL,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK,OAAA;AAAA,IAC1B,SAAA,EAAW,YAAA;AAAA,IACX,QAAA,EAAU,KAAA,CAAM,UAAA,CAAW,EAAA,CAAG,QAAA;AAAA,IAC9B,YAAA,EAAc;AAAA,GAChB;AAAA,EACA,IAAA,EAAM;AAAA,IACJ,aAAA,EAAe,WAAA;AAAA,IACf,QAAA,EAAU,EAAA;AAAA,IACV,OAAA,EAAS,GAAA;AAAA,IACT,YAAA,EAAc,KAAA,CAAM,OAAA,CAAQ,CAAC,CAAA;AAAA,IAC7B,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA;AAE9B,CAAA,CAAE,CAAA;AAEF,SAAS,SAAS,KAAA,EAIf;AACD,EAAA,MAAM,EAAE,QAAA,EAAU,KAAA,EAAO,KAAA,EAAO,GAAG,OAAM,GAAI,KAAA;AAC7C,EAAA,MAAM,UAAU,SAAA,EAAU;AAC1B,EAAA,uBACE,GAAA;AAAA,IAAC,KAAA;AAAA,IAAA;AAAA,MACC,IAAA,EAAK,UAAA;AAAA,MACL,QAAQ,KAAA,KAAU,KAAA;AAAA,MAClB,EAAA,EAAI,qBAAqB,KAAK,CAAA,CAAA;AAAA,MAC9B,iBAAA,EAAiB,gBAAgB,KAAK,CAAA,CAAA;AAAA,MACtC,WAAW,OAAA,CAAQ,WAAA;AAAA,MAClB,GAAG,KAAA;AAAA,MAEH,QAAA,EAAA,KAAA,KAAU,yBACT,GAAA,CAAC,GAAA,EAAA,EAAI,IAAI,CAAA,EAAG,EAAA,EAAI,GACb,QAAA,EACH;AAAA;AAAA,GAEJ;AAEJ;AAEA,SAAS,UAAU,KAAA,EAAe;AAChC,EAAA,OAAO;AAAA,IACL,EAAA,EAAI,gBAAgB,KAAK,CAAA,CAAA;AAAA,IACzB,eAAA,EAAiB,qBAAqB,KAAK,CAAA;AAAA,GAC7C;AACF;AAOO,SAAS,oBAAoB,KAAA,EAIjC;AACD,EAAA,MAAM,EAAE,IAAA,EAAM,MAAA,EAAQ,OAAA,EAAQ,GAAI,KAAA;AAClC,EAAA,MAAM,CAAC,SAAA,EAAW,YAAY,CAAA,GAAI,SAAS,CAAC,CAAA;AAC5C,EAAA,MAAM,UAAU,SAAA,EAAU;AAC1B,EAAA,MAAM,EAAE,CAAA,EAAE,GAAI,iBAAA,CAAkB,qBAAqB,CAAA;AAErD,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,YAAA,CAAa,CAAC,CAAA;AAAA,EAChB,CAAA,EAAG,CAAC,IAAI,CAAC,CAAA;AAET,EAAA,MAAM,MAAA,GAAS,OAAO,gBAAgB,CAAA;AACtC,EAAA,MAAM,gBAAA,GAAmB,MAAA,CAAO,sBAAA,CAAuB,MAAM,CAAA;AAE7D,EAAA,IAAI,QAAA,GAAW,CAAA;AACf,EAAA,IAAI,aAAA,GAAgB,CAAA;AAEpB,EAAA,uBACE,IAAA;AAAA,IAAC,MAAA;AAAA,IAAA;AAAA,MACC,SAAA,EAAS,IAAA;AAAA,MACT,QAAA,EAAS,IAAA;AAAA,MACT,IAAA;AAAA,MACA,OAAA;AAAA,MACA,iBAAA,EAAgB,6BAAA;AAAA,MAChB,UAAA,EAAY,EAAE,SAAA,EAAW,OAAA,CAAQ,gBAAA,EAAiB;AAAA,MAElD,QAAA,EAAA;AAAA,wBAAA,IAAA,CAAC,WAAA,EAAA,EAAY,EAAA,EAAG,6BAAA,EAA8B,iBAAA,EAAiB,IAAA,EAC7D,QAAA,EAAA;AAAA,0BAAA,IAAA,CAAC,UAAA,EAAA,EAAW,SAAA,EAAW,OAAA,CAAQ,IAAA,EAAM,QAAA,EAAA;AAAA,YAAA,OAAA;AAAA,YAC7B,GAAA;AAAA,YACL,gBAAA,EAAkB,KAAA,IAAS,CAAA,CAAE,oCAAoC;AAAA,WAAA,EACpE,CAAA;AAAA,0BACA,GAAA,CAAC,UAAA,EAAA,EAAW,SAAA,EAAW,OAAA,CAAQ,KAAA,EAAO,OAAA,EAAQ,IAAA,EAC5C,QAAA,kBAAA,GAAA,CAAC,iBAAA,EAAA,EAAkB,SAAA,EAAW,MAAA,EAAQ,CAAA,EACxC;AAAA,SAAA,EACF,CAAA;AAAA,6BACC,aAAA,EAAA,EAAc,QAAA,EAAQ,IAAA,EAAC,SAAA,EAAW,QAAQ,IAAA,EACzC,QAAA,EAAA;AAAA,0BAAA,IAAA;AAAA,YAAC,IAAA;AAAA,YAAA;AAAA,cACC,WAAA,EAAY,UAAA;AAAA,cACZ,OAAA,EAAQ,YAAA;AAAA,cACR,KAAA,EAAO,SAAA;AAAA,cACP,QAAA,EAAU,CAAC,CAAA,EAAG,QAAA,KAAa,aAAa,QAAQ,CAAA;AAAA,cAChD,YAAA,EAAY,EAAE,mCAAmC,CAAA;AAAA,cACjD,WAAW,OAAA,CAAQ,IAAA;AAAA,cAElB,QAAA,EAAA;AAAA,gBAAA,gBAAA,mBACC,GAAA,CAAC,OAAI,KAAA,EAAO,gBAAA,CAAiB,OAAQ,GAAG,SAAA,CAAU,QAAA,EAAU,CAAA,EAAG,CAAA,GAC7D,IAAA;AAAA,gCACJ,GAAA;AAAA,kBAAC,GAAA;AAAA,kBAAA;AAAA,oBACC,KAAA,EAAO,EAAE,oCAAoC,CAAA;AAAA,oBAC5C,GAAG,UAAU,QAAA,EAAU;AAAA;AAAA;AAC1B;AAAA;AAAA,WACF;AAAA,UAEC,gBAAA,mBACC,GAAA,CAAC,QAAA,EAAA,EAAS,KAAA,EAAO,SAAA,EAAW,KAAA,EAAO,aAAA,EAAA,EAChC,QAAA,EAAA,gBAAA,CAAiB,SAAA,CAAU,MAAA,CAAO,IAAA,CAAK,UAAU,GACpD,CAAA,GACE,IAAA;AAAA,0BACJ,GAAA,CAAC,QAAA,EAAA,EAAS,KAAA,EAAO,SAAA,EAAW,OAAO,aAAA,EAAA,EACjC,QAAA,kBAAA,GAAA;AAAA,YAAC,wBAAA;AAAA,YAAA;AAAA,cACC,UAAA,EAAY,OAAO,IAAA,CAAK,UAAA;AAAA,cACxB,QAAA,EAAU,gBAAA,EAAkB,WAAA,IAAe,MAAA,CAAO,IAAA,CAAK;AAAA;AAAA,WACzD,EACF;AAAA,SAAA,EACF,CAAA;AAAA,wBACA,GAAA,CAAC,aAAA,EAAA,EACC,QAAA,kBAAA,GAAA,CAAC,MAAA,EAAA,EAAO,OAAA,EAAS,OAAA,EAAS,KAAA,EAAM,SAAA,EAC7B,QAAA,EAAA,CAAA,CAAE,sCAAsC,CAAA,EAC3C,CAAA,EACF;AAAA;AAAA;AAAA,GACF;AAEJ;;;;"}
|
package/dist/package.json.esm.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
var name = "@backstage/plugin-api-docs";
|
|
2
|
-
var version = "0.0.0-nightly-
|
|
2
|
+
var version = "0.0.0-nightly-20260416031834";
|
|
3
3
|
var description = "A Backstage plugin that helps represent API entities in the frontend";
|
|
4
4
|
var backstage = {
|
|
5
5
|
role: "frontend-plugin",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-api-docs",
|
|
3
|
-
"version": "0.0.0-nightly-
|
|
3
|
+
"version": "0.0.0-nightly-20260416031834",
|
|
4
4
|
"description": "A Backstage plugin that helps represent API entities in the frontend",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "frontend-plugin",
|
|
@@ -66,15 +66,15 @@
|
|
|
66
66
|
},
|
|
67
67
|
"dependencies": {
|
|
68
68
|
"@asyncapi/react-component": "^2.3.3",
|
|
69
|
-
"@backstage/catalog-model": "0.0.0-nightly-
|
|
70
|
-
"@backstage/core-components": "0.0.0-nightly-
|
|
71
|
-
"@backstage/core-plugin-api": "0.0.0-nightly-
|
|
72
|
-
"@backstage/frontend-plugin-api": "0.0.0-nightly-
|
|
73
|
-
"@backstage/plugin-catalog": "0.0.0-nightly-
|
|
74
|
-
"@backstage/plugin-catalog-common": "0.0.0-nightly-
|
|
75
|
-
"@backstage/plugin-catalog-react": "0.0.0-nightly-
|
|
76
|
-
"@backstage/plugin-permission-react": "0.0.0-nightly-
|
|
77
|
-
"@backstage/ui": "0.0.0-nightly-
|
|
69
|
+
"@backstage/catalog-model": "0.0.0-nightly-20260416031834",
|
|
70
|
+
"@backstage/core-components": "0.0.0-nightly-20260416031834",
|
|
71
|
+
"@backstage/core-plugin-api": "0.0.0-nightly-20260416031834",
|
|
72
|
+
"@backstage/frontend-plugin-api": "0.0.0-nightly-20260416031834",
|
|
73
|
+
"@backstage/plugin-catalog": "0.0.0-nightly-20260416031834",
|
|
74
|
+
"@backstage/plugin-catalog-common": "0.0.0-nightly-20260416031834",
|
|
75
|
+
"@backstage/plugin-catalog-react": "0.0.0-nightly-20260416031834",
|
|
76
|
+
"@backstage/plugin-permission-react": "0.0.0-nightly-20260416031834",
|
|
77
|
+
"@backstage/ui": "0.0.0-nightly-20260416031834",
|
|
78
78
|
"@graphiql/react": "0.29.0",
|
|
79
79
|
"@material-ui/core": "^4.12.2",
|
|
80
80
|
"@material-ui/icons": "^4.9.1",
|
|
@@ -86,11 +86,11 @@
|
|
|
86
86
|
"swagger-ui-react": "^5.27.1"
|
|
87
87
|
},
|
|
88
88
|
"devDependencies": {
|
|
89
|
-
"@backstage/cli": "0.0.0-nightly-
|
|
90
|
-
"@backstage/core-app-api": "0.0.0-nightly-
|
|
91
|
-
"@backstage/dev-utils": "0.0.0-nightly-
|
|
92
|
-
"@backstage/frontend-test-utils": "0.0.0-nightly-
|
|
93
|
-
"@backstage/test-utils": "0.0.0-nightly-
|
|
89
|
+
"@backstage/cli": "0.0.0-nightly-20260416031834",
|
|
90
|
+
"@backstage/core-app-api": "0.0.0-nightly-20260416031834",
|
|
91
|
+
"@backstage/dev-utils": "0.0.0-nightly-20260416031834",
|
|
92
|
+
"@backstage/frontend-test-utils": "0.0.0-nightly-20260416031834",
|
|
93
|
+
"@backstage/test-utils": "0.0.0-nightly-20260416031834",
|
|
94
94
|
"@testing-library/dom": "^10.0.0",
|
|
95
95
|
"@testing-library/jest-dom": "^6.0.0",
|
|
96
96
|
"@testing-library/react": "^16.0.0",
|