BlueConic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BlueConic REST API v2 URL mappings API

4 actions 4 updates phrasing extends openapi/blueconic-url-mappings-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/urlmappings'].post

$.paths['/urlmappings/{id}'].get

$.paths['/urlmappings/{id}'].put

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 BlueConic REST API v2 URL mappings API
  version: 1.0.0
extends: openapi/blueconic-url-mappings-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: 3
- target: $.paths['/urlmappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a URL mapping
      effect: write
      questions:
      - How do I map a URL so visits to it set profile properties?
      - Can I create a URL mapping without an external tracker?
      instructions:
      - text: Create URL mapping {id} for {url} with properties {properties}.
        slots:
          id: requestBody.id
          url: requestBody.url
          properties: requestBody.properties
      - text: Add a new {type} URL mapping {id} for {url} setting {properties}.
        slots:
          type: requestBody.type
          id: requestBody.id
          url: requestBody.url
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/urlmappings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a URL mapping
      effect: read
      questions:
      - Which properties does an existing URL mapping set?
      - Can I check how a URL mapping is defined by its ID?
      instructions:
      - text: Get URL mapping {id}.
        slots:
          id: path.id
      - text: Show me the details of URL mapping {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/urlmappings/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing URL mapping
      effect: write
      questions:
      - Can I change the URL or properties of a mapping I already created?
      - What must I send to modify an existing URL mapping?
      instructions:
      - text: Update URL mapping {id} to point at {url} with properties {properties}.
        slots:
          id: path.id
          url: requestBody.url
          properties: requestBody.properties
      - text: Change existing mapping {id} so mapping {bodyId} uses {url} and sets {properties}.
        slots:
          id: path.id
          bodyId: requestBody.id
          url: requestBody.url
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'