Infor · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Infor ION API Gateway ION Documents API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/ion-api/documents'].get
$.paths['/ion-api/documents/{documentId}'].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 Infor ION API Gateway ION Documents API
  version: 1.0.0
extends: openapi/infor-ion-documents-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: 2
- target: $.paths['/ion-api/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List ION business documents and their routing
      effect: read
      questions:
      - Which ION business documents have been routed between my Infor applications lately?
      - Can I see only SyncSalesOrder documents that ION routed in a given date range?
      - What sender, receiver and status does each routed ION document show?
      instructions:
      - text: List the ION documents of type {documentType} with status {status}.
        slots:
          documentType: query.documentType
          status: query.status
      - text: Show ION documents routed between {from} and {to}, {pageSize} per page.
        slots:
          from: query.from
          to: query.to
          pageSize: query.pageSize
      - text: List my recent ION document routing records.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ion-api/documents/{documentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one ION document with its payload
      effect: read
      questions:
      - How do I see the full payload of a single ION document?
      - Where can I trace the routing history of one specific ION document?
      instructions:
      - text: Fetch ION document {documentId} with its payload.
        slots:
          documentId: path.documentId
      - text: Show the routing history for ION document {documentId}.
        slots:
          documentId: path.documentId
      method: generated
      generated: '2026-10-01'