Sendcloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Parcel Documents API

3 actions 3 updates phrasing extends openapi/sendcloud-parcel-documents-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Sendcloud's API. It is a proposal applied on top of the contract, not a document Sendcloud publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/parcels/{id}/documents/{type}'].get
$.paths['/parcel-documents/{type}'].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 Parcel Documents API
  version: 1.0.0
extends: openapi/sendcloud-parcel-documents-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/parcels/{id}/documents/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a parcel document
      effect: read
      questions:
      - How do I download a specific document, like a label, for one parcel?
      - Can I choose the resolution and paper size of a parcel document?
      instructions:
      - text: Download the {type} document for parcel {id}.
        slots:
          id: path.id
          type: path.type
      - text: Get parcel {id}'s {type} document at {dpi} dpi.
        slots:
          id: path.id
          type: path.type
          dpi: query.dpi
      method: generated
      generated: '2026-10-01'
- target: $.paths['/parcel-documents/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a document type for many parcels
      effect: read
      questions:
      - Can I download the same document type for several parcels together?
      - What paper sizes can I use for bulk parcel documents?
      instructions:
      - text: Download {type} documents for parcels {parcels}.
        slots:
          type: path.type
          parcels: query.parcels
      - text: Get {type} documents for parcels {parcels} on {paper_size} paper.
        slots:
          type: path.type
          parcels: query.parcels
          paper_size: query.paper_size
      method: generated
      generated: '2026-10-01'