Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Password Quality Policy API

6 actions 6 updates phrasing extends openapi/strivacity-password-quality-policy-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 6

$.info
$.paths['/admin/api/v1/passwordPolicies'].get
$.paths['/admin/api/v1/passwordPolicies'].post
$.paths['/admin/api/v1/passwordPolicies/{id}'].get
$.paths['/admin/api/v1/passwordPolicies/{id}'].put
$.paths['/admin/api/v1/passwordPolicies/{id}'].delete

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 Portal Password Quality Policy API
  version: 1.0.0
extends: openapi/strivacity-password-quality-policy-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: 5
- target: $.paths['/admin/api/v1/passwordPolicies'].get
  update:
    x-apievangelist-phrasing:
      intent: List password quality policies
      effect: read
      questions:
      - What password quality policies are set up?
      - Can I filter password policies by tag or name?
      instructions:
      - text: List password quality policies.
      - text: List password policies tagged {policyTags}.
        slots:
          policyTags: query.policyTags
      - text: Find password policies named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/passwordPolicies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a password quality policy
      effect: write
      questions:
      - How do I enforce password complexity rules for customers?
      - Can a password policy block passwords found in breaches?
      instructions:
      - text: Create password policy {name} with rules {policy}.
        slots:
          name: requestBody.name
          policy: requestBody.policy
      - text: Create password policy {name} with rules {policy} and breached password protection {breachedPasswordProtection}.
        slots:
          name: requestBody.name
          policy: requestBody.policy
          breachedPasswordProtection: requestBody.breachedPasswordProtection
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/passwordPolicies/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a password quality policy
      effect: read
      questions:
      - What rules does a specific password policy enforce?
      - Is breached password protection on for a given password policy?
      instructions:
      - text: Get password policy {id}.
        slots:
          id: path.id
      - text: Show the rules of password quality policy {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/passwordPolicies/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a password quality policy
      effect: write
      questions:
      - How do I tighten the rules on an existing password policy?
      - Can I show a password requirement indicator to users?
      instructions:
      - text: Update password policy {id} rules to {policy}.
        slots:
          id: path.id
          policy: requestBody.policy
      - text: Set the requirement indicator on password policy {id} to {passwordRequirementIndicator}.
        slots:
          id: path.id
          passwordRequirementIndicator: requestBody.passwordRequirementIndicator
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/passwordPolicies/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a password quality policy
      effect: destructive
      questions:
      - Why can't I delete a password policy that an identity store uses?
      - How do I remove an unused password quality policy?
      instructions:
      - text: Delete password policy {id}.
        slots:
          id: path.id
      - text: Remove the unused password quality policy {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'