Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal NPM Dependency API

3 actions 3 updates phrasing extends openapi/strivacity-npm-dependency-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 3

$.info
$.paths['/admin/api/v1/eventHooks/npm/package'].post
$.paths['/admin/api/v1/eventHooks/npm/search'].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 NPM Dependency API
  version: 1.0.0
extends: openapi/strivacity-npm-dependency-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: 2
- target: $.paths['/admin/api/v1/eventHooks/npm/package'].post
  update:
    x-apievangelist-phrasing:
      intent: List versions of an NPM package for a hook
      effect: read
      questions:
      - Which versions of an NPM package can my event hook depend on?
      - How do I check available versions before pinning a hook dependency?
      instructions:
      - text: List the available versions of NPM package {name}.
        slots:
          name: requestBody.name
      - text: Show which versions of {name} I can use in a lifecycle hook.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/eventHooks/npm/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search NPM packages for a lifecycle hook
      effect: read
      questions:
      - Can I search for NPM packages to add to an event hook by keyword?
      - What NPM dependencies match a name I'm typing?
      instructions:
      - text: Suggest NPM dependencies matching {query}.
        slots:
          query: requestBody.query
      - text: Search NPM packages for {query} to use in my event hook.
        slots:
          query: requestBody.query
      method: generated
      generated: '2026-10-01'