@backstage/plugin-api-docs 0.13.5-next.1 → 0.13.5
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 +38 -0
- package/README.md +86 -65
- package/dist/alpha.d.ts +36 -36
- package/dist/alpha.esm.js +13 -10
- package/dist/alpha.esm.js.map +1 -1
- package/dist/components/ApiExplorerPage/DefaultApiExplorerPage.esm.js +86 -30
- package/dist/components/ApiExplorerPage/DefaultApiExplorerPage.esm.js.map +1 -1
- package/dist/components/ApisCards/ConsumedApisCard.esm.js +31 -2
- package/dist/components/ApisCards/ConsumedApisCard.esm.js.map +1 -1
- package/dist/components/ApisCards/HasApisCard.esm.js +33 -3
- package/dist/components/ApisCards/HasApisCard.esm.js.map +1 -1
- package/dist/components/ApisCards/ProvidedApisCard.esm.js +31 -2
- package/dist/components/ApisCards/ProvidedApisCard.esm.js.map +1 -1
- package/dist/components/ApisCards/presets.esm.js +45 -7
- package/dist/components/ApisCards/presets.esm.js.map +1 -1
- package/dist/components/ComponentsCards/ConsumingComponentsCard.esm.js +27 -1
- package/dist/components/ComponentsCards/ConsumingComponentsCard.esm.js.map +1 -1
- package/dist/components/ComponentsCards/ProvidingComponentsCard.esm.js +27 -1
- package/dist/components/ComponentsCards/ProvidingComponentsCard.esm.js.map +1 -1
- package/dist/index.d.ts +128 -49
- package/dist/index.esm.js +1 -0
- package/dist/index.esm.js.map +1 -1
- package/dist/package.json.esm.js +6 -4
- package/dist/package.json.esm.js.map +1 -1
- package/dist/translation.esm.js +1 -1
- package/dist/translation.esm.js.map +1 -1
- package/package.json +19 -17
package/dist/index.d.ts
CHANGED
|
@@ -1,11 +1,10 @@
|
|
|
1
1
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
2
|
-
import * as _backstage_core_components from '@backstage/core-components';
|
|
3
2
|
import { TableColumn, TableProps, InfoCardVariants, TableOptions } from '@backstage/core-components';
|
|
4
3
|
import { CatalogTableRow } from '@backstage/plugin-catalog';
|
|
5
4
|
import { UserListFilterKind, EntityOwnerPickerProps, EntityListPagination } from '@backstage/plugin-catalog-react';
|
|
6
5
|
import { ReactElement } from 'react';
|
|
7
|
-
import * as _backstage_catalog_model from '@backstage/catalog-model';
|
|
8
6
|
import { ApiEntity, ComponentEntity } from '@backstage/catalog-model';
|
|
7
|
+
import { EntityColumnConfig } from '@backstage/plugin-catalog-react/alpha';
|
|
9
8
|
import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
|
|
10
9
|
import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
|
|
11
10
|
|
|
@@ -63,35 +62,77 @@ declare function ApiDefinitionDialog(props: {
|
|
|
63
62
|
onClose: () => void;
|
|
64
63
|
}): react_jsx_runtime.JSX.Element;
|
|
65
64
|
|
|
65
|
+
/** @public */
|
|
66
|
+
interface ConsumedApisCardProps {
|
|
67
|
+
title?: string;
|
|
68
|
+
columnConfig?: EntityColumnConfig[];
|
|
69
|
+
}
|
|
66
70
|
/**
|
|
71
|
+
* Props for the legacy MUI-based rendering.
|
|
72
|
+
* @deprecated Use {@link ConsumedApisCardProps} instead.
|
|
67
73
|
* @public
|
|
68
74
|
*/
|
|
69
|
-
|
|
70
|
-
variant?: InfoCardVariants;
|
|
75
|
+
interface ConsumedApisCardLegacyProps {
|
|
71
76
|
title?: string;
|
|
77
|
+
/** @deprecated Use `columnConfig` instead. */
|
|
78
|
+
variant?: InfoCardVariants;
|
|
79
|
+
/** @deprecated Use `columnConfig` instead. */
|
|
72
80
|
columns?: TableColumn<ApiEntity>[];
|
|
81
|
+
/** @deprecated Use `columnConfig` instead. */
|
|
73
82
|
tableOptions?: TableOptions;
|
|
74
|
-
}
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
declare const ConsumedApisCard: (props: ConsumedApisCardProps | ConsumedApisCardLegacyProps) => react_jsx_runtime.JSX.Element;
|
|
75
88
|
|
|
89
|
+
/** @public */
|
|
90
|
+
interface HasApisCardProps {
|
|
91
|
+
title?: string;
|
|
92
|
+
columnConfig?: EntityColumnConfig[];
|
|
93
|
+
}
|
|
76
94
|
/**
|
|
95
|
+
* Props for the legacy MUI-based rendering.
|
|
96
|
+
* @deprecated Use {@link HasApisCardProps} instead.
|
|
77
97
|
* @public
|
|
78
98
|
*/
|
|
79
|
-
|
|
80
|
-
variant?: InfoCardVariants;
|
|
99
|
+
interface HasApisCardLegacyProps {
|
|
81
100
|
title?: string;
|
|
101
|
+
/** @deprecated Use `columnConfig` instead. */
|
|
102
|
+
variant?: InfoCardVariants;
|
|
103
|
+
/** @deprecated Use `columnConfig` instead. */
|
|
82
104
|
columns?: TableColumn<ApiEntity>[];
|
|
105
|
+
/** @deprecated Use `columnConfig` instead. */
|
|
83
106
|
tableOptions?: TableOptions;
|
|
84
|
-
}
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
declare const HasApisCard: (props: HasApisCardProps | HasApisCardLegacyProps) => react_jsx_runtime.JSX.Element;
|
|
85
112
|
|
|
113
|
+
/** @public */
|
|
114
|
+
interface ProvidedApisCardProps {
|
|
115
|
+
title?: string;
|
|
116
|
+
columnConfig?: EntityColumnConfig[];
|
|
117
|
+
}
|
|
86
118
|
/**
|
|
119
|
+
* Props for the legacy MUI-based rendering.
|
|
120
|
+
* @deprecated Use {@link ProvidedApisCardProps} instead.
|
|
87
121
|
* @public
|
|
88
122
|
*/
|
|
89
|
-
|
|
90
|
-
variant?: InfoCardVariants;
|
|
123
|
+
interface ProvidedApisCardLegacyProps {
|
|
91
124
|
title?: string;
|
|
125
|
+
/** @deprecated Use `columnConfig` instead. */
|
|
126
|
+
variant?: InfoCardVariants;
|
|
127
|
+
/** @deprecated Use `columnConfig` instead. */
|
|
92
128
|
columns?: TableColumn<ApiEntity>[];
|
|
129
|
+
/** @deprecated Use `columnConfig` instead. */
|
|
93
130
|
tableOptions?: TableOptions;
|
|
94
|
-
}
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
135
|
+
declare const ProvidedApisCard: (props: ProvidedApisCardProps | ProvidedApisCardLegacyProps) => react_jsx_runtime.JSX.Element;
|
|
95
136
|
|
|
96
137
|
/** @public */
|
|
97
138
|
type AsyncApiResolver = {
|
|
@@ -109,23 +150,51 @@ type AsyncApiDefinitionWidgetProps = {
|
|
|
109
150
|
/** @public */
|
|
110
151
|
declare const AsyncApiDefinitionWidget: (props: AsyncApiDefinitionWidgetProps) => react_jsx_runtime.JSX.Element;
|
|
111
152
|
|
|
153
|
+
/** @public */
|
|
154
|
+
interface ConsumingComponentsCardProps {
|
|
155
|
+
title?: string;
|
|
156
|
+
columnConfig?: EntityColumnConfig[];
|
|
157
|
+
}
|
|
112
158
|
/**
|
|
159
|
+
* Props for the legacy MUI-based rendering.
|
|
160
|
+
* @deprecated Use {@link ConsumingComponentsCardProps} instead.
|
|
113
161
|
* @public
|
|
114
162
|
*/
|
|
115
|
-
|
|
116
|
-
variant?: InfoCardVariants;
|
|
163
|
+
interface ConsumingComponentsCardLegacyProps {
|
|
117
164
|
title?: string;
|
|
165
|
+
/** @deprecated Use `columnConfig` instead. */
|
|
166
|
+
variant?: InfoCardVariants;
|
|
167
|
+
/** @deprecated Use `columnConfig` instead. */
|
|
118
168
|
columns?: TableColumn<ComponentEntity>[];
|
|
169
|
+
/** @deprecated Use `columnConfig` instead. */
|
|
119
170
|
tableOptions?: TableOptions;
|
|
120
|
-
}
|
|
171
|
+
}
|
|
172
|
+
/**
|
|
173
|
+
* @public
|
|
174
|
+
*/
|
|
175
|
+
declare const ConsumingComponentsCard: (props: ConsumingComponentsCardProps | ConsumingComponentsCardLegacyProps) => react_jsx_runtime.JSX.Element;
|
|
121
176
|
|
|
122
177
|
/** @public */
|
|
123
|
-
|
|
124
|
-
variant?: InfoCardVariants;
|
|
178
|
+
interface ProvidingComponentsCardProps {
|
|
125
179
|
title?: string;
|
|
180
|
+
columnConfig?: EntityColumnConfig[];
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* Props for the legacy MUI-based rendering.
|
|
184
|
+
* @deprecated Use {@link ProvidingComponentsCardProps} instead.
|
|
185
|
+
* @public
|
|
186
|
+
*/
|
|
187
|
+
interface ProvidingComponentsCardLegacyProps {
|
|
188
|
+
title?: string;
|
|
189
|
+
/** @deprecated Use `columnConfig` instead. */
|
|
190
|
+
variant?: InfoCardVariants;
|
|
191
|
+
/** @deprecated Use `columnConfig` instead. */
|
|
126
192
|
columns?: TableColumn<ComponentEntity>[];
|
|
193
|
+
/** @deprecated Use `columnConfig` instead. */
|
|
127
194
|
tableOptions?: TableOptions;
|
|
128
|
-
}
|
|
195
|
+
}
|
|
196
|
+
/** @public */
|
|
197
|
+
declare const ProvidingComponentsCard: (props: ProvidingComponentsCardProps | ProvidingComponentsCardLegacyProps) => react_jsx_runtime.JSX.Element;
|
|
129
198
|
|
|
130
199
|
/** @public */
|
|
131
200
|
type GraphQlDefinitionWidgetProps = {
|
|
@@ -176,40 +245,50 @@ declare const ApiExplorerPage: (props: DefaultApiExplorerPageProps) => react_jsx
|
|
|
176
245
|
/** @public */
|
|
177
246
|
declare const EntityApiDefinitionCard: () => react_jsx_runtime.JSX.Element;
|
|
178
247
|
/** @public */
|
|
179
|
-
declare const EntityConsumedApisCard: (props:
|
|
180
|
-
variant?: _backstage_core_components.InfoCardVariants;
|
|
181
|
-
title?: string;
|
|
182
|
-
columns?: _backstage_core_components.TableColumn<ApiEntity>[];
|
|
183
|
-
tableOptions?: _backstage_core_components.TableOptions;
|
|
184
|
-
}) => react_jsx_runtime.JSX.Element;
|
|
248
|
+
declare const EntityConsumedApisCard: (props: ConsumedApisCardProps | ConsumedApisCardLegacyProps) => react_jsx_runtime.JSX.Element;
|
|
185
249
|
/** @public */
|
|
186
|
-
declare const EntityConsumingComponentsCard: (props:
|
|
187
|
-
variant?: _backstage_core_components.InfoCardVariants;
|
|
188
|
-
title?: string;
|
|
189
|
-
columns?: _backstage_core_components.TableColumn<_backstage_catalog_model.ComponentEntity>[];
|
|
190
|
-
tableOptions?: _backstage_core_components.TableOptions;
|
|
191
|
-
}) => react_jsx_runtime.JSX.Element;
|
|
250
|
+
declare const EntityConsumingComponentsCard: (props: ConsumingComponentsCardProps | ConsumingComponentsCardLegacyProps) => react_jsx_runtime.JSX.Element;
|
|
192
251
|
/** @public */
|
|
193
|
-
declare const EntityProvidedApisCard: (props:
|
|
194
|
-
variant?: _backstage_core_components.InfoCardVariants;
|
|
195
|
-
title?: string;
|
|
196
|
-
columns?: _backstage_core_components.TableColumn<ApiEntity>[];
|
|
197
|
-
tableOptions?: _backstage_core_components.TableOptions;
|
|
198
|
-
}) => react_jsx_runtime.JSX.Element;
|
|
252
|
+
declare const EntityProvidedApisCard: (props: ProvidedApisCardProps | ProvidedApisCardLegacyProps) => react_jsx_runtime.JSX.Element;
|
|
199
253
|
/** @public */
|
|
200
|
-
declare const EntityProvidingComponentsCard: (props:
|
|
201
|
-
variant?: _backstage_core_components.InfoCardVariants;
|
|
202
|
-
title?: string;
|
|
203
|
-
columns?: _backstage_core_components.TableColumn<_backstage_catalog_model.ComponentEntity>[];
|
|
204
|
-
tableOptions?: _backstage_core_components.TableOptions;
|
|
205
|
-
}) => react_jsx_runtime.JSX.Element;
|
|
254
|
+
declare const EntityProvidingComponentsCard: (props: ProvidingComponentsCardProps | ProvidingComponentsCardLegacyProps) => react_jsx_runtime.JSX.Element;
|
|
206
255
|
/** @public */
|
|
207
|
-
declare const EntityHasApisCard: (props:
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
256
|
+
declare const EntityHasApisCard: (props: HasApisCardProps | HasApisCardLegacyProps) => react_jsx_runtime.JSX.Element;
|
|
257
|
+
|
|
258
|
+
/**
|
|
259
|
+
* @public
|
|
260
|
+
*/
|
|
261
|
+
declare const apiDocsTranslationRef: _backstage_frontend_plugin_api.TranslationRef<"api-docs", {
|
|
262
|
+
readonly "apiDefinitionCard.error.title": "Could not fetch the API";
|
|
263
|
+
readonly "apiDefinitionCard.rawButtonTitle": "Raw";
|
|
264
|
+
readonly "apiDefinitionDialog.closeButtonTitle": "Close";
|
|
265
|
+
readonly "apiDefinitionDialog.tabsAriaLabel": "API definition options";
|
|
266
|
+
readonly "apiDefinitionDialog.rawButtonTitle": "Raw";
|
|
267
|
+
readonly "apiDefinitionDialog.toggleButtonAriaLabel": "Toggle API Definition Dialog";
|
|
268
|
+
readonly "defaultApiExplorerPage.title": "APIs";
|
|
269
|
+
readonly "defaultApiExplorerPage.subtitle": "{{orgName}} API Explorer";
|
|
270
|
+
readonly "defaultApiExplorerPage.pageTitleOverride": "APIs";
|
|
271
|
+
readonly "defaultApiExplorerPage.createButtonTitle": "Register Existing API";
|
|
272
|
+
readonly "defaultApiExplorerPage.supportButtonTitle": "All your APIs";
|
|
273
|
+
readonly "consumedApisCard.error.title": "Could not load APIs";
|
|
274
|
+
readonly "consumedApisCard.title": "Consumed APIs";
|
|
275
|
+
readonly "consumedApisCard.emptyContent.title": "This {{entity}} does not consume any APIs.";
|
|
276
|
+
readonly "hasApisCard.error.title": "Could not load APIs";
|
|
277
|
+
readonly "hasApisCard.title": "APIs";
|
|
278
|
+
readonly "hasApisCard.emptyContent.title": "This {{entity}} does not contain any APIs.";
|
|
279
|
+
readonly "providedApisCard.error.title": "Could not load APIs";
|
|
280
|
+
readonly "providedApisCard.title": "Provided APIs";
|
|
281
|
+
readonly "providedApisCard.emptyContent.title": "This {{entity}} does not provide any APIs.";
|
|
282
|
+
readonly "apiEntityColumns.typeTitle": "Type";
|
|
283
|
+
readonly "apiEntityColumns.apiDefinitionTitle": "API Definition";
|
|
284
|
+
readonly "consumingComponentsCard.error.title": "Could not load components";
|
|
285
|
+
readonly "consumingComponentsCard.title": "Consumers";
|
|
286
|
+
readonly "consumingComponentsCard.emptyContent.title": "No component consumes this API.";
|
|
287
|
+
readonly "providingComponentsCard.error.title": "Could not load components";
|
|
288
|
+
readonly "providingComponentsCard.title": "Providers";
|
|
289
|
+
readonly "providingComponentsCard.emptyContent.title": "No component provides this API.";
|
|
290
|
+
readonly apisCardHelpLinkTitle: "Learn how to change this.";
|
|
291
|
+
}>;
|
|
213
292
|
|
|
214
|
-
export { ApiDefinitionCard, ApiDefinitionDialog, ApiExplorerPage$1 as ApiExplorerIndexPage, ApiExplorerPage, ApiTypeTitle, AsyncApiDefinitionWidget, ConsumedApisCard, ConsumingComponentsCard, DefaultApiExplorerPage, EntityApiDefinitionCard, EntityConsumedApisCard, EntityConsumingComponentsCard, EntityHasApisCard, EntityProvidedApisCard, EntityProvidingComponentsCard, GraphQlDefinitionWidget, HasApisCard, OpenApiDefinitionWidget, PlainApiDefinitionWidget, ProvidedApisCard, ProvidingComponentsCard, TrpcApiDefinitionWidget, apiDocsConfigRef, apiDocsPlugin, defaultDefinitionWidgets, apiDocsPlugin as plugin };
|
|
215
|
-
export type { ApiDefinitionWidget, ApiDocsConfig, AsyncApiDefinitionWidgetProps, AsyncApiResolver, DefaultApiExplorerPageProps, GraphQlDefinitionWidgetProps, OpenApiDefinitionWidgetProps, PlainApiDefinitionWidgetProps, TrpcApiDefinitionWidgetProps };
|
|
293
|
+
export { ApiDefinitionCard, ApiDefinitionDialog, ApiExplorerPage$1 as ApiExplorerIndexPage, ApiExplorerPage, ApiTypeTitle, AsyncApiDefinitionWidget, ConsumedApisCard, ConsumingComponentsCard, DefaultApiExplorerPage, EntityApiDefinitionCard, EntityConsumedApisCard, EntityConsumingComponentsCard, EntityHasApisCard, EntityProvidedApisCard, EntityProvidingComponentsCard, GraphQlDefinitionWidget, HasApisCard, OpenApiDefinitionWidget, PlainApiDefinitionWidget, ProvidedApisCard, ProvidingComponentsCard, TrpcApiDefinitionWidget, apiDocsConfigRef, apiDocsPlugin, apiDocsTranslationRef, defaultDefinitionWidgets, apiDocsPlugin as plugin };
|
|
294
|
+
export type { ApiDefinitionWidget, ApiDocsConfig, AsyncApiDefinitionWidgetProps, AsyncApiResolver, ConsumedApisCardLegacyProps, ConsumedApisCardProps, ConsumingComponentsCardLegacyProps, ConsumingComponentsCardProps, DefaultApiExplorerPageProps, GraphQlDefinitionWidgetProps, HasApisCardLegacyProps, HasApisCardProps, OpenApiDefinitionWidgetProps, PlainApiDefinitionWidgetProps, ProvidedApisCardLegacyProps, ProvidedApisCardProps, ProvidingComponentsCardLegacyProps, ProvidingComponentsCardProps, TrpcApiDefinitionWidgetProps };
|
package/dist/index.esm.js
CHANGED
|
@@ -16,4 +16,5 @@ export { PlainApiDefinitionWidget } from './components/PlainApiDefinitionWidget/
|
|
|
16
16
|
export { TrpcApiDefinitionWidget } from './components/TrpcDefinitionWidget/TrpcApiDefinitionWidget.esm.js';
|
|
17
17
|
export { apiDocsConfigRef } from './config.esm.js';
|
|
18
18
|
export { ApiExplorerPage, EntityApiDefinitionCard, EntityConsumedApisCard, EntityConsumingComponentsCard, EntityHasApisCard, EntityProvidedApisCard, EntityProvidingComponentsCard, apiDocsPlugin, apiDocsPlugin as plugin } from './plugin.esm.js';
|
|
19
|
+
export { apiDocsTranslationRef } from './translation.esm.js';
|
|
19
20
|
//# sourceMappingURL=index.esm.js.map
|
package/dist/index.esm.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;"}
|
package/dist/package.json.esm.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
var name = "@backstage/plugin-api-docs";
|
|
2
|
-
var version = "0.13.5
|
|
2
|
+
var version = "0.13.5";
|
|
3
3
|
var description = "A Backstage plugin that helps represent API entities in the frontend";
|
|
4
4
|
var backstage = {
|
|
5
5
|
role: "frontend-plugin",
|
|
@@ -61,13 +61,14 @@ var dependencies = {
|
|
|
61
61
|
"@backstage/plugin-catalog-common": "workspace:^",
|
|
62
62
|
"@backstage/plugin-catalog-react": "workspace:^",
|
|
63
63
|
"@backstage/plugin-permission-react": "workspace:^",
|
|
64
|
-
"@
|
|
64
|
+
"@backstage/ui": "workspace:^",
|
|
65
|
+
"@graphiql/react": "0.29.0",
|
|
65
66
|
"@material-ui/core": "^4.12.2",
|
|
66
67
|
"@material-ui/icons": "^4.9.1",
|
|
67
68
|
"@material-ui/lab": "4.0.0-alpha.61",
|
|
68
|
-
|
|
69
|
+
"@remixicon/react": "^4.6.0",
|
|
70
|
+
graphiql: "^3.9.0",
|
|
69
71
|
graphql: "^16.0.0",
|
|
70
|
-
"graphql-config": "^5.0.2",
|
|
71
72
|
"graphql-ws": "^5.4.1",
|
|
72
73
|
"swagger-ui-react": "^5.27.1"
|
|
73
74
|
};
|
|
@@ -84,6 +85,7 @@ var devDependencies = {
|
|
|
84
85
|
"@types/highlightjs": "^10.1.0",
|
|
85
86
|
"@types/react": "^18.0.0",
|
|
86
87
|
"@types/swagger-ui-react": "^5.0.0",
|
|
88
|
+
"graphql-config": "^5.1.6",
|
|
87
89
|
react: "^18.0.2",
|
|
88
90
|
"react-dom": "^18.0.2",
|
|
89
91
|
"react-router-dom": "^6.30.2"
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"package.json.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"package.json.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|
package/dist/translation.esm.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"translation.esm.js","sources":["../src/translation.ts"],"sourcesContent":["/*\n * Copyright 2025 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 { createTranslationRef } from '@backstage/frontend-plugin-api';\n\n/**\n * @
|
|
1
|
+
{"version":3,"file":"translation.esm.js","sources":["../src/translation.ts"],"sourcesContent":["/*\n * Copyright 2025 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 { createTranslationRef } from '@backstage/frontend-plugin-api';\n\n/**\n * @public\n */\nexport const apiDocsTranslationRef = createTranslationRef({\n id: 'api-docs',\n messages: {\n apiDefinitionCard: {\n error: {\n title: 'Could not fetch the API',\n },\n rawButtonTitle: 'Raw',\n },\n apiDefinitionDialog: {\n closeButtonTitle: 'Close',\n tabsAriaLabel: 'API definition options',\n toggleButtonAriaLabel: 'Toggle API Definition Dialog',\n rawButtonTitle: 'Raw',\n },\n defaultApiExplorerPage: {\n title: 'APIs',\n subtitle: '{{orgName}} API Explorer',\n pageTitleOverride: 'APIs',\n createButtonTitle: 'Register Existing API',\n supportButtonTitle: 'All your APIs',\n },\n consumedApisCard: {\n title: 'Consumed APIs',\n error: {\n title: 'Could not load APIs',\n },\n emptyContent: {\n title: 'This {{entity}} does not consume any APIs.',\n },\n },\n hasApisCard: {\n title: 'APIs',\n error: {\n title: 'Could not load APIs',\n },\n emptyContent: {\n title: 'This {{entity}} does not contain any APIs.',\n },\n },\n providedApisCard: {\n title: 'Provided APIs',\n error: {\n title: 'Could not load APIs',\n },\n emptyContent: {\n title: 'This {{entity}} does not provide any APIs.',\n },\n },\n apiEntityColumns: {\n typeTitle: 'Type',\n apiDefinitionTitle: 'API Definition',\n },\n consumingComponentsCard: {\n title: 'Consumers',\n error: {\n title: 'Could not load components',\n },\n emptyContent: {\n title: 'No component consumes this API.',\n },\n },\n providingComponentsCard: {\n title: 'Providers',\n error: {\n title: 'Could not load components',\n },\n emptyContent: {\n title: 'No component provides this API.',\n },\n },\n apisCardHelpLinkTitle: 'Learn how to change this.',\n },\n});\n"],"names":[],"mappings":";;AAqBO,MAAM,wBAAwB,oBAAA,CAAqB;AAAA,EACxD,EAAA,EAAI,UAAA;AAAA,EACJ,QAAA,EAAU;AAAA,IACR,iBAAA,EAAmB;AAAA,MACjB,KAAA,EAAO;AAAA,QACL,KAAA,EAAO;AAAA,OACT;AAAA,MACA,cAAA,EAAgB;AAAA,KAClB;AAAA,IACA,mBAAA,EAAqB;AAAA,MACnB,gBAAA,EAAkB,OAAA;AAAA,MAClB,aAAA,EAAe,wBAAA;AAAA,MACf,qBAAA,EAAuB,8BAAA;AAAA,MACvB,cAAA,EAAgB;AAAA,KAClB;AAAA,IACA,sBAAA,EAAwB;AAAA,MACtB,KAAA,EAAO,MAAA;AAAA,MACP,QAAA,EAAU,0BAAA;AAAA,MACV,iBAAA,EAAmB,MAAA;AAAA,MACnB,iBAAA,EAAmB,uBAAA;AAAA,MACnB,kBAAA,EAAoB;AAAA,KACtB;AAAA,IACA,gBAAA,EAAkB;AAAA,MAChB,KAAA,EAAO,eAAA;AAAA,MACP,KAAA,EAAO;AAAA,QACL,KAAA,EAAO;AAAA,OACT;AAAA,MACA,YAAA,EAAc;AAAA,QACZ,KAAA,EAAO;AAAA;AACT,KACF;AAAA,IACA,WAAA,EAAa;AAAA,MACX,KAAA,EAAO,MAAA;AAAA,MACP,KAAA,EAAO;AAAA,QACL,KAAA,EAAO;AAAA,OACT;AAAA,MACA,YAAA,EAAc;AAAA,QACZ,KAAA,EAAO;AAAA;AACT,KACF;AAAA,IACA,gBAAA,EAAkB;AAAA,MAChB,KAAA,EAAO,eAAA;AAAA,MACP,KAAA,EAAO;AAAA,QACL,KAAA,EAAO;AAAA,OACT;AAAA,MACA,YAAA,EAAc;AAAA,QACZ,KAAA,EAAO;AAAA;AACT,KACF;AAAA,IACA,gBAAA,EAAkB;AAAA,MAChB,SAAA,EAAW,MAAA;AAAA,MACX,kBAAA,EAAoB;AAAA,KACtB;AAAA,IACA,uBAAA,EAAyB;AAAA,MACvB,KAAA,EAAO,WAAA;AAAA,MACP,KAAA,EAAO;AAAA,QACL,KAAA,EAAO;AAAA,OACT;AAAA,MACA,YAAA,EAAc;AAAA,QACZ,KAAA,EAAO;AAAA;AACT,KACF;AAAA,IACA,uBAAA,EAAyB;AAAA,MACvB,KAAA,EAAO,WAAA;AAAA,MACP,KAAA,EAAO;AAAA,QACL,KAAA,EAAO;AAAA,OACT;AAAA,MACA,YAAA,EAAc;AAAA,QACZ,KAAA,EAAO;AAAA;AACT,KACF;AAAA,IACA,qBAAA,EAAuB;AAAA;AAE3B,CAAC;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-api-docs",
|
|
3
|
-
"version": "0.13.5
|
|
3
|
+
"version": "0.13.5",
|
|
4
4
|
"description": "A Backstage plugin that helps represent API entities in the frontend",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "frontend-plugin",
|
|
@@ -66,30 +66,31 @@
|
|
|
66
66
|
},
|
|
67
67
|
"dependencies": {
|
|
68
68
|
"@asyncapi/react-component": "^2.3.3",
|
|
69
|
-
"@backstage/catalog-model": "1.7.
|
|
70
|
-
"@backstage/core-components": "0.18.8
|
|
71
|
-
"@backstage/core-plugin-api": "1.12.4
|
|
72
|
-
"@backstage/frontend-plugin-api": "0.
|
|
73
|
-
"@backstage/plugin-catalog": "
|
|
74
|
-
"@backstage/plugin-catalog-common": "1.1.8",
|
|
75
|
-
"@backstage/plugin-catalog-react": "2.1.0
|
|
76
|
-
"@backstage/plugin-permission-react": "0.4.41
|
|
77
|
-
"@
|
|
69
|
+
"@backstage/catalog-model": "^1.7.7",
|
|
70
|
+
"@backstage/core-components": "^0.18.8",
|
|
71
|
+
"@backstage/core-plugin-api": "^1.12.4",
|
|
72
|
+
"@backstage/frontend-plugin-api": "^0.15.0",
|
|
73
|
+
"@backstage/plugin-catalog": "^2.0.0",
|
|
74
|
+
"@backstage/plugin-catalog-common": "^1.1.8",
|
|
75
|
+
"@backstage/plugin-catalog-react": "^2.1.0",
|
|
76
|
+
"@backstage/plugin-permission-react": "^0.4.41",
|
|
77
|
+
"@backstage/ui": "^0.13.0",
|
|
78
|
+
"@graphiql/react": "0.29.0",
|
|
78
79
|
"@material-ui/core": "^4.12.2",
|
|
79
80
|
"@material-ui/icons": "^4.9.1",
|
|
80
81
|
"@material-ui/lab": "4.0.0-alpha.61",
|
|
81
|
-
"
|
|
82
|
+
"@remixicon/react": "^4.6.0",
|
|
83
|
+
"graphiql": "^3.9.0",
|
|
82
84
|
"graphql": "^16.0.0",
|
|
83
|
-
"graphql-config": "^5.0.2",
|
|
84
85
|
"graphql-ws": "^5.4.1",
|
|
85
86
|
"swagger-ui-react": "^5.27.1"
|
|
86
87
|
},
|
|
87
88
|
"devDependencies": {
|
|
88
|
-
"@backstage/cli": "0.36.0
|
|
89
|
-
"@backstage/core-app-api": "1.19.6
|
|
90
|
-
"@backstage/dev-utils": "1.1.21
|
|
91
|
-
"@backstage/frontend-test-utils": "0.5.1
|
|
92
|
-
"@backstage/test-utils": "1.7.16
|
|
89
|
+
"@backstage/cli": "^0.36.0",
|
|
90
|
+
"@backstage/core-app-api": "^1.19.6",
|
|
91
|
+
"@backstage/dev-utils": "^1.1.21",
|
|
92
|
+
"@backstage/frontend-test-utils": "^0.5.1",
|
|
93
|
+
"@backstage/test-utils": "^1.7.16",
|
|
93
94
|
"@testing-library/dom": "^10.0.0",
|
|
94
95
|
"@testing-library/jest-dom": "^6.0.0",
|
|
95
96
|
"@testing-library/react": "^16.0.0",
|
|
@@ -97,6 +98,7 @@
|
|
|
97
98
|
"@types/highlightjs": "^10.1.0",
|
|
98
99
|
"@types/react": "^18.0.0",
|
|
99
100
|
"@types/swagger-ui-react": "^5.0.0",
|
|
101
|
+
"graphql-config": "^5.1.6",
|
|
100
102
|
"react": "^18.0.2",
|
|
101
103
|
"react-dom": "^18.0.2",
|
|
102
104
|
"react-router-dom": "^6.30.2"
|