diff --git a/packages/backend-openapi-utils/config.d.ts b/packages/backend-openapi-utils/config.d.ts new file mode 100644 index 0000000000..7256dc55e0 --- /dev/null +++ b/packages/backend-openapi-utils/config.d.ts @@ -0,0 +1,23 @@ +/* + * Copyright 2023 The Backstage Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +export interface Config { + openapi?: { + /** + * A list of plugins, whose OpenAPI specs you want to collate in `InternalOpenApiDocumentationProvider`. + */ + plugins: string[]; + }; +} diff --git a/packages/backend-openapi-utils/package.json b/packages/backend-openapi-utils/package.json index 15957dd4ac..b7be1acf3c 100644 --- a/packages/backend-openapi-utils/package.json +++ b/packages/backend-openapi-utils/package.json @@ -34,8 +34,10 @@ "supertest": "^6.1.3" }, "files": [ - "dist" + "dist", + "config.d.ts" ], + "configSchema": "config.d.ts", "dependencies": { "@backstage/backend-plugin-api": "workspace:^", "@backstage/config": "workspace:^", diff --git a/plugins/catalog-backend-module-openapi-spec/api-report.md b/plugins/catalog-backend-module-openapi-spec/api-report.md index a3d1933b78..62b4c7194e 100644 --- a/plugins/catalog-backend-module-openapi-spec/api-report.md +++ b/plugins/catalog-backend-module-openapi-spec/api-report.md @@ -6,7 +6,9 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; // @public (undocumented) -export const catalogModuleInternalOpenApiSpec: () => BackendFeature; +const catalogModuleInternalOpenApiSpec: () => BackendFeature; +export { catalogModuleInternalOpenApiSpec }; +export default catalogModuleInternalOpenApiSpec; // @public (undocumented) export type MetaApiDocsPluginOptions = {