HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Lookup Service v1 Resources API

3 actions 3 updates phrasing extends openapi/here-resources-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['/resources/{hrn}/apis'].get
$.paths['/resources/{hrn}/apis/{api}/{version}'].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 Lookup Service v1 Resources API
  version: 1.0.0
extends: openapi/here-resources-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['/resources/{hrn}/apis'].get
  update:
    x-apievangelist-phrasing:
      intent: List the APIs available for a resource
      effect: read
      questions:
      - Which API base URLs should I call for a given catalog HRN?
      - Can I look up a resource's API endpoints for a specific region?
      instructions:
      - text: List the APIs for resource {hrn}.
        slots:
          hrn: path.hrn
      - text: Show the API endpoints for {hrn} in region {region}.
        slots:
          hrn: path.hrn
          region: query.region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/{hrn}/apis/{api}/{version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one API's endpoint for a resource
      effect: read
      questions:
      - What is the base URL for one specific API version on a catalog?
      - Can I look up just the query API endpoint for a resource?
      instructions:
      - text: Get API {api} version {version} for resource {hrn}.
        slots:
          api: path.api
          version: path.version
          hrn: path.hrn
      - text: Show the base URL of {api} {version} for {hrn} in region {region}.
        slots:
          api: path.api
          version: path.version
          hrn: path.hrn
          region: query.region
      method: generated
      generated: '2026-09-26'