corteza/api/crm/spec/module.json

{
  "Title": "Modules",
  "Description": "CRM module definitions",
  "Package": "crm",
  "Interface": "Module",
  "Struct": [
    {
      "imports": [
        "sqlxTypes github.com/jmoiron/sqlx/types",
        "github.com/crusttech/crust/crm/types"
      ]
    }
  ],
  "Parameters": null,
  "Protocol": "",
  "Authentication": [],
  "Path": "/module",
  "APIs": [
    {
      "Name": "list",
      "Method": "GET",
      "Title": "List modules",
      "Path": "/",
      "Parameters": {
        "get": [
          {
            "name": "query",
            "required": false,
            "title": "Search query",
            "type": "string"
          }
        ]
      }
    },
    {
      "Name": "create",
      "Method": "POST",
      "Title": "Create module",
      "Path": "/",
      "Parameters": {
        "post": [
          {
            "name": "name",
            "required": true,
            "title": "Module Name",
            "type": "string"
          },
          {
            "name": "fields",
            "required": true,
            "title": "Fields JSON",
            "type": "types.ModuleFieldSet"
          }
        ]
      }
    },
    {
      "Name": "read",
      "Method": "GET",
      "Title": "Read module",
      "Path": "/{moduleID}",
      "Parameters": {
        "path": [
          {
            "name": "moduleID",
            "required": true,
            "title": "Module ID",
            "type": "uint64"
          }
        ]
      }
    },
    {
      "Name": "chart",
      "Method": "GET",
      "Title": "Analyze data for chart",
      "Path": "/{moduleID}/chart",
      "Parameters": {
        "get": [
          {
            "name": "name",
            "required": true,
            "title": "The chart name",
            "type": "string"
          },
          {
            "name": "description",
            "required": true,
            "title": "The chart description",
            "type": "string"
          },
          {
            "name": "xAxis",
            "required": true,
            "title": "X axis value",
            "type": "string"
          },
          {
            "name": "xMin",
            "required": false,
            "title": "Min value",
            "type": "string"
          },
          {
            "name": "xMax",
            "required": false,
            "title": "Max value",
            "type": "string"
          },
          {
            "name": "yAxis",
            "required": true,
            "title": "Y axis value",
            "type": "string"
          },
          {
            "name": "groupBy",
            "required": true,
            "title": "Group by field",
            "type": "string"
          },
          {
            "name": "sum",
            "required": true,
            "title": "Sum values field",
            "type": "string"
          },
          {
            "name": "count",
            "required": true,
            "title": "Count values field",
            "type": "string"
          },
          {
            "name": "kind",
            "required": true,
            "title": "Chart kind (line, spline, step, area, area-spline, area-step, bar, scatter, pie, donut, gauge)",
            "type": "string"
          }
        ],
        "path": [
          {
            "name": "moduleID",
            "required": true,
            "title": "Module ID",
            "type": "uint64"
          }
        ]
      }
    },
    {
      "Name": "edit",
      "Method": "POST",
      "Title": "Edit module",
      "Path": "/{moduleID}",
      "Parameters": {
        "path": [
          {
            "name": "moduleID",
            "required": true,
            "title": "Module ID",
            "type": "uint64"
          }
        ],
        "post": [
          {
            "name": "name",
            "required": true,
            "title": "Module Name",
            "type": "string"
          },
          {
            "name": "fields",
            "required": true,
            "title": "Fields JSON",
            "type": "types.ModuleFieldSet"
          }
        ]
      }
    },
    {
      "Name": "delete",
      "Method": "DELETE",
      "Title": "Delete module",
      "Path": "/{moduleID}",
      "Parameters": {
        "path": [
          {
            "name": "moduleID",
            "required": true,
            "title": "Module ID",
            "type": "uint64"
          }
        ]
      }
    },
    {
      "Name": "content/report",
      "Method": "GET",
      "Title": "Generates report from module records",
      "Path": "/{moduleID}/report",
      "Parameters": {
        "get": [
          {
            "name": "metrics",
            "required": true,
            "title": "Metrics (syntax: alias:expression;...)",
            "type": "string"
          },
          {
            "name": "dimensions",
            "required": true,
            "title": "Dimensions (syntax: alias:field|modifier|modifier2;...)",
            "type": "string"
          }
        ],
        "path": [
          {
            "name": "moduleID",
            "required": true,
            "title": "Module ID",
            "type": "uint64"
          }
        ]
      }
    },
    {
      "Name": "content/list",
      "Method": "GET",
      "Title": "List/read contents from module section",
      "Path": "/{moduleID}/content",
      "Parameters": {
        "get": [
          {
            "name": "query",
            "required": false,
            "title": "Search query",
            "type": "string"
          },
          {
            "name": "page",
            "required": false,
            "title": "Page number (0 based)",
            "type": "int"
          },
          {
            "name": "perPage",
            "required": false,
            "title": "Returned items per page (default 50)",
            "type": "int"
          },
          {
            "name": "sort",
            "required": false,
            "title": "Sort field (default id desc)",
            "type": "string"
          }
        ],
        "path": [
          {
            "name": "moduleID",
            "required": true,
            "title": "Module ID",
            "type": "uint64"
          }
        ]
      }
    },
    {
      "Name": "content/create",
      "Method": "POST",
      "Title": "List/read contents from module section",
      "Path": "/{moduleID}/content",
      "Parameters": {
        "path": [
          {
            "name": "moduleID",
            "required": true,
            "title": "Module ID",
            "type": "uint64"
          }
        ],
        "post": [
          {
            "name": "fields",
            "required": true,
            "title": "Content JSON",
            "type": "sqlxTypes.JSONText"
          }
        ]
      }
    },
    {
      "Name": "content/read",
      "Method": "GET",
      "Title": "Read contents by ID from module section",
      "Path": "/{moduleID}/content/{contentID}",
      "Parameters": {
        "path": [
          {
            "name": "moduleID",
            "required": true,
            "title": "Module ID",
            "type": "uint64"
          },
          {
            "name": "contentID",
            "required": true,
            "title": "Content ID",
            "type": "uint64"
          }
        ]
      }
    },
    {
      "Name": "content/edit",
      "Method": "POST",
      "Title": "Add/update contents in module section",
      "Path": "/{moduleID}/content/{contentID}",
      "Parameters": {
        "path": [
          {
            "name": "moduleID",
            "required": true,
            "title": "Module ID",
            "type": "uint64"
          },
          {
            "name": "contentID",
            "required": true,
            "title": "Content ID",
            "type": "uint64"
          }
        ],
        "post": [
          {
            "name": "fields",
            "required": true,
            "title": "Content JSON",
            "type": "sqlxTypes.JSONText"
          }
        ]
      }
    },
    {
      "Name": "content/delete",
      "Method": "DELETE",
      "Title": "Delete content row from module section",
      "Path": "/{moduleID}/content/{contentID}",
      "Parameters": {
        "path": [
          {
            "name": "moduleID",
            "required": true,
            "title": "Module ID",
            "type": "uint64"
          },
          {
            "name": "contentID",
            "required": true,
            "title": "Content ID",
            "type": "uint64"
          }
        ]
      }
    }
  ]
}