# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for dotCMS REST Authentication API
  version: 1.0.0
extends: openapi/dotcms-authentication-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['/api/v1/authentication'].post
  update:
    x-apievangelist-phrasing:
      intent: Log in with a username and password
      effect: write
      questions:
      - How do I start a session with my dotCMS login and password?
      - Can I ask to be remembered when logging in to the back end?
      instructions:
      - text: Log in as {userId} with password {password}.
        slots:
          userId: requestBody.userId
          password: requestBody.password
      - text: Sign {userId} in with {password} and remember me set to {rememberMe}.
        slots:
          userId: requestBody.userId
          password: requestBody.password
          rememberMe: requestBody.rememberMe
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/authentication/logInUser'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the currently logged-in user
      effect: read
      questions:
      - Who am I logged in as right now?
      - Can I get the details of the user in the current session?
      instructions:
      - text: Show the user in my current session.
      - text: Get my logged-in user details.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/forgotpassword'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a password reset email
      effect: write
      questions:
      - I forgot my password; how do I get a reset link emailed?
      - Which email address does the reset link get sent to?
      instructions:
      - text: Send a password reset email to user {userId}.
        slots:
          userId: requestBody.userId
      - text: Email a reset link for account {userId}.
        slots:
          userId: requestBody.userId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/loginform'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the login form configuration
      effect: read
      questions:
      - What languages and company details does the login screen offer?
      - Can I load localized messages for the login page?
      instructions:
      - text: Get the login form configuration.
      - text: Load the login form in language {language} for country {country}.
        slots:
          language: requestBody.language
          country: requestBody.country
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/logout'].get
  update:
    x-apievangelist-phrasing:
      intent: Log out the current user
      effect: destructive
      questions:
      - How do I end my dotCMS session?
      - Does logging out return a URL to redirect to?
      instructions:
      - text: Log me out.
      - text: End the current session and give me the redirect URL.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/changePassword'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a new password with a reset token
      effect: write
      questions:
      - How do I choose a new password using the token from my reset email?
      - Can I change a password without being logged in?
      instructions:
      - text: Reset my password to {password} using token {token}.
        slots:
          password: requestBody.password
          token: requestBody.token
      - text: Use reset token {token} to set password {password}.
        slots:
          token: requestBody.token
          password: requestBody.password
      method: generated
      generated: '2026-09-26'