HERE · OpenAPI Overlay 1.0.0

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

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

$.info

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

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

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 Pricing Terms API
  version: 1.0.0
extends: openapi/here-platform-pricing-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: 2
- target: $.paths['/realms/{realmHrnOrMe}/pricingTermsAcceptance'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether pricing terms were accepted
      effect: read
      questions:
      - Has my organization accepted the platform pricing terms yet?
      - Who accepted the platform pricing terms for our realm, and when?
      instructions:
      - text: Get the pricing terms acceptance for realm {realmHrnOrMe}.
        slots:
          realmHrnOrMe: path.realmHrnOrMe
      - text: Check if realm {realmHrnOrMe} has accepted the pricing terms.
        slots:
          realmHrnOrMe: path.realmHrnOrMe
      method: generated
      generated: '2026-09-26'
- target: $.paths['/realms/{realmHrnOrMe}/pricingTermsAcceptance'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept the platform pricing terms
      effect: write
      questions:
      - How do I accept the HERE platform pricing terms for my organization?
      - What permission is needed to accept pricing terms on behalf of a realm?
      instructions:
      - text: Accept the platform pricing terms for realm {realmHrnOrMe}.
        slots:
          realmHrnOrMe: path.realmHrnOrMe
      - text: Record pricing terms acceptance for {realmHrnOrMe}.
        slots:
          realmHrnOrMe: path.realmHrnOrMe
      method: generated
      generated: '2026-09-26'