Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Application Variant API

8 actions 8 updates phrasing extends openapi/strivacity-application-variant-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 8

$.info
$.paths['/admin/api/v2/applicationVariants'].get
$.paths['/admin/api/v2/applications/{applicationId}/variants'].get
$.paths['/admin/api/v2/applications/{applicationId}/variants'].put
$.paths['/admin/api/v2/applications/{applicationId}/variants'].post
$.paths['/admin/api/v2/applications/{applicationId}/variants/{variantId}'].get
$.paths['/admin/api/v2/applications/{applicationId}/variants/{variantId}'].put
$.paths['/admin/api/v2/applications/{applicationId}/variants/{variantId}'].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 Application Variant API
  version: 1.0.0
extends: openapi/strivacity-application-variant-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: 7
- target: $.paths['/admin/api/v2/applicationVariants'].get
  update:
    x-apievangelist-phrasing:
      intent: List variants across all applications
      effect: read
      questions:
      - What A/B testing variants exist across all my applications?
      - Can I see every variant grouped by application in one call?
      instructions:
      - text: List all variants grouped by application.
      - text: Show every A/B testing variant across all applications.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/variants'].get
  update:
    x-apievangelist-phrasing:
      intent: List an application's A/B testing variants
      effect: read
      questions:
      - Which A/B testing variants does one application have?
      - Can I see the config variants for a single application?
      instructions:
      - text: List the variants of application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: Show A/B test variants configured for application {applicationId}.
        slots:
          applicationId: path.applicationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/variants'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder an application's variants
      effect: write
      questions:
      - How do I change the priority order of an application's variants?
      - Does variant order matter, and can I rearrange it?
      instructions:
      - text: Reorder the variants of application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: Put application {applicationId}'s variants in a new order.
        slots:
          applicationId: path.applicationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/variants'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an A/B testing variant
      effect: write
      questions:
      - Can I A/B test different policies or consents for part of an application's users?
      - What do I need to define when creating an application config variant?
      instructions:
      - text: Create variant {name} on application {applicationId} targeting {target}.
        slots:
          name: requestBody.name
          applicationId: path.applicationId
          target: requestBody.target
      - text: Add variant {name} to application {applicationId} with policy overrides {policyOverrides}.
        slots:
          name: requestBody.name
          applicationId: path.applicationId
          policyOverrides: requestBody.policyOverrides
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/variants/{variantId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an A/B testing variant
      effect: read
      questions:
      - What overrides does a particular application variant apply?
      - Can I check which users a specific variant targets?
      instructions:
      - text: Get variant {variantId} of application {applicationId}.
        slots:
          variantId: path.variantId
          applicationId: path.applicationId
      - text: Show overrides in application {applicationId} variant {variantId}.
        slots:
          variantId: path.variantId
          applicationId: path.applicationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/variants/{variantId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an A/B testing variant
      effect: write
      questions:
      - Can I disable an A/B test variant without deleting it?
      - How do I change the target or hook overrides of an existing variant?
      instructions:
      - text: Update variant {variantId} of application {applicationId} to target {target}.
        slots:
          variantId: path.variantId
          applicationId: path.applicationId
          target: requestBody.target
      - text: Set enabled to {enabled} on application {applicationId} variant {variantId}.
        slots:
          enabled: requestBody.enabled
          variantId: path.variantId
          applicationId: path.applicationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/variants/{variantId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an A/B testing variant
      effect: destructive
      questions:
      - How do I remove an A/B test variant from an application?
      - What happens to an application when I delete one of its variants?
      instructions:
      - text: Delete variant {variantId} from application {applicationId}.
        slots:
          variantId: path.variantId
          applicationId: path.applicationId
      - text: Remove application {applicationId}'s A/B variant {variantId}.
        slots:
          variantId: path.variantId
          applicationId: path.applicationId
      method: generated
      generated: '2026-10-01'