# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Chef Automate API Documentation User Settings Service API
  version: 1.0.0
extends: openapi/progress-software-usersettingsservice-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['/api/v0/audit/admin/request'].get
  update:
    x-apievangelist-phrasing:
      intent: Request audit logs for selected users
      effect: write
      questions:
      - As an admin, how do I generate audit logs for specific users?
      - Can I request other users' audit logs for a date range?
      instructions:
      - text: Request audit logs for users {usernames} from {from} to {to}.
        slots:
          usernames: query.usernames
          from: query.from
          to: query.to
      - text: Start generating admin audit logs for {usernames}.
        slots:
          usernames: query.usernames
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/audit/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a generated audit log file
      effect: read
      questions:
      - How do I download the audit log file after it's generated?
      - If I leave out the request ID, which audit log do I get?
      instructions:
      - text: Download audit logs for request {request_id}.
        slots:
          request_id: query.request_id
      - text: Download my latest completed audit log file.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/audit/self/request'].get
  update:
    x-apievangelist-phrasing:
      intent: Request my own audit logs
      effect: write
      questions:
      - Can I generate an audit log of my own activity?
      - How do I request my audit history for a time range?
      instructions:
      - text: Request my audit logs from {from} to {to}.
        slots:
          from: query.from
          to: query.to
      - text: Generate my own audit log in {order} order.
        slots:
          order: query.order
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/audit/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check audit log request status
      effect: read
      questions:
      - Is my audit log request finished yet?
      - What's the status of an audit log generation request?
      instructions:
      - text: Check the status of audit log request {request_id}.
        slots:
          request_id: query.request_id
      - text: Tell me whether audit request {request_id} is ready to download.
        slots:
          request_id: query.request_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/user-settings/{user.name}/{user.connector}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's preferences
      effect: read
      questions:
      - What preferences are saved for a given user?
      - Can I read a user's settings by name and connector?
      instructions:
      - text: Get settings for user {user_name} on connector {user_connector}.
        slots:
          user_name: path.user.name
          user_connector: path.user.connector
      - text: Show {user_name}'s saved preferences via {user_connector}.
        slots:
          user_name: path.user.name
          user_connector: path.user.connector
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/user-settings/{user.name}/{user.connector}'].put
  update:
    x-apievangelist-phrasing:
      intent: Save a user's preferences
      effect: write
      questions:
      - How do I update all of a user's preferences at once?
      - Does saving user settings replace the whole set?
      instructions:
      - text: Save settings {settings} for user {user_name} on connector {user_connector}.
        slots:
          settings: requestBody.settings
          user_name: path.user.name
          user_connector: path.user.connector
      - text: Upsert preferences for {user_name} on {user_connector}.
        slots:
          user_name: path.user.name
          user_connector: path.user.connector
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/user-settings/{user.name}/{user.connector}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user's preferences
      effect: destructive
      questions:
      - Can I wipe all saved settings for a user?
      - How do I reset a user's preferences entirely?
      instructions:
      - text: Delete all settings for user {user_name} on connector {user_connector}.
        slots:
          user_name: path.user.name
          user_connector: path.user.connector
      - text: Clear {user_name}'s preferences on {user_connector}.
        slots:
          user_name: path.user.name
          user_connector: path.user.connector
      method: generated
      generated: '2026-10-01'