Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Retrieve using Journeys API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/ajo/journey'].get
$.paths['/ajo/journey/{id}'].get

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 Retrieve using Journeys API
  version: 1.0.0
extends: openapi/adobe-suite-journeys-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: 2
- target: $.paths['/ajo/journey'].get
  update:
    x-apievangelist-phrasing:
      intent: List Journey Optimizer journeys
      effect: read
      questions:
      - How do I list the journeys in a Journey Optimizer sandbox?
      - Can I filter journeys by fields like status and sort the results?
      instructions:
      - text: List journeys in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: List journeys where {filter}, sorted by {sort}, {pageSize} per page.
        slots:
          filter: query.filter
          sort: query.sort
          pageSize: query.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ajo/journey/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a journey by ID
      effect: read
      questions:
      - What does one journey's full definition look like when fetched by ID?
      - Can I include the journey's campaigns and surfaces in the response?
      instructions:
      - text: Get journey {id}.
        slots:
          id: path.id
      - text: Get journey {id} including {include}.
        slots:
          id: path.id
          include: query.include
      method: generated
      generated: '2026-09-26'