atlassian-connect.json

{
  "key": "structurizr-confluence",
  "name": "Structurizr",
  "description": "Structurizr for Atlassian Confluence Cloud",
  "apiVersion": 2,
  "version": "2.3.0",
  "vendor": {
    "name": "Structurizr Limited",
    "url": "https://structurizr.com"
  },
  "baseUrl": "https://static.structurizr.com/atlassian-confluence-cloud",
  "authentication": {
    "type": "none"
  },"scopes": [
    "read"
  ],
  "modules": {
    "dynamicContentMacros": [
      {
        "key": "structurizr-workspace",
        "name": {
          "i18n": "structurizr-workspace.macro.name",
          "value": "Structurizr workspace embed"
        },
        "description": {
          "i18n": "structurizr-workspace.macro.desc",
          "value": "Embeds a diagram from a Structurizr workspace (please note that diagram previews do not always display - you may need to save/publish the page)."
        },
        "width": "100%",
        "height": "100px",
        "url": "/embed-workspace.html?pageId={page.id}&pageVersion={page.version}&macroId={macro.id}",
        "icon": {
          "height": 80,
          "url": "/img/structurizr-logo-square.png",
          "width": 80
        },
        "bodyType": "none",
        "documentation": {
          "url": "https://github.com/structurizr/atlassian-confluence-cloud"
        },
        "categories": [ "external-content", "visuals" ],
        "parameters": [
          {
            "identifier": "structurizrUrl",
            "name": {
              "value": "Structurizr URL"
            },
            "description": {
              "value": "The URL of the Structurizr installation."
            },
            "type": "string",
            "required": true,
            "multiple": false,
            "defaultValue": "https://structurizr.com",
            "hidden": false
          },
          {
            "identifier": "workspaceId",
            "name": {
              "value": "Workspace ID"
            },
            "description": {
              "value": "The ID of the workspace."
            },
            "type": "string",
            "required": true,
            "multiple": false,
            "defaultValue": "",
            "hidden": false
          },
          {
            "identifier": "apiKey",
            "name": {
              "value": "API key"
            },
            "description": {
              "value": "The workspace API key (required for private workspaces)."
            },
            "type": "string",
            "required": false,
            "multiple": false,
            "defaultValue": "",
            "hidden": false
          },
          {
            "identifier": "diagram",
            "name": {
              "value": "Diagram key"
            },
            "description": {
              "value": "The key of the diagram to embed."
            },
            "type": "string",
            "required": true,
            "multiple": false,
            "defaultValue": "",
            "hidden": false
          },
          {
            "identifier": "perspective",
            "name": {
              "value": "Perspective"
            },
            "description": {
              "value": "The name of the perspective to show (optional)."
            },
            "type": "string",
            "required": false,
            "multiple": false,
            "defaultValue": "",
            "hidden": false
          },
          {
            "identifier": "diagramSelector",
            "name": {
              "value": "Diagram selector"
            },
            "description": {
              "value": "Include the diagram selector."
            },
            "type": "boolean",
            "required": true,
            "multiple": false,
            "defaultValue": "false",
            "hidden": false
          }
        ]
      }
    ]
  }
}