Vital · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Junction Introspect API

3 actions 3 updates phrasing extends openapi/vital-io-introspect-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Vital's API. It is a proposal applied on top of the contract, not a document Vital publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v2/introspect/resources'].get

$.paths['/v2/introspect/historical_pull'].get

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 Junction Introspect API
  version: 1.0.0
extends: openapi/vital-io-introspect-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['/v2/introspect/resources'].get
  update:
    x-apievangelist-phrasing:
      intent: Inspect synced data resources per user
      effect: read
      questions:
      - Can I see which data resources each user has synced from a provider?
      - What resource sync state does my team have across users?
      instructions:
      - text: Introspect synced resources for user {user}.
        slots:
          user: query.user_id
      - text: List resource sync status for provider {provider}, {user_limit} users at a time.
        slots:
          provider: query.provider
          user_limit: query.user_limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/introspect/historical_pull'].get
  update:
    x-apievangelist-phrasing:
      intent: Inspect historical data pulls per user
      effect: read
      questions:
      - Has the historical backfill finished for a user's newly connected provider?
      - Can I page through historical pull status for all my users?
      instructions:
      - text: Show historical pull status for user {user}.
        slots:
          user: query.user_id
      - text: Check historical backfills from {provider} across my users.
        slots:
          provider: query.provider
      method: generated
      generated: '2026-10-01'