HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Authentication API v1.1 Trusted Domain Management API

10 actions 10 updates phrasing extends openapi/here-trusted-domain-management-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 10

$.info
$.paths['/apps/{app}/trustedDomainsEnabled'].get
$.paths['/apps/{app}/trustedDomainsEnabled'].put
$.paths['/apps/{app}/trustedDomainsEnabled'].delete
$.paths['/apps/{app}/trustedDomains/{trustedDomainUri}'].get
$.paths['/apps/{app}/trustedDomains/{trustedDomainUri}'].put
$.paths['/apps/{app}/trustedDomains/{trustedDomainUri}'].delete
$.paths['/apps/{app}/trustedDomains'].get
$.paths['/apps/{app}/trustedDomains'].post
$.paths['/apps/{app}/trustedDomains'].delete

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 Authentication API v1.1 Trusted Domain Management API
  version: 1.0.0
extends: openapi/here-trusted-domain-management-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: 9
- target: $.paths['/apps/{app}/trustedDomainsEnabled'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if Trusted Domains is enabled for an app
      effect: read
      questions:
      - Is Trusted Domains switched on for my app?
      - How can I tell whether an application restricts API key use to trusted domains?
      instructions:
      - text: Check whether Trusted Domains is enabled for app {app}.
        slots:
          app: path.app
      - text: Tell me if app {app} has Trusted Domains turned on.
        slots:
          app: path.app
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apps/{app}/trustedDomainsEnabled'].put
  update:
    x-apievangelist-phrasing:
      intent: Turn on Trusted Domains for an app
      effect: write
      questions:
      - How do I turn on Trusted Domains for an application?
      - What's the maximum number of trusted domains allowed once I enable the feature?
      instructions:
      - text: Enable Trusted Domains for app {app}.
        slots:
          app: path.app
      - text: Switch on trusted-domain enforcement for application {app}.
        slots:
          app: path.app
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apps/{app}/trustedDomainsEnabled'].delete
  update:
    x-apievangelist-phrasing:
      intent: Turn off Trusted Domains for an app
      effect: destructive
      questions:
      - How do I switch off Trusted Domains for an app?
      - Can I stop enforcing trusted domains on an application without deleting the domain list?
      instructions:
      - text: Disable Trusted Domains for app {app}.
        slots:
          app: path.app
      - text: Turn off trusted-domain enforcement on application {app}.
        slots:
          app: path.app
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apps/{app}/trustedDomains/{trustedDomainUri}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one trusted domain of an app
      effect: read
      questions:
      - Is a specific domain on my app's trusted list?
      - How do I look up a single trusted domain entry?
      instructions:
      - text: Get trusted domain {trustedDomainUri} for app {app}.
        slots:
          trustedDomainUri: path.trustedDomainUri
          app: path.app
      - text: Check whether {trustedDomainUri} is a trusted domain of app {app}.
        slots:
          trustedDomainUri: path.trustedDomainUri
          app: path.app
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apps/{app}/trustedDomains/{trustedDomainUri}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a single trusted domain to an app
      effect: write
      questions:
      - How do I add one website domain to my app's trusted list?
      - Can I allow a single new domain to use my app's credentials?
      instructions:
      - text: Add trusted domain {trustedDomainUri} to app {app}.
        slots:
          trustedDomainUri: path.trustedDomainUri
          app: path.app
      - text: Trust the single domain {trustedDomainUri} for application {app}.
        slots:
          trustedDomainUri: path.trustedDomainUri
          app: path.app
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apps/{app}/trustedDomains/{trustedDomainUri}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a single trusted domain from an app
      effect: destructive
      questions:
      - How do I remove one domain from my app's trusted domains?
      - Can I revoke trust for a single website domain?
      instructions:
      - text: Delete trusted domain {trustedDomainUri} from app {app}.
        slots:
          trustedDomainUri: path.trustedDomainUri
          app: path.app
      - text: Stop trusting the single domain {trustedDomainUri} for application {app}.
        slots:
          trustedDomainUri: path.trustedDomainUri
          app: path.app
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apps/{app}/trustedDomains'].get
  update:
    x-apievangelist-phrasing:
      intent: List an app's trusted domains
      effect: read
      questions:
      - Which domains are currently trusted for my app?
      - Can I page through a long list of trusted domains?
      instructions:
      - text: List the trusted domains for app {app}.
        slots:
          app: path.app
      - text: Show up to {limit} trusted domains of application {app}.
        slots:
          limit: query.limit
          app: path.app
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apps/{app}/trustedDomains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add several trusted domains to an app at once
      effect: write
      questions:
      - How do I add a batch of trusted domains to an application in one call?
      - What is the upper limit on trusted domains per app when adding in bulk?
      instructions:
      - text: Add the trusted domains {data} to app {app} in one request.
        slots:
          data: requestBody.data
          app: path.app
      - text: Bulk-add multiple domains {data} to application {app}'s trusted list.
        slots:
          data: requestBody.data
          app: path.app
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apps/{app}/trustedDomains'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove several trusted domains from an app
      effect: destructive
      questions:
      - How do I remove multiple trusted domains from an app in one call?
      - Can I bulk-delete a list of trusted domains?
      instructions:
      - text: Delete the trusted domains {list} from app {app}.
        slots:
          list: query.list
          app: path.app
      - text: Bulk-remove domains {list} from application {app}'s trusted list.
        slots:
          list: query.list
          app: path.app
      method: generated
      generated: '2026-09-26'