HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Authentication API v1.1 User Account Management API

5 actions 5 updates phrasing extends openapi/here-user-account-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 5

$.info

$.paths['/users/{user}/activate'].post

$.paths['/users/{user}/deactivate'].post

$.paths['/users/{user}'].delete

$.paths['/users/{user}/apps'].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 User Account Management API
  version: 1.0.0
extends: openapi/here-user-account-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: 4
- target: $.paths['/users/{user}/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a user account
      effect: write
      questions:
      - How do I reactivate a user account that was deactivated?
      - What permission do I need to activate someone's account?
      instructions:
      - text: Activate user account {user}.
        slots:
          user: path.user
      - text: Re-enable the account for user {user}.
        slots:
          user: path.user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user}/deactivate'].post
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a user account
      effect: destructive
      questions:
      - How do I suspend a user's account and invalidate their access tokens?
      - Can I deactivate a user without deleting their account?
      instructions:
      - text: Deactivate user account {user}.
        slots:
          user: path.user
      - text: Suspend {user} and revoke all their tokens.
        slots:
          user: path.user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user account
      effect: destructive
      questions:
      - How do I permanently delete a user account?
      - Can I remove someone's account from the platform entirely?
      instructions:
      - text: Delete user account {user}.
        slots:
          user: path.user
      - text: Permanently remove the account of {user}.
        slots:
          user: path.user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user}/apps'].get
  update:
    x-apievangelist-phrasing:
      intent: List apps a user can act on
      effect: read
      questions:
      - Which apps does a user have a given permission over, directly or through a group?
      - How do I see the applications a user can manage?
      instructions:
      - text: List the apps user {user} can perform action {action} on.
        slots:
          user: path.user
          action: query.action
      - text: Show up to {limit} applications where {user} holds permission {action}.
        slots:
          limit: query.limit
          user: path.user
          action: query.action
      method: generated
      generated: '2026-09-26'