UNPKG

1.01 kBTypeScriptView Raw
1export interface ApiFile {
2 apiTitle: string;
3 filePath?: string;
4 apiRepository?: string;
5 revision?: string;
6 mdFile?: string;
7}
8export interface ApiVersion {
9 name: string;
10 visibleName?: string;
11 revision: string;
12 exclude?: Array<string>;
13}
14export interface ApiDefinition {
15 name: string;
16 apiRepository: string;
17 deprecations?: {
18 [apiName: string]: {
19 inVersion: string;
20 notice?: string;
21 removedIn?: string;
22 };
23 };
24 files: Array<ApiFile>;
25 versions: Array<ApiVersion>;
26}
27export interface StaticFileDefinition {
28 name: string;
29 urlName: string;
30 markdownFilePath: string;
31 removedIn?: string;
32 deprecated?: string;
33}
34export interface ApiStaticDefinitionObject {
35 version: string;
36 files?: Array<StaticFileDefinition>;
37 ref?: string;
38 alongWith?: string;
39}
40export interface ApiStaticDefinition {
41 name: string;
42 apiRepository: string;
43 apis: Array<ApiStaticDefinitionObject>;
44}