Generated by API Evangelist
Written by API Evangelist tooling for Jira's API. It is a proposal applied on top of the contract, not a document Jira publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Jira Cloud platform REST Dynamic modules API
version: 1.0.0
extends: openapi/jira-dynamic-modules-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/rest/atlassian-connect/1/app/module/dynamic'].get
update:
x-apievangelist-phrasing:
intent: List a Connect app's dynamic modules
effect: read
questions:
- Which modules has my Connect app registered dynamically at runtime?
- Can I see the dynamic modules my app added outside its descriptor?
instructions:
- text: List all dynamically registered modules for my Connect app.
- text: Show the runtime modules this app has registered.
method: generated
generated: '2026-09-26'
- target: $.paths['/rest/atlassian-connect/1/app/module/dynamic'].post
update:
x-apievangelist-phrasing:
intent: Register dynamic modules for a Connect app
effect: write
questions:
- How do I add modules to my Connect app without changing its descriptor?
- What format do dynamically registered modules need to follow?
instructions:
- text: 'Register these dynamic modules: {modules}.'
slots:
modules: requestBody.modules
- text: Add modules {modules} to my Connect app at runtime.
slots:
modules: requestBody.modules
method: generated
generated: '2026-09-26'
- target: $.paths['/rest/atlassian-connect/1/app/module/dynamic'].delete
update:
x-apievangelist-phrasing:
intent: Remove a Connect app's dynamic modules
effect: destructive
questions:
- How do I unregister modules my Connect app added dynamically?
- Can I remove just one dynamic module instead of all of them?
instructions:
- text: Remove all dynamically registered modules from my app.
- text: Unregister dynamic module {moduleKey}.
slots:
moduleKey: query.moduleKey
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
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.