Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MyAccount Portal Self Management API

12 actions 12 updates phrasing extends openapi/strivacity-self-management-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Strivacity's API. It is a proposal applied on top of the contract, not a document Strivacity publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 12

$.info
$.paths['/myaccount/api/v1/attributes'].get
$.paths['/myaccount/api/v1/identifier'].post
$.paths['/myaccount/api/v1/identities'].get
$.paths['/myaccount/api/v1/identities/{externalLoginId}'].delete
$.paths['/myaccount/api/v1/me'].get
$.paths['/myaccount/api/v1/notificationPreferences'].get
$.paths['/myaccount/api/v1/notificationPreferences'].put
$.paths['/myaccount/api/v1/notificationPreferences/descriptor'].get
$.paths['/myaccount/api/v1/password'].post
$.paths['/myaccount/api/v1/personal'].get
$.paths['/myaccount/api/v1/personal'].put

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for MyAccount Portal Self Management API
  version: 1.0.0
extends: openapi/strivacity-self-management-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: 11
- target: $.paths['/myaccount/api/v1/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List profile attributes I can manage
      effect: read
      questions:
      - Which profile attributes am I allowed to edit on my own account?
      - What personal fields does self-service expose to a signed-in customer?
      instructions:
      - text: List the attributes I can manage on my account.
      - text: Show which personal information fields are available to me.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/myaccount/api/v1/identifier'].post
  update:
    x-apievangelist-phrasing:
      intent: Change my email or phone identifier
      effect: write
      questions:
      - How do I change the email address I sign in with?
      - Why does changing my phone identifier need a verification code?
      instructions:
      - text: Change my {type} identifier to {identifier}.
        slots:
          type: requestBody.type
          identifier: requestBody.identifier
      - text: Confirm my identifier change with verification code {code}.
        slots:
          code: header.X-Challenge
      method: generated
      generated: '2026-10-01'
- target: $.paths['/myaccount/api/v1/identities'].get
  update:
    x-apievangelist-phrasing:
      intent: List my linked identities
      effect: read
      questions:
      - Which social or external logins are linked to my account?
      - How can I see all identities on my own account?
      instructions:
      - text: List the identities on my account.
      - text: Show the external logins linked to me.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/myaccount/api/v1/identities/{externalLoginId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink an external login from my account
      effect: destructive
      questions:
      - How do I disconnect a social login from my account?
      - Can I unlink an external identity I no longer use?
      instructions:
      - text: Unlink external identity {externalLoginId} from my account.
        slots:
          externalLoginId: path.externalLoginId
      - text: Disconnect social login {externalLoginId}.
        slots:
          externalLoginId: path.externalLoginId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/myaccount/api/v1/me'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my account information
      effect: read
      questions:
      - How do I fetch the details of the account I'm signed in as?
      - What account information does the self-service me endpoint return?
      instructions:
      - text: Show my account information.
      - text: Tell me who I'm currently signed in as.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/myaccount/api/v1/notificationPreferences'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my notification preferences
      effect: read
      questions:
      - Which security emails am I currently set to receive?
      - Can I check my own notification settings?
      instructions:
      - text: Show my current notification preferences.
      - text: Check whether I get account lockout notifications.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/myaccount/api/v1/notificationPreferences'].put
  update:
    x-apievangelist-phrasing:
      intent: Update my notification preferences
      effect: write
      questions:
      - How do I turn off emails when my account attributes change?
      - Can I opt in to notifications about MFA method changes?
      instructions:
      - text: Set my account deletion notification to {accountDeletion}.
        slots:
          accountDeletion: requestBody.accountDeletion
      - text: Turn off my MFA method change notifications.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/myaccount/api/v1/notificationPreferences/descriptor'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe the available notification options
      effect: read
      questions:
      - What notification types and channels can a customer choose from?
      - Which values are allowed for each notification preference?
      instructions:
      - text: List the possible notification preference descriptors.
      - text: Show me which notification options exist before I change mine.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/myaccount/api/v1/password'].post
  update:
    x-apievangelist-phrasing:
      intent: Change my password
      effect: write
      questions:
      - How do I change my own password when I know the current one?
      - Does changing my password require the self-service option to be on?
      instructions:
      - text: Change my password from {currentPassword} to {newPassword}.
        slots:
          currentPassword: requestBody.currentPassword
          newPassword: requestBody.newPassword
      - text: Update my password to {newPassword}.
        slots:
          newPassword: requestBody.newPassword
      method: generated
      generated: '2026-10-01'
- target: $.paths['/myaccount/api/v1/personal'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my profile metadata
      effect: read
      questions:
      - What personal information is stored on my profile?
      - How can I read back my own profile metadata?
      instructions:
      - text: Show my profile metadata.
      - text: Get the personal details saved on my account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/myaccount/api/v1/personal'].put
  update:
    x-apievangelist-phrasing:
      intent: Update my profile metadata
      effect: write
      questions:
      - How do I edit my name or other personal details myself?
      - Will sending null for a profile field clear it?
      instructions:
      - text: Update my profile metadata with my new display name.
      - text: Edit the personal details on my account.
      method: generated
      generated: '2026-10-01'