Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Strivacity Branding Policy API

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

$.info
$.paths['/admin/api/v1/admin/brand'].get
$.paths['/admin/api/v1/admin/brand'].put
$.paths['/admin/api/v1/brands'].get
$.paths['/admin/api/v1/brands'].post
$.paths['/admin/api/v1/brands/{id}'].get
$.paths['/admin/api/v1/brands/{id}'].put
$.paths['/admin/api/v1/brands/{id}'].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 Strivacity Branding Policy API
  version: 1.0.0
extends: openapi/strivacity-branding-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: 7
- target: $.paths['/admin/api/v1/admin/brand'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the admin portal branding
      effect: read
      questions:
      - What logo and colors does the admin console currently use?
      - How can I see the branding applied to the admin portal itself?
      instructions:
      - text: Show the admin portal branding policy.
      - text: Get the colors and logo of the admin console.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/brand'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the admin portal branding
      effect: write
      questions:
      - How do I put my company logo on the admin console?
      - Can I add custom CSS to the admin portal branding?
      instructions:
      - text: Set the admin portal primary color to {primaryColor} and background to {backgroundColor}.
        slots:
          primaryColor: requestBody.primaryColor
          backgroundColor: requestBody.backgroundColor
      - text: Change the admin console logo to {logoUrl}.
        slots:
          logoUrl: requestBody.logoUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/brands'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer branding policies
      effect: read
      questions:
      - Which branding policies exist for my customer login pages?
      - Can I filter branding policies by policy tag?
      instructions:
      - text: List branding policies tagged {policyTags}.
        slots:
          policyTags: query.policyTags
      - text: Find the branding policy named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/brands'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer branding policy
      effect: write
      questions:
      - How do I brand the customer login pages for a new product?
      - Can a branding policy include extra scripts and a support text?
      instructions:
      - text: Create branding policy {name} for brand {brandName} with primary color {primaryColor} and background {backgroundColor}.
        slots:
          name: requestBody.name
          brandName: requestBody.brandName
          primaryColor: requestBody.primaryColor
          backgroundColor: requestBody.backgroundColor
      - text: Add a new branding policy {name} using logo {logoUrl}.
        slots:
          name: requestBody.name
          logoUrl: requestBody.logoUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/brands/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer branding policy
      effect: read
      questions:
      - How do I view the full settings of one branding policy?
      - What colors and links does a particular branding policy define?
      instructions:
      - text: Show branding policy {id}.
        slots:
          id: path.id
      - text: Get the settings of branding policy {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/brands/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a customer branding policy
      effect: write
      questions:
      - How do I change the privacy policy link on an existing login brand?
      - Can I move the logo into the footer of an existing branding policy?
      instructions:
      - text: Update branding policy {id} to use privacy policy URL {privacyPolicyUrl}.
        slots:
          id: path.id
          privacyPolicyUrl: requestBody.privacyPolicyUrl
      - text: Change the primary color of existing branding policy {id} to {primaryColor}.
        slots:
          id: path.id
          primaryColor: requestBody.primaryColor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/brands/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer branding policy
      effect: destructive
      questions:
      - How do I remove a branding policy I no longer need?
      - Can I delete an old login page brand?
      instructions:
      - text: Delete branding policy {id}.
        slots:
          id: path.id
      - text: Remove the unused login brand {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'