HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Here Weather Report API

3 actions 3 updates phrasing extends openapi/here-weather-report-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 3

$.info
$.paths['/weather/1.0/report'].get
$.paths['/report'].get

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 Report API
  version: 1.0.0
extends: openapi/here-weather-report-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: 2
- target: $.paths['/weather/1.0/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a weather report (legacy v1 endpoint)
      effect: read
      questions:
      - How do I get current weather for a city by name from the older 1.0 weather report endpoint?
      - Can the legacy v1 weather report return hourly forecasts for a given date?
      - Does the 1.0 weather endpoint accept a ZIP code instead of coordinates?
      instructions:
      - text: Using the v1 weather endpoint, get the {product} report for city {name}.
        slots:
          product: query.product
          name: query.name
      - text: Get the legacy 1.0 {product} weather report at latitude {latitude}, longitude {longitude}.
        slots:
          product: query.product
          latitude: query.latitude
          longitude: query.longitude
      - text: Fetch the v1 {product} report for ZIP code {zipCode} with metric units set to {metric}.
        slots:
          product: query.product
          zipCode: query.zipCode
          metric: query.metric
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Get weather observations, forecasts and alerts
      effect: read
      questions:
      - What is the weather forecast for an address I can type as free text?
      - Can I request several report types, like observation and forecast, in one v3 call?
      - Are there severe weather alerts near a set of coordinates?
      instructions:
      - text: Get the {products} weather for {q}.
        slots:
          products: query.products
          q: query.q
      - text: Get {products} weather at location {location} in {units} units.
        slots:
          products: query.products
          location: query.location
          units: query.units
      - text: Show hourly {products} forecasts for {q} on {hourlyDate}.
        slots:
          products: query.products
          q: query.q
          hourlyDate: query.hourlyDate
      method: generated
      generated: '2026-09-26'