All files / src/server route.config.js

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

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 1235x           5x                                                                                                                                                                                   5x                                           5x        
const { INTERACTIONS } = require('../constants');
 
/**
 * @name routes
 * @description Common express routes used for all resources
 */
let routes = [
  {
    type: 'patch',
    path: '/:base_version/:resource/:id',
    interaction: INTERACTIONS.PATCH,
  },
  {
    type: 'get',
    path: '/:base_version/:resource',
    interaction: INTERACTIONS.SEARCH,
  },
  {
    type: 'post',
    path: '/:base_version/:resource/_search',
    interaction: INTERACTIONS.SEARCH,
  },
  {
    type: 'get',
    path: '/:base_version/:resource/:id/_history/:version_id',
    interaction: INTERACTIONS.SEARCH_BY_VID,
  },
  {
    type: 'get',
    path: '/:base_version/:resource/_history',
    interaction: INTERACTIONS.HISTORY,
  },
  {
    type: 'get',
    path: '/:base_version/:resource/:id/_history',
    interaction: INTERACTIONS.HISTORY_BY_ID,
  },
  {
    type: 'get',
    path: '/:base_version/:resource/:id',
    interaction: INTERACTIONS.SEARCH_BY_ID,
  },
  {
    type: 'post',
    path: '/:base_version/:resource',
    interaction: INTERACTIONS.CREATE,
  },
  {
    type: 'put',
    path: '/:base_version/:resource/:id',
    interaction: INTERACTIONS.UPDATE,
  },
  {
    type: 'delete',
    path: '/:base_version/:resource/:id',
    interaction: INTERACTIONS.DELETE,
  },
  /* eslint-disable no-useless-escape */
  {
    type: 'get',
    path: '/:base_version/:resource/:id/([$])expand',
    interaction: INTERACTIONS.EXPAND_BY_ID,
  },
  /* eslint-disable no-useless-escape */
  {
    type: 'post',
    path: '/:base_version/:resource',
    interaction: INTERACTIONS.OPERATIONS_POST,
  },
  {
    type: 'get',
    path: '/:base_version/:resource',
    interaction: INTERACTIONS.OPERATIONS_GET,
  },
  // bundle
  {
    type: 'get',
    path: '/:base_version',
    interaction: INTERACTIONS.OPERATIONS_GET,
  },
  {
    type: 'post',
    path: '/:base_version',
    interaction: INTERACTIONS.OPERATIONS_POST,
  },
  {
    type: 'put',
    path: '/:base_version/',
    interaction: INTERACTIONS.OPERATIONS_PUT,
  },
];
 
/**
 * @name routeArgs
 * @description Common express arguments used on many routes as route params
 */
let routeArgs = {
  BASE: {
    name: 'base_version',
    type: 'string',
    conformance_hide: true,
  },
  ID: {
    name: 'id',
    type: 'string',
    conformance_hide: true,
  },
  VERSION_ID: {
    name: 'version_id',
    type: 'string',
    conformance_hide: true,
  },
};
 
/**
 * @name exports
 * @summary Route config
 */
module.exports = {
  routeArgs: routeArgs,
  routes,
};