HERE · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for v1 Index API
7 actions
7 updates
phrasing
extends
openapi/here-index-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 7
$.info
$.paths['/layers/{layerID}'].get
$.paths['/layers/{layerID}'].put
$.paths['/layers/{layerID}'].post
$.paths['/layers/{layerID}'].delete
$.paths['/layers/{layerID}/deleteRequest/{deleteId}'].get
$.paths['/layers/{layerID}/parts'].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 v1 Index API
version: 1.0.0
extends: openapi/here-index-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: 6
- target: $.paths['/layers/{layerID}'].get
update:
x-apievangelist-phrasing:
intent: Query partitions in an index layer
effect: read
questions:
- How do I find index layer partitions that match a query, such as by time window or tile?
- Can I split an index layer query into parts to run it in parallel?
instructions:
- text: Query index layer {layerID} for partitions matching {query}.
slots:
layerID: path.layerID
query: query.query
- text: Run query {query} on index layer {layerID} restricted to part {part}.
slots:
query: query.query
layerID: path.layerID
part: query.part
method: generated
generated: '2026-09-26'
- target: $.paths['/layers/{layerID}'].put
update:
x-apievangelist-phrasing:
intent: Add and remove index layer partitions
effect: write
questions:
- How do I add and remove index entries in an index layer in a single request?
- Can I delete the underlying data blob when removing index partitions?
instructions:
- text: Update index layer {layerID} with additions {additions} and removals {removals}.
slots:
layerID: path.layerID
additions: requestBody.additions
removals: requestBody.removals
- text: Remove index entries {removals} from layer {layerID} and delete their blobs {deleteBlob}.
slots:
removals: requestBody.removals
layerID: path.layerID
deleteBlob: requestBody.deleteBlob
method: generated
generated: '2026-09-26'
- target: $.paths['/layers/{layerID}'].post
update:
x-apievangelist-phrasing:
intent: Insert index data into an index layer
effect: write
questions:
- How do I publish index records for a data blob to an index layer?
- What's the call to add new index entries after uploading data?
instructions:
- text: Insert index data for my uploaded blob into index layer {layerID}.
slots:
layerID: path.layerID
- text: Add new index entries to layer {layerID} with billing tag {billingTag}.
slots:
layerID: path.layerID
billingTag: query.billingTag
method: generated
generated: '2026-09-26'
- target: $.paths['/layers/{layerID}'].delete
update:
x-apievangelist-phrasing:
intent: Delete index partitions matching a query
effect: destructive
questions:
- How do I delete all index layer partitions that match a condition?
- Does deleting index partitions by query give me an ID to track progress?
instructions:
- text: Delete the partitions in index layer {layerID} matching {deleteQuery}.
slots:
layerID: path.layerID
deleteQuery: query.deleteQuery
- text: Purge index layer {layerID} entries where {deleteQuery}.
slots:
layerID: path.layerID
deleteQuery: query.deleteQuery
method: generated
generated: '2026-09-26'
- target: $.paths['/layers/{layerID}/deleteRequest/{deleteId}'].get
update:
x-apievangelist-phrasing:
intent: Check the status of an index delete request
effect: read
questions:
- Has my index layer delete request finished, failed, or is it still processing?
- How do I track a delete-by-query job on an index layer?
instructions:
- text: Get the status of delete request {deleteId} on index layer {layerID}.
slots:
deleteId: path.deleteId
layerID: path.layerID
- text: Check whether delete {deleteId} in layer {layerID} succeeded.
slots:
deleteId: path.deleteId
layerID: path.layerID
method: generated
generated: '2026-09-26'
- target: $.paths['/layers/{layerID}/parts'].get
update:
x-apievangelist-phrasing:
intent: Get part IDs for parallel index queries
effect: read
questions:
- How do I split an index layer into parts so I can query it in parallel?
- Can I ask for a specific number of parts to divide an index query across?
instructions:
- text: Get {numRequestedParts} part IDs for index layer {layerID}.
slots:
numRequestedParts: query.numRequestedParts
layerID: path.layerID
- text: Divide index layer {layerID} into {numRequestedParts} parts for parallel querying.
slots:
layerID: path.layerID
numRequestedParts: query.numRequestedParts
method: generated
generated: '2026-09-26'