@backstage/plugin-api-docs 0.0.0-nightly-20250305023316 → 0.0.0-nightly-20250306023446
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 +6 -6
- package/dist/alpha.d.ts +60 -60
- package/package.json +8 -8
package/CHANGELOG.md
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
# @backstage/plugin-api-docs
|
|
2
2
|
|
|
3
|
-
## 0.0.0-nightly-
|
|
3
|
+
## 0.0.0-nightly-20250306023446
|
|
4
4
|
|
|
5
5
|
### Patch Changes
|
|
6
6
|
|
|
7
7
|
- Updated dependencies
|
|
8
|
-
- @backstage/core-components@0.0.0-nightly-
|
|
9
|
-
- @backstage/plugin-
|
|
10
|
-
- @backstage/plugin-catalog@0.0.0-nightly-
|
|
11
|
-
- @backstage/
|
|
12
|
-
- @backstage/
|
|
8
|
+
- @backstage/core-components@0.0.0-nightly-20250306023446
|
|
9
|
+
- @backstage/frontend-plugin-api@0.0.0-nightly-20250306023446
|
|
10
|
+
- @backstage/plugin-catalog-react@0.0.0-nightly-20250306023446
|
|
11
|
+
- @backstage/plugin-catalog@0.0.0-nightly-20250306023446
|
|
12
|
+
- @backstage/core-compat-api@0.0.0-nightly-20250306023446
|
|
13
13
|
- @backstage/catalog-model@1.7.3
|
|
14
14
|
- @backstage/core-plugin-api@1.10.4
|
|
15
15
|
- @backstage/plugin-catalog-common@1.1.3
|
package/dist/alpha.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
+
import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
|
|
1
2
|
import * as _backstage_plugin_catalog_react_alpha from '@backstage/plugin-catalog-react/alpha';
|
|
2
3
|
import * as _backstage_catalog_model from '@backstage/catalog-model';
|
|
3
|
-
import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
|
|
4
4
|
import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
|
|
5
5
|
import React__default from 'react';
|
|
6
6
|
|
|
@@ -9,23 +9,6 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
|
|
|
9
9
|
}, {
|
|
10
10
|
registerApi: _backstage_frontend_plugin_api.ExternalRouteRef<undefined>;
|
|
11
11
|
}, {
|
|
12
|
-
"nav-item:api-docs": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
13
|
-
kind: "nav-item";
|
|
14
|
-
name: undefined;
|
|
15
|
-
config: {};
|
|
16
|
-
configInput: {};
|
|
17
|
-
output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
|
|
18
|
-
title: string;
|
|
19
|
-
icon: _backstage_core_plugin_api.IconComponent;
|
|
20
|
-
routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
|
|
21
|
-
}, "core.nav-item.target", {}>;
|
|
22
|
-
inputs: {};
|
|
23
|
-
params: {
|
|
24
|
-
title: string;
|
|
25
|
-
icon: _backstage_core_plugin_api.IconComponent;
|
|
26
|
-
routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
|
|
27
|
-
};
|
|
28
|
-
}>;
|
|
29
12
|
"api:api-docs/config": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
30
13
|
kind: "api";
|
|
31
14
|
name: "config";
|
|
@@ -37,37 +20,9 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
|
|
|
37
20
|
factory: _backstage_frontend_plugin_api.AnyApiFactory;
|
|
38
21
|
};
|
|
39
22
|
}>;
|
|
40
|
-
"
|
|
41
|
-
config: {
|
|
42
|
-
initiallySelectedFilter: "all" | "owned" | "starred" | undefined;
|
|
43
|
-
} & {
|
|
44
|
-
path: string | undefined;
|
|
45
|
-
};
|
|
46
|
-
configInput: {
|
|
47
|
-
initiallySelectedFilter?: "all" | "owned" | "starred" | undefined;
|
|
48
|
-
} & {
|
|
49
|
-
path?: string | undefined;
|
|
50
|
-
};
|
|
51
|
-
output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
|
|
52
|
-
optional: true;
|
|
53
|
-
}>;
|
|
54
|
-
inputs: {
|
|
55
|
-
[x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
|
|
56
|
-
optional: boolean;
|
|
57
|
-
singleton: boolean;
|
|
58
|
-
}>;
|
|
59
|
-
};
|
|
60
|
-
kind: "page";
|
|
61
|
-
name: undefined;
|
|
62
|
-
params: {
|
|
63
|
-
defaultPath: string;
|
|
64
|
-
loader: () => Promise<JSX.Element>;
|
|
65
|
-
routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
|
|
66
|
-
};
|
|
67
|
-
}>;
|
|
68
|
-
"entity-card:api-docs/has-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
23
|
+
"entity-card:api-docs/consumed-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
69
24
|
kind: "entity-card";
|
|
70
|
-
name: "
|
|
25
|
+
name: "consumed-apis";
|
|
71
26
|
config: {
|
|
72
27
|
filter: string | undefined;
|
|
73
28
|
type: "full" | "info" | "peek" | undefined;
|
|
@@ -90,9 +45,9 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
|
|
|
90
45
|
type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
|
|
91
46
|
};
|
|
92
47
|
}>;
|
|
93
|
-
"entity-card:api-docs/
|
|
48
|
+
"entity-card:api-docs/consuming-components": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
94
49
|
kind: "entity-card";
|
|
95
|
-
name: "
|
|
50
|
+
name: "consuming-components";
|
|
96
51
|
config: {
|
|
97
52
|
filter: string | undefined;
|
|
98
53
|
type: "full" | "info" | "peek" | undefined;
|
|
@@ -115,9 +70,9 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
|
|
|
115
70
|
type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
|
|
116
71
|
};
|
|
117
72
|
}>;
|
|
118
|
-
"entity-card:api-docs/
|
|
73
|
+
"entity-card:api-docs/definition": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
119
74
|
kind: "entity-card";
|
|
120
|
-
name: "
|
|
75
|
+
name: "definition";
|
|
121
76
|
config: {
|
|
122
77
|
filter: string | undefined;
|
|
123
78
|
type: "full" | "info" | "peek" | undefined;
|
|
@@ -140,9 +95,9 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
|
|
|
140
95
|
type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
|
|
141
96
|
};
|
|
142
97
|
}>;
|
|
143
|
-
"entity-card:api-docs/
|
|
98
|
+
"entity-card:api-docs/has-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
144
99
|
kind: "entity-card";
|
|
145
|
-
name: "
|
|
100
|
+
name: "has-apis";
|
|
146
101
|
config: {
|
|
147
102
|
filter: string | undefined;
|
|
148
103
|
type: "full" | "info" | "peek" | undefined;
|
|
@@ -165,9 +120,9 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
|
|
|
165
120
|
type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
|
|
166
121
|
};
|
|
167
122
|
}>;
|
|
168
|
-
"entity-card:api-docs/
|
|
123
|
+
"entity-card:api-docs/provided-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
169
124
|
kind: "entity-card";
|
|
170
|
-
name: "
|
|
125
|
+
name: "provided-apis";
|
|
171
126
|
config: {
|
|
172
127
|
filter: string | undefined;
|
|
173
128
|
type: "full" | "info" | "peek" | undefined;
|
|
@@ -215,9 +170,9 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
|
|
|
215
170
|
type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
|
|
216
171
|
};
|
|
217
172
|
}>;
|
|
218
|
-
"entity-content:api-docs/
|
|
173
|
+
"entity-content:api-docs/apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
219
174
|
kind: "entity-content";
|
|
220
|
-
name: "
|
|
175
|
+
name: "apis";
|
|
221
176
|
config: {
|
|
222
177
|
path: string | undefined;
|
|
223
178
|
title: string | undefined;
|
|
@@ -249,9 +204,9 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
|
|
|
249
204
|
filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
|
|
250
205
|
};
|
|
251
206
|
}>;
|
|
252
|
-
"entity-content:api-docs/
|
|
207
|
+
"entity-content:api-docs/definition": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
253
208
|
kind: "entity-content";
|
|
254
|
-
name: "
|
|
209
|
+
name: "definition";
|
|
255
210
|
config: {
|
|
256
211
|
path: string | undefined;
|
|
257
212
|
title: string | undefined;
|
|
@@ -283,6 +238,51 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
|
|
|
283
238
|
filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
|
|
284
239
|
};
|
|
285
240
|
}>;
|
|
241
|
+
"nav-item:api-docs": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
242
|
+
kind: "nav-item";
|
|
243
|
+
name: undefined;
|
|
244
|
+
config: {};
|
|
245
|
+
configInput: {};
|
|
246
|
+
output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
|
|
247
|
+
title: string;
|
|
248
|
+
icon: _backstage_core_plugin_api.IconComponent;
|
|
249
|
+
routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
|
|
250
|
+
}, "core.nav-item.target", {}>;
|
|
251
|
+
inputs: {};
|
|
252
|
+
params: {
|
|
253
|
+
title: string;
|
|
254
|
+
icon: _backstage_core_plugin_api.IconComponent;
|
|
255
|
+
routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
|
|
256
|
+
};
|
|
257
|
+
}>;
|
|
258
|
+
"page:api-docs": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
259
|
+
config: {
|
|
260
|
+
initiallySelectedFilter: "all" | "owned" | "starred" | undefined;
|
|
261
|
+
} & {
|
|
262
|
+
path: string | undefined;
|
|
263
|
+
};
|
|
264
|
+
configInput: {
|
|
265
|
+
initiallySelectedFilter?: "all" | "owned" | "starred" | undefined;
|
|
266
|
+
} & {
|
|
267
|
+
path?: string | undefined;
|
|
268
|
+
};
|
|
269
|
+
output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
|
|
270
|
+
optional: true;
|
|
271
|
+
}>;
|
|
272
|
+
inputs: {
|
|
273
|
+
[x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
|
|
274
|
+
optional: boolean;
|
|
275
|
+
singleton: boolean;
|
|
276
|
+
}>;
|
|
277
|
+
};
|
|
278
|
+
kind: "page";
|
|
279
|
+
name: undefined;
|
|
280
|
+
params: {
|
|
281
|
+
defaultPath: string;
|
|
282
|
+
loader: () => Promise<JSX.Element>;
|
|
283
|
+
routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
|
|
284
|
+
};
|
|
285
|
+
}>;
|
|
286
286
|
}>;
|
|
287
287
|
|
|
288
288
|
export { _default as default };
|
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-20250306023446",
|
|
4
4
|
"description": "A Backstage plugin that helps represent API entities in the frontend",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "frontend-plugin",
|
|
@@ -67,13 +67,13 @@
|
|
|
67
67
|
"dependencies": {
|
|
68
68
|
"@asyncapi/react-component": "^2.3.3",
|
|
69
69
|
"@backstage/catalog-model": "1.7.3",
|
|
70
|
-
"@backstage/core-compat-api": "0.0.0-nightly-
|
|
71
|
-
"@backstage/core-components": "0.0.0-nightly-
|
|
70
|
+
"@backstage/core-compat-api": "0.0.0-nightly-20250306023446",
|
|
71
|
+
"@backstage/core-components": "0.0.0-nightly-20250306023446",
|
|
72
72
|
"@backstage/core-plugin-api": "1.10.4",
|
|
73
|
-
"@backstage/frontend-plugin-api": "0.0.0-nightly-
|
|
74
|
-
"@backstage/plugin-catalog": "0.0.0-nightly-
|
|
73
|
+
"@backstage/frontend-plugin-api": "0.0.0-nightly-20250306023446",
|
|
74
|
+
"@backstage/plugin-catalog": "0.0.0-nightly-20250306023446",
|
|
75
75
|
"@backstage/plugin-catalog-common": "1.1.3",
|
|
76
|
-
"@backstage/plugin-catalog-react": "0.0.0-nightly-
|
|
76
|
+
"@backstage/plugin-catalog-react": "0.0.0-nightly-20250306023446",
|
|
77
77
|
"@backstage/plugin-permission-react": "0.4.31",
|
|
78
78
|
"@graphiql/react": "^0.23.0",
|
|
79
79
|
"@material-ui/core": "^4.12.2",
|
|
@@ -87,9 +87,9 @@
|
|
|
87
87
|
"swagger-ui-react": "^5.0.0"
|
|
88
88
|
},
|
|
89
89
|
"devDependencies": {
|
|
90
|
-
"@backstage/cli": "0.0.0-nightly-
|
|
90
|
+
"@backstage/cli": "0.0.0-nightly-20250306023446",
|
|
91
91
|
"@backstage/core-app-api": "1.15.5",
|
|
92
|
-
"@backstage/dev-utils": "0.0.0-nightly-
|
|
92
|
+
"@backstage/dev-utils": "0.0.0-nightly-20250306023446",
|
|
93
93
|
"@backstage/test-utils": "1.7.5",
|
|
94
94
|
"@testing-library/dom": "^10.0.0",
|
|
95
95
|
"@testing-library/jest-dom": "^6.0.0",
|