Developer
API Types

API Types

With reference to the documentation, below are typescript definitions to expect for certain key endpoints.

interface WikiSubmissionResponse<T> {
    /** Whether the request was successful for its intended purpose */
    success: boolean;
 
    /** The response data */
    results: T;
 
    /** Additional request details */
    metadata: { 
        timestamp: number;
    };
 
    /** The response error, if thrown */
    error?: {
        name: string;
        description: string;
        fault: 'client' | 'server';
        severity: 'low' | 'medium' | 'high';
    };
}