Generated by API Evangelist
Written by API Evangelist tooling for Confluence's API. It is a proposal applied on top of the contract, not a document Confluence publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Confluence Cloud REST Dynamic modules API
version: 1.0.0
extends: openapi/confluence-dynamic-modules-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/wiki/rest/atlassian-connect/1/app/module/dynamic'].get
update:
x-apievangelist-phrasing:
intent: List an app's dynamically registered modules
effect: read
questions:
- Which modules has my Connect app registered at runtime?
- Can I see my app's dynamic modules?
instructions:
- text: List the modules my app registered dynamically.
- text: Show all dynamic modules for the calling app.
method: generated
generated: '2026-10-01'
- target: $.paths['/wiki/rest/atlassian-connect/1/app/module/dynamic'].post
update:
x-apievangelist-phrasing:
intent: Register dynamic modules for an app
effect: write
questions:
- How do I register Connect modules at runtime instead of in the descriptor?
- Can my app add new modules dynamically?
instructions:
- text: 'Register these dynamic modules: {modules}.'
slots:
modules: requestBody.modules
- text: Add the modules {modules} to my app at runtime.
slots:
modules: requestBody.modules
method: generated
generated: '2026-10-01'
- target: $.paths['/wiki/rest/atlassian-connect/1/app/module/dynamic'].delete
update:
x-apievangelist-phrasing:
intent: Remove dynamically registered modules
effect: destructive
questions:
- How do I unregister a dynamic module my app added?
- Can I remove just some of my app's dynamic modules?
instructions:
- text: Remove dynamic module {moduleKey}.
slots:
moduleKey: query.moduleKey
- text: Unregister my app's dynamic modules with keys {moduleKey}.
slots:
moduleKey: query.moduleKey
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.