@backstage/plugin-api-docs 0.0.0-nightly-20250218023004 → 0.0.0-nightly-20250221023113

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 (3) hide show
  1. package/CHANGELOG.md +17 -8
  2. package/dist/alpha.d.ts +40 -0
  3. package/package.json +12 -12
package/CHANGELOG.md CHANGED
@@ -1,18 +1,27 @@
1
1
  # @backstage/plugin-api-docs
2
2
 
3
- ## 0.0.0-nightly-20250218023004
3
+ ## 0.0.0-nightly-20250221023113
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+ - @backstage/plugin-catalog-react@0.0.0-nightly-20250221023113
9
+ - @backstage/plugin-catalog@0.0.0-nightly-20250221023113
10
+ - @backstage/core-compat-api@0.3.6
11
+
12
+ ## 0.12.4
4
13
 
5
14
  ### Patch Changes
6
15
 
7
16
  - 58ec9e7: Removed older versions of React packages as a preparatory step for upgrading to React 19. This commit does not introduce any functional changes, but removes dependencies on previous React versions, allowing for a cleaner upgrade path in subsequent commits.
8
17
  - Updated dependencies
9
- - @backstage/core-components@0.0.0-nightly-20250218023004
10
- - @backstage/plugin-catalog@0.0.0-nightly-20250218023004
11
- - @backstage/plugin-catalog-react@0.0.0-nightly-20250218023004
12
- - @backstage/frontend-plugin-api@0.0.0-nightly-20250218023004
13
- - @backstage/core-compat-api@0.0.0-nightly-20250218023004
14
- - @backstage/core-plugin-api@0.0.0-nightly-20250218023004
15
- - @backstage/plugin-permission-react@0.0.0-nightly-20250218023004
18
+ - @backstage/core-components@0.16.4
19
+ - @backstage/plugin-catalog@1.27.0
20
+ - @backstage/plugin-catalog-react@1.15.2
21
+ - @backstage/frontend-plugin-api@0.9.5
22
+ - @backstage/core-compat-api@0.3.6
23
+ - @backstage/core-plugin-api@1.10.4
24
+ - @backstage/plugin-permission-react@0.4.31
16
25
  - @backstage/catalog-model@1.7.3
17
26
  - @backstage/plugin-catalog-common@1.1.3
18
27
 
package/dist/alpha.d.ts CHANGED
@@ -69,19 +69,24 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
69
69
  name: "has-apis";
70
70
  config: {
71
71
  filter: string | undefined;
72
+ area: "full" | "info" | "peek" | undefined;
72
73
  };
73
74
  configInput: {
74
75
  filter?: string | undefined;
76
+ area?: "full" | "info" | "peek" | undefined;
75
77
  };
76
78
  output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
77
79
  optional: true;
78
80
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
79
81
  optional: true;
82
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<"full" | "info" | "peek", "catalog.entity-card-area", {
83
+ optional: true;
80
84
  }>;
81
85
  inputs: {};
82
86
  params: {
83
87
  loader: () => Promise<JSX.Element>;
84
88
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
89
+ defaultArea?: "full" | "info" | "peek" | undefined;
85
90
  };
86
91
  }>;
87
92
  "entity-card:api-docs/definition": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -89,19 +94,24 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
89
94
  name: "definition";
90
95
  config: {
91
96
  filter: string | undefined;
97
+ area: "full" | "info" | "peek" | undefined;
92
98
  };
93
99
  configInput: {
94
100
  filter?: string | undefined;
101
+ area?: "full" | "info" | "peek" | undefined;
95
102
  };
96
103
  output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
97
104
  optional: true;
98
105
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
99
106
  optional: true;
107
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<"full" | "info" | "peek", "catalog.entity-card-area", {
108
+ optional: true;
100
109
  }>;
101
110
  inputs: {};
102
111
  params: {
103
112
  loader: () => Promise<JSX.Element>;
104
113
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
114
+ defaultArea?: "full" | "info" | "peek" | undefined;
105
115
  };
106
116
  }>;
107
117
  "entity-card:api-docs/consumed-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -109,19 +119,24 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
109
119
  name: "consumed-apis";
110
120
  config: {
111
121
  filter: string | undefined;
122
+ area: "full" | "info" | "peek" | undefined;
112
123
  };
113
124
  configInput: {
114
125
  filter?: string | undefined;
126
+ area?: "full" | "info" | "peek" | undefined;
115
127
  };
116
128
  output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
117
129
  optional: true;
118
130
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
119
131
  optional: true;
132
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<"full" | "info" | "peek", "catalog.entity-card-area", {
133
+ optional: true;
120
134
  }>;
121
135
  inputs: {};
122
136
  params: {
123
137
  loader: () => Promise<JSX.Element>;
124
138
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
139
+ defaultArea?: "full" | "info" | "peek" | undefined;
125
140
  };
126
141
  }>;
127
142
  "entity-card:api-docs/provided-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -129,19 +144,24 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
129
144
  name: "provided-apis";
130
145
  config: {
131
146
  filter: string | undefined;
147
+ area: "full" | "info" | "peek" | undefined;
132
148
  };
133
149
  configInput: {
134
150
  filter?: string | undefined;
151
+ area?: "full" | "info" | "peek" | undefined;
135
152
  };
136
153
  output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
137
154
  optional: true;
138
155
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
139
156
  optional: true;
157
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<"full" | "info" | "peek", "catalog.entity-card-area", {
158
+ optional: true;
140
159
  }>;
141
160
  inputs: {};
142
161
  params: {
143
162
  loader: () => Promise<JSX.Element>;
144
163
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
164
+ defaultArea?: "full" | "info" | "peek" | undefined;
145
165
  };
146
166
  }>;
147
167
  "entity-card:api-docs/consuming-components": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -149,19 +169,24 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
149
169
  name: "consuming-components";
150
170
  config: {
151
171
  filter: string | undefined;
172
+ area: "full" | "info" | "peek" | undefined;
152
173
  };
153
174
  configInput: {
154
175
  filter?: string | undefined;
176
+ area?: "full" | "info" | "peek" | undefined;
155
177
  };
156
178
  output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
157
179
  optional: true;
158
180
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
159
181
  optional: true;
182
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<"full" | "info" | "peek", "catalog.entity-card-area", {
183
+ optional: true;
160
184
  }>;
161
185
  inputs: {};
162
186
  params: {
163
187
  loader: () => Promise<JSX.Element>;
164
188
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
189
+ defaultArea?: "full" | "info" | "peek" | undefined;
165
190
  };
166
191
  }>;
167
192
  "entity-card:api-docs/providing-components": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -169,19 +194,24 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
169
194
  name: "providing-components";
170
195
  config: {
171
196
  filter: string | undefined;
197
+ area: "full" | "info" | "peek" | undefined;
172
198
  };
173
199
  configInput: {
174
200
  filter?: string | undefined;
201
+ area?: "full" | "info" | "peek" | undefined;
175
202
  };
176
203
  output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
177
204
  optional: true;
178
205
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
179
206
  optional: true;
207
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<"full" | "info" | "peek", "catalog.entity-card-area", {
208
+ optional: true;
180
209
  }>;
181
210
  inputs: {};
182
211
  params: {
183
212
  loader: () => Promise<JSX.Element>;
184
213
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
214
+ defaultArea?: "full" | "info" | "peek" | undefined;
185
215
  };
186
216
  }>;
187
217
  "entity-content:api-docs/definition": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -191,11 +221,13 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
191
221
  path: string | undefined;
192
222
  title: string | undefined;
193
223
  filter: string | undefined;
224
+ group: string | false | undefined;
194
225
  };
195
226
  configInput: {
196
227
  filter?: string | undefined;
197
228
  title?: string | undefined;
198
229
  path?: string | undefined;
230
+ group?: string | false | undefined;
199
231
  };
200
232
  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", {
201
233
  optional: true;
@@ -203,12 +235,15 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
203
235
  optional: true;
204
236
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
205
237
  optional: true;
238
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string | false, "catalog.entity-content-group", {
239
+ optional: true;
206
240
  }>;
207
241
  inputs: {};
208
242
  params: {
209
243
  loader: () => Promise<JSX.Element>;
210
244
  defaultPath: string;
211
245
  defaultTitle: string;
246
+ defaultGroup?: "documentation" | "development" | "deployment" | "observability" | undefined;
212
247
  routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
213
248
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
214
249
  };
@@ -220,11 +255,13 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
220
255
  path: string | undefined;
221
256
  title: string | undefined;
222
257
  filter: string | undefined;
258
+ group: string | false | undefined;
223
259
  };
224
260
  configInput: {
225
261
  filter?: string | undefined;
226
262
  title?: string | undefined;
227
263
  path?: string | undefined;
264
+ group?: string | false | undefined;
228
265
  };
229
266
  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", {
230
267
  optional: true;
@@ -232,12 +269,15 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
232
269
  optional: true;
233
270
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
234
271
  optional: true;
272
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string | false, "catalog.entity-content-group", {
273
+ optional: true;
235
274
  }>;
236
275
  inputs: {};
237
276
  params: {
238
277
  loader: () => Promise<JSX.Element>;
239
278
  defaultPath: string;
240
279
  defaultTitle: string;
280
+ defaultGroup?: "documentation" | "development" | "deployment" | "observability" | undefined;
241
281
  routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
242
282
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
243
283
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-api-docs",
3
- "version": "0.0.0-nightly-20250218023004",
3
+ "version": "0.0.0-nightly-20250221023113",
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.7.3",
70
- "@backstage/core-compat-api": "0.0.0-nightly-20250218023004",
71
- "@backstage/core-components": "0.0.0-nightly-20250218023004",
72
- "@backstage/core-plugin-api": "0.0.0-nightly-20250218023004",
73
- "@backstage/frontend-plugin-api": "0.0.0-nightly-20250218023004",
74
- "@backstage/plugin-catalog": "0.0.0-nightly-20250218023004",
70
+ "@backstage/core-compat-api": "0.3.6",
71
+ "@backstage/core-components": "0.16.4",
72
+ "@backstage/core-plugin-api": "1.10.4",
73
+ "@backstage/frontend-plugin-api": "0.9.5",
74
+ "@backstage/plugin-catalog": "0.0.0-nightly-20250221023113",
75
75
  "@backstage/plugin-catalog-common": "1.1.3",
76
- "@backstage/plugin-catalog-react": "0.0.0-nightly-20250218023004",
77
- "@backstage/plugin-permission-react": "0.0.0-nightly-20250218023004",
76
+ "@backstage/plugin-catalog-react": "0.0.0-nightly-20250221023113",
77
+ "@backstage/plugin-permission-react": "0.4.31",
78
78
  "@graphiql/react": "^0.23.0",
79
79
  "@material-ui/core": "^4.12.2",
80
80
  "@material-ui/icons": "^4.9.1",
@@ -87,10 +87,10 @@
87
87
  "swagger-ui-react": "^5.0.0"
88
88
  },
89
89
  "devDependencies": {
90
- "@backstage/cli": "0.0.0-nightly-20250218023004",
91
- "@backstage/core-app-api": "0.0.0-nightly-20250218023004",
92
- "@backstage/dev-utils": "0.0.0-nightly-20250218023004",
93
- "@backstage/test-utils": "0.0.0-nightly-20250218023004",
90
+ "@backstage/cli": "0.30.0",
91
+ "@backstage/core-app-api": "1.15.5",
92
+ "@backstage/dev-utils": "0.0.0-nightly-20250221023113",
93
+ "@backstage/test-utils": "1.7.5",
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",