diff --git a/.changeset/slimy-penguins-sing.md b/.changeset/slimy-penguins-sing.md new file mode 100644 index 0000000000..62b27a1ce6 --- /dev/null +++ b/.changeset/slimy-penguins-sing.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-backend': patch +--- + +Added configuration schema for the commonly used properties diff --git a/plugins/catalog-backend/config.d.ts b/plugins/catalog-backend/config.d.ts new file mode 100644 index 0000000000..1978b573f6 --- /dev/null +++ b/plugins/catalog-backend/config.d.ts @@ -0,0 +1,44 @@ +/* + * Copyright 2020 Spotify AB + * + * 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 { + /** Configuration options for the catalog plugin */ + + catalog?: { + rules?: Array<{ + allow: Array; + }>; + processors?: { + githubOrg?: { + providers: Array<{ + [key: string]: string; + }>; + }; + ldapOrg?: { + providers: { + target: string; + bind?: { [key: string]: string }; + users: { [key: string]: string | { [key: string]: string } }; + groups: { [key: string]: string | { [key: string]: string } }; + }; + }; + microsoftGraphOrg?: { + providers: { [key: string]: string }; + }; + }; + locations?: Array<{ [key: string]: string }>; + }; +} diff --git a/plugins/catalog-backend/package.json b/plugins/catalog-backend/package.json index 180956c986..d8c8641a85 100644 --- a/plugins/catalog-backend/package.json +++ b/plugins/catalog-backend/package.json @@ -70,6 +70,8 @@ }, "files": [ "dist", - "migrations/**/*.{js,d.ts}" - ] + "migrations/**/*.{js,d.ts}", + "config.d.ts" + ], + "configSchema": "config.d.ts" }