-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdata.ts
28 lines (24 loc) · 1.02 KB
/
data.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
export interface Data {
sections: ResourceBlock[];
}
interface ResourceBlock {
title: string;
description: string; // Accepts GitHub-flavored markdown
items?: Record<string, ResourceItem[]>; // e.g. { channels: ..., socialLinks: ... } - should correspond to a tag in the docs
issues?: Issue[];
}
interface ResourceItem {
operationSummary: string; // The "title" of the operation, or the name of the socket event
operationId: string; // Everything after https://www.guilded.gg/docs/api/{}
issues: Issue[];
}
export interface Issue {
description: string; // Accepts GitHub-flavored markdown
references?: Reference[]; // Messages (or any content) mentioning the issue or request, if applicable
isComplete?: boolean; // The issue is no longer applicable
completedAt?: string; // Approximate date or exact time (e.g. of an announcement) when the issue was resolved. Not required with isComplete
issues?: Issue[]; // Sub-issues, if applicable
}
interface Reference {
url: string; // URL to public content in Guilded
}