| 1 | export interface PingResponse {
|
| 2 | pong?: string;
|
| 3 | }
|
| 4 | export interface PreviewResponse {
|
| 5 | expires_at?: string;
|
| 6 | id: string;
|
| 7 | public_url?: string;
|
| 8 | }
|
| 9 | export interface InvalidDefinitionError {
|
| 10 | errors: {
|
| 11 | [keys: string]: unknown;
|
| 12 | };
|
| 13 | message?: string;
|
| 14 | }
|
| 15 | export interface PreviewRequest {
|
| 16 | definition: string;
|
| 17 | references?: Reference[];
|
| 18 | }
|
| 19 | export interface Reference {
|
| 20 | content?: string;
|
| 21 | location?: string;
|
| 22 | }
|
| 23 | export interface VersionRequest {
|
| 24 | auto_create_documentation?: boolean;
|
| 25 | branch_name?: string;
|
| 26 | definition: string;
|
| 27 | documentation: string;
|
| 28 | documentation_name?: string;
|
| 29 | hub?: string;
|
| 30 | previous_version_id?: string;
|
| 31 | references?: Reference[];
|
| 32 | unpublished?: boolean;
|
| 33 | }
|
| 34 | export interface VersionResponse {
|
| 35 | doc_public_url?: string;
|
| 36 | id: string;
|
| 37 | }
|
| 38 | export interface WithDiff {
|
| 39 | diff_breaking?: boolean;
|
| 40 | diff_details?: DiffItem[];
|
| 41 | diff_markdown?: string;
|
| 42 | diff_public_url?: string;
|
| 43 | diff_summary?: string;
|
| 44 | }
|
| 45 | export interface DiffRequest {
|
| 46 | definition: string;
|
| 47 | expires_at?: string;
|
| 48 | previous_definition: string;
|
| 49 | previous_references?: Reference[];
|
| 50 | references?: Reference[];
|
| 51 | }
|
| 52 | export interface DiffResponse {
|
| 53 | breaking?: boolean;
|
| 54 | details?: DiffItem[];
|
| 55 | html?: string;
|
| 56 | id: string;
|
| 57 | markdown?: string;
|
| 58 | public_url?: string;
|
| 59 | text?: string;
|
| 60 | }
|
| 61 | export interface DiffItem {
|
| 62 | breaking: boolean;
|
| 63 | children: DiffItem[];
|
| 64 | id: string;
|
| 65 | name: string;
|
| 66 | status: string;
|
| 67 | type: string;
|
| 68 | }
|