HERE · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Authentication API v1.1 Application Management API
12 actions
12 updates
phrasing
extends
openapi/here-application-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.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/apps'].get
$.paths['/apps'].post
$.paths['/apps/{app}'].get
$.paths['/apps/{app}'].delete
$.paths['/apps/{app}'].patch
$.paths['/apps/{app}/defaultScope'].get
$.paths['/apps/{app}/defaultScope'].put
$.paths['/apps/{app}/defaultScope'].delete
$.paths['/apps/{app}/appCreationEnabled'].get
$.paths['/apps/{app}/appCreationEnabled'].put
$.paths['/apps/{app}/appCreationEnabled'].delete
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 Management API
version: 1.0.0
extends: openapi/here-application-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: 11
- target: $.paths['/apps'].get
update:
x-apievangelist-phrasing:
intent: List the apps I can manage
effect: read
questions:
- Which HERE platform applications do I or my groups have access to?
- Can I filter my apps to the ones I have a particular action permission on?
instructions:
- text: List my applications.
- text: List the apps I hold the {action} permission on.
slots:
action: query.action
method: generated
generated: '2026-09-26'
- target: $.paths['/apps'].post
update:
x-apievangelist-phrasing:
intent: Register a new application
effect: write
questions:
- How do I register a new app and get a client ID for it?
- Can I set redirect URIs and allowed scopes when creating an app?
- What token lifetime can a new application be given?
instructions:
- text: Create an application named {name}.
slots:
name: requestBody.name
- text: Register app {name} with redirect URIs {redirectUris}.
slots:
name: requestBody.name
redirectUris: requestBody.redirectUris
- text: Create app {name} whose tokens last {tokenDuration} seconds.
slots:
name: requestBody.name
tokenDuration: requestBody.tokenDuration
method: generated
generated: '2026-09-26'
- target: $.paths['/apps/{app}'].get
update:
x-apievangelist-phrasing:
intent: View an application
effect: read
questions:
- What are the settings of a specific application?
- Can I look up an app by its HRN?
instructions:
- text: Show me application {app}.
slots:
app: path.app
- text: Get the configuration of app {app}.
slots:
app: path.app
method: generated
generated: '2026-09-26'
- target: $.paths['/apps/{app}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an application
effect: destructive
questions:
- How do I delete an app I no longer need?
- Can I remove an application permanently by its HRN?
instructions:
- text: Delete application {app}.
slots:
app: path.app
- text: Permanently remove app {app}.
slots:
app: path.app
method: generated
generated: '2026-09-26'
- target: $.paths['/apps/{app}'].patch
update:
x-apievangelist-phrasing:
intent: Update an application's settings
effect: write
questions:
- How do I change the redirect URIs of an existing app?
- Can I change the token duration for an app I already registered?
instructions:
- text: Rename existing app {app} to {name}.
slots:
app: path.app
name: requestBody.name
- text: Update the redirect URIs of app {app} to {redirectUris}.
slots:
app: path.app
redirectUris: requestBody.redirectUris
- text: Change app {app}'s token duration to {tokenDuration} seconds.
slots:
app: path.app
tokenDuration: requestBody.tokenDuration
method: generated
generated: '2026-09-26'
- target: $.paths['/apps/{app}/defaultScope'].get
update:
x-apievangelist-phrasing:
intent: View an app's default scope
effect: read
questions:
- What default scope does an application's token get?
- Is an app locked to a default project scope?
instructions:
- text: Show the default scope of app {app}.
slots:
app: path.app
- text: Tell me which project app {app} is scoped to by default.
slots:
app: path.app
method: generated
generated: '2026-09-26'
- target: $.paths['/apps/{app}/defaultScope'].put
update:
x-apievangelist-phrasing:
intent: Set an app's default scope
effect: write
questions:
- How do I make an app's tokens default to a particular project?
- Can I restrict an app so it always uses its default project scope?
instructions:
- text: Set the default scope of app {app} to {scope}.
slots:
app: path.app
scope: requestBody.scope
- text: Lock app {app} to default scope {scope} with alwaysProjectScope {alwaysProjectScope}.
slots:
app: path.app
scope: requestBody.scope
alwaysProjectScope: requestBody.alwaysProjectScope
method: generated
generated: '2026-09-26'
- target: $.paths['/apps/{app}/defaultScope'].delete
update:
x-apievangelist-phrasing:
intent: Remove an app's default scope
effect: destructive
questions:
- How do I clear the default project scope from an application?
- Can an app go back to having no default scope?
instructions:
- text: Remove the default scope from app {app}.
slots:
app: path.app
- text: Clear app {app}'s default project scope.
slots:
app: path.app
method: generated
generated: '2026-09-26'
- target: $.paths['/apps/{app}/appCreationEnabled'].get
update:
x-apievangelist-phrasing:
intent: Check if an app may create other apps
effect: read
questions:
- Is this application allowed to create other applications?
- Can I verify the appCreationEnabled flag on an app?
instructions:
- text: Check whether app {app} can create other apps.
slots:
app: path.app
- text: Tell me if app creation is enabled for {app}.
slots:
app: path.app
method: generated
generated: '2026-09-26'
- target: $.paths['/apps/{app}/appCreationEnabled'].put
update:
x-apievangelist-phrasing:
intent: Let an app create other apps
effect: write
questions:
- How do I allow an application to create new applications itself?
- Can I turn on app creation for a service app?
instructions:
- text: Enable app creation for {app}.
slots:
app: path.app
- text: Allow application {app} to create other apps.
slots:
app: path.app
method: generated
generated: '2026-09-26'
- target: $.paths['/apps/{app}/appCreationEnabled'].delete
update:
x-apievangelist-phrasing:
intent: Stop an app from creating other apps
effect: destructive
questions:
- How do I take away an application's ability to create more apps?
- Can I switch off appCreationEnabled on an app?
instructions:
- text: Disable app creation for {app}.
slots:
app: path.app
- text: Stop application {app} from creating new apps.
slots:
app: path.app
method: generated
generated: '2026-09-26'