OutSystems · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Portfolios API

3 actions 3 updates phrasing extends openapi/outsystems-portfolios-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 3

$.info
$.paths['/portfolios'].get
$.paths['/portfolios/{portfolioKey}'].patch

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 Portfolios API
  version: 1.0.0
extends: openapi/outsystems-portfolios-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['/portfolios'].get
  update:
    x-apievangelist-phrasing:
      intent: List portfolios
      effect: read
      questions:
      - What portfolios exist in my ODC organization?
      - Can I page through portfolios?
      instructions:
      - text: List all my portfolios.
      - text: Get portfolio {portfolioKey} from the portfolio list.
        slots:
          portfolioKey: query.portfolioKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/portfolios/{portfolioKey}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a portfolio
      effect: write
      questions:
      - How do I rename a portfolio?
      - What permission is required to change a portfolio's name?
      instructions:
      - text: Rename portfolio {portfolioKey} to {name}.
        slots:
          portfolioKey: path.portfolioKey
          name: requestBody.name
      - text: Change the name of portfolio {portfolioKey} to {name} now.
        slots:
          portfolioKey: path.portfolioKey
          name: requestBody.name
      method: generated
      generated: '2026-10-01'