All files / types/api heartbeats.ts

100% Statements 16/16
100% Branches 0/0
100% Functions 0/0
100% Lines 16/16

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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125    1x                                                                                                                                                                                                                     1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x  
import { Validator } from '../backend/validation';
 
import { apiCodeValidator } from './_code';
import {
  api400Body,
  api401Body, api403Body, api500Body
} from './_shared';
 
export interface Heartbeat {
  Server: string;
  LastHeartbeat?: number;
  IsActive?: boolean;
  IsFailed?: boolean;
  IsPrimary?: boolean;
}
 
/**
 * Retrieve the current heartbeat information from the VHF recorders
 * @summary Retrieve Current Recorder State
 * @tags Heartbeats
 */
export type GetAllHeartbeatsApi = {
  path: '/api/v2/heartbeats/';
  method: 'GET';
  responses: {
 
    /**
     * @contentType application/json
     */
    200: Heartbeat[];
 
    /**
     * @contentType application/json
     */
    401: typeof api401Body;
 
    /**
     * @contentType application/json
     */
    403: typeof api403Body;
 
    /**
     * @contentType application/json
     */
    500: typeof api500Body;
  };
  security: [{
    cookie: [],
  }];
};
 
/**
 * Add a heartbeat from a recorder
 * @summary Add Heartbeat
 * @tags Heartbeats
 * @body.contentType application/json
 */
export type AddHeartbeatApi = {
  path: '/api/v2/heartbeats/';
  method: 'POST';
  body: {
 
    /**
     * The name of the server that is sending the heartbeat
     */
    Server: string;
 
    /**
     * Is this server self-identifying as the primary server?
     */
    IsPrimary: boolean;
 
    /**
     * Is this server actively uploading files?
     */
    IsActive: boolean;
 
    /**
     * The API code for validation
     */
    code: string;
  };
  responses: {
 
    /**
     * @contentType application/json
     */
    200: Heartbeat[];
 
    /**
     * @contentType application/json
     */
    400: typeof api400Body;
 
    /**
     * @contentType application/json
     */
    401: typeof api401Body;
 
    /**
     * @contentType application/json
     */
    500: typeof api500Body;
  };
  security: [{
    apiKey: [];
  }];
};
 
export const addHeartbeatBodyValidator: Validator<AddHeartbeatApi['body']> = {
  ...apiCodeValidator,
  Server: {
    required: true,
    types: { string: {}, },
  },
  IsPrimary: {
    required: true,
    types: { boolean: {}, },
  },
  IsActive: {
    required: true,
    types: { boolean: {}, },
  },
};