@backstage/plugin-api-docs 0.12.4 → 0.12.5-next.0

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 +10 -0
  2. package/dist/alpha.d.ts +41 -0
  3. package/package.json +14 -14
package/CHANGELOG.md CHANGED
@@ -1,5 +1,15 @@
1
1
  # @backstage/plugin-api-docs
2
2
 
3
+ ## 0.12.5-next.0
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+ - @backstage/plugin-catalog-react@1.16.0-next.0
9
+ - @backstage/plugin-catalog@1.28.0-next.0
10
+ - @backstage/frontend-plugin-api@0.9.6-next.0
11
+ - @backstage/core-compat-api@0.3.7-next.0
12
+
3
13
  ## 0.12.4
4
14
 
5
15
  ### Patch Changes
package/dist/alpha.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ import * as _backstage_plugin_catalog_react_alpha from '@backstage/plugin-catalog-react/alpha';
1
2
  import * as _backstage_catalog_model from '@backstage/catalog-model';
2
3
  import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
3
4
  import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
@@ -69,19 +70,24 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
69
70
  name: "has-apis";
70
71
  config: {
71
72
  filter: string | undefined;
73
+ type: "full" | "info" | "peek" | undefined;
72
74
  };
73
75
  configInput: {
74
76
  filter?: string | undefined;
77
+ type?: "full" | "info" | "peek" | undefined;
75
78
  };
76
79
  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
80
  optional: true;
78
81
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
79
82
  optional: true;
83
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_plugin_catalog_react_alpha.EntityCardType, "catalog.entity-card-type", {
84
+ optional: true;
80
85
  }>;
81
86
  inputs: {};
82
87
  params: {
83
88
  loader: () => Promise<JSX.Element>;
84
89
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
90
+ type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
85
91
  };
86
92
  }>;
87
93
  "entity-card:api-docs/definition": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -89,19 +95,24 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
89
95
  name: "definition";
90
96
  config: {
91
97
  filter: string | undefined;
98
+ type: "full" | "info" | "peek" | undefined;
92
99
  };
93
100
  configInput: {
94
101
  filter?: string | undefined;
102
+ type?: "full" | "info" | "peek" | undefined;
95
103
  };
96
104
  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
105
  optional: true;
98
106
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
99
107
  optional: true;
108
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_plugin_catalog_react_alpha.EntityCardType, "catalog.entity-card-type", {
109
+ optional: true;
100
110
  }>;
101
111
  inputs: {};
102
112
  params: {
103
113
  loader: () => Promise<JSX.Element>;
104
114
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
115
+ type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
105
116
  };
106
117
  }>;
107
118
  "entity-card:api-docs/consumed-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -109,19 +120,24 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
109
120
  name: "consumed-apis";
110
121
  config: {
111
122
  filter: string | undefined;
123
+ type: "full" | "info" | "peek" | undefined;
112
124
  };
113
125
  configInput: {
114
126
  filter?: string | undefined;
127
+ type?: "full" | "info" | "peek" | undefined;
115
128
  };
116
129
  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
130
  optional: true;
118
131
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
119
132
  optional: true;
133
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_plugin_catalog_react_alpha.EntityCardType, "catalog.entity-card-type", {
134
+ optional: true;
120
135
  }>;
121
136
  inputs: {};
122
137
  params: {
123
138
  loader: () => Promise<JSX.Element>;
124
139
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
140
+ type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
125
141
  };
126
142
  }>;
127
143
  "entity-card:api-docs/provided-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -129,19 +145,24 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
129
145
  name: "provided-apis";
130
146
  config: {
131
147
  filter: string | undefined;
148
+ type: "full" | "info" | "peek" | undefined;
132
149
  };
133
150
  configInput: {
134
151
  filter?: string | undefined;
152
+ type?: "full" | "info" | "peek" | undefined;
135
153
  };
136
154
  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
155
  optional: true;
138
156
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
139
157
  optional: true;
158
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_plugin_catalog_react_alpha.EntityCardType, "catalog.entity-card-type", {
159
+ optional: true;
140
160
  }>;
141
161
  inputs: {};
142
162
  params: {
143
163
  loader: () => Promise<JSX.Element>;
144
164
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
165
+ type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
145
166
  };
146
167
  }>;
147
168
  "entity-card:api-docs/consuming-components": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -149,19 +170,24 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
149
170
  name: "consuming-components";
150
171
  config: {
151
172
  filter: string | undefined;
173
+ type: "full" | "info" | "peek" | undefined;
152
174
  };
153
175
  configInput: {
154
176
  filter?: string | undefined;
177
+ type?: "full" | "info" | "peek" | undefined;
155
178
  };
156
179
  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
180
  optional: true;
158
181
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
159
182
  optional: true;
183
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_plugin_catalog_react_alpha.EntityCardType, "catalog.entity-card-type", {
184
+ optional: true;
160
185
  }>;
161
186
  inputs: {};
162
187
  params: {
163
188
  loader: () => Promise<JSX.Element>;
164
189
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
190
+ type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
165
191
  };
166
192
  }>;
167
193
  "entity-card:api-docs/providing-components": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -169,19 +195,24 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
169
195
  name: "providing-components";
170
196
  config: {
171
197
  filter: string | undefined;
198
+ type: "full" | "info" | "peek" | undefined;
172
199
  };
173
200
  configInput: {
174
201
  filter?: string | undefined;
202
+ type?: "full" | "info" | "peek" | undefined;
175
203
  };
176
204
  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
205
  optional: true;
178
206
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
179
207
  optional: true;
208
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_plugin_catalog_react_alpha.EntityCardType, "catalog.entity-card-type", {
209
+ optional: true;
180
210
  }>;
181
211
  inputs: {};
182
212
  params: {
183
213
  loader: () => Promise<JSX.Element>;
184
214
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
215
+ type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
185
216
  };
186
217
  }>;
187
218
  "entity-content:api-docs/definition": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -191,11 +222,13 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
191
222
  path: string | undefined;
192
223
  title: string | undefined;
193
224
  filter: string | undefined;
225
+ group: string | false | undefined;
194
226
  };
195
227
  configInput: {
196
228
  filter?: string | undefined;
197
229
  title?: string | undefined;
198
230
  path?: string | undefined;
231
+ group?: string | false | undefined;
199
232
  };
200
233
  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
234
  optional: true;
@@ -203,12 +236,15 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
203
236
  optional: true;
204
237
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
205
238
  optional: true;
239
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-content-group", {
240
+ optional: true;
206
241
  }>;
207
242
  inputs: {};
208
243
  params: {
209
244
  loader: () => Promise<JSX.Element>;
210
245
  defaultPath: string;
211
246
  defaultTitle: string;
247
+ defaultGroup?: (string & {}) | "documentation" | "development" | "deployment" | "observability" | undefined;
212
248
  routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
213
249
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
214
250
  };
@@ -220,11 +256,13 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
220
256
  path: string | undefined;
221
257
  title: string | undefined;
222
258
  filter: string | undefined;
259
+ group: string | false | undefined;
223
260
  };
224
261
  configInput: {
225
262
  filter?: string | undefined;
226
263
  title?: string | undefined;
227
264
  path?: string | undefined;
265
+ group?: string | false | undefined;
228
266
  };
229
267
  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
268
  optional: true;
@@ -232,12 +270,15 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
232
270
  optional: true;
233
271
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
234
272
  optional: true;
273
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-content-group", {
274
+ optional: true;
235
275
  }>;
236
276
  inputs: {};
237
277
  params: {
238
278
  loader: () => Promise<JSX.Element>;
239
279
  defaultPath: string;
240
280
  defaultTitle: string;
281
+ defaultGroup?: (string & {}) | "documentation" | "development" | "deployment" | "observability" | undefined;
241
282
  routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
242
283
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
243
284
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-api-docs",
3
- "version": "0.12.4",
3
+ "version": "0.12.5-next.0",
4
4
  "description": "A Backstage plugin that helps represent API entities in the frontend",
5
5
  "backstage": {
6
6
  "role": "frontend-plugin",
@@ -66,15 +66,15 @@
66
66
  },
67
67
  "dependencies": {
68
68
  "@asyncapi/react-component": "^2.3.3",
69
- "@backstage/catalog-model": "^1.7.3",
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": "^1.27.0",
75
- "@backstage/plugin-catalog-common": "^1.1.3",
76
- "@backstage/plugin-catalog-react": "^1.15.2",
77
- "@backstage/plugin-permission-react": "^0.4.31",
69
+ "@backstage/catalog-model": "1.7.3",
70
+ "@backstage/core-compat-api": "0.3.7-next.0",
71
+ "@backstage/core-components": "0.16.4",
72
+ "@backstage/core-plugin-api": "1.10.4",
73
+ "@backstage/frontend-plugin-api": "0.9.6-next.0",
74
+ "@backstage/plugin-catalog": "1.28.0-next.0",
75
+ "@backstage/plugin-catalog-common": "1.1.3",
76
+ "@backstage/plugin-catalog-react": "1.16.0-next.0",
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.30.0",
91
- "@backstage/core-app-api": "^1.15.5",
92
- "@backstage/dev-utils": "^1.1.7",
93
- "@backstage/test-utils": "^1.7.5",
90
+ "@backstage/cli": "0.30.0",
91
+ "@backstage/core-app-api": "1.15.5",
92
+ "@backstage/dev-utils": "1.1.8-next.0",
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",