HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Authentication API v1.1 Platform Service Terms API

5 actions 5 updates phrasing extends openapi/here-platform-service-terms-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 5

$.info

$.paths['/serviceTerms'].get

$.paths['/realms/{realmHrnOrMe}/serviceTermsAcceptance'].get

$.paths['/realms/{realmHrnOrMe}/serviceTermsAcceptance'].post

$.paths['/realms/{realmHrn}/serviceTermsAcceptanceHistory'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Authentication API v1.1 Platform Service Terms API
  version: 1.0.0
extends: openapi/here-platform-service-terms-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: 4
- target: $.paths['/serviceTerms'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the current Platform Service Terms
      effect: read
      questions:
      - What are the current HERE Platform Service Terms?
      - Do the published service terms apply to organizations with an offline contract?
      instructions:
      - text: Get the current Platform Service Terms.
      - text: Show me the platform terms of service text.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/realms/{realmHrnOrMe}/serviceTermsAcceptance'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a realm's service terms acceptance
      effect: read
      questions:
      - Has my organization accepted the Platform Service Terms?
      - Which version of the service terms applies to my realm?
      instructions:
      - text: Check the service terms acceptance status for realm {realmHrnOrMe}.
        slots:
          realmHrnOrMe: path.realmHrnOrMe
      - text: Show whether realm {realmHrnOrMe} has agreed to the platform terms.
        slots:
          realmHrnOrMe: path.realmHrnOrMe
      method: generated
      generated: '2026-09-26'
- target: $.paths['/realms/{realmHrnOrMe}/serviceTermsAcceptance'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept the Platform Service Terms for a realm
      effect: write
      questions:
      - How do I accept the Platform Service Terms on behalf of my organization?
      - Who is allowed to agree to the service terms for a realm?
      instructions:
      - text: Accept the Platform Service Terms for realm {realmHrnOrMe}.
        slots:
          realmHrnOrMe: path.realmHrnOrMe
      - text: Agree to the platform terms on behalf of realm {realmHrnOrMe}.
        slots:
          realmHrnOrMe: path.realmHrnOrMe
      method: generated
      generated: '2026-09-26'
- target: $.paths['/realms/{realmHrn}/serviceTermsAcceptanceHistory'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a realm's service terms acceptance history
      effect: read
      questions:
      - When did my organization accept past versions of the service terms?
      - Can I audit the history of platform terms acceptance for our realm?
      instructions:
      - text: Get the service terms acceptance history for realm {realmHrn}.
        slots:
          realmHrn: path.realmHrn
      - text: List every past terms acceptance by realm {realmHrn}.
        slots:
          realmHrn: path.realmHrn
      method: generated
      generated: '2026-09-26'