@backstage/plugin-api-docs 0.9.10 → 0.9.11-next.1
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 +11 -18
- package/dist/index.d.ts +25 -24
- package/package.json +10 -10
package/CHANGELOG.md
CHANGED
|
@@ -1,35 +1,28 @@
|
|
|
1
1
|
# @backstage/plugin-api-docs
|
|
2
2
|
|
|
3
|
-
## 0.9.
|
|
3
|
+
## 0.9.11-next.1
|
|
4
4
|
|
|
5
5
|
### Patch Changes
|
|
6
6
|
|
|
7
7
|
- Updated dependencies
|
|
8
|
-
- @backstage/plugin-catalog-react@1.8.
|
|
9
|
-
- @backstage/
|
|
10
|
-
- @backstage/
|
|
11
|
-
- @backstage/
|
|
8
|
+
- @backstage/plugin-catalog-react@1.8.4-next.1
|
|
9
|
+
- @backstage/core-components@0.13.5-next.1
|
|
10
|
+
- @backstage/plugin-catalog@1.12.5-next.1
|
|
11
|
+
- @backstage/catalog-model@1.4.2-next.0
|
|
12
|
+
- @backstage/core-plugin-api@1.6.0-next.1
|
|
12
13
|
- @backstage/theme@0.4.1
|
|
13
|
-
- @backstage/plugin-catalog@1.12.4
|
|
14
14
|
|
|
15
|
-
## 0.9.
|
|
15
|
+
## 0.9.10-next.0
|
|
16
16
|
|
|
17
17
|
### Patch Changes
|
|
18
18
|
|
|
19
19
|
- Updated dependencies
|
|
20
|
-
- @backstage/plugin-catalog
|
|
20
|
+
- @backstage/plugin-catalog@1.12.4-next.0
|
|
21
|
+
- @backstage/core-plugin-api@1.6.0-next.0
|
|
22
|
+
- @backstage/core-components@0.13.5-next.0
|
|
21
23
|
- @backstage/catalog-model@1.4.1
|
|
22
|
-
- @backstage/core-components@0.13.4
|
|
23
|
-
- @backstage/core-plugin-api@1.5.3
|
|
24
24
|
- @backstage/theme@0.4.1
|
|
25
|
-
- @backstage/plugin-catalog@1.
|
|
26
|
-
|
|
27
|
-
## 0.9.8
|
|
28
|
-
|
|
29
|
-
### Patch Changes
|
|
30
|
-
|
|
31
|
-
- Updated dependencies
|
|
32
|
-
- @backstage/plugin-catalog@1.12.2
|
|
25
|
+
- @backstage/plugin-catalog-react@1.8.3-next.0
|
|
33
26
|
|
|
34
27
|
## 0.9.7
|
|
35
28
|
|
package/dist/index.d.ts
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
|
+
import * as React from 'react';
|
|
3
|
+
import React__default from 'react';
|
|
2
4
|
import * as _backstage_core_components from '@backstage/core-components';
|
|
3
5
|
import { TableColumn, TableProps, InfoCardVariants } from '@backstage/core-components';
|
|
4
6
|
import { CatalogTableRow } from '@backstage/plugin-catalog';
|
|
5
7
|
import { UserListFilterKind } from '@backstage/plugin-catalog-react';
|
|
6
|
-
import React from 'react';
|
|
7
8
|
import { ApiEntity } from '@backstage/catalog-model';
|
|
8
9
|
import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
|
|
9
10
|
|
|
@@ -20,22 +21,22 @@ type DefaultApiExplorerPageProps = {
|
|
|
20
21
|
* DefaultApiExplorerPage
|
|
21
22
|
* @public
|
|
22
23
|
*/
|
|
23
|
-
declare const DefaultApiExplorerPage: (props: DefaultApiExplorerPageProps) => JSX.Element;
|
|
24
|
+
declare const DefaultApiExplorerPage: (props: DefaultApiExplorerPageProps) => React__default.JSX.Element;
|
|
24
25
|
|
|
25
26
|
/**
|
|
26
27
|
* ApiExplorerPage
|
|
27
28
|
* @public
|
|
28
29
|
*/
|
|
29
|
-
declare const ApiExplorerPage$1: (props: DefaultApiExplorerPageProps) => JSX.Element;
|
|
30
|
+
declare const ApiExplorerPage$1: (props: DefaultApiExplorerPageProps) => React__default.JSX.Element;
|
|
30
31
|
|
|
31
32
|
/** @public */
|
|
32
|
-
declare const ApiDefinitionCard: () => JSX.Element;
|
|
33
|
+
declare const ApiDefinitionCard: () => React__default.JSX.Element;
|
|
33
34
|
|
|
34
35
|
/** @public */
|
|
35
36
|
type ApiDefinitionWidget = {
|
|
36
37
|
type: string;
|
|
37
38
|
title: string;
|
|
38
|
-
component: (definition: string) =>
|
|
39
|
+
component: (definition: string) => React__default.ReactElement;
|
|
39
40
|
rawLanguage?: string;
|
|
40
41
|
};
|
|
41
42
|
/** @public */
|
|
@@ -46,7 +47,7 @@ declare function defaultDefinitionWidgets(): ApiDefinitionWidget[];
|
|
|
46
47
|
*/
|
|
47
48
|
declare const ApiTypeTitle: (props: {
|
|
48
49
|
apiEntity: ApiEntity;
|
|
49
|
-
}) => JSX.Element;
|
|
50
|
+
}) => React__default.JSX.Element;
|
|
50
51
|
|
|
51
52
|
/**
|
|
52
53
|
* A dialog that lets users inspect the API definition.
|
|
@@ -57,7 +58,7 @@ declare function ApiDefinitionDialog(props: {
|
|
|
57
58
|
open: boolean;
|
|
58
59
|
entity: ApiEntity;
|
|
59
60
|
onClose: () => void;
|
|
60
|
-
}): JSX.Element;
|
|
61
|
+
}): React__default.JSX.Element;
|
|
61
62
|
|
|
62
63
|
/**
|
|
63
64
|
* @public
|
|
@@ -65,7 +66,7 @@ declare function ApiDefinitionDialog(props: {
|
|
|
65
66
|
declare const ConsumedApisCard: (props: {
|
|
66
67
|
variant?: InfoCardVariants;
|
|
67
68
|
columns?: TableColumn<ApiEntity>[];
|
|
68
|
-
}) => JSX.Element;
|
|
69
|
+
}) => React__default.JSX.Element;
|
|
69
70
|
|
|
70
71
|
/**
|
|
71
72
|
* @public
|
|
@@ -73,7 +74,7 @@ declare const ConsumedApisCard: (props: {
|
|
|
73
74
|
declare const HasApisCard: (props: {
|
|
74
75
|
variant?: InfoCardVariants;
|
|
75
76
|
columns?: TableColumn<ApiEntity>[];
|
|
76
|
-
}) => JSX.Element;
|
|
77
|
+
}) => React__default.JSX.Element;
|
|
77
78
|
|
|
78
79
|
/**
|
|
79
80
|
* @public
|
|
@@ -81,40 +82,40 @@ declare const HasApisCard: (props: {
|
|
|
81
82
|
declare const ProvidedApisCard: (props: {
|
|
82
83
|
variant?: InfoCardVariants;
|
|
83
84
|
columns?: TableColumn<ApiEntity>[];
|
|
84
|
-
}) => JSX.Element;
|
|
85
|
+
}) => React__default.JSX.Element;
|
|
85
86
|
|
|
86
87
|
/** @public */
|
|
87
88
|
type AsyncApiDefinitionWidgetProps = {
|
|
88
89
|
definition: string;
|
|
89
90
|
};
|
|
90
91
|
/** @public */
|
|
91
|
-
declare const AsyncApiDefinitionWidget: (props: AsyncApiDefinitionWidgetProps) => JSX.Element;
|
|
92
|
+
declare const AsyncApiDefinitionWidget: (props: AsyncApiDefinitionWidgetProps) => React__default.JSX.Element;
|
|
92
93
|
|
|
93
94
|
/**
|
|
94
95
|
* @public
|
|
95
96
|
*/
|
|
96
97
|
declare const ConsumingComponentsCard: (props: {
|
|
97
98
|
variant?: InfoCardVariants;
|
|
98
|
-
}) => JSX.Element;
|
|
99
|
+
}) => React__default.JSX.Element;
|
|
99
100
|
|
|
100
101
|
/** @public */
|
|
101
102
|
declare const ProvidingComponentsCard: (props: {
|
|
102
103
|
variant?: InfoCardVariants;
|
|
103
|
-
}) => JSX.Element;
|
|
104
|
+
}) => React__default.JSX.Element;
|
|
104
105
|
|
|
105
106
|
/** @public */
|
|
106
107
|
type GraphQlDefinitionWidgetProps = {
|
|
107
108
|
definition: string;
|
|
108
109
|
};
|
|
109
110
|
/** @public */
|
|
110
|
-
declare const GraphQlDefinitionWidget: (props: GraphQlDefinitionWidgetProps) => JSX.Element;
|
|
111
|
+
declare const GraphQlDefinitionWidget: (props: GraphQlDefinitionWidgetProps) => React__default.JSX.Element;
|
|
111
112
|
|
|
112
113
|
/** @public */
|
|
113
114
|
type OpenApiDefinitionWidgetProps = {
|
|
114
115
|
definition: string;
|
|
115
116
|
};
|
|
116
117
|
/** @public */
|
|
117
|
-
declare const OpenApiDefinitionWidget: (props: OpenApiDefinitionWidgetProps) => JSX.Element;
|
|
118
|
+
declare const OpenApiDefinitionWidget: (props: OpenApiDefinitionWidgetProps) => React__default.JSX.Element;
|
|
118
119
|
|
|
119
120
|
/** @public */
|
|
120
121
|
type PlainApiDefinitionWidgetProps = {
|
|
@@ -122,14 +123,14 @@ type PlainApiDefinitionWidgetProps = {
|
|
|
122
123
|
language: string;
|
|
123
124
|
};
|
|
124
125
|
/** @public */
|
|
125
|
-
declare const PlainApiDefinitionWidget: (props: PlainApiDefinitionWidgetProps) => JSX.Element;
|
|
126
|
+
declare const PlainApiDefinitionWidget: (props: PlainApiDefinitionWidgetProps) => React__default.JSX.Element;
|
|
126
127
|
|
|
127
128
|
/** @public */
|
|
128
129
|
type TrpcApiDefinitionWidgetProps = {
|
|
129
130
|
definition: string;
|
|
130
131
|
};
|
|
131
132
|
/** @public */
|
|
132
|
-
declare const TrpcApiDefinitionWidget: (props: TrpcApiDefinitionWidgetProps) => JSX.Element;
|
|
133
|
+
declare const TrpcApiDefinitionWidget: (props: TrpcApiDefinitionWidgetProps) => React__default.JSX.Element;
|
|
133
134
|
|
|
134
135
|
/** @public */
|
|
135
136
|
declare const apiDocsConfigRef: _backstage_core_plugin_api.ApiRef<ApiDocsConfig>;
|
|
@@ -145,31 +146,31 @@ declare const apiDocsPlugin: _backstage_core_plugin_api.BackstagePlugin<{
|
|
|
145
146
|
registerApi: _backstage_core_plugin_api.ExternalRouteRef<undefined, true>;
|
|
146
147
|
}, {}>;
|
|
147
148
|
/** @public */
|
|
148
|
-
declare const ApiExplorerPage: (props: DefaultApiExplorerPageProps) => JSX.Element;
|
|
149
|
+
declare const ApiExplorerPage: (props: DefaultApiExplorerPageProps) => React.JSX.Element;
|
|
149
150
|
/** @public */
|
|
150
|
-
declare const EntityApiDefinitionCard: () => JSX.Element;
|
|
151
|
+
declare const EntityApiDefinitionCard: () => React.JSX.Element;
|
|
151
152
|
/** @public */
|
|
152
153
|
declare const EntityConsumedApisCard: (props: {
|
|
153
154
|
variant?: _backstage_core_components.InfoCardVariants | undefined;
|
|
154
155
|
columns?: _backstage_core_components.TableColumn<ApiEntity>[] | undefined;
|
|
155
|
-
}) => JSX.Element;
|
|
156
|
+
}) => React.JSX.Element;
|
|
156
157
|
/** @public */
|
|
157
158
|
declare const EntityConsumingComponentsCard: (props: {
|
|
158
159
|
variant?: _backstage_core_components.InfoCardVariants | undefined;
|
|
159
|
-
}) => JSX.Element;
|
|
160
|
+
}) => React.JSX.Element;
|
|
160
161
|
/** @public */
|
|
161
162
|
declare const EntityProvidedApisCard: (props: {
|
|
162
163
|
variant?: _backstage_core_components.InfoCardVariants | undefined;
|
|
163
164
|
columns?: _backstage_core_components.TableColumn<ApiEntity>[] | undefined;
|
|
164
|
-
}) => JSX.Element;
|
|
165
|
+
}) => React.JSX.Element;
|
|
165
166
|
/** @public */
|
|
166
167
|
declare const EntityProvidingComponentsCard: (props: {
|
|
167
168
|
variant?: _backstage_core_components.InfoCardVariants | undefined;
|
|
168
|
-
}) => JSX.Element;
|
|
169
|
+
}) => React.JSX.Element;
|
|
169
170
|
/** @public */
|
|
170
171
|
declare const EntityHasApisCard: (props: {
|
|
171
172
|
variant?: _backstage_core_components.InfoCardVariants | undefined;
|
|
172
173
|
columns?: _backstage_core_components.TableColumn<ApiEntity>[] | undefined;
|
|
173
|
-
}) => JSX.Element;
|
|
174
|
+
}) => React.JSX.Element;
|
|
174
175
|
|
|
175
176
|
export { ApiDefinitionCard, ApiDefinitionDialog, ApiDefinitionWidget, ApiDocsConfig, ApiExplorerPage$1 as ApiExplorerIndexPage, ApiExplorerPage, ApiTypeTitle, AsyncApiDefinitionWidget, AsyncApiDefinitionWidgetProps, ConsumedApisCard, ConsumingComponentsCard, DefaultApiExplorerPage, DefaultApiExplorerPageProps, EntityApiDefinitionCard, EntityConsumedApisCard, EntityConsumingComponentsCard, EntityHasApisCard, EntityProvidedApisCard, EntityProvidingComponentsCard, GraphQlDefinitionWidget, GraphQlDefinitionWidgetProps, HasApisCard, OpenApiDefinitionWidget, OpenApiDefinitionWidgetProps, PlainApiDefinitionWidget, PlainApiDefinitionWidgetProps, ProvidedApisCard, ProvidingComponentsCard, TrpcApiDefinitionWidget, TrpcApiDefinitionWidgetProps, apiDocsConfigRef, apiDocsPlugin, defaultDefinitionWidgets, apiDocsPlugin as plugin };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-api-docs",
|
|
3
3
|
"description": "A Backstage plugin that helps represent API entities in the frontend",
|
|
4
|
-
"version": "0.9.
|
|
4
|
+
"version": "0.9.11-next.1",
|
|
5
5
|
"main": "dist/index.esm.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"license": "Apache-2.0",
|
|
@@ -33,11 +33,11 @@
|
|
|
33
33
|
},
|
|
34
34
|
"dependencies": {
|
|
35
35
|
"@asyncapi/react-component": "1.0.0-next.48",
|
|
36
|
-
"@backstage/catalog-model": "^1.4.
|
|
37
|
-
"@backstage/core-components": "^0.13.
|
|
38
|
-
"@backstage/core-plugin-api": "^1.
|
|
39
|
-
"@backstage/plugin-catalog": "^1.12.
|
|
40
|
-
"@backstage/plugin-catalog-react": "^1.8.
|
|
36
|
+
"@backstage/catalog-model": "^1.4.2-next.0",
|
|
37
|
+
"@backstage/core-components": "^0.13.5-next.1",
|
|
38
|
+
"@backstage/core-plugin-api": "^1.6.0-next.1",
|
|
39
|
+
"@backstage/plugin-catalog": "^1.12.5-next.1",
|
|
40
|
+
"@backstage/plugin-catalog-react": "^1.8.4-next.1",
|
|
41
41
|
"@backstage/theme": "^0.4.1",
|
|
42
42
|
"@material-ui/core": "^4.12.2",
|
|
43
43
|
"@material-ui/icons": "^4.9.1",
|
|
@@ -56,10 +56,10 @@
|
|
|
56
56
|
"react-router-dom": "6.0.0-beta.0 || ^6.3.0"
|
|
57
57
|
},
|
|
58
58
|
"devDependencies": {
|
|
59
|
-
"@backstage/cli": "^0.22.
|
|
60
|
-
"@backstage/core-app-api": "^1.
|
|
61
|
-
"@backstage/dev-utils": "^1.0.
|
|
62
|
-
"@backstage/test-utils": "^1.4.
|
|
59
|
+
"@backstage/cli": "^0.22.13-next.1",
|
|
60
|
+
"@backstage/core-app-api": "^1.10.0-next.1",
|
|
61
|
+
"@backstage/dev-utils": "^1.0.21-next.1",
|
|
62
|
+
"@backstage/test-utils": "^1.4.3-next.1",
|
|
63
63
|
"@testing-library/dom": "^8.0.0",
|
|
64
64
|
"@testing-library/jest-dom": "^5.10.1",
|
|
65
65
|
"@testing-library/react": "^12.1.3",
|