HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Authorization API v1.1 Services API

4 actions 4 updates phrasing extends openapi/here-services-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['/services/{serviceId}'].get
$.paths['/services'].get
$.paths['/services/resourceTypes'].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 Authorization API v1.1 Services API
  version: 1.0.0
extends: openapi/here-services-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['/services/{serviceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a platform service by ID
      effect: read
      questions:
      - What actions and resource types does one specific platform service, looked up by its ID, define?
      - Can I get a service's information from its service ID?
      instructions:
      - text: Show information for service {serviceId}.
        slots:
          serviceId: path.serviceId
      - text: Describe the platform service with id {serviceId}.
        slots:
          serviceId: path.serviceId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/services'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a platform service by alias
      effect: read
      questions:
      - How do I find a service when I only know its short alias like data or pipeline?
      - Which service ID does an alias map to?
      instructions:
      - text: Get service information for alias {serviceIdAlias}.
        slots:
          serviceIdAlias: query.serviceIdAlias
      - text: Find the service whose alias is {serviceIdAlias}.
        slots:
          serviceIdAlias: query.serviceIdAlias
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services/resourceTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List resource types across services
      effect: read
      questions:
      - What resource types exist across all platform services?
      - Which kinds of resources can permissions be granted on?
      instructions:
      - text: List resource types for all services.
      - text: Show the first {limit} service resource types.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'