# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness SMTP API
  version: 1.0.0
extends: openapi/harness-smtp-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/ng/api/smtpConfig/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete the SMTP configuration
      effect: destructive
      questions:
      - How do I remove the SMTP server configuration from my account?
      - Can I delete an SMTP config by its identifier?
      instructions:
      - text: Delete SMTP config {smtp_id}.
        slots:
          smtp_id: path.identifier
      - text: Remove the SMTP settings {smtp_id} from account {account}.
        slots:
          smtp_id: path.identifier
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/smtpConfig'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the account's SMTP configuration
      effect: read
      questions:
      - Which SMTP server does Harness use to send email for my account?
      - Is an SMTP configuration set up on my account?
      instructions:
      - text: Show the SMTP configuration.
      - text: Get the SMTP config for account {account}.
        slots:
          account: query.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/smtpConfig'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the SMTP configuration
      effect: write
      questions:
      - How do I change the SMTP host or credentials Harness sends mail through?
      - Can I rename an existing SMTP configuration?
      instructions:
      - text: Update SMTP config {name} for account {account} with settings {value}.
        slots:
          name: requestBody.name
          account: requestBody.accountId
          value: requestBody.value
      - text: Change SMTP config {uuid} to use settings {value}, named {name}, on account {account}.
        slots:
          uuid: requestBody.uuid
          value: requestBody.value
          name: requestBody.name
          account: requestBody.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/smtpConfig'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an SMTP configuration
      effect: write
      questions:
      - How do I set up an SMTP server so Harness can send notification emails?
      - What do I need to provide to add a new SMTP config?
      instructions:
      - text: Create SMTP config {name} for account {account} with settings {value}.
        slots:
          name: requestBody.name
          account: requestBody.accountId
          value: requestBody.value
      - text: Add a new mail server config named {name} using {value} on account {account}.
        slots:
          name: requestBody.name
          value: requestBody.value
          account: requestBody.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/smtpConfig/validate-connectivity'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test email through the SMTP config
      effect: write
      questions:
      - How can I check my SMTP settings work by sending a test email?
      - Can I choose the recipient and subject of the SMTP test message?
      instructions:
      - text: Send a test email via SMTP config {smtp_id} to {to} with subject {subject} and body {body}, account {account}.
        slots:
          smtp_id: query.identifier
          to: query.to
          subject: query.subject
          body: query.body
          account: query.accountId
      - text: 'Test SMTP {smtp_id} by emailing {to}: subject {subject}, message {body}, account {account}.'
        slots:
          smtp_id: query.identifier
          to: query.to
          subject: query.subject
          body: query.body
          account: query.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/smtpConfig/validateName'].post
  update:
    x-apievangelist-phrasing:
      intent: Check an SMTP config name is available
      effect: read
      questions:
      - Is the name I want for an SMTP config already used by another connector?
      - Can I check a name is free before creating the SMTP config?
      instructions:
      - text: Check whether name {name} is free for an SMTP config in account {account}.
        slots:
          name: query.name
          account: query.accountId
      - text: Verify no other connector in account {account} is called {name}.
        slots:
          account: query.accountId
          name: query.name
      method: generated
      generated: '2026-09-26'