Files
backstage/plugins/techdocs/config.d.ts
T
2021-03-16 15:48:46 +01:00

37 lines
1.0 KiB
TypeScript

/*
* 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 techdocs plugin
* @see http://backstage.io/docs/features/techdocs/configuration
*/
techdocs: {
/**
* Documentation building process depends on the builder attr
* @visibility frontend
*/
builder: 'local' | 'external';
/**
* @example http://localhost:7000/api/techdocs
* @visibility frontend
* @deprecated
*/
requestUrl?: string;
};
}