Adobe Experience Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Experience Cloud Adobe Journey Optimizer Journeys API

8 actions 8 updates phrasing extends openapi/adobe-experience-cloud-journeys-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Experience Cloud's API. It is a proposal applied on top of the contract, not a document Adobe Experience Cloud publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/journey/journeys'].get
$.paths['/journey/journeys'].post
$.paths['/journey/journeys/{journeyId}'].get
$.paths['/journey/journeys/{journeyId}'].put
$.paths['/journey/journeys/{journeyId}'].delete
$.paths['/journey/journeys/{journeyId}/publish'].post
$.paths['/journey/journeys/{journeyId}/stop'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Experience Cloud Adobe Journey Optimizer Journeys API
  version: 1.0.0
extends: openapi/adobe-experience-cloud-journeys-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: 7
- target: $.paths['/journey/journeys'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer journeys
      effect: read
      questions:
      - Which customer journeys are configured in Journey Optimizer?
      - Can I page through journeys and see their status and version?
      instructions:
      - text: List journeys in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show page {page} of journeys, {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/journey/journeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer journey draft
      effect: write
      questions:
      - How do I build a new customer journey with entry conditions?
      - Does a newly created journey go live right away?
      instructions:
      - text: Create a journey named {name} in sandbox {sandbox}.
        slots:
          name: requestBody.name
          sandbox: header.x-sandbox-name
      - text: Create draft journey {name} with entry condition {entryCondition}.
        slots:
          name: requestBody.name
          entryCondition: requestBody.entryCondition
      method: generated
      generated: '2026-10-01'
- target: $.paths['/journey/journeys/{journeyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a journey's full definition
      effect: read
      questions:
      - What activities and transitions make up a specific journey?
      - Where can I see one journey's entry conditions and channels?
      instructions:
      - text: Show journey {journeyId}.
        slots:
          journeyId: path.journeyId
      - text: Get the definition of journey {journeyId} in sandbox {sandbox}.
        slots:
          journeyId: path.journeyId
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/journey/journeys/{journeyId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a draft journey
      effect: write
      questions:
      - Can I edit a journey after it's been published?
      - Is it possible to change the activities in a draft journey?
      instructions:
      - text: Rename draft journey {journeyId} to {name}.
        slots:
          journeyId: path.journeyId
          name: requestBody.name
      - text: Replace the activities of draft journey {journeyId} with {activities}, keeping name {name}.
        slots:
          journeyId: path.journeyId
          activities: requestBody.activities
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/journey/journeys/{journeyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a draft or closed journey
      effect: destructive
      questions:
      - Can I delete a journey that is currently active?
      - Which journey statuses can be removed?
      instructions:
      - text: Delete journey {journeyId}.
        slots:
          journeyId: path.journeyId
      - text: Remove closed journey {journeyId} from sandbox {sandbox}.
        slots:
          journeyId: path.journeyId
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/journey/journeys/{journeyId}/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a journey to go live
      effect: write
      questions:
      - How do I make a draft journey live?
      - When does a published journey start processing entry events?
      instructions:
      - text: Publish journey {journeyId}.
        slots:
          journeyId: path.journeyId
      - text: Take draft journey {journeyId} live in sandbox {sandbox}.
        slots:
          journeyId: path.journeyId
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/journey/journeys/{journeyId}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop an active journey
      effect: destructive
      questions:
      - What happens to profiles already in a journey when I stop it?
      - Can I prevent new profiles from entering a live journey?
      instructions:
      - text: Stop journey {journeyId}.
        slots:
          journeyId: path.journeyId
      - text: Halt active journey {journeyId} in sandbox {sandbox}.
        slots:
          journeyId: path.journeyId
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-10-01'