Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian Dynamic Modules API

7 actions 7 updates phrasing extends openapi/atlassian-dynamic-modules-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Atlassian's API. It is a proposal applied on top of the contract, not a document Atlassian publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/atlassian-connect/1/app/module/dynamic'].get

$.paths['/atlassian-connect/1/app/module/dynamic'].post

$.paths['/atlassian-connect/1/app/module/dynamic'].delete

$.paths['/rest/atlassian-connect/1/app/module/dynamic'].get

$.paths['/rest/atlassian-connect/1/app/module/dynamic'].post

$.paths['/rest/atlassian-connect/1/app/module/dynamic'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Atlassian Dynamic Modules API
  version: 1.0.0
extends: openapi/atlassian-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: 6
- target: $.paths['/atlassian-connect/1/app/module/dynamic'].get
  update:
    x-apievangelist-phrasing:
      intent: List my Connect app's dynamic modules (Confluence)
      effect: read
      questions:
      - Which modules has my Connect app registered dynamically in Confluence?
      - Can my Confluence Connect app see what it registered at runtime under /atlassian-connect?
      instructions:
      - text: List the dynamic modules my app registered in Confluence.
      - text: Show my Confluence Connect app's runtime-registered modules.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/atlassian-connect/1/app/module/dynamic'].post
  update:
    x-apievangelist-phrasing:
      intent: Register dynamic modules (Confluence)
      effect: write
      questions:
      - How does my Connect app register modules at runtime in Confluence?
      - Which Confluence module types support dynamic registration?
      instructions:
      - text: Register Confluence dynamic modules {modules} for my app.
        slots:
          modules: requestBody.modules
      - text: Add these modules {modules} to my Confluence Connect app at runtime.
        slots:
          modules: requestBody.modules
      method: generated
      generated: '2026-10-01'
- target: $.paths['/atlassian-connect/1/app/module/dynamic'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove dynamic modules (Confluence)
      effect: destructive
      questions:
      - How do I unregister a dynamic module my app added in Confluence?
      - Can I remove specific Confluence dynamic modules by key?
      instructions:
      - text: Remove Confluence dynamic module {moduleKey} from my app.
        slots:
          moduleKey: query.moduleKey
      - text: Unregister the Confluence modules with key {moduleKey}.
        slots:
          moduleKey: query.moduleKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/atlassian-connect/1/app/module/dynamic'].get
  update:
    x-apievangelist-phrasing:
      intent: List my Connect app's dynamic modules (Jira)
      effect: read
      questions:
      - What modules has my Connect app registered dynamically in Jira?
      - Can my Jira Connect app list its runtime modules via the /rest/atlassian-connect path?
      instructions:
      - text: List the dynamic modules my app registered in Jira.
      - text: Show my Jira Connect app's runtime-registered modules.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/atlassian-connect/1/app/module/dynamic'].post
  update:
    x-apievangelist-phrasing:
      intent: Register dynamic modules (Jira)
      effect: write
      questions:
      - How does my Connect app register modules at runtime in Jira?
      - Can I add Jira modules without redeploying my app descriptor?
      instructions:
      - text: Register Jira dynamic modules {modules} for my app.
        slots:
          modules: requestBody.modules
      - text: Add modules {modules} to my Jira Connect app at runtime.
        slots:
          modules: requestBody.modules
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/atlassian-connect/1/app/module/dynamic'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove dynamic modules (Jira)
      effect: destructive
      questions:
      - How do I unregister all the dynamic modules my app added in Jira?
      - Can I remove just one Jira dynamic module by key?
      instructions:
      - text: Remove all dynamic modules my app registered in Jira.
      - text: Unregister Jira dynamic module {moduleKey}.
        slots:
          moduleKey: query.moduleKey
      method: generated
      generated: '2026-10-01'