# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin Portal Restricted Password API
  version: 1.0.0
extends: openapi/strivacity-restricted-password-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['/admin/api/v1/passwordPolicies/{policyId}/restrictedPasswords'].get
  update:
    x-apievangelist-phrasing:
      intent: List banned-password lists in a password policy
      effect: read
      questions:
      - Which restricted password word lists are on my password policy?
      - Can I see the banned word lists attached to a password policy?
      instructions:
      - text: List password word restrictions in password policy {policy}.
        slots:
          policy: path.policyId
      - text: Show banned-word lists for password policy {policy}.
        slots:
          policy: path.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/passwordPolicies/{policyId}/restrictedPasswords'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a banned-password word list
      effect: write
      questions:
      - How do I upload a list of words users can't use in passwords?
      - Can I add a restricted password file to a password policy?
      instructions:
      - text: Upload restricted password file {file} named {name} to password policy {policy}.
        slots:
          file: requestBody.file
          name: requestBody.name
          policy: path.policyId
      - text: Create a banned-word list {name} in password policy {policy}.
        slots:
          name: requestBody.name
          policy: path.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/passwordPolicies/{policyId}/restrictedPasswords/quota'].get
  update:
    x-apievangelist-phrasing:
      intent: Check banned-password storage used
      effect: read
      questions:
      - How much space do my restricted password lists take in MB?
      - Is there a size quota for password restriction files?
      instructions:
      - text: Get the total size in MB of restricted passwords for policy {policy}.
        slots:
          policy: path.policyId
      - text: Check the restricted-password quota used by policy {policy}.
        slots:
          policy: path.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/passwordPolicies/{policyId}/restrictedPasswords/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a banned-password word list
      effect: read
      questions:
      - What is in one restricted password list?
      - Can I view a single password word restriction by ID?
      instructions:
      - text: Get password word restriction {id} in policy {policy}.
        slots:
          id: path.id
          policy: path.policyId
      - text: Show banned-word list {id} from password policy {policy}.
        slots:
          id: path.id
          policy: path.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/passwordPolicies/{policyId}/restrictedPasswords/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or describe a banned-password list
      effect: write
      questions:
      - How do I rename a restricted password word list?
      - Can I change the description of a banned-word list?
      instructions:
      - text: Rename password word restriction {id} in policy {policy} to {name}.
        slots:
          id: path.id
          policy: path.policyId
          name: requestBody.name
      - text: Update the description of banned-word list {id} in policy {policy}.
        slots:
          id: path.id
          policy: path.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/passwordPolicies/{policyId}/restrictedPasswords/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a banned-password word list
      effect: destructive
      questions:
      - How do I remove a restricted password list from my policy?
      - Can I delete a banned-word list I uploaded?
      instructions:
      - text: Delete password word restriction {id} from policy {policy}.
        slots:
          id: path.id
          policy: path.policyId
      - text: Remove banned-word list {id} in password policy {policy}.
        slots:
          id: path.id
          policy: path.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/passwordPolicies/{policyId}/restrictedPasswords/{id}/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a banned-password word list
      effect: read
      questions:
      - How do I download a restricted password list I uploaded?
      - Can I export the words in a password restriction?
      instructions:
      - text: Export password restriction {id} from policy {policy}.
        slots:
          id: path.id
          policy: path.policyId
      - text: Download the banned-word file {id} of password policy {policy}.
        slots:
          id: path.id
          policy: path.policyId
      method: generated
      generated: '2026-10-01'