# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Storefront API V1 Sessions API
  version: 1.0.0
extends: openapi/optimizely-sessions-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: 5
- target: $.paths['/api/v1/sessions/current'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current shopper session
      effect: read
      questions:
      - Is the current shopper signed in, and as which user?
      - What bill-to, ship-to, language and currency does my current session use?
      instructions:
      - text: Get the current storefront session.
      - text: Show who is signed in and which customer the current session is set to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/sessions/current'].delete
  update:
    x-apievangelist-phrasing:
      intent: Sign out of the current session
      effect: destructive
      questions:
      - How do I log a shopper out of the storefront?
      - Can I end the current session entirely through the API?
      instructions:
      - text: Sign out and end the current storefront session.
      - text: Delete the current session to log the shopper out.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/sessions/current'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update the current shopper session
      effect: write
      questions:
      - How do I switch the active bill-to and ship-to on my current session?
      - Can I change the session's language or currency without signing in again?
      - Is changing a password done by updating the current session?
      instructions:
      - text: Switch the current session to bill-to {billTo} and ship-to {shipTo}.
        slots:
          billTo: requestBody.billTo
          shipTo: requestBody.shipTo
      - text: Change the current session's language to {language} and currency to {currency}.
        slots:
          language: requestBody.language
          currency: requestBody.currency
      - text: Change the signed-in user's password from {password} to {newPassword} on the current session.
        slots:
          password: requestBody.password
          newPassword: requestBody.newPassword
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign in and start a shopper session
      effect: write
      questions:
      - How do I sign a user in to the commerce storefront through the API?
      - Can I keep a shopper signed in when I create their session?
      instructions:
      - text: Sign in as {userName} with password {password}.
        slots:
          userName: requestBody.userName
          password: requestBody.password
      - text: Start a session for {userName} with password {password} and remember me set to {rememberMe}.
        slots:
          userName: requestBody.userName
          password: requestBody.password
          rememberMe: requestBody.rememberMe
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/sessions/current/authentication'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove authentication from the current session
      effect: destructive
      questions:
      - Can I drop the signed-in identity but keep the session itself?
      - How do I de-authenticate the current session without deleting it?
      instructions:
      - text: Remove the authentication from the current session.
      - text: De-authenticate the current session while leaving the session in place.
      method: generated
      generated: '2026-09-26'