HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Here Account v1 Authorization Information API

5 actions 5 updates phrasing extends openapi/here-authorization-information-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['/user/me/authorization'].get

$.paths['/user/me/authorization/permissions'].get

$.paths['/app/me/authorization'].get

$.paths['/app/me/authorization/permissions'].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 Here Account v1 Authorization Information API
  version: 1.0.0
extends: openapi/here-authorization-information-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['/user/me/authorization'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my user's roles and permissions
      effect: read
      questions:
      - What roles and permissions does my HERE user account have?
      - Can I include every permission, not only the direct ones, in my authorization details?
      instructions:
      - text: Show my user authorization details.
      - text: Get my user roles and permissions with includeAllPermissions set to {includeAllPermissions}.
        slots:
          includeAllPermissions: query.includeAllPermissions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/me/authorization/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List permissions assigned to me
      effect: read
      questions:
      - Which permissions am I, as a user, assigned?
      - Can I page through my own user permissions?
      instructions:
      - text: List the permissions assigned to my user.
      - text: Show {count} of my user permissions per page.
        slots:
          count: query.count
      method: generated
      generated: '2026-09-26'
- target: $.paths['/app/me/authorization'].get
  update:
    x-apievangelist-phrasing:
      intent: Introspect my application's authorization
      effect: read
      questions:
      - What authorization does the app I'm calling with currently have?
      - How can an application check its own roles and permissions?
      instructions:
      - text: Introspect my application's authorization.
      - text: 'Show this app''s authorization including all permissions: {includeAllPermissions}.'
        slots:
          includeAllPermissions: query.includeAllPermissions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/app/me/authorization/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List permissions assigned directly to my app
      effect: read
      questions:
      - Which permissions are directly assigned to my application?
      - Why don't permissions my app gets through groups or plans show up in its direct permission list?
      instructions:
      - text: List the permissions assigned directly to my app.
      - text: Show {count} of my app's direct permissions per page.
        slots:
          count: query.count
      method: generated
      generated: '2026-09-26'