Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Variables API

6 actions 6 updates phrasing extends openapi/strivacity-variables-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/v1/instance/variables'].get

$.paths['/admin/api/v1/instance/variables'].post

$.paths['/admin/api/v1/instance/variables/{id}'].get

$.paths['/admin/api/v1/instance/variables/{id}'].put

$.paths['/admin/api/v1/instance/variables/{id}'].delete

OpenAPI Overlay

# 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 Variables API
  version: 1.0.0
extends: openapi/strivacity-variables-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/v1/instance/variables'].get
  update:
    x-apievangelist-phrasing:
      intent: List instance variables
      effect: read
      questions:
      - Which variables are defined in my instance?
      - Can I filter variables by type or name?
      instructions:
      - text: List all instance variables.
      - text: Find variables of type {type}.
        slots:
          type: query.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/variables'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an instance variable
      effect: write
      questions:
      - How do I store a reusable value or secret for my hooks?
      - Can I define a new instance-level variable?
      instructions:
      - text: Create an instance variable.
      - text: Add a new variable to my instance.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/variables/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an instance variable
      effect: read
      questions:
      - What value does a particular variable hold?
      - Can I look up one variable by ID?
      instructions:
      - text: Get variable {id}.
        slots:
          id: path.id
      - text: Show instance variable {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/variables/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an instance variable
      effect: write
      questions:
      - How do I change the value of a variable?
      - Can I edit an existing instance variable?
      instructions:
      - text: Update variable {id}.
        slots:
          id: path.id
      - text: Change the value of instance variable {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/variables/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an instance variable
      effect: destructive
      questions:
      - How do I remove a variable I no longer need?
      - Can an instance variable be deleted?
      instructions:
      - text: Delete variable {id}.
        slots:
          id: path.id
      - text: Remove instance variable {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'