Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online LinkedIn / Extension API

7 actions 7 updates phrasing extends openapi/live-direct-marketing-online-linkedin-extension-api-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Live Direct Marketing's API. It is a proposal applied on top of the contract, not a document Live Direct Marketing publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/api/ext/linkedin/session'].post
$.paths['/api/ext/linkedin/next'].get
$.paths['/api/ext/linkedin/report'].post
$.paths['/api/ext/linkedin/events'].post
$.paths['/api/ext/linkedin/config'].get
$.paths['/api/ext/linkedin/heartbeat'].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 Live Direct Marketing Online LinkedIn / Extension API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-linkedin-extension-api-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['/api/ext/linkedin/session'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload LinkedIn session cookies from the extension
      effect: write
      questions:
      - How does the browser extension hand over an authorized LinkedIn session?
      - Can I refresh the stored LinkedIn session cookies?
      instructions:
      - text: Upload the LinkedIn session cookies from my browser.
      - text: Replace the stored LinkedIn session with fresh cookies.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/ext/linkedin/next'].get
  update:
    x-apievangelist-phrasing:
      intent: Claim the next due LinkedIn action
      effect: write
      questions:
      - What LinkedIn action should the extension perform next?
      - What happens when no LinkedIn action is due for an account?
      instructions:
      - text: Claim the next due LinkedIn action for account {accountId} with key {key}.
        slots:
          accountId: query.accountId
          key: query.key
      - text: Fetch the next queued LinkedIn task for {accountId}.
        slots:
          accountId: query.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/ext/linkedin/report'].post
  update:
    x-apievangelist-phrasing:
      intent: Report the outcome of a LinkedIn action
      effect: write
      questions:
      - How does the extension report whether a LinkedIn action succeeded?
      - Where do I send the result of an executed LinkedIn action?
      instructions:
      - text: Report that the LinkedIn connection request was sent.
      - text: Report a failed LinkedIn action execution.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/ext/linkedin/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Send LinkedIn widget events
      effect: write
      questions:
      - How are accepted invites and replies on LinkedIn sent back to the platform?
      - Where does the extension report LinkedIn warnings or security challenges?
      instructions:
      - text: Send a LinkedIn reply event from the widget.
      - text: Report a LinkedIn security challenge event.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/ext/linkedin/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get LinkedIn extension config and guard-rails
      effect: read
      questions:
      - Which toggles and safety limits apply to the LinkedIn extension?
      - What guard-rails is the LinkedIn client running with?
      instructions:
      - text: Fetch the LinkedIn extension config for key {key}.
        slots:
          key: query.key
      - text: Show the LinkedIn toggles and guard-rails for extension key {key}.
        slots:
          key: query.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/ext/linkedin/heartbeat'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a LinkedIn extension heartbeat
      effect: write
      questions:
      - How does the LinkedIn widget show it is still alive?
      - Can a heartbeat also carry refreshed LinkedIn cookies?
      instructions:
      - text: Send a heartbeat from the LinkedIn extension.
      - text: Ping the LinkedIn heartbeat with fresh cookies attached.
      method: generated
      generated: '2026-10-01'