Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST App Migration API

4 actions 4 updates phrasing extends openapi/atlassian-app-migration-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 4

$.info

$.paths['/rest/atlassian-connect/1/migration/field'].put

$.paths['/rest/atlassian-connect/1/migration/properties/{entityType}'].put

$.paths['/rest/atlassian-connect/1/migration/workflow/rule/search'].post

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 The Jira Cloud platform REST App Migration API
  version: 1.0.0
extends: openapi/atlassian-app-migration-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['/rest/atlassian-connect/1/migration/field'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update app custom field values during migration
      effect: write
      questions:
      - How does a Connect app set its custom field values on many issues during a server-to-cloud migration?
      - How many custom field values can one migration update change?
      instructions:
      - text: Apply custom field updates {updateValueList} for migration transfer {transferId}.
        slots:
          updateValueList: requestBody.updateValueList
          transferId: header.Atlassian-Transfer-Id
      - text: Bulk set app field values on issues under transfer {transferId}.
        slots:
          transferId: header.Atlassian-Transfer-Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/atlassian-connect/1/migration/properties/{entityType}'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update entity properties during app migration
      effect: write
      questions:
      - How does my app restore entity properties in bulk after migrating to cloud?
      - What's the limit on entity property updates per migration request?
      instructions:
      - text: Bulk update {entityType} entity properties for migration transfer {transferId}.
        slots:
          entityType: path.entityType
          transferId: header.Atlassian-Transfer-Id
      - text: Write migrated property values for {entityType} under transfer {transferId}.
        slots:
          entityType: path.entityType
          transferId: header.Atlassian-Transfer-Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/atlassian-connect/1/migration/workflow/rule/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up migrated workflow transition rule configs
      effect: read
      questions:
      - Which workflow transition rule configurations did my app bring over from server?
      - Can I fetch migrated rule configs for one workflow by rule id?
      instructions:
      - text: Get migrated rule configurations {ruleIds} for workflow {workflowEntityId} under transfer {transferId}.
        slots:
          ruleIds: requestBody.ruleIds
          workflowEntityId: requestBody.workflowEntityId
          transferId: header.Atlassian-Transfer-Id
      - text: Search my app's migrated transition rules in workflow {workflowEntityId}.
        slots:
          workflowEntityId: requestBody.workflowEntityId
      method: generated
      generated: '2026-10-01'