CarsXE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CarsXE Vehicle Data Auth API

2 actions 2 updates phrasing extends openapi/carsxe-auth-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 2

$.info
$.paths['/v1/auth/validate'].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 CarsXE Vehicle Data Auth API
  version: 1.0.0
extends: openapi/carsxe-auth-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: 1
- target: $.paths['/v1/auth/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Check that an API key is valid
      effect: read
      questions:
      - Is my CarsXE API key still valid?
      - Can I test an API key before making vehicle data calls with it?
      - What happens if I send a revoked or mistyped key to the validation endpoint?
      instructions:
      - text: Validate the API key {key}.
        slots:
          key: query.key
      - text: Confirm that key {key} is accepted before we start decoding vehicles.
        slots:
          key: query.key
      method: generated
      generated: '2026-09-26'