OutSystems · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Subscription Organization API

5 actions 5 updates phrasing extends openapi/outsystems-organization-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 5

$.info
$.paths['/organization/configurations'].get
$.paths['/organization/configurations'].patch
$.paths['/organization/entitlements'].get
$.paths['/organization/entitlements/usage'].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 Subscription Organization API
  version: 1.0.0
extends: openapi/outsystems-organization-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: 4
- target: $.paths['/organization/configurations'].get
  update:
    x-apievangelist-phrasing:
      intent: Get organization configurations
      effect: read
      questions:
      - What organization-level settings are configured in ODC?
      - Which email domains are treated as internal for my organization?
      instructions:
      - text: Show my organization configurations.
      - text: Get the organization settings, including internal email domains.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organization/configurations'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update organization email domain settings
      effect: write
      questions:
      - How do I mark certain email domains as internal to my organization?
      - Can I treat all email domains as internal?
      instructions:
      - text: Set my organization's internal email domains to {internalEmailDomains}.
        slots:
          internalEmailDomains: requestBody.internalEmailDomains
      - text: Set whether all email domains count as internal to {areAllEmailDomainsInternal}.
        slots:
          areAllEmailDomainsInternal: requestBody.areAllEmailDomainsInternal
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organization/entitlements'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the organization's entitlements
      effect: read
      questions:
      - What does my OutSystems subscription entitle my whole organization to?
      - Which add-ons are included at the organization level?
      instructions:
      - text: Show my organization's entitlements.
      - text: List the organization-wide add-ons and subscription details.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organization/entitlements/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get organization-wide entitlement usage
      effect: read
      questions:
      - How much of our entitlements has the organization used this month?
      - Can I see organization usage for specific entitlements over a date range?
      instructions:
      - text: Show organization-wide entitlement usage from {since} to {to}.
        slots:
          since: query.since
          to: query.to
      - text: Get organization usage for entitlements {entitlementIds} at {granularity} granularity.
        slots:
          entitlementIds: query.entitlementIds
          granularity: query.granularity
      method: generated
      generated: '2026-10-01'