HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Rate Limit Rules API v1 Endpoints API

3 actions 3 updates phrasing extends openapi/here-endpoints-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['/endpoints'].get
$.paths['/endpoints/{endpointId}'].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 Rate Limit Rules API v1 Endpoints API
  version: 1.0.0
extends: openapi/here-endpoints-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['/endpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List endpoints subject to rate limits
      effect: read
      questions:
      - Which HERE platform endpoints are subject to rate limiting rules?
      - Can I page through the list of rate-limited endpoints?
      instructions:
      - text: List the endpoints covered by rate limit rules.
      - text: Show up to {limit} rate-limited endpoints.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoints/{endpointId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get rate-limit metadata for one endpoint
      effect: read
      questions:
      - How do I see the rate limiting metadata for a specific endpoint?
      - What do the rate limit rules say about one particular endpoint?
      instructions:
      - text: Get rate limit metadata for endpoint {endpointId}.
        slots:
          endpointId: path.endpointId
      - text: Show details of rate-limited endpoint {endpointId}.
        slots:
          endpointId: path.endpointId
      method: generated
      generated: '2026-09-26'