@backstage/plugin-catalog-backend-module-backstage-openapi 0.5.15-next.0 → 0.5.16-next.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @backstage/plugin-catalog-backend-module-backstage-openapi
 
+## 0.5.16-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.9.3-next.0
+  - @backstage/plugin-catalog-node@2.2.3-next.0
+  - @backstage/backend-openapi-utils@0.6.11-next.0
+
+## 0.5.15
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.9.2
+  - @backstage/backend-openapi-utils@0.6.10
+  - @backstage/plugin-catalog-node@2.2.2
+
 ## 0.5.15-next.0
 
 ### Patch Changes

package/README.md

@@ -28,7 +28,7 @@ catalog:
         - catalog
         - events
         - search
-      definitionFormat: 'yaml"' # Optional, defaults to 'json'
+      definitionFormat: 'yaml' # Optional, defaults to 'json'
       entityOverrides: # All optional
         metadata:
           name: 'my-name'

package/config.schema.json

@@ -0,0 +1,44 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "catalog": {
+      "type": "object",
+      "properties": {
+        "providers": {
+          "type": "object",
+          "properties": {
+            "backstageOpenapi": {
+              "type": "object",
+              "properties": {
+                "plugins": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  },
+                  "description": "A list of plugins, whose OpenAPI specs you want to collate in `InternalOpenApiDocumentationProvider`."
+                },
+                "entityOverrides": {
+                  "type": "object",
+                  "description": "Properties to override on the final entity object."
+                },
+                "definitionFormat": {
+                  "type": "string",
+                  "enum": [
+                    "json",
+                    "yaml"
+                  ],
+                  "description": "The format of the definition."
+                }
+              },
+              "required": [
+                "plugins"
+              ],
+              "description": "BackstageOpenApiEntityProvider configuration"
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-backstage-openapi",
-  "version": "0.5.15-next.0",
+  "version": "0.5.16-next.0",
   "backstage": {
     "role": "backend-plugin-module",
     "pluginId": "catalog",
@@ -24,7 +24,7 @@
   "types": "dist/index.d.ts",
   "files": [
     "dist",
-    "config.d.ts"
+    "config.schema.json"
   ],
   "scripts": {
     "build": "backstage-cli package build",
@@ -36,22 +36,22 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-openapi-utils": "0.6.10-next.0",
-    "@backstage/backend-plugin-api": "1.9.2-next.0",
+    "@backstage/backend-openapi-utils": "0.6.11-next.0",
+    "@backstage/backend-plugin-api": "1.9.3-next.0",
     "@backstage/catalog-model": "1.9.0",
     "@backstage/config": "1.3.8",
     "@backstage/errors": "1.3.1",
-    "@backstage/plugin-catalog-node": "2.2.2-next.0",
+    "@backstage/plugin-catalog-node": "2.2.3-next.0",
     "cross-fetch": "^4.0.0",
     "lodash": "^4.17.21",
     "openapi-merge": "^1.3.2",
     "yaml": "^2.7.0"
   },
   "devDependencies": {
-    "@backstage/cli": "0.36.3-next.0",
+    "@backstage/cli": "0.36.4-next.0",
     "openapi3-ts": "^3.1.2"
   },
-  "configSchema": "config.d.ts",
+  "configSchema": "config.schema.json",
   "typesVersions": {
     "*": {
       "package.json": [

package/config.d.ts

@@ -1,40 +0,0 @@
-/*
- * 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 {
-  catalog?: {
-    providers?: {
-      /**
-       * BackstageOpenApiEntityProvider configuration
-       */
-      backstageOpenapi?: {
-        /**
-         * A list of plugins, whose OpenAPI specs you want to collate in `InternalOpenApiDocumentationProvider`.
-         */
-        plugins: string[];
-        /**
-         * Properties to override on the final entity object.
-         */
-        entityOverrides?: object;
-        /**
-         * The format of the definition.
-         * @defaultValue json
-         */
-        definitionFormat?: 'json' | 'yaml';
-      };
-    };
-  };
-}