OutSystems · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for External Library Generation Service Generation Operations…

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

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/generation-operations'].get
$.paths['/generation-operations'].post
$.paths['/generation-operations/{operationKey}'].get
$.paths['/generation-operations/{operationKey}'].delete
$.paths['/generation-operations/{operationKey}/contents'].get
$.paths['/generation-operations/{operationKey}/log-messages'].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 External Library Generation Service Generation Operations…
  version: 1.0.0
extends: openapi/outsystems-generationoperations-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['/generation-operations'].get
  update:
    x-apievangelist-phrasing:
      intent: List external library generation operations
      effect: read
      questions:
      - Which external library generation operations have run in my tenant?
      - Can I see all the high-code package generations at once?
      instructions:
      - text: List all generation operations.
      - text: Show every external library generation I have started.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/generation-operations'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate an external library from code
      effect: write
      questions:
      - How do I turn a high-code package into an external library?
      - Is generating an external library synchronous or asynchronous?
      instructions:
      - text: Generate an external library from the package at {highCodeBinaryUri}.
        slots:
          highCodeBinaryUri: requestBody.highCodeBinaryUri
      - text: Create a generation operation for file {fileName} uploaded at {highCodeBinaryUri}.
        slots:
          fileName: requestBody.fileName
          highCodeBinaryUri: requestBody.highCodeBinaryUri
      method: generated
      generated: '2026-10-01'
- target: $.paths['/generation-operations/{operationKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a library generation's details
      effect: read
      questions:
      - Has my external library generation finished?
      - What status does one generation operation report?
      instructions:
      - text: Get generation operation {operationKey}.
        slots:
          operationKey: path.operationKey
      - text: Check the status of library generation {operationKey}.
        slots:
          operationKey: path.operationKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/generation-operations/{operationKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a library generation operation
      effect: destructive
      questions:
      - Can I delete a generation operation along with its logs?
      - How do I clean up an external library generation I no longer need?
      instructions:
      - text: Delete generation operation {operationKey}.
        slots:
          operationKey: path.operationKey
      - text: Remove library generation {operationKey} and its logs.
        slots:
          operationKey: path.operationKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/generation-operations/{operationKey}/contents'].get
  update:
    x-apievangelist-phrasing:
      intent: List actions and structures in a generation
      effect: read
      questions:
      - Which actions and structures were found in my high-code package?
      - What will an external library expose once its generation completes?
      instructions:
      - text: Show the contents of generation operation {operationKey}.
        slots:
          operationKey: path.operationKey
      - text: List the actions and structures from library generation {operationKey}.
        slots:
          operationKey: path.operationKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/generation-operations/{operationKey}/log-messages'].get
  update:
    x-apievangelist-phrasing:
      intent: Read validation messages of a generation
      effect: read
      questions:
      - Why did my external library generation fail validation?
      - Where can I read the validation log of a generation operation?
      instructions:
      - text: Get the log messages for generation operation {operationKey}.
        slots:
          operationKey: path.operationKey
      - text: Show validation errors from library generation {operationKey}.
        slots:
          operationKey: path.operationKey
      method: generated
      generated: '2026-10-01'