# 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 API Security Policy API
  version: 1.0.0
extends: openapi/strivacity-api-security-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: 9
- target: $.paths['/admin/api/v1/accessPolicies'].get
  update:
    x-apievangelist-phrasing:
      intent: List API security policies
      effect: read
      questions:
      - Which API security policies are configured in my instance?
      - Can I filter API security policies by audience or client?
      instructions:
      - text: List all API security policies.
      - text: Find API security policies with audience {audience}.
        slots:
          audience: query.audience
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/accessPolicies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API security policy
      effect: write
      questions:
      - How do I protect my API with a new security policy and audience?
      - What do I need to set up an API security policy in Strivacity?
      instructions:
      - text: Create an API security policy named {name} for audience {audience}.
        slots:
          name: requestBody.name
          audience: requestBody.audience
      - text: Set up a new API security policy {name} with audience {audience}.
        slots:
          name: requestBody.name
          audience: requestBody.audience
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/accessPolicies/{policyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API security policy
      effect: read
      questions:
      - What audience and settings does a given API security policy use?
      - Can I look up one API security policy by ID?
      instructions:
      - text: Get API security policy {policy}.
        slots:
          policy: path.policyId
      - text: Show the details of API security policy {policy}.
        slots:
          policy: path.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/accessPolicies/{policyId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an API security policy
      effect: write
      questions:
      - How do I change the audience or name of an API security policy?
      - Can I retag an existing API security policy?
      instructions:
      - text: Update API security policy {policy} to audience {audience}.
        slots:
          policy: path.policyId
          audience: requestBody.audience
      - text: Rename API security policy {policy} to {name}.
        slots:
          policy: path.policyId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/accessPolicies/{policyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API security policy
      effect: destructive
      questions:
      - How do I remove an API security policy I no longer use?
      - Can an API security policy be deleted entirely?
      instructions:
      - text: Delete API security policy {policy}.
        slots:
          policy: path.policyId
      - text: Remove the API security policy {policy} permanently.
        slots:
          policy: path.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/accessPolicies/{policyId}/assignments'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign a client to an API security policy
      effect: write
      questions:
      - How do I let a client call an API protected by a security policy?
      - Which clients can be assigned to an API security policy?
      instructions:
      - text: Assign client {client} to API security policy {policy} with scopes {scopes}.
        slots:
          client: requestBody.client
          policy: path.policyId
          scopes: requestBody.scopes
      - text: Give client {client} access to API policy {policy}.
        slots:
          client: requestBody.client
          policy: path.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/accessPolicies/{policyId}/assignments/{clientId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a client's API security policy assignment
      effect: read
      questions:
      - Which scopes does a client have on an API security policy?
      - Can I check whether a client is assigned to a policy?
      instructions:
      - text: Get the assignment of client {client} on API security policy {policy}.
        slots:
          client: path.clientId
          policy: path.policyId
      - text: Show scopes granted to client {client} under policy {policy}.
        slots:
          client: path.clientId
          policy: path.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/accessPolicies/{policyId}/assignments/{clientId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a client's API policy scopes
      effect: write
      questions:
      - How do I change the scopes a client has on an API security policy?
      - Can I update an existing client assignment on a policy?
      instructions:
      - text: Update client {client}'s assignment on policy {policy} to scopes {scopes}.
        slots:
          client: path.clientId
          policy: path.policyId
          scopes: requestBody.scopes
      - text: Change the scopes for client {client} on API security policy {policy}.
        slots:
          client: path.clientId
          policy: path.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/accessPolicies/{policyId}/assignments/{clientId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassign a client from an API security policy
      effect: destructive
      questions:
      - How do I revoke a client's access to an API security policy?
      - Can I remove a client assignment from a policy?
      instructions:
      - text: Remove client {client} from API security policy {policy}.
        slots:
          client: path.clientId
          policy: path.policyId
      - text: Revoke API policy {policy} access for client {client}.
        slots:
          client: path.clientId
          policy: path.policyId
      method: generated
      generated: '2026-10-01'