# 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 Scope API
  version: 1.0.0
extends: openapi/strivacity-api-security-policy-scope-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: 4
- target: $.paths['/admin/api/v1/accessPolicies/{policyId}/scopes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a scope to an API security policy
      effect: write
      questions:
      - How do I define a new scope for an API I'm protecting?
      - Can an API security policy have custom scopes?
      instructions:
      - text: Create scope {name} on API security policy {policy}.
        slots:
          name: requestBody.name
          policy: path.policyId
      - text: Add scope {name} to API policy {policy}.
        slots:
          name: requestBody.name
          policy: path.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/accessPolicies/{policyId}/scopes/{scopeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API security policy scope
      effect: read
      questions:
      - What is a particular scope on my API security policy?
      - Can I look up one scope of an API policy?
      instructions:
      - text: Get scope {scope} of API security policy {policy}.
        slots:
          scope: path.scopeId
          policy: path.policyId
      - text: Show scope {scope} on API policy {policy}.
        slots:
          scope: path.scopeId
          policy: path.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/accessPolicies/{policyId}/scopes/{scopeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename an API security policy scope
      effect: write
      questions:
      - How do I rename a scope on an API security policy?
      - Can I change an existing API policy scope?
      instructions:
      - text: Rename scope {scope} on API security policy {policy} to {name}.
        slots:
          scope: path.scopeId
          policy: path.policyId
          name: requestBody.name
      - text: Update scope {scope} in API policy {policy}.
        slots:
          scope: path.scopeId
          policy: path.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/accessPolicies/{policyId}/scopes/{scopeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API security policy scope
      effect: destructive
      questions:
      - How do I remove a scope from an API security policy?
      - Can I delete a scope clients no longer use?
      instructions:
      - text: Delete scope {scope} from API security policy {policy}.
        slots:
          scope: path.scopeId
          policy: path.policyId
      - text: Remove scope {scope} on API policy {policy}.
        slots:
          scope: path.scopeId
          policy: path.policyId
      method: generated
      generated: '2026-10-01'