@fabrix/spool-tapestries/archetype/config/tapestries.ts

Spool - Tapestries, Easy RESTful Services

/**
 * Tapestries Configuration
 * (config.tapestries)
 *
 * Tapestries are routes that are auto-generated from your model and controller
 * definitions in api/controllers and api/models.
 *
 * @see https://fabrix.app/docs/config/tapestries
 */
export const tapestries = {
  /**
   * Prefix your tapestry routes
   */
  prefix: '/api/v1',

  /**
   * Generate routes for controller handlers.
   */
  controllers: false,

  /**
   * Generate conventional Create, Read, Update, and Delete (CRUD) routes for
   * each Model.
   */
  models: {
    options: {

      /**
       * The max number of objects to return by default. Can be overridden in
       * the request using the ?limit argument.
       */
      defaultLimit: 100,

      /**
       * Whether to populate all model associations by default (for "find")
       */
      populate: true
    },

    actions: {
      create: true,
      find: true,
      update: true,
      destroy: true,

      /**
       * Specify which "association" endpoints to activate.
       */
      createAssociation: true,
      findAssociation: true,
      updateAssociation: true,
      destroyAssociation: true
    }
  }
}