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