Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Bridge Policy Resource API

7 actions 7 updates phrasing extends openapi/strivacity-bridge-policy-resource-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 7

$.info
$.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}/resources'].get
$.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}/resources'].put
$.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}/resources'].post
$.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}/resources/{resourceId}'].get
$.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}/resources/{resourceId}'].put
$.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}/resources/{resourceId}'].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 Bridge Policy Resource API
  version: 1.0.0
extends: openapi/strivacity-bridge-policy-resource-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: 6
- target: $.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}/resources'].get
  update:
    x-apievangelist-phrasing:
      intent: List bridge policy resources
      effect: read
      questions:
      - Which path patterns are protected by a bridge policy on my client?
      - Can I see all resources in an application client's bridge policy?
      instructions:
      - text: List bridge policy resources for policy {policy} on client {client} of app {app}.
        slots:
          app: path.applicationId
          client: path.clientId
          policy: path.apiAccessPolicyId
      - text: Show protected paths in bridge policy {policy}, client {client}, application {app}.
        slots:
          app: path.applicationId
          client: path.clientId
          policy: path.apiAccessPolicyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}/resources'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder bridge policy resources
      effect: write
      questions:
      - How do I change the evaluation order of bridge policy resources?
      - Can I reorder the resources in a bridge policy?
      instructions:
      - text: Reorder resources in bridge policy {policy} for client {client} of app {app}.
        slots:
          app: path.applicationId
          client: path.clientId
          policy: path.apiAccessPolicyId
      - text: Put the bridge resources of policy {policy}, client {client}, app {app} in my new order.
        slots:
          app: path.applicationId
          client: path.clientId
          policy: path.apiAccessPolicyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}/resources'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a resource to a bridge policy
      effect: write
      questions:
      - How do I protect a new path pattern behind a bridge policy?
      - Which HTTP methods and authentication can a bridge resource require?
      instructions:
      - text: Add bridge resource {pattern} with methods {methods} to policy {policy}, client {client}, app {app}.
        slots:
          app: path.applicationId
          client: path.clientId
          policy: path.apiAccessPolicyId
          pattern: requestBody.pathPattern
          methods: requestBody.methods
      - text: Protect path {pattern} in bridge policy {policy} for client {client} of app {app}.
        slots:
          app: path.applicationId
          client: path.clientId
          policy: path.apiAccessPolicyId
          pattern: requestBody.pathPattern
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}/resources/{resourceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a bridge policy resource
      effect: read
      questions:
      - What methods and authentication does one bridge resource require?
      - Can I read a single bridge policy resource?
      instructions:
      - text: Get bridge resource {resource} in policy {policy}, client {client}, app {app}.
        slots:
          app: path.applicationId
          client: path.clientId
          policy: path.apiAccessPolicyId
          resource: path.resourceId
      - text: Show the settings of bridge resource {resource} for policy {policy}, client {client}, app {app}.
        slots:
          app: path.applicationId
          client: path.clientId
          policy: path.apiAccessPolicyId
          resource: path.resourceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}/resources/{resourceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a bridge policy resource
      effect: write
      questions:
      - How do I change the path pattern of a bridge resource?
      - Can I change which methods a bridge resource covers?
      instructions:
      - text: Update bridge resource {resource} to pattern {pattern} in policy {policy}, client {client}, app {app}.
        slots:
          app: path.applicationId
          client: path.clientId
          policy: path.apiAccessPolicyId
          resource: path.resourceId
          pattern: requestBody.pathPattern
      - text: Change methods of bridge resource {resource} to {methods} (policy {policy}, client {client}, app {app}).
        slots:
          app: path.applicationId
          client: path.clientId
          policy: path.apiAccessPolicyId
          resource: path.resourceId
          methods: requestBody.methods
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}/resources/{resourceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a bridge policy resource
      effect: destructive
      questions:
      - How do I stop protecting a path in a bridge policy?
      - Can I remove one resource from a bridge policy?
      instructions:
      - text: Delete bridge resource {resource} from policy {policy}, client {client}, app {app}.
        slots:
          app: path.applicationId
          client: path.clientId
          policy: path.apiAccessPolicyId
          resource: path.resourceId
      - text: Remove protected path {resource} in bridge policy {policy} of client {client}, app {app}.
        slots:
          app: path.applicationId
          client: path.clientId
          policy: path.apiAccessPolicyId
          resource: path.resourceId
      method: generated
      generated: '2026-10-01'