{
  "key": "com.playsql.requirementyogi",
  "baseUrl": "https://ww1.requirementyogi.cloud",
  "regionBaseUrls": {
    "EU": "https://ww1.requirementyogi.cloud",
    "US": "https://ww1.us.requirementyogi.cloud"
  },
  "name": "Requirement Yogi for Confluence Cloud",
  "description": "Contact us at https://requirementyogi.atlassian.net/servicedesk - Documentation at https://docs.requirementyogi.com/cloud/",
  "enableLicensing": true,
  "vendor": {
    "name": "Requirement Yogi",
    "url": "https://www.requirementyogi.com"
  },
  "authentication": {
    "type": "jwt"
  },
  "apiMigrations": {
    "context-qsh": true,
    "signed-install": true
  },
  "cloudAppMigration": {
    "migrationWebhookPath": "/rest/admin/migrations/atlassian/notification"
  },
  "dataResidency": {
    "realmPersistenceDays": 30
  },
  "lifecycle": {
    "installed": "/installation",
    "uninstalled": "/uninstalled",
    "enabled": "/lifecycle/enabled",
    "disabled": "/lifecycle/disabled"
  },
  "links": {
    "documentation": "https://documentation.requirementyogi.com/display/RYC",
    "support": "https://requirementyogi.atlassian.net/servicedesk"
  },
  "modules": {
    "generalPages": [
      {
        "key": "transformation-page-dialog",
        "name": {
          "value": "Page transformation"
        },
        "url": "/web/transform/page-transformation-dialog?spaceKey={ac.spaceKey}&contentId={ac.contentId}&backUrl={ac.backUrl}",
        "location": "none"
      },
      {
        "key": "create-sample",
        "name": {
          "value": "Create sample data"
        },
        "url": "/web/champion/sample",
        "location": "none"
      },
      {
        "key": "requirement-search-page",
        "name": {
          "value": "Requirements"
        },
        "url": "/web/search?spaceKey={space.key}&search={ac.search}&requirement={ac.requirement}&variantId={ac.variantId}&query={ac.query}&redirect={ac.redirect}&pageId={ac.pageId}",
        "location": "none"
      },
      {
        "key": "about",
        "name": {
          "value": "About Requirement Yogi"
        },
        "url": "/web/about",
        "location": "system.help/pages"
      },
      {
        "key": "health",
        "name": {
          "value": "Health information"
        },
        "url": "/web/health",
        "location": "none"
      },
      {
        "key": "champion",
        "name": {
          "value": "RY Champion center"
        },
        "url": "/web/champion",
        "location": "system.content.action"
      }
    ],
    "customContent": [
      {
        "key": "requirements",
        "name": {
          "value": "Requirements"
        },
        "apiSupport": {
          "supportedContainerTypes": ["space"]
        },
        "uiSupport": {
          "listViewComponent": {
            "moduleKey": "requirement-search-page"
          },
          "contentViewComponent": {
            "moduleKey": "requirement-search-page"
          },
          "icons": {
            "item": {
              "width": 16,
              "height": 16,
              "url": "/web/static/media/ry-v3-svg-simple-blue-bicolor.svg"
            }
          }
        }
      }
    ],
    "staticContentMacros": [
      {
        "key": "requirement-yogi",
        "name": {
          "value": "Requirement Yogi"
        },
        "categories": ["external-content"],
        "description": {
          "value": "Define a requirement"
        },
        "icon": {
          "width": 16,
          "height": 16,
          "url": "/web/static/media/ry-v3-svg-simple.svg"
        },
        "url": "/macro/requirement-definition?pageId={content.id}&spaceKey={space.key}&reqKey={reqKey}",
        "outputType": "inline",
        "parameters": [
          {
            "identifier": "reqKey",
            "name": {
              "value": "Requirement key"
            },
            "type": "string",
            "required": true,
            "multiple": false
          }
        ],
        "editor": {
          "url": "/web/macro/requirement-editor",
          "editTitle": {
            "value": "Edit the requirement macro"
          },
          "insertTitle": {
            "value": "Insert a requirement macro"
          },
          "width": "500px",
          "height": "300px"
        }
      },
      {
        "key": "requirement-yogi-link",
        "name": {
          "value": "Requirement Yogi link"
        },
        "categories": ["external-content"],
        "description": {
          "value": "Link to a requirement"
        },
        "icon": {
          "width": 16,
          "height": 16,
          "url": "/web/static/media/ry-v3-svg-simple.svg"
        },
        "url": "/macro/link?pageId={content.id}&spaceKey={spaceKey}&pageSpaceKey={space.key}&reqKey={reqKey}&variantId={variantId}&hideRequirementKey={hideRequirementKey}&properties={properties}",
        "outputType": "inline",
        "parameters": [
          {
            "identifier": "reqKey",
            "name": {
              "value": "Requirement key"
            },
            "type": "string",
            "required": true,
            "multiple": false
          },
          {
            "identifier": "spaceKey",
            "name": {
              "value": "Space key"
            },
            "type": "string",
            "required": true,
            "multiple": false,
            "hidden": false
          },
          {
            "identifier": "variantId",
            "name": {
              "value": "Variant identifier"
            },
            "type": "string",
            "required": false,
            "multiple": false,
            "hidden": false
          },
          {
            "identifier": "hardLinkVariant",
            "name": {
              "value": "Force the variant destination"
            },
            "description": {
              "value": "If set, the link will always point to the specified variant"
            },
            "type": "boolean",
            "defaultValue": "false",
            "required": false,
            "hidden": false,
            "indexing": {
              "enabled": false
            }
          },
          {
            "identifier": "hardLinkSpace",
            "name": {
              "value": "Force the space destination"
            },
            "description": {
              "value": "If set, the link will always point to the specified space"
            },
            "type": "boolean",
            "defaultValue": "false",
            "required": false,
            "hidden": false,
            "indexing": {
              "enabled": false
            }
          },
          {
            "identifier": "properties",
            "name": {
              "value": "Selected properties displayed"
            },
            "description": {
              "value": "Json representation of the properties to display in the link"
            },
            "type": "string",
            "required": false,
            "multiple": false,
            "hidden": false,
            "indexing": {
              "enabled": false
            }
          }
        ],
        "editor": {
          "url": "/web/macro/link-editor",
          "editTitle": {
            "value": "Edit the link macro"
          },
          "insertTitle": {
            "value": "Insert a link macro"
          }
        }
      },
      {
        "key": "requirements-configuration",
        "name": {
          "value": "Requirement Yogi configuration"
        },
        "categories": ["external-content"],
        "description": {
          "value": "Configure the indexing of requirements"
        },
        "icon": {
          "width": 16,
          "height": 16,
          "url": "/web/static/media/ry-v3-svg-simple.svg"
        },
        "url": "/macro/requirements-configuration?render={output.type}&configuration={configuration}&spaceKey={space.key}&pageId={page.id}",
        "outputType": "inline",
        "parameters": [
          {
            "identifier": "configuration",
            "name": {
              "value": "Configuration"
            },
            "type": "string",
            "required": true,
            "multiple": false
          }
        ],
        "editor": {
          "url": "/web/macro/requirement-configuration-editor",
          "editTitle": {
            "value": "Edit the configuration macro"
          },
          "insertTitle": {
            "value": "Insert a configuration macro"
          },
          "width": "60%",
          "height": "60%"
        }
      },
      {
        "key": "requirement-yogi-calculation",
        "name": {
          "value": "Requirement Yogi calculation"
        },
        "categories": ["external-content"],
        "description": {
          "value": "Perform a calculation based on requirement properties"
        },
        "icon": {
          "width": 16,
          "height": 16,
          "url": "/web/static/media/ry-v3-svg-simple.svg"
        },
        "url": "/macro/calculation?spaceKey={spaceKey}&variantId={variantId}&key={key}&formula={formula}",
        "outputType": "inline",
        "parameters": [
          {
            "identifier": "spaceKey",
            "name": {
              "value": "Space key"
            },
            "type": "string",
            "required": true,
            "multiple": false,
            "hidden": false
          },
          {
            "identifier": "variantId",
            "name": {
              "value": "Variant identifier"
            },
            "type": "int",
            "required": false,
            "multiple": false,
            "hidden": false
          },
          {
            "identifier": "key",
            "name": {
              "value": "Requirement key"
            },
            "type": "string",
            "required": true,
            "multiple": false
          },
          {
            "identifier": "formula",
            "name": {
              "value": "Calculation formula"
            },
            "type": "string",
            "required": true,
            "multiple": false
          }
        ],
        "editor": {
          "url": "/web/macro/calculation-editor",
          "editTitle": {
            "value": "Edit the calculation macro"
          },
          "insertTitle": {
            "value": "Insert a calculation macro"
          }
        }
      }
    ],
    "dynamicContentMacros": [
      {
        "key": "ry-report-macro",
        "name": {
          "value": "Requirement Yogi report"
        },
        "url": "/web/macro/report?render={output.type}&queryId={queryId}&enableEditExtProp={enableEditExtProp}",
        "renderModes": {
          "default": {
            "url": "/macro/report-static?render={output.type}&queryId={queryId}&showTitle={showTitle}&showDescription={showDescription}&values={values}&contentId={ac.contentId}&pageId={page.id}"
          }
        },
        "description": {
          "value": "Insert a Requirement Yogi report"
        },
        "icon": {
          "width": 16,
          "height": 16,
          "url": "/web/static/media/ry-v3-svg-simple.svg"
        },
        "documentation": {
          "url": "https://docs.requirementyogi.com/cloud/traceability-matrix"
        },
        "categories": ["reporting"],
        "outputType": "block",
        "bodyType": "none",
        "aliases": ["report"],
        "featured": true,
        "parameters": [
          {
            "identifier": "queryId",
            "name": {
              "value": "Saved query identifier"
            },
            "description": {
              "value": "The identifier of the saved query"
            },
            "type": "int",
            "required": true,
            "hidden": false,
            "indexing": {
              "enabled": false
            }
          },
          {
            "identifier": "enableEditExtProp",
            "name": {
              "value": "Enable edit external properties"
            },
            "description": {
              "value": "Whether to allow editing the external properties from the Confluence page"
            },
            "type": "boolean",
            "defaultValue": "false",
            "required": true,
            "hidden": false,
            "indexing": {
              "enabled": false
            }
          },
          {
            "identifier": "showTitle",
            "name": {
              "value": "Enable to show the title of the report"
            },
            "description": {
              "value": "Should the report title be shown"
            },
            "type": "boolean",
            "defaultValue": "true",
            "hidden": false,
            "indexing": {
              "enabled": false
            }
          },
          {
            "identifier": "showDescription",
            "name": {
              "value": "Enable to show the description of the report"
            },
            "description": {
              "value": "Should the report description be shown"
            },
            "type": "boolean",
            "defaultValue": "true",
            "hidden": false,
            "indexing": {
              "enabled": false
            }
          },
          {
            "identifier": "spaceKey",
            "name": {
              "value": "Space key"
            },
            "description": {
              "value": "The space key to which the saved query belongs"
            },
            "type": "string",
            "required": true,
            "hidden": false,
            "indexing": {
              "enabled": false
            }
          },
          {
            "identifier": "values",
            "name": {
              "value": "Values"
            },
            "description": {
              "value": "The values of variables declared in the query"
            },
            "type": "string",
            "required": false,
            "hidden": false,
            "indexing": {
              "enabled": false
            }
          }
        ],
        "editor": {
          "url": "/web/macro/report-editor",
          "editTitle": {
            "value": "Edit the report macro"
          },
          "insertTitle": {
            "value": "Insert a report macro"
          }
        }
      }
    ],
    "contentBylineItems": [
      {
        "key": "ry-byline",
        "context": "addon",
        "url": "/web/byline/dialog?pageId={content.id}",
        "name": {
          "value": "Requirement Yogi"
        },
        "target": {
          "type": "inlinedialog",
          "options": {
            "showDelay": 200,
            "onHover": false,
            "width": "380px",
            "chrome": false
          }
        },
        "icon": {
          "width": 16,
          "height": 16,
          "url": "/web/static/media/ry-v3-svg-simple.svg"
        },
        "conditions": [
          {
            "condition": "has_page_permission",
            "params": {
              "permission": "EDIT"
            }
          }
        ]
      }
    ],
    "confluenceContentProperties": [
      {
        "keyConfigurations": [
          {
            "propertyKey": "requirement_yogi_migration",
            "extractions": [
              {
                "objectName": "isMigrated",
                "type": "string",
                "alias": "ryc_isMigrated"
              }
            ]
          }
        ],
        "name": {
          "value": "Requirement Yogi migration status"
        },
        "key": "RYC-ContentProperty"
      }
    ],
    "webItems": [
      {
        "key": "transform-web-item",
        "name": {
          "value": "RY Transformation Wizard"
        },
        "url": "/web/transform/dialog",
        "location": "system.content.action/modify",
        "target": {
          "type": "dialog",
          "options": {
            "header": {
              "value": "Requirement definition configuration"
            },
            "size": "maximum",
            "chrome": false
          }
        },
        "conditions": [
          {
            "condition": "has_page_permission",
            "params": {
              "permission": "EDIT"
            }
          }
        ]
      },
      {
        "key": "doc",
        "name": {
          "value": "Requirement Yogi Documentation"
        },
        "url": "https://documentation.requirementyogi.com/display/RYC",
        "location": "system.help/pages"
      }
    ],
    "configurePage": {
      "url": "/web/administration",
      "key": "configure",
      "name": {
        "value": "Requirement Yogi administration"
      }
    },
    "postInstallPage": {
      "url": "/web/installation-checklist",
      "name": {
        "value": "Requirement Yogi"
      },
      "key": "post-install"
    },
    "adminPages": [
      {
        "url": "/web/gdpr-uninstall",
        "name": {
          "value": "Requirement Yogi Administration"
        },
        "key": "gdpr-uninstall",
        "location": "none"
      },
      {
        "url": "/web/support",
        "name": {
          "value": "Support - Requirement Yogi"
        },
        "weight": 300,
        "key": "support",
        "location": "system.admin/admin-section"
      },
      {
        "url": "/web/migration-notifications",
        "name": {
          "value": "Requirement Yogi Migration Notifications"
        },
        "key": "migration-notifications",
        "location": "none"
      },
      {
        "url": "/web/administration",
        "name": {
          "value": "Administration - Requirement Yogi"
        },
        "weight": 200,
        "key": "administration",
        "location": "system.admin/admin-section"
      },
      {
        "url": "/web/installation-checklist",
        "name": {
          "value": "Installation checklist - Requirement Yogi"
        },
        "weight": 100,
        "key": "installation-checklist",
        "location": "system.admin/admin-section"
      }
    ],
    "webSections": [
      {
        "key": "admin-section",
        "location": "system.admin",
        "name": {
          "value": "Requirement Yogi"
        },
        "weight": 50
      }
    ],
    "webhooks": [
      {
        "event": "page_created",
        "url": "/page/created",
        "excludeBody": false
      },
      {
        "event": "page_updated",
        "url": "/page/updated",
        "excludeBody": false
      },
      {
        "event": "page_trashed",
        "url": "/page/deleted",
        "excludeBody": false
      },
      {
        "event": "page_moved",
        "url": "/page/moved",
        "excludeBody": false
      },
      {
        "event": "page_restored",
        "url": "/page/restored",
        "excludeBody": false
      },
      {
        "event": "page_archived",
        "url": "/page/archived",
        "excludeBody": false
      },
      {
        "event": "page_children_reordered",
        "url": "/page/children_reordered",
        "excludeBody": false
      },
      {
        "event": "page_copied",
        "url": "/page/copied",
        "excludeBody": false
      },
      {
        "event": "page_removed",
        "url": "/page/removed",
        "excludeBody": false
      },
      {
        "event": "page_unarchived",
        "url": "/page/unarchived",
        "excludeBody": false
      }
    ]
  },
  "scopes": ["act_as_user", "read", "write"]
}