Extension

Extensions are custom pages that enhances Console capabilities by integrating it into the sidebar navigation.

To create or edit an extension, you need to provide a manifest, whose resources property should adhere to the following JSON schema.

tip

The JSON schemas of the extension resources and of the full extension manifest are available on GitHub.

Schema Viewer

Catalog extension resources

type : object

• contexts (string,...)[] required

  type : array

  • items[x] string

    type : string

    Possible values : 

    • console
    • project
    • company
• extensionType string required

  type : string

  Possible values : 

  • iframe
  • external-link
  • composer-page
• name string required

  type : string
• permissions (string,...)[]

  type : array

  • items[x] string

    type : string
• roleIds (string,...)[]

  type : array

  • items[x] string

    type : string

Resources of Catalog items of type extension

allOf

any

type : any

Always valid

Conditional subschemas

If

type : object

• extensionType string

  type : string

  Possible values : 

  • iframe
  • external-link

Then

type : object

• entry string required

  type : string
• routes (object,...)[]

  type : array

  • items[x] object

    type : object

    • destinationPath string

      type : string
    • icon object

      type : object

      • name string

        type : string
    • id string required

      type : string
    • labelIntl object required

      type : object

      • en string

        type : string
      • it string

        type : string
    • locationId string required

      type : string
    • matchExactMountPath boolean

      type : boolean
    • order number

      type : number
    • parentId string

      type : string
    • renderType "category" constant

      type : string

      Possible values : 

      • category

any

type : any

Always valid

Conditional subschemas

If

type : object

• extensionType "composer-page" constant

  type : string

  Constant value : composer-page

Then

type : object

• configuration string required

  type : string

Raw JSON Schema

{
  "$id": "catalog-extension-resources.schema.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "allOf": [
    {
      "if": {
        "properties": {
          "extensionType": {
            "enum": [
              "iframe",
              "external-link"
            ],
            "type": "string"
          }
        }
      },
      "then": {
        "properties": {
          "entry": {
            "type": "string"
          },
          "routes": {
            "items": {
              "properties": {
                "destinationPath": {
                  "type": "string"
                },
                "icon": {
                  "properties": {
                    "name": {
                      "type": "string"
                    }
                  },
                  "type": "object"
                },
                "id": {
                  "type": "string"
                },
                "labelIntl": {
                  "properties": {
                    "en": {
                      "type": "string"
                    },
                    "it": {
                      "type": "string"
                    }
                  },
                  "type": "object"
                },
                "locationId": {
                  "type": "string"
                },
                "matchExactMountPath": {
                  "type": "boolean"
                },
                "order": {
                  "type": "number"
                },
                "parentId": {
                  "type": "string"
                },
                "renderType": {
                  "enum": [
                    "category"
                  ],
                  "type": "string"
                }
              },
              "required": [
                "id",
                "locationId",
                "labelIntl"
              ],
              "type": "object"
            },
            "type": "array"
          }
        },
        "required": [
          "entry"
        ]
      }
    },
    {
      "if": {
        "properties": {
          "extensionType": {
            "const": "composer-page"
          }
        }
      },
      "then": {
        "properties": {
          "configuration": {
            "type": "string"
          }
        },
        "required": [
          "configuration"
        ]
      }
    }
  ],
  "description": "Resources of Catalog items of type extension",
  "properties": {
    "contexts": {
      "items": {
        "enum": [
          "console",
          "project",
          "company"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "extensionType": {
      "enum": [
        "iframe",
        "external-link",
        "composer-page"
      ],
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "permissions": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "roleIds": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "name",
    "extensionType",
    "contexts"
  ],
  "title": "Catalog extension resources",
  "type": "object",
  "examples": [
    {
      "name": "E-Commerce configurator",
      "extensionType": "iframe",
      "contexts": [
        "company"
      ],
      "entry": "https://e-commerce-configurator.com"
    },
    {
      "name": "E-Commerce dashboard",
      "extensionType": "external-link",
      "contexts": [
        "company"
      ],
      "entry": "https://e-commerce-dashboard.com"
    },
    {
      "name": "E-Commerce CMS",
      "extensionType": "composer-page",
      "contexts": [
        "project"
      ],
      "configuration": "{\"tag\":\"p\",\"content\":\"Hello!\"}"
    }
  ]
}

Example

{
  "name": "E-Commerce configurator",
  "extensionType": "iframe",
  "contexts": [
    "company"
  ],
  "entry": "https://e-commerce-configurator.com"
}