Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Plugin Library API

8 actions 8 updates phrasing extends openapi/strivacity-plugin-library-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/pluginLibrary/categories'].get
$.paths['/admin/api/v2/pluginLibrary/eventHookSnippets/{type}'].get
$.paths['/admin/api/v2/pluginLibrary/eventHookSnippets/{type}/{id}'].get
$.paths['/admin/api/v2/pluginLibrary/eventHooks'].get
$.paths['/admin/api/v2/pluginLibrary/eventHooks/{id}'].get
$.paths['/admin/api/v2/pluginLibrary/journeys'].get
$.paths['/admin/api/v2/pluginLibrary/journeys/{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 Admin Portal Plugin Library API
  version: 1.0.0
extends: openapi/strivacity-plugin-library-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/pluginLibrary/categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List plugin library categories
      effect: read
      questions:
      - What categories are plugins grouped into in the plugin library?
      - How is the integration library organized?
      instructions:
      - text: List the plugin library categories.
      - text: Show the categories used to group plugins.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/pluginLibrary/eventHookSnippets/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List code snippets for an event hook type
      effect: read
      questions:
      - Are there ready-made code snippets for a given lifecycle hook type?
      - Which sample snippets exist for a pre-registration hook?
      instructions:
      - text: List the snippets available for hook type {type}.
        slots:
          type: path.type
      - text: Show sample code snippets for {type} event hooks.
        slots:
          type: path.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/pluginLibrary/eventHookSnippets/{type}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the code of an event hook snippet
      effect: read
      questions:
      - How do I get the actual source code of a hook snippet?
      - Can I copy the code for one specific event hook snippet?
      instructions:
      - text: Get the code for snippet {id} of hook type {type}.
        slots:
          id: path.id
          type: path.type
      - text: Show me the source of {type} hook snippet {id}.
        slots:
          type: path.type
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/pluginLibrary/eventHooks'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse lifecycle event hook integrations
      effect: read
      questions:
      - Which prebuilt integrations exist for lifecycle event hooks?
      - What event hook plugins can I install from the library?
      instructions:
      - text: List the lifecycle event hook integrations in the plugin library.
      - text: Show all event hook plugins available.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/pluginLibrary/eventHooks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a lifecycle event hook integration
      effect: read
      questions:
      - How do I see the details of one event hook integration?
      - What does a specific lifecycle hook plugin do?
      instructions:
      - text: Show event hook integration {id}.
        slots:
          id: path.id
      - text: Get details of the lifecycle hook plugin {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/pluginLibrary/journeys'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse journey integrations
      effect: read
      questions:
      - Which prebuilt integrations can I use in login journeys?
      - What journey plugins does the library offer?
      instructions:
      - text: List the journey integrations in the plugin library.
      - text: Show all plugins available for journeys.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/pluginLibrary/journeys/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a journey integration
      effect: read
      questions:
      - How do I view the details of one journey plugin?
      - What does a specific journey integration provide?
      instructions:
      - text: Show journey integration {id}.
        slots:
          id: path.id
      - text: Get the details of journey plugin {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'