HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Here Weather Alerts API

4 actions 4 updates phrasing extends openapi/here-weather-alerts-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for HERE's API. It is a proposal applied on top of the contract, not a document HERE publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/weather/2.0/alerts'].get
$.paths['/weather/2.0/alerts'].post
$.paths['/alerts'].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 Here Weather Alerts API
  version: 1.0.0
extends: openapi/here-weather-alerts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/weather/2.0/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get weather alerts around a car's location
      effect: read
      questions:
      - Are there any severe weather alerts near a vehicle's current position?
      - Can I widen the area checked around a single location for weather warnings?
      instructions:
      - text: Get weather alerts around latitude {lat} longitude {lon}.
        slots:
          lat: query.lat
          lon: query.lon
      - text: Check weather warnings within {width} of {lat},{lon}.
        slots:
          width: query.width
          lat: query.lat
          lon: query.lon
      method: generated
      generated: '2026-09-26'
- target: $.paths['/weather/2.0/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Get weather alerts along a route (v1)
      effect: read
      questions:
      - What weather alerts are along my route using the v1 weather API?
      - Can the older weather alerts call check a corridor along a route?
      instructions:
      - text: Get weather alerts along route {route} from the older route-only weather/2.0 alerts call.
        slots:
          route: requestBody.route
      - text: Check v1 weather warnings within {width} of route {route}.
        slots:
          width: requestBody.width
          route: requestBody.route
      method: generated
      generated: '2026-10-02'
- target: $.paths['/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Get weather alerts for a route or location
      effect: read
      questions:
      - Which severe weather warnings affect my trip or a single point?
      - Can I check weather alerts around a single point location, not only along a route?
      instructions:
      - text: Get weather alerts around the point or route features {features} with the current alerts call.
        slots:
          features: requestBody.features
      - text: Check current weather warnings along the route features {features}.
        slots:
          features: requestBody.features
      method: generated
      generated: '2026-10-02'