HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for v1 Volatile Blob API

6 actions 6 updates phrasing extends openapi/here-volatile-blob-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 6

$.info

$.paths['/layers/{layerId}/data/{dataHandle}'].get

$.paths['/layers/{layerId}/data/{dataHandle}'].put

$.paths['/layers/{layerId}/data/{dataHandle}'].delete

$.paths['/layers/{layerId}/data/{dataHandle}'].patch

$.paths['/layers/{layerId}/data/{dataHandle}'].head

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 Volatile Blob API
  version: 1.0.0
extends: openapi/here-volatile-blob-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: 5
- target: $.paths['/layers/{layerId}/data/{dataHandle}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a volatile data blob
      effect: read
      questions:
      - How do I read the data stored under a handle in a volatile layer?
      - Can I download a volatile blob's contents by its data handle?
      instructions:
      - text: Get the volatile blob {dataHandle} from layer {layerId}.
        slots:
          dataHandle: path.dataHandle
          layerId: path.layerId
      - text: Download data handle {dataHandle} in volatile layer {layerId}.
        slots:
          dataHandle: path.dataHandle
          layerId: path.layerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/layers/{layerId}/data/{dataHandle}'].put
  update:
    x-apievangelist-phrasing:
      intent: Publish a volatile data blob
      effect: write
      questions:
      - How do I write or overwrite data in a volatile layer?
      - Can I replicate a volatile blob when I publish it?
      instructions:
      - text: Publish data to handle {dataHandle} in volatile layer {layerId}.
        slots:
          dataHandle: path.dataHandle
          layerId: path.layerId
      - text: Upload a volatile blob to {dataHandle} in {layerId} with replication {replicate}.
        slots:
          dataHandle: path.dataHandle
          layerId: path.layerId
          replicate: header.X-Replicate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/layers/{layerId}/data/{dataHandle}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a volatile data blob
      effect: destructive
      questions:
      - How do I remove data stored under a handle in a volatile layer?
      - Can I delete a volatile blob before its time-to-live expires?
      instructions:
      - text: Delete volatile blob {dataHandle} from layer {layerId}.
        slots:
          dataHandle: path.dataHandle
          layerId: path.layerId
      - text: Remove the data at handle {dataHandle} in volatile layer {layerId}.
        slots:
          dataHandle: path.dataHandle
          layerId: path.layerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/layers/{layerId}/data/{dataHandle}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a volatile blob's time-to-live
      effect: write
      questions:
      - Can I extend how long a volatile blob is kept without re-uploading it?
      - How do I change the TTL on existing volatile data?
      instructions:
      - text: Set the TTL of blob {dataHandle} in layer {layerId} to {ttl}.
        slots:
          dataHandle: path.dataHandle
          layerId: path.layerId
          ttl: requestBody.ttl
      - text: Extend the expiry of volatile data {dataHandle} in {layerId}.
        slots:
          dataHandle: path.dataHandle
          layerId: path.layerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/layers/{layerId}/data/{dataHandle}'].head
  update:
    x-apievangelist-phrasing:
      intent: Check whether a volatile blob exists
      effect: read
      questions:
      - How can I check if data exists for a handle without downloading it?
      - Is there a quick existence check for a volatile data handle?
      instructions:
      - text: Check whether handle {dataHandle} exists in volatile layer {layerId}.
        slots:
          dataHandle: path.dataHandle
          layerId: path.layerId
      - text: Confirm there is data at {dataHandle} in layer {layerId} without fetching it.
        slots:
          dataHandle: path.dataHandle
          layerId: path.layerId
      method: generated
      generated: '2026-09-26'