HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Authentication API v1.1 Application Access Key Management…

6 actions 6 updates phrasing extends openapi/here-application-access-key-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 6

$.info

$.paths['/apps/{app}/accessKeys'].get

$.paths['/apps/{app}/accessKeys'].post

$.paths['/apps/{app}/accessKeys/{accessKey}'].delete

$.paths['/apps/{app}/accessKeys/{accessKey}/enable'].post

$.paths['/apps/{app}/accessKeys/{accessKey}/disable'].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 Application Access Key Management…
  version: 1.0.0
extends: openapi/here-application-access-key-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: 5
- target: $.paths['/apps/{app}/accessKeys'].get
  update:
    x-apievangelist-phrasing:
      intent: List an app's access keys
      effect: read
      questions:
      - Which access keys exist for my application?
      - Can I page through all access keys on an app?
      instructions:
      - text: List the access keys for app {app}.
        slots:
          app: path.app
      - text: Show {limit} access keys of application {app}.
        slots:
          limit: query.limit
          app: path.app
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apps/{app}/accessKeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new access key for an app
      effect: write
      questions:
      - How do I generate a new access key for my application?
      - What permission do I need to create an app access key?
      instructions:
      - text: Create a new access key for app {app}.
        slots:
          app: path.app
      - text: Generate an additional access key on application {app}.
        slots:
          app: path.app
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apps/{app}/accessKeys/{accessKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an app's access key
      effect: destructive
      questions:
      - Can I permanently delete a leaked access key?
      - How do I remove an access key from an app?
      instructions:
      - text: Delete access key {access_key} from app {app}.
        slots:
          access_key: path.accessKey
          app: path.app
      - text: Permanently remove key {access_key} on application {app}.
        slots:
          access_key: path.accessKey
          app: path.app
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apps/{app}/accessKeys/{accessKey}/enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable an app's access key
      effect: write
      questions:
      - Can I turn a disabled access key back on?
      - What's needed to reactivate an app access key?
      instructions:
      - text: Enable access key {access_key} for app {app}.
        slots:
          access_key: path.accessKey
          app: path.app
      - text: Reactivate the disabled key {access_key} on application {app}.
        slots:
          access_key: path.accessKey
          app: path.app
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apps/{app}/accessKeys/{accessKey}/disable'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable an app's access key
      effect: destructive
      questions:
      - Can I temporarily switch off an access key without deleting it?
      - Which call stops an access key from working for now?
      instructions:
      - text: Disable access key {access_key} for app {app}.
        slots:
          access_key: path.accessKey
          app: path.app
      - text: Turn off key {access_key} on application {app} without deleting it.
        slots:
          access_key: path.accessKey
          app: path.app
      method: generated
      generated: '2026-09-26'