All files / types/api errors.ts

0% Statements 0/20
100% Branches 1/1
100% Functions 1/1
0% Lines 0/20

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103                                                                                                                                                                                                             
import {
  api400Body,
  api401Body,
  api403Body,
  api500Body
} from '@/types/api/_shared';
import { Validator } from '@/types/backend/validation';
 
export interface ErrorTableItem {
  Datetime: number;
  Url: string;
  Message: string;
  Trace: string;
  UserAgent: string;
  User?: string;
}
 
/**
 * Retrieve a list of the last 100 errors that have been reported
 * @summary Retrieve Errors List
 * @tags Errors
 */
export type GetErrorsApi = {
  path: '/api/v2/errors/';
  method: 'GET';
  responses: {
 
    /**
     * @contentType application/json
     */
    200: {
      errors: ErrorTableItem[];
    };
 
    /**
     * @contentType application/json
     */
    401: typeof api401Body;
 
    /**
     * @contentType application/json
     */
    403: typeof api403Body;
 
    /**
     * @contentType application/json
     */
    500: typeof api500Body;
  };
  security: [{
    cookie: [];
  }];
};
 
/**
 * Sends an error message to the backend signaling a front-end error.
 * @summary Log Error Event
 * @tags Errors
 * @body.contentType application/json
 */
export type AddErrorApi = {
  path: '/api/v2/errors/';
  method: 'POST';
  body: {
    url: string;
    message: string;
    trace: string;
  };
  responses: {
 
    /**
     * @contentType application/json
     */
    400: typeof api400Body;
 
    /**
     * @contentType application/json
     */
    500: typeof api500Body;
  };
};
 
export const errorItemValidator: Validator<AddErrorApi['body']> = {
  url: {
    required: true,
    types: {
      string: {},
    },
  },
  message: {
    required: true,
    types: {
      string: {},
    },
  },
  trace: {
    required: true,
    types: {
      string: {},
    },
  },
};