Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Bridge Policy API

6 actions 6 updates phrasing extends openapi/strivacity-bridge-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/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies'].get
$.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies'].post
$.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}'].get
$.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}'].put
$.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}'].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 API
  version: 1.0.0
extends: openapi/strivacity-bridge-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/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies'].get
  update:
    x-apievangelist-phrasing:
      intent: List bridge policies for an application client
      effect: read
      questions:
      - Which bridge policies proxy traffic for an application client?
      - How can I see the upstream bridges set up on a client?
      instructions:
      - text: List bridge policies for client {clientId} of application {applicationId}.
        slots:
          clientId: path.clientId
          applicationId: path.applicationId
      - text: Show the bridges configured on application {applicationId}, client {clientId}.
        slots:
          applicationId: path.applicationId
          clientId: path.clientId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a bridge policy to an upstream service
      effect: write
      questions:
      - How do I route an application client's API calls to my upstream URLs?
      - Can a bridge policy include a health monitoring path?
      instructions:
      - text: Create a bridge policy on client {clientId} of application {applicationId} pointing to {upstreamUrls}.
        slots:
          clientId: path.clientId
          applicationId: path.applicationId
          upstreamUrls: requestBody.upstreamUrls
      - text: Add a bridge for application {applicationId} client {clientId} using API policy {apiAccessPolicy} and headers {headers}.
        slots:
          applicationId: path.applicationId
          clientId: path.clientId
          apiAccessPolicy: requestBody.apiAccessPolicy
          headers: requestBody.headers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a bridge policy
      effect: read
      questions:
      - Which upstream URLs does a specific bridge policy forward to?
      - How do I inspect one bridge policy?
      instructions:
      - text: Show bridge policy {apiAccessPolicyId} on client {clientId} of application {applicationId}.
        slots:
          apiAccessPolicyId: path.apiAccessPolicyId
          clientId: path.clientId
          applicationId: path.applicationId
      - text: Get the upstreams of bridge {apiAccessPolicyId} for application {applicationId} client {clientId}.
        slots:
          apiAccessPolicyId: path.apiAccessPolicyId
          applicationId: path.applicationId
          clientId: path.clientId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a bridge policy
      effect: write
      questions:
      - How do I change the upstream URLs of an existing bridge policy?
      - Can I update the forwarded headers on a bridge?
      instructions:
      - text: Update bridge policy {apiAccessPolicyId} on client {clientId} of application {applicationId} to use {upstreamUrls}.
        slots:
          apiAccessPolicyId: path.apiAccessPolicyId
          clientId: path.clientId
          applicationId: path.applicationId
          upstreamUrls: requestBody.upstreamUrls
      - text: Set health check path {healthMonitoringPath} on existing bridge {apiAccessPolicyId} for application {applicationId} client {clientId}.
        slots:
          healthMonitoringPath: requestBody.healthMonitoringPath
          apiAccessPolicyId: path.apiAccessPolicyId
          applicationId: path.applicationId
          clientId: path.clientId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a bridge policy
      effect: destructive
      questions:
      - How do I remove a bridge policy from an application client?
      - Can I stop proxying a client's calls to an upstream?
      instructions:
      - text: Delete bridge policy {apiAccessPolicyId} from client {clientId} of application {applicationId}.
        slots:
          apiAccessPolicyId: path.apiAccessPolicyId
          clientId: path.clientId
          applicationId: path.applicationId
      - text: Remove bridge {apiAccessPolicyId} on application {applicationId} client {clientId}.
        slots:
          apiAccessPolicyId: path.apiAccessPolicyId
          applicationId: path.applicationId
          clientId: path.clientId
      method: generated
      generated: '2026-10-01'