@backstage/plugin-api-docs 0.0.0-nightly-20240918022959 → 0.0.0-nightly-20240919023143

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 (4) hide show
  1. package/CHANGELOG.md +5 -5
  2. package/alpha/package.json +1 -1
  3. package/dist/alpha.d.ts +51 -0
  4. package/package.json +7 -7
package/CHANGELOG.md CHANGED
@@ -1,14 +1,14 @@
1
1
  # @backstage/plugin-api-docs
2
2
 
3
- ## 0.0.0-nightly-20240918022959
3
+ ## 0.0.0-nightly-20240919023143
4
4
 
5
5
  ### Patch Changes
6
6
 
7
7
  - Updated dependencies
8
- - @backstage/frontend-plugin-api@0.0.0-nightly-20240918022959
9
- - @backstage/core-compat-api@0.0.0-nightly-20240918022959
10
- - @backstage/plugin-catalog@0.0.0-nightly-20240918022959
11
- - @backstage/plugin-catalog-react@0.0.0-nightly-20240918022959
8
+ - @backstage/plugin-catalog@0.0.0-nightly-20240919023143
9
+ - @backstage/frontend-plugin-api@0.0.0-nightly-20240919023143
10
+ - @backstage/core-compat-api@0.0.0-nightly-20240919023143
11
+ - @backstage/plugin-catalog-react@0.0.0-nightly-20240919023143
12
12
  - @backstage/catalog-model@1.7.0
13
13
  - @backstage/core-components@0.15.0
14
14
  - @backstage/core-plugin-api@1.9.4
package/alpha/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-api-docs__alpha",
3
- "version": "0.0.0-nightly-20240918022959",
3
+ "version": "0.0.0-nightly-20240919023143",
4
4
  "main": "../dist/alpha.esm.js",
5
5
  "module": "../dist/alpha.esm.js",
6
6
  "types": "../dist/alpha.d.ts"
package/dist/alpha.d.ts CHANGED
@@ -20,6 +20,11 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
20
20
  routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
21
21
  }, "core.nav-item.target", {}>;
22
22
  inputs: {};
23
+ params: {
24
+ title: string;
25
+ icon: _backstage_core_plugin_api.IconComponent;
26
+ routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
27
+ };
23
28
  }>;
24
29
  "api:api-docs/config": _backstage_frontend_plugin_api.ExtensionDefinition<{
25
30
  kind: "api";
@@ -29,6 +34,9 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
29
34
  configInput: {};
30
35
  output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.AnyApiFactory, "core.api.factory", {}>;
31
36
  inputs: {};
37
+ params: {
38
+ factory: _backstage_frontend_plugin_api.AnyApiFactory;
39
+ };
32
40
  }>;
33
41
  "page:api-docs": _backstage_frontend_plugin_api.ExtensionDefinition<{
34
42
  config: {
@@ -53,6 +61,11 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
53
61
  kind: "page";
54
62
  namespace: undefined;
55
63
  name: undefined;
64
+ params: {
65
+ defaultPath: string;
66
+ loader: () => Promise<JSX.Element>;
67
+ routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
68
+ };
56
69
  }>;
57
70
  "entity-card:api-docs/has-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
58
71
  kind: "entity-card";
@@ -70,6 +83,10 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
70
83
  optional: true;
71
84
  }>;
72
85
  inputs: {};
86
+ params: {
87
+ loader: () => Promise<JSX.Element>;
88
+ filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
89
+ };
73
90
  }>;
74
91
  "entity-card:api-docs/definition": _backstage_frontend_plugin_api.ExtensionDefinition<{
75
92
  kind: "entity-card";
@@ -87,6 +104,10 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
87
104
  optional: true;
88
105
  }>;
89
106
  inputs: {};
107
+ params: {
108
+ loader: () => Promise<JSX.Element>;
109
+ filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
110
+ };
90
111
  }>;
91
112
  "entity-card:api-docs/consumed-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
92
113
  kind: "entity-card";
@@ -104,6 +125,10 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
104
125
  optional: true;
105
126
  }>;
106
127
  inputs: {};
128
+ params: {
129
+ loader: () => Promise<JSX.Element>;
130
+ filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
131
+ };
107
132
  }>;
108
133
  "entity-card:api-docs/provided-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
109
134
  kind: "entity-card";
@@ -121,6 +146,10 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
121
146
  optional: true;
122
147
  }>;
123
148
  inputs: {};
149
+ params: {
150
+ loader: () => Promise<JSX.Element>;
151
+ filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
152
+ };
124
153
  }>;
125
154
  "entity-card:api-docs/consuming-components": _backstage_frontend_plugin_api.ExtensionDefinition<{
126
155
  kind: "entity-card";
@@ -138,6 +167,10 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
138
167
  optional: true;
139
168
  }>;
140
169
  inputs: {};
170
+ params: {
171
+ loader: () => Promise<JSX.Element>;
172
+ filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
173
+ };
141
174
  }>;
142
175
  "entity-card:api-docs/providing-components": _backstage_frontend_plugin_api.ExtensionDefinition<{
143
176
  kind: "entity-card";
@@ -155,6 +188,10 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
155
188
  optional: true;
156
189
  }>;
157
190
  inputs: {};
191
+ params: {
192
+ loader: () => Promise<JSX.Element>;
193
+ filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
194
+ };
158
195
  }>;
159
196
  "entity-content:api-docs/definition": _backstage_frontend_plugin_api.ExtensionDefinition<{
160
197
  kind: "entity-content";
@@ -178,6 +215,13 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
178
215
  optional: true;
179
216
  }>;
180
217
  inputs: {};
218
+ params: {
219
+ loader: () => Promise<JSX.Element>;
220
+ defaultPath: string;
221
+ defaultTitle: string;
222
+ routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
223
+ filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
224
+ };
181
225
  }>;
182
226
  "entity-content:api-docs/apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
183
227
  kind: "entity-content";
@@ -201,6 +245,13 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
201
245
  optional: true;
202
246
  }>;
203
247
  inputs: {};
248
+ params: {
249
+ loader: () => Promise<JSX.Element>;
250
+ defaultPath: string;
251
+ defaultTitle: string;
252
+ routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
253
+ filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
254
+ };
204
255
  }>;
205
256
  }>;
206
257
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-api-docs",
3
- "version": "0.0.0-nightly-20240918022959",
3
+ "version": "0.0.0-nightly-20240919023143",
4
4
  "description": "A Backstage plugin that helps represent API entities in the frontend",
5
5
  "backstage": {
6
6
  "role": "frontend-plugin",
@@ -54,13 +54,13 @@
54
54
  "dependencies": {
55
55
  "@asyncapi/react-component": "1.3.1",
56
56
  "@backstage/catalog-model": "^1.7.0",
57
- "@backstage/core-compat-api": "^0.0.0-nightly-20240918022959",
57
+ "@backstage/core-compat-api": "^0.0.0-nightly-20240919023143",
58
58
  "@backstage/core-components": "^0.15.0",
59
59
  "@backstage/core-plugin-api": "^1.9.4",
60
- "@backstage/frontend-plugin-api": "^0.0.0-nightly-20240918022959",
61
- "@backstage/plugin-catalog": "^0.0.0-nightly-20240918022959",
60
+ "@backstage/frontend-plugin-api": "^0.0.0-nightly-20240919023143",
61
+ "@backstage/plugin-catalog": "^0.0.0-nightly-20240919023143",
62
62
  "@backstage/plugin-catalog-common": "^1.1.0",
63
- "@backstage/plugin-catalog-react": "^0.0.0-nightly-20240918022959",
63
+ "@backstage/plugin-catalog-react": "^0.0.0-nightly-20240919023143",
64
64
  "@backstage/plugin-permission-react": "^0.4.26",
65
65
  "@graphiql/react": "^0.23.0",
66
66
  "@material-ui/core": "^4.12.2",
@@ -75,9 +75,9 @@
75
75
  "swagger-ui-react": "^5.0.0"
76
76
  },
77
77
  "devDependencies": {
78
- "@backstage/cli": "^0.0.0-nightly-20240918022959",
78
+ "@backstage/cli": "^0.0.0-nightly-20240919023143",
79
79
  "@backstage/core-app-api": "^1.15.0",
80
- "@backstage/dev-utils": "^0.0.0-nightly-20240918022959",
80
+ "@backstage/dev-utils": "^0.0.0-nightly-20240919023143",
81
81
  "@backstage/test-utils": "^1.6.0",
82
82
  "@testing-library/dom": "^10.0.0",
83
83
  "@testing-library/jest-dom": "^6.0.0",