Vital · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Junction Team API

7 actions 7 updates phrasing extends openapi/vital-io-team-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 7

$.info

$.paths['/v2/team/{team_id}'].get

$.paths['/v2/team/users/search'].get

$.paths['/v2/team/svix/url'].get

$.paths['/v2/team/source/priorities'].get

$.paths['/v2/team/source/priorities'].patch

$.paths['/v2/team/{team_id}/physicians'].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 Team API
  version: 1.0.0
extends: openapi/vital-io-team-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: 6
- target: $.paths['/v2/team/{team_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a team's details
      effect: read
      questions:
      - What configuration and details are stored for my team?
      - Can I look up a team by its ID?
      instructions:
      - text: Get team {team_id}.
        slots:
          team_id: path.team_id
      - text: Show the details of team {team_id}.
        slots:
          team_id: path.team_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/team/users/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Find a team user by either ID
      effect: read
      questions:
      - Can I find a team user by their Vital user ID or my own client user ID?
      - Which user on my team matches an ID from my system?
      instructions:
      - text: Search team users for {query_id}.
        slots:
          query_id: query.query_id
      - text: Find the user whose user ID or client user ID is {query_id}.
        slots:
          query_id: query.query_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/team/svix/url'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my team's webhook portal URL
      effect: read
      questions:
      - Where do I manage my team's webhook endpoints?
      - Can I get the webhook portal URL for my team?
      instructions:
      - text: Get my team's webhook portal URL.
      - text: Open the webhook management link for my team.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/team/source/priorities'].get
  update:
    x-apievangelist-phrasing:
      intent: Get data source priorities
      effect: read
      questions:
      - Which data source takes precedence when several providers report the same data?
      - Can I see source priorities for a single data type?
      instructions:
      - text: Get my team's source priorities.
      - text: Show source priorities for data type {data_type}.
        slots:
          data_type: query.data_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/team/source/priorities'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update data source priorities
      effect: write
      questions:
      - Can I change which provider wins when data sources overlap?
      - How do I reorder my team's source priorities?
      instructions:
      - text: Update my team's source priorities.
      - text: Reorder the data source priority list for my team.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/team/{team_id}/physicians'].get
  update:
    x-apievangelist-phrasing:
      intent: List a team's physicians
      effect: read
      questions:
      - Which physicians are set up for my team?
      - Can I list the ordering physicians on a team?
      instructions:
      - text: List physicians for team {team_id}.
        slots:
          team_id: path.team_id
      - text: Show team {team_id}'s ordering physicians.
        slots:
          team_id: path.team_id
      method: generated
      generated: '2026-10-01'