Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Lifecycle Event Hook Tryout API

4 actions 4 updates phrasing extends openapi/strivacity-lifecycle-event-hook-tryout-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 4

$.info
$.paths['/admin/api/v1/eventHooks/function/{functionId}/test'].post
$.paths['/admin/api/v1/eventHooks/function/{functionId}/test/{id}'].delete
$.paths['/admin/api/v1/eventHooks/function/{functionId}/test/{id}/call'].post

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 Lifecycle Event Hook Tryout API
  version: 1.0.0
extends: openapi/strivacity-lifecycle-event-hook-tryout-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: 3
- target: $.paths['/admin/api/v1/eventHooks/function/{functionId}/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a tryout event hook function
      effect: write
      questions:
      - Can I test lifecycle event hook code before deploying it?
      - How do I create a tryout environment for an event hook function?
      instructions:
      - text: Create a tryout resource for function {functionId} with code {code}.
        slots:
          functionId: path.functionId
          code: requestBody.code
      - text: Set up a test run of hook function {functionId} with code {code} and dependencies {packageDependencies}.
        slots:
          functionId: path.functionId
          code: requestBody.code
          packageDependencies: requestBody.packageDependencies
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/eventHooks/function/{functionId}/test/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tryout event hook function
      effect: destructive
      questions:
      - How do I clean up a tryout event hook resource when testing is done?
      - Can I delete a test function resource for an event hook?
      instructions:
      - text: Delete tryout resource {id} of function {functionId}.
        slots:
          id: path.id
          functionId: path.functionId
      - text: Remove event hook test resource {id} for function {functionId}.
        slots:
          id: path.id
          functionId: path.functionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/eventHooks/function/{functionId}/test/{id}/call'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a tryout event hook function
      effect: write
      questions:
      - Can I run a tryout event hook function against a sample request?
      - What input do I send to call a test hook function?
      instructions:
      - text: Call tryout resource {id} of function {functionId} with request {requestBody} and code {code}.
        slots:
          id: path.id
          functionId: path.functionId
          requestBody: requestBody.requestBody
          code: requestBody.code
      - text: Execute event hook test {id} for {functionId} using code {code} and sample input {requestBody}.
        slots:
          id: path.id
          functionId: path.functionId
          code: requestBody.code
          requestBody: requestBody.requestBody
      method: generated
      generated: '2026-10-01'