/
techdocsTypes.ts
58 lines (55 loc) · 1.37 KB
/
techdocsTypes.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
/*
* Copyright 2021 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.
*/
import { Entity } from '@backstage/catalog-model';
import { IndexableDocument } from '@backstage/plugin-search-common';
/**
* TechDocs indexable document interface
* @public
*/
export interface TechDocsDocument extends IndexableDocument {
/**
* Entity kind
*/
kind: string;
/**
* Entity metadata namespace
*/
namespace: string;
/**
* Entity metadata name
*/
name: string;
/**
* Entity lifecycle
*/
lifecycle: string;
/**
* Entity owner
*/
owner: string;
/**
* Entity path
*/
path: string;
}
/**
* A strategy for when to build TechDocs locally, and when to skip building TechDocs (allowing for an external build)
*
* @public
*/
export interface DocsBuildStrategy {
shouldBuild(params: { entity: Entity }): Promise<boolean>;
}