@backstage/plugin-api-docs 0.0.0-nightly-20260804031620 → 0.0.0-nightly-20260806031410

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.
Files changed (5) hide show
  1. package/CHANGELOG.md +22 -8
  2. package/dist/components/OpenApiDefinitionWidget/OpenApiDefinition.esm.js +15 -0
  3. package/dist/components/OpenApiDefinitionWidget/OpenApiDefinition.esm.js.map +1 -1
  4. package/dist/package.json.esm.js +1 -1
  5. package/package.json +13 -13
package/CHANGELOG.md CHANGED
@@ -1,20 +1,34 @@
1
1
  # @backstage/plugin-api-docs
2
2
 
3
- ## 0.0.0-nightly-20260804031620
3
+ ## 0.0.0-nightly-20260806031410
4
4
 
5
5
  ### Patch Changes
6
6
 
7
+ - b7085d1: Fixed deep linking in OpenAPI definition widget.
7
8
  - a8b5ba6: Updated dependencies.
8
9
  - Updated dependencies
9
- - @backstage/core-components@0.0.0-nightly-20260804031620
10
- - @backstage/plugin-catalog-react@0.0.0-nightly-20260804031620
11
- - @backstage/ui@0.0.0-nightly-20260804031620
12
- - @backstage/frontend-plugin-api@0.0.0-nightly-20260804031620
13
- - @backstage/plugin-catalog@0.0.0-nightly-20260804031620
14
- - @backstage/core-plugin-api@0.0.0-nightly-20260804031620
10
+ - @backstage/core-components@0.0.0-nightly-20260806031410
11
+ - @backstage/plugin-catalog@0.0.0-nightly-20260806031410
12
+ - @backstage/plugin-catalog-react@0.0.0-nightly-20260806031410
13
+ - @backstage/ui@0.0.0-nightly-20260806031410
14
+ - @backstage/frontend-plugin-api@0.0.0-nightly-20260806031410
15
+ - @backstage/core-plugin-api@0.0.0-nightly-20260806031410
15
16
  - @backstage/catalog-model@1.9.0
16
17
  - @backstage/plugin-catalog-common@1.1.10
17
- - @backstage/plugin-permission-react@0.0.0-nightly-20260804031620
18
+ - @backstage/plugin-permission-react@0.0.0-nightly-20260806031410
19
+
20
+ ## 0.14.4-next.1
21
+
22
+ ### Patch Changes
23
+
24
+ - a8b5ba6: Updated dependencies.
25
+ - Updated dependencies
26
+ - @backstage/plugin-catalog@2.0.8-next.2
27
+ - @backstage/plugin-catalog-react@3.2.1-next.2
28
+ - @backstage/frontend-plugin-api@0.18.0-next.0
29
+ - @backstage/core-plugin-api@1.12.9-next.0
30
+ - @backstage/core-components@0.18.13-next.2
31
+ - @backstage/plugin-permission-react@0.5.4-next.0
18
32
 
19
33
  ## 0.14.4-next.0
20
34
 
package/dist/components/OpenApiDefinitionWidget/OpenApiDefinition.esm.js CHANGED
@@ -169,6 +169,20 @@ const useStyles = makeStyles((theme) => ({
169
169
  }
170
170
  }
171
171
  }));
172
+ const scrollToDeepLink = () => {
173
+ const hash = window.location.hash;
174
+ if (!hash || !hash.startsWith("#/")) return;
175
+ let fragment;
176
+ try {
177
+ fragment = decodeURIComponent(hash.substring(2));
178
+ } catch {
179
+ return;
180
+ }
181
+ const [tag, operationId] = fragment.split("/");
182
+ if (!tag) return;
183
+ const elementId = operationId ? `operations-${tag}-${operationId}` : `operations-tag-${tag}`;
184
+ document.getElementById(elementId)?.scrollIntoView({ behavior: "auto", block: "start" });
185
+ };
172
186
  const OpenApiDefinition = ({
173
187
  definition,
174
188
  ...swaggerUiProps
@@ -186,6 +200,7 @@ const OpenApiDefinition = ({
186
200
  url: "",
187
201
  deepLinking: true,
188
202
  oauth2RedirectUrl: `${window.location.protocol}//${window.location.host}/oauth2-redirect.html`,
203
+ onComplete: scrollToDeepLink,
189
204
  ...swaggerUiProps
190
205
  }
191
206
  ) });
package/dist/components/OpenApiDefinitionWidget/OpenApiDefinition.esm.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"OpenApiDefinition.esm.js","sources":["../../../src/components/OpenApiDefinitionWidget/OpenApiDefinition.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 { makeStyles } from '@material-ui/core/styles';\nimport { useEffect, useState } from 'react';\nimport SwaggerUI from 'swagger-ui-react';\nimport 'swagger-ui-react/swagger-ui.css';\n\nconst useStyles = makeStyles(theme => ({\n root: {\n '& .swagger-ui': {\n fontFamily: theme.typography.fontFamily,\n color: theme.palette.text.primary,\n\n ['& .btn-clear']: {\n color: theme.palette.text.primary,\n },\n [`& .scheme-container`]: {\n backgroundColor: theme.palette.background.default,\n },\n [`& .opblock-tag,\n .opblock-tag small,\n table thead tr td,\n table thead tr th,\n table tbody tr td,\n table tbody tr th`]: {\n fontFamily: theme.typography.fontFamily,\n color: theme.palette.text.primary,\n borderColor: theme.palette.divider,\n },\n [`& section.models,\n section.models.is-open h4`]: {\n borderColor: theme.palette.divider,\n },\n [`& .model-title,\n .model .renderedMarkdown,\n .model .description`]: {\n fontFamily: theme.typography.fontFamily,\n fontWeight: theme.typography.fontWeightRegular,\n },\n [`& h1, h2, h3, h4, h5, h6,\n .errors h4, .error h4, .opblock h4, section.models h4,\n .response-control-media-type__accept-message,\n .opblock-summary-description,\n .opblock-summary-operation-id,\n .opblock-summary-path,\n .opblock-summary-path__deprecated,\n .opblock-description-wrapper,\n .opblock-external-docs-wrapper,\n .opblock-section-header .btn,\n .opblock-section-header>label,\n .scheme-container .schemes>label,a.nostyle,\n .parameter__name,\n .response-col_status,\n .response-col_links,\n .error .btn,\n .info .title,\n .info .base-url`]: {\n fontFamily: theme.typography.fontFamily,\n color: theme.palette.text.primary,\n },\n [`& .opblock .opblock-section-header,\n .model-box,\n section.models .model-container`]: {\n background: theme.palette.background.default,\n },\n [`& .prop-format,\n .parameter__in`]: {\n color: theme.palette.text.disabled,\n },\n [`& table.model,\n .parameter__type,\n .model.model-title,\n .model-title,\n .model span,\n .model .brace-open,\n .model .brace-close,\n .model .property.primitive,\n .model .renderedMarkdown,\n .model .description,\n .errors small`]: {\n color: theme.palette.text.secondary,\n },\n [`& .parameter__name.required:after,\n .parameter__name.required span`]: {\n color: theme.palette.warning.dark,\n },\n [`& table.model,\n table.model .model,\n .opblock-external-docs-wrapper`]: {\n fontSize: theme.typography.fontSize,\n },\n [`& table.headers td`]: {\n color: theme.palette.text.primary,\n fontWeight: theme.typography.fontWeightRegular,\n },\n [`& .model-hint`]: {\n color: theme.palette.text.secondary,\n backgroundColor: theme.palette.background.paper,\n },\n [`& .opblock-summary-method,\n .info a`]: {\n fontFamily: theme.typography.fontFamily,\n },\n [`& .info, .opblock, .tab`]: {\n [`& li, p`]: {\n fontFamily: theme.typography.fontFamily,\n color: theme.palette.text.primary,\n },\n },\n [`& a`]: {\n color: theme.palette.primary.main,\n },\n [`& .renderedMarkdown code`]: {\n color: theme.palette.secondary.light,\n },\n [`& .property-row td:first-child`]: {\n color: theme.palette.text.primary,\n },\n [`& span.prop-type`]: {\n color: theme.palette.success.light,\n },\n [`& .opblock-control-arrow svg, .authorization__btn .unlocked`]: {\n fill: theme.palette.text.primary,\n },\n [`& .json-schema-2020-12__title,\n .json-schema-2020-12-keyword__name,\n .json-schema-2020-12-property .json-schema-2020-12__title,\n .json-schema-2020-12-keyword--description`]: {\n color: theme.palette.text.primary,\n },\n [`.json-schema-2020-12-accordion__icon svg`]: {\n fill: theme.palette.text.primary,\n },\n [`& .json-schema-2020-12-accordion,\n .json-schema-2020-12-expand-deep-button`]: {\n background: 'none',\n appearance: 'none',\n },\n [`& .json-schema-2020-12-expand-deep-button,\n .json-schema-2020-12-keyword__name--secondary,\n .json-schema-2020-12-keyword__value--secondary,\n .json-schema-2020-12__attribute--muted,\n .json-schema-2020-12-keyword__value--const,\n .json-schema-2020-12-keyword__value--warning`]: {\n color: theme.palette.text.secondary,\n },\n [`& .json-schema-2020-12-body,\n .json-schema-2020-12-keyword__value--const,\n .json-schema-2020-12-keyword__value--warning`]: {\n borderColor: theme.palette.text.secondary,\n },\n [`.json-schema-2020-12__constraint--string`]: {\n backgroundColor: theme.palette.primary.main,\n },\n [`& .json-schema-2020-12__attribute--primary`]: {\n color: theme.palette.primary.main,\n },\n [`& .json-schema-2020-12-property--required>.json-schema-2020-12:first-of-type>.json-schema-2020-12-head .json-schema-2020-12__title:after`]:\n {\n color: theme.palette.warning.dark,\n },\n [`& input[type=text],\n & input[type=password],\n & input[type=email],\n & input[type=number],\n & textarea,\n & select`]: {\n backgroundColor: theme.palette.background.paper,\n color: theme.palette.text.primary,\n borderColor: theme.palette.divider,\n },\n },\n },\n}));\n\nexport type OpenApiDefinitionProps = {\n definition: string;\n} & Omit<React.ComponentProps<typeof SwaggerUI>, 'spec'>;\n\nexport const OpenApiDefinition = ({\n definition,\n ...swaggerUiProps\n}: OpenApiDefinitionProps) => {\n const classes = useStyles();\n\n // Due to a bug in the swagger-ui-react component, the component needs\n // to be created without content first.\n const [def, setDef] = useState('');\n\n useEffect(() => {\n const timer = setTimeout(() => setDef(definition), 0);\n return () => clearTimeout(timer);\n }, [definition, setDef]);\n\n return (\n <div className={classes.root}>\n <SwaggerUI\n spec={def}\n url=\"\"\n deepLinking\n oauth2RedirectUrl={`${window.location.protocol}//${window.location.host}/oauth2-redirect.html`}\n {...swaggerUiProps}\n />\n </div>\n );\n};\n"],"names":[],"mappings":";;;;;;AAqBA,MAAM,SAAA,GAAY,WAAW,CAAA,KAAA,MAAU;AAAA,EACrC,IAAA,EAAM;AAAA,IACJ,eAAA,EAAiB;AAAA,MACf,UAAA,EAAY,MAAM,UAAA,CAAW,UAAA;AAAA,MAC7B,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK,OAAA;AAAA,MAE1B,CAAC,cAAc,GAAG;AAAA,QAChB,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA,OAC5B;AAAA,MACA,CAAC,qBAAqB,GAAG;AAAA,QACvB,eAAA,EAAiB,KAAA,CAAM,OAAA,CAAQ,UAAA,CAAW;AAAA,OAC5C;AAAA,MACA,CAAC,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,2BAAA,CAKqB,GAAG;AAAA,QACvB,UAAA,EAAY,MAAM,UAAA,CAAW,UAAA;AAAA,QAC7B,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK,OAAA;AAAA,QAC1B,WAAA,EAAa,MAAM,OAAA,CAAQ;AAAA,OAC7B;AAAA,MACA,CAAC,CAAA;AAAA,mCAAA,CAC6B,GAAG;AAAA,QAC/B,WAAA,EAAa,MAAM,OAAA,CAAQ;AAAA,OAC7B;AAAA,MACA,CAAC,CAAA;AAAA;AAAA,6BAAA,CAEuB,GAAG;AAAA,QACzB,UAAA,EAAY,MAAM,UAAA,CAAW,UAAA;AAAA,QAC7B,UAAA,EAAY,MAAM,UAAA,CAAW;AAAA,OAC/B;AAAA,MACA,CAAC,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAAA,CAiBmB,GAAG;AAAA,QACrB,UAAA,EAAY,MAAM,UAAA,CAAW,UAAA;AAAA,QAC7B,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA,OAC5B;AAAA,MACA,CAAC,CAAA;AAAA;AAAA,yCAAA,CAEmC,GAAG;AAAA,QACrC,UAAA,EAAY,KAAA,CAAM,OAAA,CAAQ,UAAA,CAAW;AAAA,OACvC;AAAA,MACA,CAAC,CAAA;AAAA,wBAAA,CACkB,GAAG;AAAA,QACpB,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA,OAC5B;AAAA,MACA,CAAC,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAA,CAUiB,GAAG;AAAA,QACnB,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA,OAC5B;AAAA,MACA,CAAC,CAAA;AAAA,sCAAA,CACgC,GAAG;AAAA,QAClC,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,OAAA,CAAQ;AAAA,OAC/B;AAAA,MACA,CAAC,CAAA;AAAA;AAAA,wCAAA,CAEkC,GAAG;AAAA,QACpC,QAAA,EAAU,MAAM,UAAA,CAAW;AAAA,OAC7B;AAAA,MACA,CAAC,oBAAoB,GAAG;AAAA,QACtB,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK,OAAA;AAAA,QAC1B,UAAA,EAAY,MAAM,UAAA,CAAW;AAAA,OAC/B;AAAA,MACA,CAAC,eAAe,GAAG;AAAA,QACjB,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK,SAAA;AAAA,QAC1B,eAAA,EAAiB,KAAA,CAAM,OAAA,CAAQ,UAAA,CAAW;AAAA,OAC5C;AAAA,MACA,CAAC,CAAA;AAAA,iBAAA,CACW,GAAG;AAAA,QACb,UAAA,EAAY,MAAM,UAAA,CAAW;AAAA,OAC/B;AAAA,MACA,CAAC,yBAAyB,GAAG;AAAA,QAC3B,CAAC,SAAS,GAAG;AAAA,UACX,UAAA,EAAY,MAAM,UAAA,CAAW,UAAA;AAAA,UAC7B,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA;AAC5B,OACF;AAAA,MACA,CAAC,KAAK,GAAG;AAAA,QACP,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,OAAA,CAAQ;AAAA,OAC/B;AAAA,MACA,CAAC,0BAA0B,GAAG;AAAA,QAC5B,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,SAAA,CAAU;AAAA,OACjC;AAAA,MACA,CAAC,gCAAgC,GAAG;AAAA,QAClC,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA,OAC5B;AAAA,MACA,CAAC,kBAAkB,GAAG;AAAA,QACpB,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,OAAA,CAAQ;AAAA,OAC/B;AAAA,MACA,CAAC,6DAA6D,GAAG;AAAA,QAC/D,IAAA,EAAM,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA,OAC3B;AAAA,MACA,CAAC,CAAA;AAAA;AAAA;AAAA,mDAAA,CAG6C,GAAG;AAAA,QAC/C,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA,OAC5B;AAAA,MACA,CAAC,0CAA0C,GAAG;AAAA,QAC5C,IAAA,EAAM,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA,OAC3B;AAAA,MACA,CAAC,CAAA;AAAA,iDAAA,CAC2C,GAAG;AAAA,QAC7C,UAAA,EAAY,MAAA;AAAA,QACZ,UAAA,EAAY;AAAA,OACd;AAAA,MACA,CAAC,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,sDAAA,CAKgD,GAAG;AAAA,QAClD,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA,OAC5B;AAAA,MACA,CAAC,CAAA;AAAA;AAAA,sDAAA,CAEgD,GAAG;AAAA,QAClD,WAAA,EAAa,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA,OAClC;AAAA,MACA,CAAC,0CAA0C,GAAG;AAAA,QAC5C,eAAA,EAAiB,KAAA,CAAM,OAAA,CAAQ,OAAA,CAAQ;AAAA,OACzC;AAAA,MACA,CAAC,4CAA4C,GAAG;AAAA,QAC9C,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,OAAA,CAAQ;AAAA,OAC/B;AAAA,MACA,CAAC,0IAA0I,GACzI;AAAA,QACE,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,OAAA,CAAQ;AAAA,OAC/B;AAAA,MACF,CAAC,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAA,CAKY,GAAG;AAAA,QACd,eAAA,EAAiB,KAAA,CAAM,OAAA,CAAQ,UAAA,CAAW,KAAA;AAAA,QAC1C,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK,OAAA;AAAA,QAC1B,WAAA,EAAa,MAAM,OAAA,CAAQ;AAAA;AAC7B;AACF;AAEJ,CAAA,CAAE,CAAA;AAMK,MAAM,oBAAoB,CAAC;AAAA,EAChC,UAAA;AAAA,EACA,GAAG;AACL,CAAA,KAA8B;AAC5B,EAAA,MAAM,UAAU,SAAA,EAAU;AAI1B,EAAA,MAAM,CAAC,GAAA,EAAK,MAAM,CAAA,GAAI,SAAS,EAAE,CAAA;AAEjC,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,MAAM,QAAQ,UAAA,CAAW,MAAM,MAAA,CAAO,UAAU,GAAG,CAAC,CAAA;AACpD,IAAA,OAAO,MAAM,aAAa,KAAK,CAAA;AAAA,EACjC,CAAA,EAAG,CAAC,UAAA,EAAY,MAAM,CAAC,CAAA;AAEvB,EAAA,uBACE,GAAA,CAAC,KAAA,EAAA,EAAI,SAAA,EAAW,OAAA,CAAQ,IAAA,EACtB,QAAA,kBAAA,GAAA;AAAA,IAAC,SAAA;AAAA,IAAA;AAAA,MACC,IAAA,EAAM,GAAA;AAAA,MACN,GAAA,EAAI,EAAA;AAAA,MACJ,WAAA,EAAW,IAAA;AAAA,MACX,iBAAA,EAAmB,GAAG,MAAA,CAAO,QAAA,CAAS,QAAQ,CAAA,EAAA,EAAK,MAAA,CAAO,SAAS,IAAI,CAAA,qBAAA,CAAA;AAAA,MACtE,GAAG;AAAA;AAAA,GACN,EACF,CAAA;AAEJ;;;;"}
1
+ {"version":3,"file":"OpenApiDefinition.esm.js","sources":["../../../src/components/OpenApiDefinitionWidget/OpenApiDefinition.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 { makeStyles } from '@material-ui/core/styles';\nimport { useEffect, useState } from 'react';\nimport SwaggerUI from 'swagger-ui-react';\nimport 'swagger-ui-react/swagger-ui.css';\n\nconst useStyles = makeStyles(theme => ({\n root: {\n '& .swagger-ui': {\n fontFamily: theme.typography.fontFamily,\n color: theme.palette.text.primary,\n\n ['& .btn-clear']: {\n color: theme.palette.text.primary,\n },\n [`& .scheme-container`]: {\n backgroundColor: theme.palette.background.default,\n },\n [`& .opblock-tag,\n .opblock-tag small,\n table thead tr td,\n table thead tr th,\n table tbody tr td,\n table tbody tr th`]: {\n fontFamily: theme.typography.fontFamily,\n color: theme.palette.text.primary,\n borderColor: theme.palette.divider,\n },\n [`& section.models,\n section.models.is-open h4`]: {\n borderColor: theme.palette.divider,\n },\n [`& .model-title,\n .model .renderedMarkdown,\n .model .description`]: {\n fontFamily: theme.typography.fontFamily,\n fontWeight: theme.typography.fontWeightRegular,\n },\n [`& h1, h2, h3, h4, h5, h6,\n .errors h4, .error h4, .opblock h4, section.models h4,\n .response-control-media-type__accept-message,\n .opblock-summary-description,\n .opblock-summary-operation-id,\n .opblock-summary-path,\n .opblock-summary-path__deprecated,\n .opblock-description-wrapper,\n .opblock-external-docs-wrapper,\n .opblock-section-header .btn,\n .opblock-section-header>label,\n .scheme-container .schemes>label,a.nostyle,\n .parameter__name,\n .response-col_status,\n .response-col_links,\n .error .btn,\n .info .title,\n .info .base-url`]: {\n fontFamily: theme.typography.fontFamily,\n color: theme.palette.text.primary,\n },\n [`& .opblock .opblock-section-header,\n .model-box,\n section.models .model-container`]: {\n background: theme.palette.background.default,\n },\n [`& .prop-format,\n .parameter__in`]: {\n color: theme.palette.text.disabled,\n },\n [`& table.model,\n .parameter__type,\n .model.model-title,\n .model-title,\n .model span,\n .model .brace-open,\n .model .brace-close,\n .model .property.primitive,\n .model .renderedMarkdown,\n .model .description,\n .errors small`]: {\n color: theme.palette.text.secondary,\n },\n [`& .parameter__name.required:after,\n .parameter__name.required span`]: {\n color: theme.palette.warning.dark,\n },\n [`& table.model,\n table.model .model,\n .opblock-external-docs-wrapper`]: {\n fontSize: theme.typography.fontSize,\n },\n [`& table.headers td`]: {\n color: theme.palette.text.primary,\n fontWeight: theme.typography.fontWeightRegular,\n },\n [`& .model-hint`]: {\n color: theme.palette.text.secondary,\n backgroundColor: theme.palette.background.paper,\n },\n [`& .opblock-summary-method,\n .info a`]: {\n fontFamily: theme.typography.fontFamily,\n },\n [`& .info, .opblock, .tab`]: {\n [`& li, p`]: {\n fontFamily: theme.typography.fontFamily,\n color: theme.palette.text.primary,\n },\n },\n [`& a`]: {\n color: theme.palette.primary.main,\n },\n [`& .renderedMarkdown code`]: {\n color: theme.palette.secondary.light,\n },\n [`& .property-row td:first-child`]: {\n color: theme.palette.text.primary,\n },\n [`& span.prop-type`]: {\n color: theme.palette.success.light,\n },\n [`& .opblock-control-arrow svg, .authorization__btn .unlocked`]: {\n fill: theme.palette.text.primary,\n },\n [`& .json-schema-2020-12__title,\n .json-schema-2020-12-keyword__name,\n .json-schema-2020-12-property .json-schema-2020-12__title,\n .json-schema-2020-12-keyword--description`]: {\n color: theme.palette.text.primary,\n },\n [`.json-schema-2020-12-accordion__icon svg`]: {\n fill: theme.palette.text.primary,\n },\n [`& .json-schema-2020-12-accordion,\n .json-schema-2020-12-expand-deep-button`]: {\n background: 'none',\n appearance: 'none',\n },\n [`& .json-schema-2020-12-expand-deep-button,\n .json-schema-2020-12-keyword__name--secondary,\n .json-schema-2020-12-keyword__value--secondary,\n .json-schema-2020-12__attribute--muted,\n .json-schema-2020-12-keyword__value--const,\n .json-schema-2020-12-keyword__value--warning`]: {\n color: theme.palette.text.secondary,\n },\n [`& .json-schema-2020-12-body,\n .json-schema-2020-12-keyword__value--const,\n .json-schema-2020-12-keyword__value--warning`]: {\n borderColor: theme.palette.text.secondary,\n },\n [`.json-schema-2020-12__constraint--string`]: {\n backgroundColor: theme.palette.primary.main,\n },\n [`& .json-schema-2020-12__attribute--primary`]: {\n color: theme.palette.primary.main,\n },\n [`& .json-schema-2020-12-property--required>.json-schema-2020-12:first-of-type>.json-schema-2020-12-head .json-schema-2020-12__title:after`]:\n {\n color: theme.palette.warning.dark,\n },\n [`& input[type=text],\n & input[type=password],\n & input[type=email],\n & input[type=number],\n & textarea,\n & select`]: {\n backgroundColor: theme.palette.background.paper,\n color: theme.palette.text.primary,\n borderColor: theme.palette.divider,\n },\n },\n },\n}));\n\nconst scrollToDeepLink = () => {\n const hash = window.location.hash;\n if (!hash || !hash.startsWith('#/')) return;\n\n let fragment;\n try {\n fragment = decodeURIComponent(hash.substring(2)); // strip leading \"#/\"\n } catch {\n return;\n }\n const [tag, operationId] = fragment.split('/');\n if (!tag) return;\n const elementId = operationId\n ? `operations-${tag}-${operationId}`\n : `operations-tag-${tag}`;\n document\n .getElementById(elementId)\n ?.scrollIntoView({ behavior: 'auto', block: 'start' });\n};\n\nexport type OpenApiDefinitionProps = {\n definition: string;\n} & Omit<React.ComponentProps<typeof SwaggerUI>, 'spec'>;\n\nexport const OpenApiDefinition = ({\n definition,\n ...swaggerUiProps\n}: OpenApiDefinitionProps) => {\n const classes = useStyles();\n\n // Due to a bug in the swagger-ui-react component, the component needs\n // to be created without content first.\n const [def, setDef] = useState('');\n\n useEffect(() => {\n const timer = setTimeout(() => setDef(definition), 0);\n return () => clearTimeout(timer);\n }, [definition, setDef]);\n\n return (\n <div className={classes.root}>\n <SwaggerUI\n spec={def}\n url=\"\"\n deepLinking\n oauth2RedirectUrl={`${window.location.protocol}//${window.location.host}/oauth2-redirect.html`}\n onComplete={scrollToDeepLink}\n {...swaggerUiProps}\n />\n </div>\n );\n};\n"],"names":[],"mappings":";;;;;;AAqBA,MAAM,SAAA,GAAY,WAAW,CAAA,KAAA,MAAU;AAAA,EACrC,IAAA,EAAM;AAAA,IACJ,eAAA,EAAiB;AAAA,MACf,UAAA,EAAY,MAAM,UAAA,CAAW,UAAA;AAAA,MAC7B,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK,OAAA;AAAA,MAE1B,CAAC,cAAc,GAAG;AAAA,QAChB,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA,OAC5B;AAAA,MACA,CAAC,qBAAqB,GAAG;AAAA,QACvB,eAAA,EAAiB,KAAA,CAAM,OAAA,CAAQ,UAAA,CAAW;AAAA,OAC5C;AAAA,MACA,CAAC,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,2BAAA,CAKqB,GAAG;AAAA,QACvB,UAAA,EAAY,MAAM,UAAA,CAAW,UAAA;AAAA,QAC7B,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK,OAAA;AAAA,QAC1B,WAAA,EAAa,MAAM,OAAA,CAAQ;AAAA,OAC7B;AAAA,MACA,CAAC,CAAA;AAAA,mCAAA,CAC6B,GAAG;AAAA,QAC/B,WAAA,EAAa,MAAM,OAAA,CAAQ;AAAA,OAC7B;AAAA,MACA,CAAC,CAAA;AAAA;AAAA,6BAAA,CAEuB,GAAG;AAAA,QACzB,UAAA,EAAY,MAAM,UAAA,CAAW,UAAA;AAAA,QAC7B,UAAA,EAAY,MAAM,UAAA,CAAW;AAAA,OAC/B;AAAA,MACA,CAAC,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAAA,CAiBmB,GAAG;AAAA,QACrB,UAAA,EAAY,MAAM,UAAA,CAAW,UAAA;AAAA,QAC7B,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA,OAC5B;AAAA,MACA,CAAC,CAAA;AAAA;AAAA,yCAAA,CAEmC,GAAG;AAAA,QACrC,UAAA,EAAY,KAAA,CAAM,OAAA,CAAQ,UAAA,CAAW;AAAA,OACvC;AAAA,MACA,CAAC,CAAA;AAAA,wBAAA,CACkB,GAAG;AAAA,QACpB,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA,OAC5B;AAAA,MACA,CAAC,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAA,CAUiB,GAAG;AAAA,QACnB,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA,OAC5B;AAAA,MACA,CAAC,CAAA;AAAA,sCAAA,CACgC,GAAG;AAAA,QAClC,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,OAAA,CAAQ;AAAA,OAC/B;AAAA,MACA,CAAC,CAAA;AAAA;AAAA,wCAAA,CAEkC,GAAG;AAAA,QACpC,QAAA,EAAU,MAAM,UAAA,CAAW;AAAA,OAC7B;AAAA,MACA,CAAC,oBAAoB,GAAG;AAAA,QACtB,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK,OAAA;AAAA,QAC1B,UAAA,EAAY,MAAM,UAAA,CAAW;AAAA,OAC/B;AAAA,MACA,CAAC,eAAe,GAAG;AAAA,QACjB,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK,SAAA;AAAA,QAC1B,eAAA,EAAiB,KAAA,CAAM,OAAA,CAAQ,UAAA,CAAW;AAAA,OAC5C;AAAA,MACA,CAAC,CAAA;AAAA,iBAAA,CACW,GAAG;AAAA,QACb,UAAA,EAAY,MAAM,UAAA,CAAW;AAAA,OAC/B;AAAA,MACA,CAAC,yBAAyB,GAAG;AAAA,QAC3B,CAAC,SAAS,GAAG;AAAA,UACX,UAAA,EAAY,MAAM,UAAA,CAAW,UAAA;AAAA,UAC7B,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA;AAC5B,OACF;AAAA,MACA,CAAC,KAAK,GAAG;AAAA,QACP,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,OAAA,CAAQ;AAAA,OAC/B;AAAA,MACA,CAAC,0BAA0B,GAAG;AAAA,QAC5B,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,SAAA,CAAU;AAAA,OACjC;AAAA,MACA,CAAC,gCAAgC,GAAG;AAAA,QAClC,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA,OAC5B;AAAA,MACA,CAAC,kBAAkB,GAAG;AAAA,QACpB,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,OAAA,CAAQ;AAAA,OAC/B;AAAA,MACA,CAAC,6DAA6D,GAAG;AAAA,QAC/D,IAAA,EAAM,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA,OAC3B;AAAA,MACA,CAAC,CAAA;AAAA;AAAA;AAAA,mDAAA,CAG6C,GAAG;AAAA,QAC/C,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA,OAC5B;AAAA,MACA,CAAC,0CAA0C,GAAG;AAAA,QAC5C,IAAA,EAAM,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA,OAC3B;AAAA,MACA,CAAC,CAAA;AAAA,iDAAA,CAC2C,GAAG;AAAA,QAC7C,UAAA,EAAY,MAAA;AAAA,QACZ,UAAA,EAAY;AAAA,OACd;AAAA,MACA,CAAC,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,sDAAA,CAKgD,GAAG;AAAA,QAClD,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA,OAC5B;AAAA,MACA,CAAC,CAAA;AAAA;AAAA,sDAAA,CAEgD,GAAG;AAAA,QAClD,WAAA,EAAa,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK;AAAA,OAClC;AAAA,MACA,CAAC,0CAA0C,GAAG;AAAA,QAC5C,eAAA,EAAiB,KAAA,CAAM,OAAA,CAAQ,OAAA,CAAQ;AAAA,OACzC;AAAA,MACA,CAAC,4CAA4C,GAAG;AAAA,QAC9C,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,OAAA,CAAQ;AAAA,OAC/B;AAAA,MACA,CAAC,0IAA0I,GACzI;AAAA,QACE,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,OAAA,CAAQ;AAAA,OAC/B;AAAA,MACF,CAAC,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAA,CAKY,GAAG;AAAA,QACd,eAAA,EAAiB,KAAA,CAAM,OAAA,CAAQ,UAAA,CAAW,KAAA;AAAA,QAC1C,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK,OAAA;AAAA,QAC1B,WAAA,EAAa,MAAM,OAAA,CAAQ;AAAA;AAC7B;AACF;AAEJ,CAAA,CAAE,CAAA;AAEF,MAAM,mBAAmB,MAAM;AAC7B,EAAA,MAAM,IAAA,GAAO,OAAO,QAAA,CAAS,IAAA;AAC7B,EAAA,IAAI,CAAC,IAAA,IAAQ,CAAC,IAAA,CAAK,UAAA,CAAW,IAAI,CAAA,EAAG;AAErC,EAAA,IAAI,QAAA;AACJ,EAAA,IAAI;AACF,IAAA,QAAA,GAAW,kBAAA,CAAmB,IAAA,CAAK,SAAA,CAAU,CAAC,CAAC,CAAA;AAAA,EACjD,CAAA,CAAA,MAAQ;AACN,IAAA;AAAA,EACF;AACA,EAAA,MAAM,CAAC,GAAA,EAAK,WAAW,CAAA,GAAI,QAAA,CAAS,MAAM,GAAG,CAAA;AAC7C,EAAA,IAAI,CAAC,GAAA,EAAK;AACV,EAAA,MAAM,SAAA,GAAY,cACd,CAAA,WAAA,EAAc,GAAG,IAAI,WAAW,CAAA,CAAA,GAChC,kBAAkB,GAAG,CAAA,CAAA;AACzB,EAAA,QAAA,CACG,cAAA,CAAe,SAAS,CAAA,EACvB,cAAA,CAAe,EAAE,QAAA,EAAU,MAAA,EAAQ,KAAA,EAAO,OAAA,EAAS,CAAA;AACzD,CAAA;AAMO,MAAM,oBAAoB,CAAC;AAAA,EAChC,UAAA;AAAA,EACA,GAAG;AACL,CAAA,KAA8B;AAC5B,EAAA,MAAM,UAAU,SAAA,EAAU;AAI1B,EAAA,MAAM,CAAC,GAAA,EAAK,MAAM,CAAA,GAAI,SAAS,EAAE,CAAA;AAEjC,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,MAAM,QAAQ,UAAA,CAAW,MAAM,MAAA,CAAO,UAAU,GAAG,CAAC,CAAA;AACpD,IAAA,OAAO,MAAM,aAAa,KAAK,CAAA;AAAA,EACjC,CAAA,EAAG,CAAC,UAAA,EAAY,MAAM,CAAC,CAAA;AAEvB,EAAA,uBACE,GAAA,CAAC,KAAA,EAAA,EAAI,SAAA,EAAW,OAAA,CAAQ,IAAA,EACtB,QAAA,kBAAA,GAAA;AAAA,IAAC,SAAA;AAAA,IAAA;AAAA,MACC,IAAA,EAAM,GAAA;AAAA,MACN,GAAA,EAAI,EAAA;AAAA,MACJ,WAAA,EAAW,IAAA;AAAA,MACX,iBAAA,EAAmB,GAAG,MAAA,CAAO,QAAA,CAAS,QAAQ,CAAA,EAAA,EAAK,MAAA,CAAO,SAAS,IAAI,CAAA,qBAAA,CAAA;AAAA,MACvE,UAAA,EAAY,gBAAA;AAAA,MACX,GAAG;AAAA;AAAA,GACN,EACF,CAAA;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-20260804031620";
2
+ var version = "0.0.0-nightly-20260806031410";
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-20260804031620",
3
+ "version": "0.0.0-nightly-20260806031410",
4
4
  "description": "A Backstage plugin that helps represent API entities in the frontend",
5
5
  "backstage": {
6
6
  "role": "frontend-plugin",
@@ -67,14 +67,14 @@
67
67
  "dependencies": {
68
68
  "@asyncapi/react-component": "^2.3.3",
69
69
  "@backstage/catalog-model": "1.9.0",
70
- "@backstage/core-components": "0.0.0-nightly-20260804031620",
71
- "@backstage/core-plugin-api": "0.0.0-nightly-20260804031620",
72
- "@backstage/frontend-plugin-api": "0.0.0-nightly-20260804031620",
73
- "@backstage/plugin-catalog": "0.0.0-nightly-20260804031620",
70
+ "@backstage/core-components": "0.0.0-nightly-20260806031410",
71
+ "@backstage/core-plugin-api": "0.0.0-nightly-20260806031410",
72
+ "@backstage/frontend-plugin-api": "0.0.0-nightly-20260806031410",
73
+ "@backstage/plugin-catalog": "0.0.0-nightly-20260806031410",
74
74
  "@backstage/plugin-catalog-common": "1.1.10",
75
- "@backstage/plugin-catalog-react": "0.0.0-nightly-20260804031620",
76
- "@backstage/plugin-permission-react": "0.0.0-nightly-20260804031620",
77
- "@backstage/ui": "0.0.0-nightly-20260804031620",
75
+ "@backstage/plugin-catalog-react": "0.0.0-nightly-20260806031410",
76
+ "@backstage/plugin-permission-react": "0.0.0-nightly-20260806031410",
77
+ "@backstage/ui": "0.0.0-nightly-20260806031410",
78
78
  "@graphiql/react": "0.29.0",
79
79
  "@material-ui/core": "^4.12.2",
80
80
  "@material-ui/icons": "^4.9.1",
@@ -87,11 +87,11 @@
87
87
  "zod": "^4.0.0"
88
88
  },
89
89
  "devDependencies": {
90
- "@backstage/cli": "0.0.0-nightly-20260804031620",
91
- "@backstage/core-app-api": "0.0.0-nightly-20260804031620",
92
- "@backstage/dev-utils": "0.0.0-nightly-20260804031620",
93
- "@backstage/frontend-test-utils": "0.0.0-nightly-20260804031620",
94
- "@backstage/test-utils": "0.0.0-nightly-20260804031620",
90
+ "@backstage/cli": "0.0.0-nightly-20260806031410",
91
+ "@backstage/core-app-api": "0.0.0-nightly-20260806031410",
92
+ "@backstage/dev-utils": "0.0.0-nightly-20260806031410",
93
+ "@backstage/frontend-test-utils": "0.0.0-nightly-20260806031410",
94
+ "@backstage/test-utils": "0.0.0-nightly-20260806031410",
95
95
  "@testing-library/dom": "^10.0.0",
96
96
  "@testing-library/jest-dom": "^6.0.0",
97
97
  "@testing-library/react": "^16.0.0",