Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Admin User Profile Passwords API

10 actions 10 updates phrasing extends openapi/optimizely-admin-user-profile-passwords-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Optimizely's API. It is a proposal applied on top of the contract, not a document Optimizely publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/api/v1/admin/AdminUserProfilePasswords'].get
$.paths['/api/v1/admin/AdminUserProfilePasswords'].post
$.paths['/api/v1/admin/AdminUserProfilePasswords({id})'].get
$.paths['/api/v1/admin/AdminUserProfilePasswords({id})'].put
$.paths['/api/v1/admin/AdminUserProfilePasswords({id})'].delete
$.paths['/api/v1/admin/AdminUserProfilePasswords({id})'].patch
$.paths['/api/v1/admin/AdminUserProfilePasswords/Default.Default()'].get
$.paths['/api/v1/admin/adminuserprofilepasswords/delete'].delete
$.paths['/api/v1/admin/adminuserprofilepasswords({key})/customproperties({custompropertyKey})'].get

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 Admin API V1 Admin User Profile Passwords API
  version: 1.0.0
extends: openapi/optimizely-admin-user-profile-passwords-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: 9
- target: $.paths['/api/v1/admin/AdminUserProfilePasswords'].get
  update:
    x-apievangelist-phrasing:
      intent: List stored admin user password records
      effect: read
      questions:
      - How do I list the password history records for admin users?
      - Can I filter admin password records to one admin user profile?
      instructions:
      - text: List all admin user password records.
      - text: List admin password records matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfilePasswords'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a password record for an admin user
      effect: write
      questions:
      - How do I store a new password hash for an admin user?
      - What is required when creating an admin user password record?
      instructions:
      - text: Add password hash {passwordHash} for admin user profile {adminUserProfileId}.
        slots:
          passwordHash: requestBody.passwordHash
          adminUserProfileId: requestBody.adminUserProfileId
      - text: Record a password change on {passwordChangedOn} with hash {passwordHash}.
        slots:
          passwordChangedOn: requestBody.passwordChangedOn
          passwordHash: requestBody.passwordHash
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfilePasswords({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one admin password record
      effect: read
      questions:
      - How do I look up a single admin password record by id?
      - When was an admin user's password last changed according to a given record?
      instructions:
      - text: Get admin password record {id}.
        slots:
          id: path.id
      - text: Show when password record {id} was changed.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfilePasswords({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an admin password record
      effect: write
      questions:
      - How do I overwrite an admin password record entirely?
      - Is there a full replace for an admin user's stored password entry?
      instructions:
      - text: Replace admin password record {id} with hash {passwordHash}.
        slots:
          id: path.id
          passwordHash: requestBody.passwordHash
      - text: Overwrite the whole admin password record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfilePasswords({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an admin password record
      effect: destructive
      questions:
      - How do I remove one stored admin password record?
      - Can I delete an admin password entry only if the ETag matches?
      instructions:
      - text: Delete admin password record {id}.
        slots:
          id: path.id
      - text: Delete admin password record {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfilePasswords({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update fields on an admin password record
      effect: write
      questions:
      - How do I change just the password-changed date on an admin password record?
      - Can I patch only the hash of a stored admin password?
      instructions:
      - text: Set the changed-on date of admin password record {id} to {passwordChangedOn}.
        slots:
          id: path.id
          passwordChangedOn: requestBody.passwordChangedOn
      - text: Patch admin password record {id} with new hash {passwordHash}.
        slots:
          id: path.id
          passwordHash: requestBody.passwordHash
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfilePasswords/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default admin password record
      effect: read
      questions:
      - What does a default admin password record look like?
      - Can I see the starting values for a new admin password entry?
      instructions:
      - text: Get the default admin user password record.
      - text: Show the template for a new admin password record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminuserprofilepasswords/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete admin password records
      effect: destructive
      questions:
      - How do I delete many admin password records in one call?
      - Can I purge admin password history by a list of ids?
      instructions:
      - text: Bulk delete admin password records {ids}.
        slots:
          ids: query.ids
      - text: 'Purge these admin password entries: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminuserprofilepasswords({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an admin password record
      effect: read
      questions:
      - How do I read a custom property on an admin password record?
      - Can I fetch one extension property from a stored admin password entry?
      instructions:
      - text: Get custom property {custompropertyKey} on admin password record {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show custom property {custompropertyKey} for admin password entry {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'