Frequently asked questions

1. Why is there no "Try it out" button?

Sending live requests from a page to your API means the browser must contact arbitrary hosts, which requires external permissions on Atlassian Forge. Apps with those permissions cannot be Runs on Atlassian. We chose the Runs on Atlassian guarantee (nothing leaves Atlassian) over live calls. Use Postman, curl, or your API gateway's console for testing. We may offer a separate edition if enough customers ask for it.

2. Can the macro load a spec from a URL or a Git repository?

No, not in version 1. Fetching a URL is outbound traffic, which the Runs on Atlassian model does not allow. Instead, push the spec from CI as a page attachment. This works for private repositories because the app never needs access to them.

3. What are the size limits?

Pasted specs: about 150 KB. Attachments: no app-imposed small cap, but your site's maximum attachment size applies, and very large files render more slowly. See attachment mode.

4. Is my data secure? Where does it live?

The app is built on Atlassian Forge and designed to run entirely on Atlassian infrastructure. It declares no external permissions, makes no outbound requests, stores no credentials, and has no analytics beacons. Your spec stays in your Confluence site (as macro configuration or as a page attachment), subject to the same access controls as the rest of the page. For data residency, the data follows Atlassian's hosting for your site; refer to Atlassian's documentation for details on your realm.

5. How much does it cost?

Free for sites with up to 10 users. Larger sites are billed through Atlassian by user tier, and every site gets a 30-day trial. Current prices are on the Marketplace listing.

6. Which OpenAPI versions are supported?

OpenAPI 2.0 (Swagger), 3.0.x, and 3.1, in YAML or JSON. AsyncAPI, GraphQL, and Postman collections are not supported.

7. Can my spec use $ref to other files?

References inside the same document (#/components/schemas/Pet) work. References to other files or URLs are not resolved in version 1. Bundle your spec into one file before uploading, for example with npx @redocly/cli bundle. Resolving sibling attachments is planned as a fast follow.

8. Does it support dark mode?

Yes. The viewer follows the Confluence theme, including dark mode.

9. How does it perform on huge specs?

The spec is parsed and rendered in your browser. Large specs take longer, and the page may feel slow if every operation is expanded at once. Keep operations collapsed, filter by tag, and split very large APIs into one spec (and one page) per service. See Troubleshooting.

10. Is there a Jira version?

Not in version 1. The macro is for Confluence Cloud only. A Jira version is possible later if there is demand.

11. Does it work on Confluence Data Center or Server?

No. Atlassian Forge exists only for Cloud, so the app supports Confluence Cloud only.

12. How do I report a bug or ask for help?

Email support@capella.business or use the support link on the Marketplace listing's Support tab. You do not need to create an account. Please include your site URL, the page URL, the OpenAPI version, and (if you can share it) a minimal spec that reproduces the problem. Never include API tokens or passwords in a report. See also the support page.