HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for HERE Tracking Largedata API

11 actions 11 updates phrasing extends openapi/here-largedata-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 11

$.info
$.paths['/largedata/v4/health'].get
$.paths['/largedata/v4/version'].get
$.paths['/largedata/v4'].post
$.paths['/largedata/v4/{dataId}/parts/{partNumber}'].put
$.paths['/largedata/v4/{dataId}'].post
$.paths['/largedata/v4/{dataId}'].delete
$.paths['/largedata/v4/{dataId}/data'].get
$.paths['/largedata/v4/{dataId}/metadata'].get
$.paths['/largedata/v4/{dataId}/parts'].get
$.paths['/largedata/v4/devices/{trackingId}/metadata'].get

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 Tracking Largedata API
  version: 1.0.0
extends: openapi/here-largedata-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/largedata/v4/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the Largedata service health
      effect: read
      questions:
      - Is the HERE Tracking Largedata service up right now?
      - Can I ping the Largedata service before sending it requests?
      instructions:
      - text: Check the health of the Largedata service.
      - text: Tell me whether the Largedata service is healthy.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/largedata/v4/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Largedata service version
      effect: read
      questions:
      - What version of the Largedata service is deployed?
      - Which build of the Largedata service am I talking to?
      instructions:
      - text: Get the version of the Largedata service.
      - text: Show me which Largedata service version is running.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/largedata/v4'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a multipart large data upload
      effect: write
      questions:
      - How do I start a new multipart upload for a large file from a tracking device?
      - Can I name and describe a large data object when I create it?
      instructions:
      - text: Create a new large data upload named {name}.
        slots:
          name: requestBody.name
      - text: Start a multipart upload called {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-02'
- target: $.paths['/largedata/v4/{dataId}/parts/{partNumber}'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload one part of a large data object
      effect: write
      questions:
      - What limits apply to part numbers and part sizes in a large data upload?
      - Can I send an MD5 checksum with each uploaded part?
      instructions:
      - text: Upload part {partNumber} of large data {dataId}.
        slots:
          partNumber: path.partNumber
          dataId: path.dataId
      - text: Send part {partNumber} for {dataId} with MD5 {md5}.
        slots:
          partNumber: path.partNumber
          dataId: path.dataId
          md5: query.md5
      method: generated
      generated: '2026-10-01'
- target: $.paths['/largedata/v4/{dataId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete or abort a large data upload
      effect: write
      questions:
      - How do I finish a multipart upload once every part is sent?
      - Can I pass an abort flag on the upload-completion call to cancel an unfinished large data upload?
      instructions:
      - text: Complete the upload of large data {dataId}.
        slots:
          dataId: path.dataId
      - text: Abort large data upload {dataId} by setting abort to {abort}.
        slots:
          dataId: path.dataId
          abort: query.abort
      method: generated
      generated: '2026-10-02'
- target: $.paths['/largedata/v4/{dataId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a large data object
      effect: destructive
      questions:
      - Can I delete an uploaded large data object?
      - What removes a large file I stored for a device?
      instructions:
      - text: Delete large data object {dataId}.
        slots:
          dataId: path.dataId
      - text: Remove the stored large data {dataId}.
        slots:
          dataId: path.dataId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/largedata/v4/{dataId}/data'].get
  update:
    x-apievangelist-phrasing:
      intent: Download bytes of a large data object
      effect: read
      questions:
      - How do I download a stored large data object?
      - Can I download just a byte range of a large file?
      instructions:
      - text: Download large data {dataId}.
        slots:
          dataId: path.dataId
      - text: Download {count} bytes of {dataId} starting at byte {offset}.
        slots:
          count: query.count
          dataId: path.dataId
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/largedata/v4/{dataId}/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metadata of a large data object
      effect: read
      questions:
      - What is the size and status of a large data object?
      - Can I read a large file's metadata without downloading it?
      instructions:
      - text: Get the metadata for large data {dataId}.
        slots:
          dataId: path.dataId
      - text: Show size and status details of large data object {dataId}.
        slots:
          dataId: path.dataId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/largedata/v4/{dataId}/parts'].get
  update:
    x-apievangelist-phrasing:
      intent: List uploaded parts of a large data object
      effect: read
      questions:
      - Which parts of my multipart upload have arrived so far?
      - Can I check uploaded parts before completing a large data upload?
      instructions:
      - text: List the uploaded parts of large data {dataId}.
        slots:
          dataId: path.dataId
      - text: Show up to {limit} uploaded parts for {dataId}.
        slots:
          limit: query.limit
          dataId: path.dataId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/largedata/v4/devices/{trackingId}/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: List a device's large data objects
      effect: read
      questions:
      - Which large data objects has a particular device uploaded?
      - Can I list metadata for all large files tied to one tracker?
      instructions:
      - text: List large data metadata for device {trackingId}.
        slots:
          trackingId: path.trackingId
      - text: Show all large files uploaded by tracker {trackingId}.
        slots:
          trackingId: path.trackingId
      method: generated
      generated: '2026-10-01'