Meta

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "id": 1,
      "name": "core",
      "version": "0.0.1"
    },
    {
      "id": 2,
      "name": "auth",
      "version": "0.0.1"
    },
    {
      "id": 3,
      "name": "module-manager",
      "version": "0.0.1"
    }
  ]
}

Headers

Content-Type: application/json

Body

{
   "data": [
       {
           "id": "test-module",
           "name": "Testing Module",
           "version": "0.0.1",
           "class": "App\Models\SomeClass"
       },
       {
           "id": "acl-simple",
           "name": "Access Control Management",
           "version": "0.0.1",
           "class": null
       }
   ]
}

Headers

Content-Type: application/json

Body

{
  "key": "acl",
  "name": "Simple ACL Module",
  "version": "0.0.1",
  "class": "App\\Models\\SomeClass"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "description": "simple (string, required)"
    },
    "name": {
      "type": "string"
    },
    "version": {
      "type": "string"
    },
    "class": {
      "type": "string",
      "description": "The class that is associated with the module"
    }
  },
  "required": [
    "version"
  ]
}

Headers

Content-Type: application/json

Body

{
  "groups": [
    {
      "id": "some-group",
      "type": "group",
      "label": "group display name",
      "image": null,
      "action": null,
      "parameters": [],
      "permissions": null,
      "children": [
        {
          "id": null,
          "type": "action",
          "label": "Testing action",
          "image": null,
          "action": "testing::index",
          "parameters": [],
          "permissions": "do.something",
          "children": []
        }
      ]
    }
  ],
  "ungrouped": [
    {
      "id": "simple-acl",
      "type": "group",
      "label": "Access Control",
      "image": null,
      "action": null,
      "parameters": [],
      "permissions": null,
      "children": [
        {
          "id": "simple-acl-users",
          "type": "action",
          "label": "Users",
          "image": null,
          "action": "cms::acl.users.index",
          "parameters": [],
          "permissions": "acl.users.show",
          "children": []
        },
        {
          "id": "simple-acl-create-user",
          "type": "action",
          "label": "New User",
          "image": null,
          "action": "cms::acl.users.create",
          "parameters": [],
          "permissions": "acl.users.create",
          "children": []
        },
        {
          "id": "simple-acl-roles",
          "type": "action",
          "label": "Roles",
          "image": null,
          "action": "cms::acl.roles.index",
          "parameters": [],
          "permissions": "acl.roles.show",
          "children": []
        }
      ]
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "groups": {
      "type": "array",
      "description": "The menu items that are deliberately configured to be grouped. \nA nested array with Menu Presence objects (that blueprint cannot parse yet).\n"
    },
    "ungrouped": {
      "type": "array",
      "description": "The menu items that are left ungrouped. These may be added to its own default group, or listed separately.\nNote that these *will* still have their own individual module-defined nested structure.\nA nested array with Menu Presence objects (that blueprint cannot parse yet)\n"
    }
  }
}