HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for v2 Publish API

6 actions 6 updates phrasing extends openapi/here-publish-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['/publications'].post

$.paths['/publications/{publicationId}'].get

$.paths['/publications/{publicationId}'].put

$.paths['/publications/{publicationId}'].delete

$.paths['/layers/{layerId}/publications/{publicationId}/partitions'].post

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 v2 Publish API
  version: 1.0.0
extends: openapi/here-publish-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['/publications'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a new publication to catalog layers
      effect: write
      questions:
      - How do I begin publishing new data to layers in my HERE catalog?
      - Can one publication cover layers of different types?
      instructions:
      - text: Initialize a publication for layers {layerIds}.
        slots:
          layerIds: requestBody.layerIds
      - text: Start a publication for layers {layerIds} based on catalog version {catalogVersion}.
        slots:
          layerIds: requestBody.layerIds
          catalogVersion: requestBody.catalogVersion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the state of a publication
      effect: read
      questions:
      - Did my publication succeed, fail or expire?
      - What states can a catalog publication be in?
      instructions:
      - text: Get publication {publicationId}.
        slots:
          publicationId: path.publicationId
      - text: Check whether publication {publicationId} has succeeded.
        slots:
          publicationId: path.publicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Submit a publication for processing
      effect: write
      questions:
      - How do I finalize a publication once all partitions are uploaded?
      - What state does a publication move to right after I submit it?
      instructions:
      - text: Submit publication {publicationId}.
        slots:
          publicationId: path.publicationId
      - text: Finalize and commit publication {publicationId} so it gets processed.
        slots:
          publicationId: path.publicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel an unsubmitted publication
      effect: destructive
      questions:
      - Can I abandon a publication I haven't submitted yet?
      - Is it possible to cancel a publication after it has been submitted?
      instructions:
      - text: Cancel publication {publicationId}.
        slots:
          publicationId: path.publicationId
      - text: Abandon the unsubmitted publication {publicationId}.
        slots:
          publicationId: path.publicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/layers/{layerId}/publications/{publicationId}/partitions'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload partition metadata into a publication
      effect: write
      questions:
      - How do I add partitions to a layer as part of an open publication?
      - How many partitions should I batch per upload request?
      instructions:
      - text: Upload partitions {partitions} to layer {layerId} in publication {publicationId}.
        slots:
          partitions: requestBody.partitions
          layerId: path.layerId
          publicationId: path.publicationId
      - text: 'Add this batch of partitions to layer {layerId} under publication {publicationId}: {partitions}.'
        slots:
          layerId: path.layerId
          publicationId: path.publicationId
          partitions: requestBody.partitions
      method: generated
      generated: '2026-09-26'