@backstage/plugin-catalog-backend-module-backstage-openapi 0.1.11-next.0 → 0.2.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.
- package/CHANGELOG.md +31 -0
- package/README.md +10 -4
- package/config.d.ts +4 -0
- package/dist/index.cjs.js +24 -26
- package/dist/index.cjs.js.map +1 -1
- package/package.json +7 -6
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,36 @@
|
|
|
1
1
|
# @backstage/plugin-catalog-backend-module-backstage-openapi
|
|
2
2
|
|
|
3
|
+
## 0.2.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 2e2167a: The name and title of the returned openapi doc entity are now configurable
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- 58763e8: Use direct access of openapi.json files and not external route
|
|
12
|
+
- Updated dependencies
|
|
13
|
+
- @backstage/backend-plugin-api@0.6.17
|
|
14
|
+
- @backstage/backend-tasks@0.5.22
|
|
15
|
+
- @backstage/plugin-catalog-node@1.11.1
|
|
16
|
+
- @backstage/backend-openapi-utils@0.1.10
|
|
17
|
+
- @backstage/catalog-model@1.4.5
|
|
18
|
+
- @backstage/config@1.2.0
|
|
19
|
+
- @backstage/errors@1.2.4
|
|
20
|
+
|
|
21
|
+
## 0.1.11-next.1
|
|
22
|
+
|
|
23
|
+
### Patch Changes
|
|
24
|
+
|
|
25
|
+
- Updated dependencies
|
|
26
|
+
- @backstage/backend-plugin-api@0.6.17-next.1
|
|
27
|
+
- @backstage/backend-tasks@0.5.22-next.1
|
|
28
|
+
- @backstage/backend-openapi-utils@0.1.10-next.1
|
|
29
|
+
- @backstage/catalog-model@1.4.5
|
|
30
|
+
- @backstage/config@1.2.0
|
|
31
|
+
- @backstage/errors@1.2.4
|
|
32
|
+
- @backstage/plugin-catalog-node@1.11.1-next.1
|
|
33
|
+
|
|
3
34
|
## 0.1.11-next.0
|
|
4
35
|
|
|
5
36
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## Summary
|
|
4
4
|
|
|
5
|
-
This module installs an entity provider that exports a single entity, your Backstage instance documentation, which merges as many backend plugins as you have defined in the config value `catalog.providers.
|
|
5
|
+
This module installs an entity provider that exports a single entity, your Backstage instance documentation, which merges as many backend plugins as you have defined in the config value `catalog.providers.backstageOpenapi.plugins`.
|
|
6
6
|
|
|
7
7
|
## Notes
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ This module installs an entity provider that exports a single entity, your Backs
|
|
|
10
10
|
|
|
11
11
|
## Installation
|
|
12
12
|
|
|
13
|
-
To your new backend file, add
|
|
13
|
+
To your new backend file, add:
|
|
14
14
|
|
|
15
15
|
```ts title="packages/backend/src/index.ts"
|
|
16
16
|
backend.add(
|
|
@@ -18,16 +18,22 @@ backend.add(
|
|
|
18
18
|
);
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Add a list of plugins to your config
|
|
21
|
+
Add a list of plugins and optional entity overrides to your config. For example:
|
|
22
22
|
|
|
23
23
|
```yaml title="app-config.yaml"
|
|
24
24
|
catalog:
|
|
25
25
|
providers:
|
|
26
|
-
|
|
26
|
+
backstageOpenapi:
|
|
27
27
|
plugins:
|
|
28
28
|
- catalog
|
|
29
29
|
- todo
|
|
30
30
|
- search
|
|
31
|
+
entityOverrides: # All optional
|
|
32
|
+
metadata:
|
|
33
|
+
name: 'my name'
|
|
34
|
+
title: 'my title'
|
|
35
|
+
spec:
|
|
36
|
+
owner: 'my team'
|
|
31
37
|
```
|
|
32
38
|
|
|
33
39
|
We will attempt to load each plugin's OpenAPI spec hosted at `${pluginRoute}/openapi.json`. These are automatically added if you are using `@backstage/backend-openapi-utils`'s `createValidatedOpenApiRouter`.
|
package/config.d.ts
CHANGED
|
@@ -25,6 +25,10 @@ export interface Config {
|
|
|
25
25
|
* A list of plugins, whose OpenAPI specs you want to collate in `InternalOpenApiDocumentationProvider`.
|
|
26
26
|
*/
|
|
27
27
|
plugins: string[];
|
|
28
|
+
/**
|
|
29
|
+
* Properties to override on the final entity object.
|
|
30
|
+
*/
|
|
31
|
+
entityOverrides?: object;
|
|
28
32
|
};
|
|
29
33
|
};
|
|
30
34
|
};
|
package/dist/index.cjs.js
CHANGED
|
@@ -10,29 +10,13 @@ var openapiMerge = require('openapi-merge');
|
|
|
10
10
|
var backendOpenapiUtils = require('@backstage/backend-openapi-utils');
|
|
11
11
|
var fetch = require('cross-fetch');
|
|
12
12
|
var uuid = require('uuid');
|
|
13
|
+
var lodash = require('lodash');
|
|
13
14
|
|
|
14
15
|
function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
|
|
15
16
|
|
|
16
|
-
function _interopNamespaceCompat(e) {
|
|
17
|
-
if (e && typeof e === 'object' && 'default' in e) return e;
|
|
18
|
-
var n = Object.create(null);
|
|
19
|
-
if (e) {
|
|
20
|
-
Object.keys(e).forEach(function (k) {
|
|
21
|
-
if (k !== 'default') {
|
|
22
|
-
var d = Object.getOwnPropertyDescriptor(e, k);
|
|
23
|
-
Object.defineProperty(n, k, d.get ? d : {
|
|
24
|
-
enumerable: true,
|
|
25
|
-
get: function () { return e[k]; }
|
|
26
|
-
});
|
|
27
|
-
}
|
|
28
|
-
});
|
|
29
|
-
}
|
|
30
|
-
n.default = e;
|
|
31
|
-
return Object.freeze(n);
|
|
32
|
-
}
|
|
33
|
-
|
|
34
17
|
var fetch__default = /*#__PURE__*/_interopDefaultCompat(fetch);
|
|
35
|
-
var
|
|
18
|
+
var uuid__default = /*#__PURE__*/_interopDefaultCompat(uuid);
|
|
19
|
+
var lodash__default = /*#__PURE__*/_interopDefaultCompat(lodash);
|
|
36
20
|
|
|
37
21
|
var __defProp = Object.defineProperty;
|
|
38
22
|
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
@@ -181,7 +165,7 @@ class InternalOpenApiDocumentationProvider {
|
|
|
181
165
|
const logger = this.logger.child({
|
|
182
166
|
class: InternalOpenApiDocumentationProvider.prototype.constructor.name,
|
|
183
167
|
taskId,
|
|
184
|
-
taskInstanceId:
|
|
168
|
+
taskInstanceId: uuid__default.default.v4()
|
|
185
169
|
});
|
|
186
170
|
try {
|
|
187
171
|
await this.refresh(logger);
|
|
@@ -197,13 +181,24 @@ class InternalOpenApiDocumentationProvider {
|
|
|
197
181
|
const pluginsToMerge = this.config.getStringArray(
|
|
198
182
|
"catalog.providers.backstageOpenapi.plugins"
|
|
199
183
|
);
|
|
200
|
-
|
|
201
|
-
|
|
184
|
+
const configToMerge = this.config.getOptional(
|
|
185
|
+
"catalog.providers.backstageOpenapi.entityOverrides"
|
|
186
|
+
);
|
|
187
|
+
const baseConfig = {
|
|
188
|
+
metadata: {
|
|
189
|
+
name: "internal_backstage_openapi_doc",
|
|
190
|
+
title: "Backstage API"
|
|
191
|
+
},
|
|
192
|
+
spec: {
|
|
193
|
+
lifecycle: "production",
|
|
194
|
+
owner: "backstage"
|
|
195
|
+
}
|
|
196
|
+
};
|
|
197
|
+
logger.info(`Loading specs from ${pluginsToMerge}.`);
|
|
198
|
+
const requiredConfig = {
|
|
202
199
|
apiVersion: "backstage.io/v1beta1",
|
|
203
200
|
kind: "API",
|
|
204
201
|
metadata: {
|
|
205
|
-
name: "INTERNAL_instance_openapi_doc",
|
|
206
|
-
title: "Your Backstage Instance documentation",
|
|
207
202
|
annotations: {
|
|
208
203
|
[catalogModel.ANNOTATION_LOCATION]: "internal-package:@backstage/plugin-catalog-backend-module-backstage-openapi",
|
|
209
204
|
[catalogModel.ANNOTATION_ORIGIN_LOCATION]: "internal-package:@backstage/plugin-catalog-backend-module-backstage-openapi"
|
|
@@ -211,8 +206,6 @@ class InternalOpenApiDocumentationProvider {
|
|
|
211
206
|
},
|
|
212
207
|
spec: {
|
|
213
208
|
type: "openapi",
|
|
214
|
-
lifecycle: "production",
|
|
215
|
-
owner: "backstage",
|
|
216
209
|
definition: JSON.stringify(
|
|
217
210
|
await loadSpecs({
|
|
218
211
|
baseUrl: this.config.getString("backend.baseUrl"),
|
|
@@ -224,6 +217,11 @@ class InternalOpenApiDocumentationProvider {
|
|
|
224
217
|
)
|
|
225
218
|
}
|
|
226
219
|
};
|
|
220
|
+
const mergedConfig = lodash__default.default.merge(baseConfig, configToMerge);
|
|
221
|
+
const documentationEntity = lodash__default.default.merge(
|
|
222
|
+
mergedConfig,
|
|
223
|
+
requiredConfig
|
|
224
|
+
);
|
|
227
225
|
await ((_a = this.connection) == null ? void 0 : _a.applyMutation({
|
|
228
226
|
type: "full",
|
|
229
227
|
entities: [
|
package/dist/index.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs.js","sources":["../src/InternalOpenApiDocumentationProvider.ts","../src/index.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n ANNOTATION_LOCATION,\n ANNOTATION_ORIGIN_LOCATION,\n type ApiEntity,\n} from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { ForwardedError } from '@backstage/errors';\nimport {\n EntityProvider,\n EntityProviderConnection,\n} from '@backstage/plugin-catalog-node';\nimport { merge, isErrorResult } from 'openapi-merge';\nimport { getOpenApiSpecRoute } from '@backstage/backend-openapi-utils';\nimport type {\n OpenAPIObject,\n OperationObject,\n PathItemObject,\n} from 'openapi3-ts';\nimport fetch from 'cross-fetch';\nimport {\n AuthService,\n DiscoveryService,\n LoggerService,\n} from '@backstage/backend-plugin-api';\nimport * as uuid from 'uuid';\nimport { PluginTaskScheduler, TaskRunner } from '@backstage/backend-tasks';\n\nconst HTTP_VERBS: (keyof PathItemObject)[] = [\n 'get',\n 'post',\n 'put',\n 'delete',\n 'patch',\n 'trace',\n 'options',\n 'head',\n];\n\nconst addTagsToSpec = (spec: OpenAPIObject, tag: string) => {\n Object.values(spec?.paths).forEach((path: PathItemObject) => {\n HTTP_VERBS.forEach(verb => {\n if (verb in path) {\n if (!('tags' in path[verb])) {\n (path[verb] as OperationObject).tags = [];\n }\n if (!(path[verb] as OperationObject).tags?.includes(tag)) {\n (path[verb] as OperationObject).tags?.push(tag);\n }\n }\n });\n });\n};\n\nconst mergeSpecs = async ({\n baseUrl,\n specs,\n}: {\n baseUrl: string;\n specs: OpenAPIObject[];\n}) => {\n const mergeResult = merge([\n // Add the full API information as the first item for other items to merge against it with.\n {\n oas: {\n openapi: '3.0.3',\n info: {\n title: 'Backstage API',\n version: '1',\n },\n servers: [{ url: baseUrl }],\n paths: {},\n },\n },\n // For each plugin, load its spec and the known endpoint that it sits under.\n ...specs.map(\n spec =>\n ({\n oas: spec,\n // Weird typing differences between this package and the client package's openapi 3.\n } as any),\n ),\n ]);\n\n if (isErrorResult(mergeResult)) {\n throw new ForwardedError(\n `${mergeResult.message} (${mergeResult.type})`,\n mergeResult,\n );\n } else {\n return mergeResult.output;\n }\n};\n\nconst loadSpecs = async ({\n baseUrl,\n discovery,\n plugins,\n logger,\n auth,\n}: {\n baseUrl: string;\n plugins: string[];\n discovery: DiscoveryService;\n logger: LoggerService;\n auth: AuthService;\n}) => {\n const specs: OpenAPIObject[] = [];\n for (const pluginId of plugins) {\n const url = await discovery.getBaseUrl(pluginId);\n const openApiUrl = getOpenApiSpecRoute(url);\n const { token } = await auth.getPluginRequestToken({\n onBehalfOf: await auth.getOwnServiceCredentials(),\n targetPluginId: pluginId,\n });\n const response = await fetch(openApiUrl, {\n method: 'GET',\n headers: {\n Authorization: `Bearer ${token}`,\n },\n });\n if (response.ok) {\n const spec = await response.json();\n addTagsToSpec(spec, pluginId);\n specs.push(spec);\n } else if (response.status === 404) {\n logger.error(\n `Plugin=${pluginId} does not have an OpenAPI spec at '${openApiUrl}'.`,\n );\n } else {\n logger.error(\n `Failed to load spec for plugin=${pluginId} at ${openApiUrl}. Error (${\n response.status\n }): ${response.body ? await response.text() : response.statusText}`,\n );\n }\n }\n return mergeSpecs({ baseUrl, specs });\n};\n\nexport class InternalOpenApiDocumentationProvider implements EntityProvider {\n private connection?: EntityProviderConnection;\n private readonly scheduleFn: () => Promise<void>;\n\n constructor(\n public readonly config: Config,\n public readonly discovery: DiscoveryService,\n public readonly logger: LoggerService,\n public readonly auth: AuthService,\n taskRunner: TaskRunner,\n ) {\n this.scheduleFn = this.createScheduleFn(taskRunner);\n }\n\n static fromConfig(\n config: Config,\n options: {\n discovery: DiscoveryService;\n logger: LoggerService;\n schedule: PluginTaskScheduler;\n auth: AuthService;\n },\n ) {\n const taskRunner = options.schedule.createScheduledTaskRunner({\n frequency: {\n minutes: 1,\n },\n timeout: {\n minutes: 1,\n },\n });\n return new InternalOpenApiDocumentationProvider(\n config,\n options.discovery,\n options.logger,\n options.auth,\n taskRunner,\n );\n }\n /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */\n getProviderName() {\n return `InternalOpenApiDocumentationProvider`;\n }\n\n /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */\n async connect(connection: EntityProviderConnection) {\n this.connection = connection;\n return await this.scheduleFn();\n }\n\n private createScheduleFn(taskRunner: TaskRunner): () => Promise<void> {\n return async () => {\n const taskId = `${this.getProviderName()}:refresh`;\n return taskRunner.run({\n id: taskId,\n fn: async () => {\n const logger = this.logger.child({\n class:\n InternalOpenApiDocumentationProvider.prototype.constructor.name,\n taskId,\n taskInstanceId: uuid.v4(),\n });\n try {\n await this.refresh(logger);\n } catch (error) {\n logger.error(`${this.getProviderName()} refresh failed`, error);\n }\n },\n });\n };\n }\n\n async refresh(logger: LoggerService) {\n const pluginsToMerge = this.config.getStringArray(\n 'catalog.providers.backstageOpenapi.plugins',\n );\n logger.info(`Loading specs from from ${pluginsToMerge}.`);\n const documentationEntity: ApiEntity = {\n apiVersion: 'backstage.io/v1beta1',\n kind: 'API',\n metadata: {\n name: 'INTERNAL_instance_openapi_doc',\n title: 'Your Backstage Instance documentation',\n annotations: {\n [ANNOTATION_LOCATION]:\n 'internal-package:@backstage/plugin-catalog-backend-module-backstage-openapi',\n [ANNOTATION_ORIGIN_LOCATION]:\n 'internal-package:@backstage/plugin-catalog-backend-module-backstage-openapi',\n },\n },\n spec: {\n type: 'openapi',\n lifecycle: 'production',\n owner: 'backstage',\n definition: JSON.stringify(\n await loadSpecs({\n baseUrl: this.config.getString('backend.baseUrl'),\n discovery: this.discovery,\n auth: this.auth,\n plugins: pluginsToMerge,\n logger,\n }),\n ),\n },\n };\n await this.connection?.applyMutation({\n type: 'full',\n entities: [\n {\n entity: documentationEntity,\n locationKey: 'internal-api-doc',\n },\n ],\n });\n }\n}\n","/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n coreServices,\n createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport { InternalOpenApiDocumentationProvider } from './InternalOpenApiDocumentationProvider';\n\n/**\n * @public\n */\nexport type MetaApiDocsPluginOptions = { exampleOption: boolean };\n\n/**\n * @public\n */\nexport const metaOpenApiDocsPluginId = 'meta-api-docs';\n\n/**\n * @public\n */\nexport const catalogModuleInternalOpenApiSpec = createBackendModule({\n moduleId: metaOpenApiDocsPluginId,\n pluginId: 'catalog',\n register(env) {\n env.registerInit({\n deps: {\n catalog: catalogProcessingExtensionPoint,\n config: coreServices.rootConfig,\n discovery: coreServices.discovery,\n scheduler: coreServices.scheduler,\n logger: coreServices.logger,\n auth: coreServices.auth,\n },\n async init({ catalog, config, discovery, scheduler, logger, auth }) {\n catalog.addEntityProvider(\n InternalOpenApiDocumentationProvider.fromConfig(config, {\n discovery,\n schedule: scheduler,\n logger,\n auth,\n }),\n );\n },\n });\n },\n});\n\nexport default catalogModuleInternalOpenApiSpec;\n"],"names":["merge","isErrorResult","ForwardedError","getOpenApiSpecRoute","fetch","uuid","ANNOTATION_LOCATION","ANNOTATION_ORIGIN_LOCATION","createBackendModule","catalogProcessingExtensionPoint","coreServices"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CA,MAAM,UAAuC,GAAA;AAAA,EAC3C,KAAA;AAAA,EACA,MAAA;AAAA,EACA,KAAA;AAAA,EACA,QAAA;AAAA,EACA,OAAA;AAAA,EACA,OAAA;AAAA,EACA,SAAA;AAAA,EACA,MAAA;AACF,CAAA,CAAA;AAEA,MAAM,aAAA,GAAgB,CAAC,IAAA,EAAqB,GAAgB,KAAA;AAC1D,EAAA,MAAA,CAAO,OAAO,IAAM,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,IAAA,CAAA,KAAK,CAAE,CAAA,OAAA,CAAQ,CAAC,IAAyB,KAAA;AAC3D,IAAA,UAAA,CAAW,QAAQ,CAAQ,IAAA,KAAA;AAxD/B,MAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAyDM,MAAA,IAAI,QAAQ,IAAM,EAAA;AAChB,QAAA,IAAI,EAAE,MAAA,IAAU,IAAK,CAAA,IAAI,CAAI,CAAA,EAAA;AAC3B,UAAC,IAAK,CAAA,IAAI,CAAsB,CAAA,IAAA,GAAO,EAAC,CAAA;AAAA,SAC1C;AACA,QAAA,IAAI,GAAE,EAAK,GAAA,IAAA,CAAA,IAAI,EAAsB,IAA/B,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAqC,SAAS,GAAM,CAAA,CAAA,EAAA;AACxD,UAAA,CAAC,EAAK,GAAA,IAAA,CAAA,IAAI,CAAsB,CAAA,IAAA,KAA/B,mBAAqC,IAAK,CAAA,GAAA,CAAA,CAAA;AAAA,SAC7C;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACF,CAAA,CAAA;AACH,CAAA,CAAA;AAEA,MAAM,aAAa,OAAO;AAAA,EACxB,OAAA;AAAA,EACA,KAAA;AACF,CAGM,KAAA;AACJ,EAAA,MAAM,cAAcA,kBAAM,CAAA;AAAA;AAAA,IAExB;AAAA,MACE,GAAK,EAAA;AAAA,QACH,OAAS,EAAA,OAAA;AAAA,QACT,IAAM,EAAA;AAAA,UACJ,KAAO,EAAA,eAAA;AAAA,UACP,OAAS,EAAA,GAAA;AAAA,SACX;AAAA,QACA,OAAS,EAAA,CAAC,EAAE,GAAA,EAAK,SAAS,CAAA;AAAA,QAC1B,OAAO,EAAC;AAAA,OACV;AAAA,KACF;AAAA;AAAA,IAEA,GAAG,KAAM,CAAA,GAAA;AAAA,MACP,CACG,IAAA,MAAA;AAAA,QACC,GAAK,EAAA,IAAA;AAAA;AAAA,OAEP,CAAA;AAAA,KACJ;AAAA,GACD,CAAA,CAAA;AAED,EAAI,IAAAC,0BAAA,CAAc,WAAW,CAAG,EAAA;AAC9B,IAAA,MAAM,IAAIC,qBAAA;AAAA,MACR,CAAG,EAAA,WAAA,CAAY,OAAO,CAAA,EAAA,EAAK,YAAY,IAAI,CAAA,CAAA,CAAA;AAAA,MAC3C,WAAA;AAAA,KACF,CAAA;AAAA,GACK,MAAA;AACL,IAAA,OAAO,WAAY,CAAA,MAAA,CAAA;AAAA,GACrB;AACF,CAAA,CAAA;AAEA,MAAM,YAAY,OAAO;AAAA,EACvB,OAAA;AAAA,EACA,SAAA;AAAA,EACA,OAAA;AAAA,EACA,MAAA;AAAA,EACA,IAAA;AACF,CAMM,KAAA;AACJ,EAAA,MAAM,QAAyB,EAAC,CAAA;AAChC,EAAA,KAAA,MAAW,YAAY,OAAS,EAAA;AAC9B,IAAA,MAAM,GAAM,GAAA,MAAM,SAAU,CAAA,UAAA,CAAW,QAAQ,CAAA,CAAA;AAC/C,IAAM,MAAA,UAAA,GAAaC,wCAAoB,GAAG,CAAA,CAAA;AAC1C,IAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,KAAK,qBAAsB,CAAA;AAAA,MACjD,UAAA,EAAY,MAAM,IAAA,CAAK,wBAAyB,EAAA;AAAA,MAChD,cAAgB,EAAA,QAAA;AAAA,KACjB,CAAA,CAAA;AACD,IAAM,MAAA,QAAA,GAAW,MAAMC,sBAAA,CAAM,UAAY,EAAA;AAAA,MACvC,MAAQ,EAAA,KAAA;AAAA,MACR,OAAS,EAAA;AAAA,QACP,aAAA,EAAe,UAAU,KAAK,CAAA,CAAA;AAAA,OAChC;AAAA,KACD,CAAA,CAAA;AACD,IAAA,IAAI,SAAS,EAAI,EAAA;AACf,MAAM,MAAA,IAAA,GAAO,MAAM,QAAA,CAAS,IAAK,EAAA,CAAA;AACjC,MAAA,aAAA,CAAc,MAAM,QAAQ,CAAA,CAAA;AAC5B,MAAA,KAAA,CAAM,KAAK,IAAI,CAAA,CAAA;AAAA,KACjB,MAAA,IAAW,QAAS,CAAA,MAAA,KAAW,GAAK,EAAA;AAClC,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,CAAA,OAAA,EAAU,QAAQ,CAAA,mCAAA,EAAsC,UAAU,CAAA,EAAA,CAAA;AAAA,OACpE,CAAA;AAAA,KACK,MAAA;AACL,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,CAAkC,+BAAA,EAAA,QAAQ,CAAO,IAAA,EAAA,UAAU,YACzD,QAAS,CAAA,MACX,CAAM,GAAA,EAAA,QAAA,CAAS,OAAO,MAAM,QAAA,CAAS,IAAK,EAAA,GAAI,SAAS,UAAU,CAAA,CAAA;AAAA,OACnE,CAAA;AAAA,KACF;AAAA,GACF;AACA,EAAA,OAAO,UAAW,CAAA,EAAE,OAAS,EAAA,KAAA,EAAO,CAAA,CAAA;AACtC,CAAA,CAAA;AAEO,MAAM,oCAA+D,CAAA;AAAA,EAI1E,WACkB,CAAA,MAAA,EACA,SACA,EAAA,MAAA,EACA,MAChB,UACA,EAAA;AALgB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA,CAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA,CAAA;AAPlB,IAAQ,aAAA,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AACR,IAAiB,aAAA,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AASf,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA,CAAA;AAAA,GACpD;AAAA,EAEA,OAAO,UACL,CAAA,MAAA,EACA,OAMA,EAAA;AACA,IAAM,MAAA,UAAA,GAAa,OAAQ,CAAA,QAAA,CAAS,yBAA0B,CAAA;AAAA,MAC5D,SAAW,EAAA;AAAA,QACT,OAAS,EAAA,CAAA;AAAA,OACX;AAAA,MACA,OAAS,EAAA;AAAA,QACP,OAAS,EAAA,CAAA;AAAA,OACX;AAAA,KACD,CAAA,CAAA;AACD,IAAA,OAAO,IAAI,oCAAA;AAAA,MACT,MAAA;AAAA,MACA,OAAQ,CAAA,SAAA;AAAA,MACR,OAAQ,CAAA,MAAA;AAAA,MACR,OAAQ,CAAA,IAAA;AAAA,MACR,UAAA;AAAA,KACF,CAAA;AAAA,GACF;AAAA;AAAA,EAEA,eAAkB,GAAA;AAChB,IAAO,OAAA,CAAA,oCAAA,CAAA,CAAA;AAAA,GACT;AAAA;AAAA,EAGA,MAAM,QAAQ,UAAsC,EAAA;AAClD,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAO,OAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AAAA,GAC/B;AAAA,EAEQ,iBAAiB,UAA6C,EAAA;AACpE,IAAA,OAAO,YAAY;AACjB,MAAA,MAAM,MAAS,GAAA,CAAA,EAAG,IAAK,CAAA,eAAA,EAAiB,CAAA,QAAA,CAAA,CAAA;AACxC,MAAA,OAAO,WAAW,GAAI,CAAA;AAAA,QACpB,EAAI,EAAA,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAM,MAAA,MAAA,GAAS,IAAK,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,YAC/B,KAAA,EACE,oCAAqC,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YAC7D,MAAA;AAAA,YACA,cAAA,EAAgBC,gBAAK,EAAG,EAAA;AAAA,WACzB,CAAA,CAAA;AACD,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA,CAAA;AAAA,mBAClB,KAAO,EAAA;AACd,YAAA,MAAA,CAAO,MAAM,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAC,mBAAmB,KAAK,CAAA,CAAA;AAAA,WAChE;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,QAAQ,MAAuB,EAAA;AAnOvC,IAAA,IAAA,EAAA,CAAA;AAoOI,IAAM,MAAA,cAAA,GAAiB,KAAK,MAAO,CAAA,cAAA;AAAA,MACjC,4CAAA;AAAA,KACF,CAAA;AACA,IAAO,MAAA,CAAA,IAAA,CAAK,CAA2B,wBAAA,EAAA,cAAc,CAAG,CAAA,CAAA,CAAA,CAAA;AACxD,IAAA,MAAM,mBAAiC,GAAA;AAAA,MACrC,UAAY,EAAA,sBAAA;AAAA,MACZ,IAAM,EAAA,KAAA;AAAA,MACN,QAAU,EAAA;AAAA,QACR,IAAM,EAAA,+BAAA;AAAA,QACN,KAAO,EAAA,uCAAA;AAAA,QACP,WAAa,EAAA;AAAA,UACX,CAACC,gCAAmB,GAClB,6EAAA;AAAA,UACF,CAACC,uCAA0B,GACzB,6EAAA;AAAA,SACJ;AAAA,OACF;AAAA,MACA,IAAM,EAAA;AAAA,QACJ,IAAM,EAAA,SAAA;AAAA,QACN,SAAW,EAAA,YAAA;AAAA,QACX,KAAO,EAAA,WAAA;AAAA,QACP,YAAY,IAAK,CAAA,SAAA;AAAA,UACf,MAAM,SAAU,CAAA;AAAA,YACd,OAAS,EAAA,IAAA,CAAK,MAAO,CAAA,SAAA,CAAU,iBAAiB,CAAA;AAAA,YAChD,WAAW,IAAK,CAAA,SAAA;AAAA,YAChB,MAAM,IAAK,CAAA,IAAA;AAAA,YACX,OAAS,EAAA,cAAA;AAAA,YACT,MAAA;AAAA,WACD,CAAA;AAAA,SACH;AAAA,OACF;AAAA,KACF,CAAA;AACA,IAAM,OAAA,CAAA,EAAA,GAAA,IAAA,CAAK,UAAL,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAiB,aAAc,CAAA;AAAA,MACnC,IAAM,EAAA,MAAA;AAAA,MACN,QAAU,EAAA;AAAA,QACR;AAAA,UACE,MAAQ,EAAA,mBAAA;AAAA,UACR,WAAa,EAAA,kBAAA;AAAA,SACf;AAAA,OACF;AAAA,KACF,CAAA,CAAA,CAAA;AAAA,GACF;AACF;;AC/OO,MAAM,uBAA0B,GAAA,gBAAA;AAKhC,MAAM,mCAAmCC,oCAAoB,CAAA;AAAA,EAClE,QAAU,EAAA,uBAAA;AAAA,EACV,QAAU,EAAA,SAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,OAAS,EAAAC,qCAAA;AAAA,QACT,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,MAAMA,6BAAa,CAAA,IAAA;AAAA,OACrB;AAAA,MACA,MAAM,KAAK,EAAE,OAAA,EAAS,QAAQ,SAAW,EAAA,SAAA,EAAW,MAAQ,EAAA,IAAA,EAAQ,EAAA;AAClE,QAAQ,OAAA,CAAA,iBAAA;AAAA,UACN,oCAAA,CAAqC,WAAW,MAAQ,EAAA;AAAA,YACtD,SAAA;AAAA,YACA,QAAU,EAAA,SAAA;AAAA,YACV,MAAA;AAAA,YACA,IAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;;"}
|
|
1
|
+
{"version":3,"file":"index.cjs.js","sources":["../src/InternalOpenApiDocumentationProvider.ts","../src/index.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n ANNOTATION_LOCATION,\n ANNOTATION_ORIGIN_LOCATION,\n type ApiEntity,\n} from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { ForwardedError } from '@backstage/errors';\nimport {\n EntityProvider,\n EntityProviderConnection,\n} from '@backstage/plugin-catalog-node';\nimport { merge, isErrorResult } from 'openapi-merge';\nimport { getOpenApiSpecRoute } from '@backstage/backend-openapi-utils';\nimport type {\n OpenAPIObject,\n OperationObject,\n PathItemObject,\n} from 'openapi3-ts';\nimport fetch from 'cross-fetch';\nimport {\n AuthService,\n DiscoveryService,\n LoggerService,\n} from '@backstage/backend-plugin-api';\nimport uuid from 'uuid';\nimport lodash from 'lodash';\nimport { PluginTaskScheduler, TaskRunner } from '@backstage/backend-tasks';\n\nconst HTTP_VERBS: (keyof PathItemObject)[] = [\n 'get',\n 'post',\n 'put',\n 'delete',\n 'patch',\n 'trace',\n 'options',\n 'head',\n];\n\nconst addTagsToSpec = (spec: OpenAPIObject, tag: string) => {\n Object.values(spec?.paths).forEach((path: PathItemObject) => {\n HTTP_VERBS.forEach(verb => {\n if (verb in path) {\n if (!('tags' in path[verb])) {\n (path[verb] as OperationObject).tags = [];\n }\n if (!(path[verb] as OperationObject).tags?.includes(tag)) {\n (path[verb] as OperationObject).tags?.push(tag);\n }\n }\n });\n });\n};\n\nconst mergeSpecs = async ({\n baseUrl,\n specs,\n}: {\n baseUrl: string;\n specs: OpenAPIObject[];\n}) => {\n const mergeResult = merge([\n // Add the full API information as the first item for other items to merge against it with.\n {\n oas: {\n openapi: '3.0.3',\n info: {\n title: 'Backstage API',\n version: '1',\n },\n servers: [{ url: baseUrl }],\n paths: {},\n },\n },\n // For each plugin, load its spec and the known endpoint that it sits under.\n ...specs.map(\n spec =>\n ({\n oas: spec,\n // Weird typing differences between this package and the client package's openapi 3.\n } as any),\n ),\n ]);\n\n if (isErrorResult(mergeResult)) {\n throw new ForwardedError(\n `${mergeResult.message} (${mergeResult.type})`,\n mergeResult,\n );\n } else {\n return mergeResult.output;\n }\n};\n\nconst loadSpecs = async ({\n baseUrl,\n discovery,\n plugins,\n logger,\n auth,\n}: {\n baseUrl: string;\n plugins: string[];\n discovery: DiscoveryService;\n logger: LoggerService;\n auth: AuthService;\n}) => {\n const specs: OpenAPIObject[] = [];\n for (const pluginId of plugins) {\n const url = await discovery.getBaseUrl(pluginId);\n const openApiUrl = getOpenApiSpecRoute(url);\n const { token } = await auth.getPluginRequestToken({\n onBehalfOf: await auth.getOwnServiceCredentials(),\n targetPluginId: pluginId,\n });\n const response = await fetch(openApiUrl, {\n method: 'GET',\n headers: {\n Authorization: `Bearer ${token}`,\n },\n });\n if (response.ok) {\n const spec = await response.json();\n addTagsToSpec(spec, pluginId);\n specs.push(spec);\n } else if (response.status === 404) {\n logger.error(\n `Plugin=${pluginId} does not have an OpenAPI spec at '${openApiUrl}'.`,\n );\n } else {\n logger.error(\n `Failed to load spec for plugin=${pluginId} at ${openApiUrl}. Error (${\n response.status\n }): ${response.body ? await response.text() : response.statusText}`,\n );\n }\n }\n return mergeSpecs({ baseUrl, specs });\n};\n\nexport class InternalOpenApiDocumentationProvider implements EntityProvider {\n private connection?: EntityProviderConnection;\n private readonly scheduleFn: () => Promise<void>;\n\n constructor(\n public readonly config: Config,\n public readonly discovery: DiscoveryService,\n public readonly logger: LoggerService,\n public readonly auth: AuthService,\n taskRunner: TaskRunner,\n ) {\n this.scheduleFn = this.createScheduleFn(taskRunner);\n }\n\n static fromConfig(\n config: Config,\n options: {\n discovery: DiscoveryService;\n logger: LoggerService;\n schedule: PluginTaskScheduler;\n auth: AuthService;\n },\n ) {\n const taskRunner = options.schedule.createScheduledTaskRunner({\n frequency: {\n minutes: 1,\n },\n timeout: {\n minutes: 1,\n },\n });\n return new InternalOpenApiDocumentationProvider(\n config,\n options.discovery,\n options.logger,\n options.auth,\n taskRunner,\n );\n }\n /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */\n getProviderName() {\n return `InternalOpenApiDocumentationProvider`;\n }\n\n /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */\n async connect(connection: EntityProviderConnection) {\n this.connection = connection;\n return await this.scheduleFn();\n }\n\n private createScheduleFn(taskRunner: TaskRunner): () => Promise<void> {\n return async () => {\n const taskId = `${this.getProviderName()}:refresh`;\n return taskRunner.run({\n id: taskId,\n fn: async () => {\n const logger = this.logger.child({\n class:\n InternalOpenApiDocumentationProvider.prototype.constructor.name,\n taskId,\n taskInstanceId: uuid.v4(),\n });\n try {\n await this.refresh(logger);\n } catch (error) {\n logger.error(`${this.getProviderName()} refresh failed`, error);\n }\n },\n });\n };\n }\n\n async refresh(logger: LoggerService) {\n const pluginsToMerge = this.config.getStringArray(\n 'catalog.providers.backstageOpenapi.plugins',\n );\n const configToMerge = this.config.getOptional(\n 'catalog.providers.backstageOpenapi.entityOverrides',\n );\n\n const baseConfig = {\n metadata: {\n name: 'internal_backstage_openapi_doc',\n title: 'Backstage API',\n },\n spec: {\n lifecycle: 'production',\n owner: 'backstage',\n },\n };\n\n logger.info(`Loading specs from ${pluginsToMerge}.`);\n const requiredConfig = {\n apiVersion: 'backstage.io/v1beta1',\n kind: 'API',\n metadata: {\n annotations: {\n [ANNOTATION_LOCATION]:\n 'internal-package:@backstage/plugin-catalog-backend-module-backstage-openapi',\n [ANNOTATION_ORIGIN_LOCATION]:\n 'internal-package:@backstage/plugin-catalog-backend-module-backstage-openapi',\n },\n },\n spec: {\n type: 'openapi',\n definition: JSON.stringify(\n await loadSpecs({\n baseUrl: this.config.getString('backend.baseUrl'),\n discovery: this.discovery,\n auth: this.auth,\n plugins: pluginsToMerge,\n logger,\n }),\n ),\n },\n };\n\n // Overwrite baseConfig with options from config file.\n const mergedConfig = lodash.merge(baseConfig, configToMerge);\n\n // Overwite mergedConfig with requiredConfig (i.e., spec.type and spec.definition) to avoid bad configuration.\n const documentationEntity = lodash.merge(\n mergedConfig,\n requiredConfig,\n ) as ApiEntity;\n\n await this.connection?.applyMutation({\n type: 'full',\n entities: [\n {\n entity: documentationEntity,\n locationKey: 'internal-api-doc',\n },\n ],\n });\n }\n}\n","/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n coreServices,\n createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport { InternalOpenApiDocumentationProvider } from './InternalOpenApiDocumentationProvider';\n\n/**\n * @public\n */\nexport type MetaApiDocsPluginOptions = { exampleOption: boolean };\n\n/**\n * @public\n */\nexport const metaOpenApiDocsPluginId = 'meta-api-docs';\n\n/**\n * @public\n */\nexport const catalogModuleInternalOpenApiSpec = createBackendModule({\n moduleId: metaOpenApiDocsPluginId,\n pluginId: 'catalog',\n register(env) {\n env.registerInit({\n deps: {\n catalog: catalogProcessingExtensionPoint,\n config: coreServices.rootConfig,\n discovery: coreServices.discovery,\n scheduler: coreServices.scheduler,\n logger: coreServices.logger,\n auth: coreServices.auth,\n },\n async init({ catalog, config, discovery, scheduler, logger, auth }) {\n catalog.addEntityProvider(\n InternalOpenApiDocumentationProvider.fromConfig(config, {\n discovery,\n schedule: scheduler,\n logger,\n auth,\n }),\n );\n },\n });\n },\n});\n\nexport default catalogModuleInternalOpenApiSpec;\n"],"names":["merge","isErrorResult","ForwardedError","getOpenApiSpecRoute","fetch","uuid","ANNOTATION_LOCATION","ANNOTATION_ORIGIN_LOCATION","lodash","createBackendModule","catalogProcessingExtensionPoint","coreServices"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AA4CA,MAAM,UAAuC,GAAA;AAAA,EAC3C,KAAA;AAAA,EACA,MAAA;AAAA,EACA,KAAA;AAAA,EACA,QAAA;AAAA,EACA,OAAA;AAAA,EACA,OAAA;AAAA,EACA,SAAA;AAAA,EACA,MAAA;AACF,CAAA,CAAA;AAEA,MAAM,aAAA,GAAgB,CAAC,IAAA,EAAqB,GAAgB,KAAA;AAC1D,EAAA,MAAA,CAAO,OAAO,IAAM,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,IAAA,CAAA,KAAK,CAAE,CAAA,OAAA,CAAQ,CAAC,IAAyB,KAAA;AAC3D,IAAA,UAAA,CAAW,QAAQ,CAAQ,IAAA,KAAA;AAzD/B,MAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AA0DM,MAAA,IAAI,QAAQ,IAAM,EAAA;AAChB,QAAA,IAAI,EAAE,MAAA,IAAU,IAAK,CAAA,IAAI,CAAI,CAAA,EAAA;AAC3B,UAAC,IAAK,CAAA,IAAI,CAAsB,CAAA,IAAA,GAAO,EAAC,CAAA;AAAA,SAC1C;AACA,QAAA,IAAI,GAAE,EAAK,GAAA,IAAA,CAAA,IAAI,EAAsB,IAA/B,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAqC,SAAS,GAAM,CAAA,CAAA,EAAA;AACxD,UAAA,CAAC,EAAK,GAAA,IAAA,CAAA,IAAI,CAAsB,CAAA,IAAA,KAA/B,mBAAqC,IAAK,CAAA,GAAA,CAAA,CAAA;AAAA,SAC7C;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACF,CAAA,CAAA;AACH,CAAA,CAAA;AAEA,MAAM,aAAa,OAAO;AAAA,EACxB,OAAA;AAAA,EACA,KAAA;AACF,CAGM,KAAA;AACJ,EAAA,MAAM,cAAcA,kBAAM,CAAA;AAAA;AAAA,IAExB;AAAA,MACE,GAAK,EAAA;AAAA,QACH,OAAS,EAAA,OAAA;AAAA,QACT,IAAM,EAAA;AAAA,UACJ,KAAO,EAAA,eAAA;AAAA,UACP,OAAS,EAAA,GAAA;AAAA,SACX;AAAA,QACA,OAAS,EAAA,CAAC,EAAE,GAAA,EAAK,SAAS,CAAA;AAAA,QAC1B,OAAO,EAAC;AAAA,OACV;AAAA,KACF;AAAA;AAAA,IAEA,GAAG,KAAM,CAAA,GAAA;AAAA,MACP,CACG,IAAA,MAAA;AAAA,QACC,GAAK,EAAA,IAAA;AAAA;AAAA,OAEP,CAAA;AAAA,KACJ;AAAA,GACD,CAAA,CAAA;AAED,EAAI,IAAAC,0BAAA,CAAc,WAAW,CAAG,EAAA;AAC9B,IAAA,MAAM,IAAIC,qBAAA;AAAA,MACR,CAAG,EAAA,WAAA,CAAY,OAAO,CAAA,EAAA,EAAK,YAAY,IAAI,CAAA,CAAA,CAAA;AAAA,MAC3C,WAAA;AAAA,KACF,CAAA;AAAA,GACK,MAAA;AACL,IAAA,OAAO,WAAY,CAAA,MAAA,CAAA;AAAA,GACrB;AACF,CAAA,CAAA;AAEA,MAAM,YAAY,OAAO;AAAA,EACvB,OAAA;AAAA,EACA,SAAA;AAAA,EACA,OAAA;AAAA,EACA,MAAA;AAAA,EACA,IAAA;AACF,CAMM,KAAA;AACJ,EAAA,MAAM,QAAyB,EAAC,CAAA;AAChC,EAAA,KAAA,MAAW,YAAY,OAAS,EAAA;AAC9B,IAAA,MAAM,GAAM,GAAA,MAAM,SAAU,CAAA,UAAA,CAAW,QAAQ,CAAA,CAAA;AAC/C,IAAM,MAAA,UAAA,GAAaC,wCAAoB,GAAG,CAAA,CAAA;AAC1C,IAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,KAAK,qBAAsB,CAAA;AAAA,MACjD,UAAA,EAAY,MAAM,IAAA,CAAK,wBAAyB,EAAA;AAAA,MAChD,cAAgB,EAAA,QAAA;AAAA,KACjB,CAAA,CAAA;AACD,IAAM,MAAA,QAAA,GAAW,MAAMC,sBAAA,CAAM,UAAY,EAAA;AAAA,MACvC,MAAQ,EAAA,KAAA;AAAA,MACR,OAAS,EAAA;AAAA,QACP,aAAA,EAAe,UAAU,KAAK,CAAA,CAAA;AAAA,OAChC;AAAA,KACD,CAAA,CAAA;AACD,IAAA,IAAI,SAAS,EAAI,EAAA;AACf,MAAM,MAAA,IAAA,GAAO,MAAM,QAAA,CAAS,IAAK,EAAA,CAAA;AACjC,MAAA,aAAA,CAAc,MAAM,QAAQ,CAAA,CAAA;AAC5B,MAAA,KAAA,CAAM,KAAK,IAAI,CAAA,CAAA;AAAA,KACjB,MAAA,IAAW,QAAS,CAAA,MAAA,KAAW,GAAK,EAAA;AAClC,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,CAAA,OAAA,EAAU,QAAQ,CAAA,mCAAA,EAAsC,UAAU,CAAA,EAAA,CAAA;AAAA,OACpE,CAAA;AAAA,KACK,MAAA;AACL,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,CAAkC,+BAAA,EAAA,QAAQ,CAAO,IAAA,EAAA,UAAU,YACzD,QAAS,CAAA,MACX,CAAM,GAAA,EAAA,QAAA,CAAS,OAAO,MAAM,QAAA,CAAS,IAAK,EAAA,GAAI,SAAS,UAAU,CAAA,CAAA;AAAA,OACnE,CAAA;AAAA,KACF;AAAA,GACF;AACA,EAAA,OAAO,UAAW,CAAA,EAAE,OAAS,EAAA,KAAA,EAAO,CAAA,CAAA;AACtC,CAAA,CAAA;AAEO,MAAM,oCAA+D,CAAA;AAAA,EAI1E,WACkB,CAAA,MAAA,EACA,SACA,EAAA,MAAA,EACA,MAChB,UACA,EAAA;AALgB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA,CAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA,CAAA;AAPlB,IAAQ,aAAA,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AACR,IAAiB,aAAA,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AASf,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA,CAAA;AAAA,GACpD;AAAA,EAEA,OAAO,UACL,CAAA,MAAA,EACA,OAMA,EAAA;AACA,IAAM,MAAA,UAAA,GAAa,OAAQ,CAAA,QAAA,CAAS,yBAA0B,CAAA;AAAA,MAC5D,SAAW,EAAA;AAAA,QACT,OAAS,EAAA,CAAA;AAAA,OACX;AAAA,MACA,OAAS,EAAA;AAAA,QACP,OAAS,EAAA,CAAA;AAAA,OACX;AAAA,KACD,CAAA,CAAA;AACD,IAAA,OAAO,IAAI,oCAAA;AAAA,MACT,MAAA;AAAA,MACA,OAAQ,CAAA,SAAA;AAAA,MACR,OAAQ,CAAA,MAAA;AAAA,MACR,OAAQ,CAAA,IAAA;AAAA,MACR,UAAA;AAAA,KACF,CAAA;AAAA,GACF;AAAA;AAAA,EAEA,eAAkB,GAAA;AAChB,IAAO,OAAA,CAAA,oCAAA,CAAA,CAAA;AAAA,GACT;AAAA;AAAA,EAGA,MAAM,QAAQ,UAAsC,EAAA;AAClD,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAO,OAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AAAA,GAC/B;AAAA,EAEQ,iBAAiB,UAA6C,EAAA;AACpE,IAAA,OAAO,YAAY;AACjB,MAAA,MAAM,MAAS,GAAA,CAAA,EAAG,IAAK,CAAA,eAAA,EAAiB,CAAA,QAAA,CAAA,CAAA;AACxC,MAAA,OAAO,WAAW,GAAI,CAAA;AAAA,QACpB,EAAI,EAAA,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAM,MAAA,MAAA,GAAS,IAAK,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,YAC/B,KAAA,EACE,oCAAqC,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YAC7D,MAAA;AAAA,YACA,cAAA,EAAgBC,sBAAK,EAAG,EAAA;AAAA,WACzB,CAAA,CAAA;AACD,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA,CAAA;AAAA,mBAClB,KAAO,EAAA;AACd,YAAA,MAAA,CAAO,MAAM,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAC,mBAAmB,KAAK,CAAA,CAAA;AAAA,WAChE;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,QAAQ,MAAuB,EAAA;AApOvC,IAAA,IAAA,EAAA,CAAA;AAqOI,IAAM,MAAA,cAAA,GAAiB,KAAK,MAAO,CAAA,cAAA;AAAA,MACjC,4CAAA;AAAA,KACF,CAAA;AACA,IAAM,MAAA,aAAA,GAAgB,KAAK,MAAO,CAAA,WAAA;AAAA,MAChC,oDAAA;AAAA,KACF,CAAA;AAEA,IAAA,MAAM,UAAa,GAAA;AAAA,MACjB,QAAU,EAAA;AAAA,QACR,IAAM,EAAA,gCAAA;AAAA,QACN,KAAO,EAAA,eAAA;AAAA,OACT;AAAA,MACA,IAAM,EAAA;AAAA,QACJ,SAAW,EAAA,YAAA;AAAA,QACX,KAAO,EAAA,WAAA;AAAA,OACT;AAAA,KACF,CAAA;AAEA,IAAO,MAAA,CAAA,IAAA,CAAK,CAAsB,mBAAA,EAAA,cAAc,CAAG,CAAA,CAAA,CAAA,CAAA;AACnD,IAAA,MAAM,cAAiB,GAAA;AAAA,MACrB,UAAY,EAAA,sBAAA;AAAA,MACZ,IAAM,EAAA,KAAA;AAAA,MACN,QAAU,EAAA;AAAA,QACR,WAAa,EAAA;AAAA,UACX,CAACC,gCAAmB,GAClB,6EAAA;AAAA,UACF,CAACC,uCAA0B,GACzB,6EAAA;AAAA,SACJ;AAAA,OACF;AAAA,MACA,IAAM,EAAA;AAAA,QACJ,IAAM,EAAA,SAAA;AAAA,QACN,YAAY,IAAK,CAAA,SAAA;AAAA,UACf,MAAM,SAAU,CAAA;AAAA,YACd,OAAS,EAAA,IAAA,CAAK,MAAO,CAAA,SAAA,CAAU,iBAAiB,CAAA;AAAA,YAChD,WAAW,IAAK,CAAA,SAAA;AAAA,YAChB,MAAM,IAAK,CAAA,IAAA;AAAA,YACX,OAAS,EAAA,cAAA;AAAA,YACT,MAAA;AAAA,WACD,CAAA;AAAA,SACH;AAAA,OACF;AAAA,KACF,CAAA;AAGA,IAAA,MAAM,YAAe,GAAAC,uBAAA,CAAO,KAAM,CAAA,UAAA,EAAY,aAAa,CAAA,CAAA;AAG3D,IAAA,MAAM,sBAAsBA,uBAAO,CAAA,KAAA;AAAA,MACjC,YAAA;AAAA,MACA,cAAA;AAAA,KACF,CAAA;AAEA,IAAM,OAAA,CAAA,EAAA,GAAA,IAAA,CAAK,UAAL,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAiB,aAAc,CAAA;AAAA,MACnC,IAAM,EAAA,MAAA;AAAA,MACN,QAAU,EAAA;AAAA,QACR;AAAA,UACE,MAAQ,EAAA,mBAAA;AAAA,UACR,WAAa,EAAA,kBAAA;AAAA,SACf;AAAA,OACF;AAAA,KACF,CAAA,CAAA,CAAA;AAAA,GACF;AACF;;ACrQO,MAAM,uBAA0B,GAAA,gBAAA;AAKhC,MAAM,mCAAmCC,oCAAoB,CAAA;AAAA,EAClE,QAAU,EAAA,uBAAA;AAAA,EACV,QAAU,EAAA,SAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,OAAS,EAAAC,qCAAA;AAAA,QACT,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,MAAMA,6BAAa,CAAA,IAAA;AAAA,OACrB;AAAA,MACA,MAAM,KAAK,EAAE,OAAA,EAAS,QAAQ,SAAW,EAAA,SAAA,EAAW,MAAQ,EAAA,IAAA,EAAQ,EAAA;AAClE,QAAQ,OAAA,CAAA,iBAAA;AAAA,UACN,oCAAA,CAAqC,WAAW,MAAQ,EAAA;AAAA,YACtD,SAAA;AAAA,YACA,QAAU,EAAA,SAAA;AAAA,YACV,MAAA;AAAA,YACA,IAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-catalog-backend-module-backstage-openapi",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"backstage": {
|
|
5
5
|
"role": "backend-plugin-module"
|
|
6
6
|
},
|
|
@@ -31,19 +31,20 @@
|
|
|
31
31
|
"test": "backstage-cli package test"
|
|
32
32
|
},
|
|
33
33
|
"dependencies": {
|
|
34
|
-
"@backstage/backend-openapi-utils": "^0.1.10
|
|
35
|
-
"@backstage/backend-plugin-api": "^0.6.17
|
|
36
|
-
"@backstage/backend-tasks": "^0.5.22
|
|
34
|
+
"@backstage/backend-openapi-utils": "^0.1.10",
|
|
35
|
+
"@backstage/backend-plugin-api": "^0.6.17",
|
|
36
|
+
"@backstage/backend-tasks": "^0.5.22",
|
|
37
37
|
"@backstage/catalog-model": "^1.4.5",
|
|
38
38
|
"@backstage/config": "^1.2.0",
|
|
39
39
|
"@backstage/errors": "^1.2.4",
|
|
40
|
-
"@backstage/plugin-catalog-node": "^1.11.1
|
|
40
|
+
"@backstage/plugin-catalog-node": "^1.11.1",
|
|
41
41
|
"cross-fetch": "^4.0.0",
|
|
42
|
+
"lodash": "^4.17.21",
|
|
42
43
|
"openapi-merge": "^1.3.2",
|
|
43
44
|
"uuid": "^9.0.0"
|
|
44
45
|
},
|
|
45
46
|
"devDependencies": {
|
|
46
|
-
"@backstage/cli": "^0.26.3
|
|
47
|
+
"@backstage/cli": "^0.26.3",
|
|
47
48
|
"openapi3-ts": "^3.1.2"
|
|
48
49
|
},
|
|
49
50
|
"configSchema": "config.d.ts"
|