# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Environment Configurations Domains API
  version: 1.0.0
extends: openapi/outsystems-domains-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: 7
- target: $.paths['/environments/{environmentKey}/domains/{domainKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom domain of a stage
      effect: read
      questions:
      - How do I look up the details of one custom domain configured in a stage?
      - Which app is a specific custom domain pointing to by default?
      instructions:
      - text: Get custom domain {domainKey} in stage {environmentKey}.
        slots:
          domainKey: path.domainKey
          environmentKey: path.environmentKey
      - text: Show the settings of domain {domainKey} for environment {environmentKey}.
        slots:
          domainKey: path.domainKey
          environmentKey: path.environmentKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/domains/{domainKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a custom domain from a stage
      effect: destructive
      questions:
      - Can I remove a custom domain I no longer use from a stage?
      - What permission do I need to delete a custom domain in ODC?
      instructions:
      - text: Delete custom domain {domainKey} from stage {environmentKey}.
        slots:
          domainKey: path.domainKey
          environmentKey: path.environmentKey
      - text: Remove domain {domainKey} from environment {environmentKey}.
        slots:
          domainKey: path.domainKey
          environmentKey: path.environmentKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/domains/{domainKey}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set the default app for a custom domain
      effect: write
      questions:
      - How do I change which app a custom domain opens by default?
      - Can I set a redirect option for a custom domain's default app?
      instructions:
      - text: Make app {defaultApplicationKey} the default for domain {domainKey} in stage {environmentKey}.
        slots:
          defaultApplicationKey: requestBody.defaultApplicationKey
          domainKey: path.domainKey
          environmentKey: path.environmentKey
      - text: Set the redirect option of domain {domainKey} in {environmentKey} to {redirectOption}.
        slots:
          domainKey: path.domainKey
          environmentKey: path.environmentKey
          redirectOption: requestBody.redirectOption
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom domains in a stage
      effect: read
      questions:
      - What custom domains are configured for my production stage?
      - Can I page through all domains set up in an environment?
      instructions:
      - text: List the custom domains in stage {environmentKey}.
        slots:
          environmentKey: path.environmentKey
      - text: Show every domain configured for environment {environmentKey}.
        slots:
          environmentKey: path.environmentKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a custom domain to a stage
      effect: write
      questions:
      - How do I add my own hostname as a custom domain in an ODC stage?
      - Can I give a new custom domain a friendly name?
      instructions:
      - text: Add custom domain {hostname} to stage {environmentKey}.
        slots:
          hostname: requestBody.hostname
          environmentKey: path.environmentKey
      - text: Create domain {hostname} named {name} in environment {environmentKey}.
        slots:
          hostname: requestBody.hostname
          name: requestBody.name
          environmentKey: path.environmentKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/default-domain'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stage's default domain
      effect: read
      questions:
      - Which domain is set as the default for a given stage?
      - How do I find the default hostname apps use in an environment?
      instructions:
      - text: Get the default domain of stage {environmentKey}.
        slots:
          environmentKey: path.environmentKey
      - text: Show which domain environment {environmentKey} uses by default.
        slots:
          environmentKey: path.environmentKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/default-domain'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a stage's default domain
      effect: write
      questions:
      - Can I switch the default domain of a stage to one of my custom domains?
      - How do I update the default domain that a stage's apps are served from?
      instructions:
      - text: Set the default domain of stage {environmentKey} to {defaultDomain}.
        slots:
          environmentKey: path.environmentKey
          defaultDomain: requestBody.defaultDomain
      - text: Make {defaultDomain} the default domain for environment {environmentKey}.
        slots:
          defaultDomain: requestBody.defaultDomain
          environmentKey: path.environmentKey
      method: generated
      generated: '2026-10-01'