Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Strivacity Notification Template API

9 actions 9 updates phrasing extends openapi/strivacity-notification-template-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 9

$.info
$.paths['/admin/api/v1/admin/notificationPolicy/email/{id}'].put
$.paths['/admin/api/v1/admin/notificationPolicy/sms/{id}'].put
$.paths['/admin/api/v1/admin/notificationPolicy/{type}'].get
$.paths['/admin/api/v1/admin/notificationPolicy/{type}/{id}'].get
$.paths['/admin/api/v1/notificationPolicies/{policyId}/email/{id}'].put
$.paths['/admin/api/v1/notificationPolicies/{policyId}/sms/{id}'].put
$.paths['/admin/api/v1/notificationPolicies/{policyId}/{type}'].get
$.paths['/admin/api/v1/notificationPolicies/{policyId}/{type}/{id}'].get

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 Strivacity Notification Template API
  version: 1.0.0
extends: openapi/strivacity-notification-template-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: 8
- target: $.paths['/admin/api/v1/admin/notificationPolicy/email/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an admin email notification template
      effect: write
      questions:
      - How do I edit the email admins receive for a notification?
      - Can I change the subject and body of an admin email template?
      instructions:
      - text: Update admin email template {id} with subject {subject}.
        slots:
          id: path.id
          subject: requestBody.subject
      - text: Disable the admin email notification template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/notificationPolicy/sms/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an admin SMS notification template
      effect: write
      questions:
      - How do I change the text message sent to admins?
      - Can I turn off an admin SMS notification template?
      instructions:
      - text: Update admin SMS template {id} with body {body}.
        slots:
          id: path.id
          body: requestBody.body
      - text: Switch off the admin SMS notification template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/notificationPolicy/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin notification templates by type
      effect: read
      questions:
      - What admin notification templates exist for email?
      - Which admin templates are available for a notification type?
      instructions:
      - text: List admin notification templates of type {type}.
        slots:
          type: path.type
      - text: Show all admin {type} notification templates.
        slots:
          type: path.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/notificationPolicy/{type}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an admin notification template
      effect: read
      questions:
      - What does a specific admin notification template currently say?
      - Can I read one admin template by type and ID?
      instructions:
      - text: Get admin notification template {id} of type {type}.
        slots:
          id: path.id
          type: path.type
      - text: Show the admin {type} template {id}.
        slots:
          type: path.type
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/notificationPolicies/{policyId}/email/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a customer email template in a policy
      effect: write
      questions:
      - How do I customize the email customers receive from a notification policy?
      - Can I edit the plain-text version of a notification email?
      instructions:
      - text: Update email template {id} in notification policy {policy} with subject {subject}.
        slots:
          id: path.id
          policy: path.policyId
          subject: requestBody.subject
      - text: Change the body of email template {id} in policy {policy}.
        slots:
          id: path.id
          policy: path.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/notificationPolicies/{policyId}/sms/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a customer SMS template in a policy
      effect: write
      questions:
      - How do I change the SMS text customers get from a notification policy?
      - Can an SMS template in a notification policy be disabled?
      instructions:
      - text: Update SMS template {id} in notification policy {policy} with body {body}.
        slots:
          id: path.id
          policy: path.policyId
          body: requestBody.body
      - text: Disable SMS template {id} in notification policy {policy}.
        slots:
          id: path.id
          policy: path.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/notificationPolicies/{policyId}/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a notification policy's templates by type
      effect: read
      questions:
      - Which SMS templates does my notification policy contain?
      - What templates of a given type belong to a notification policy?
      instructions:
      - text: List {type} templates in notification policy {policy}.
        slots:
          type: path.type
          policy: path.policyId
      - text: Show every {type} template defined in policy {policy}.
        slots:
          type: path.type
          policy: path.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/notificationPolicies/{policyId}/{type}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a template from a notification policy
      effect: read
      questions:
      - What is the current wording of a customer-facing notification template?
      - Can I fetch one template from a notification policy?
      instructions:
      - text: Get {type} template {id} from notification policy {policy}.
        slots:
          type: path.type
          id: path.id
          policy: path.policyId
      - text: Show template {id} of type {type} in policy {policy}.
        slots:
          id: path.id
          type: path.type
          policy: path.policyId
      method: generated
      generated: '2026-10-01'