HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Here Account v1 Authorization Share API

5 actions 5 updates phrasing extends openapi/here-authorization-share-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/{userId}/authorization/share/permissions'].post
$.paths['/app/{appId}/authorization/share/permissions'].post
$.paths['/group/{groupId}/authorization/share/permissions'].post
$.paths['/permissions'].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 Here Account v1 Authorization Share API
  version: 1.0.0
extends: openapi/here-authorization-share-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/{userId}/authorization/share/permissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Share permissions with a user
      effect: write
      questions:
      - How do I share access to a resource with another user?
      - Does sharing permissions to a user work with a project-scoped token?
      instructions:
      - text: Share permissions {permissions} with user {userId}.
        slots:
          permissions: requestBody.permissions
          userId: path.userId
      - text: Grant user {userId} the permissions {permissions}.
        slots:
          userId: path.userId
          permissions: requestBody.permissions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/app/{appId}/authorization/share/permissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Share permissions with an application
      effect: write
      questions:
      - How do I give an application access to one of my resources?
      - Can I share permissions directly with an app instead of a person?
      instructions:
      - text: Share permissions {permissions} with app {appId}.
        slots:
          permissions: requestBody.permissions
          appId: path.appId
      - text: Grant application {appId} the permissions {permissions}.
        slots:
          appId: path.appId
          permissions: requestBody.permissions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/{groupId}/authorization/share/permissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Share permissions with a group
      effect: write
      questions:
      - How do I share access to a resource with everyone in a group?
      - Can one call give a whole group permissions on my catalog?
      instructions:
      - text: Share permissions {permissions} with group {groupId}.
        slots:
          permissions: requestBody.permissions
          groupId: path.groupId
      - text: Grant group {groupId} the permissions {permissions}.
        slots:
          groupId: path.groupId
          permissions: requestBody.permissions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/permissions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke shared permissions on a resource
      effect: destructive
      questions:
      - How do I take back all the permissions I shared on a resource from a user, app or group?
      - Can I revoke access to a resource from just one group?
      instructions:
      - text: Remove all permissions on resource {hrn} from user {userId}.
        slots:
          hrn: query.hrn
          userId: query.userId
      - text: Revoke group {groupId}'s permissions on {hrn}.
        slots:
          groupId: query.groupId
          hrn: query.hrn
      - text: Revoke app {appId}'s access to resource {hrn}.
        slots:
          appId: query.appId
          hrn: query.hrn
      method: generated
      generated: '2026-09-26'