CarsXE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CarsXE Year Make Model API

4 actions 4 updates phrasing extends openapi/carsxe-year-make-model-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/v1/ymm'].get

$.paths['/v1/ymm-options'].get

$.paths['/obdcodesdecoder'].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 CarsXE Year Make Model API
  version: 1.0.0
extends: openapi/carsxe-year-make-model-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/v1/ymm'].get
  update:
    x-apievangelist-phrasing:
      intent: Get vehicle data by year, make and model
      effect: read
      questions:
      - Can I get specs for a car when I only know its year, make and model?
      - How do I see every trim available for a given model year?
      instructions:
      - text: Get vehicle data for the {year} {make} {model} {trim}.
        slots:
          year: query.year
          make: query.make
          model: query.model
          trim: query.trim
      - text: List all trim options for the {year} {make} {model} with allTrimOptions {allTrimOptions}.
        slots:
          year: query.year
          make: query.make
          model: query.model
          allTrimOptions: query.allTrimOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ymm-options'].get
  update:
    x-apievangelist-phrasing:
      intent: Populate year, make, model and variant dropdowns
      effect: read
      questions:
      - How do I fill cascading year, make and model dropdowns in my car form?
      - Which model years exist for a given make and model?
      - Why does asking for variants by year and make cost more than one unit?
      instructions:
      - text: List the models {make} offers for dropdown menus.
        slots:
          make: query.make
      - text: Get the {dimension} dropdown options for {year} {make} {model}.
        slots:
          dimension: query.dimension
          year: query.year
          make: query.make
          model: query.model
      - text: List the trim choices for the {make} {model} matching {trim}.
        slots:
          make: query.make
          model: query.model
          trim: query.trim
      method: generated
      generated: '2026-09-26'
- target: $.paths['/obdcodesdecoder'].get
  update:
    x-apievangelist-phrasing:
      intent: Explain an OBD-II trouble code
      effect: read
      questions:
      - What does check engine code P0115 mean?
      - Can I translate an OBD-II diagnostic trouble code into plain English?
      instructions:
      - text: Decode OBD code {code}.
        slots:
          code: query.code
      - text: Tell me what the diagnostic trouble code {code} means.
        slots:
          code: query.code
      method: generated
      generated: '2026-09-26'