The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Application Server Application Up Storage API

5 actions 5 updates phrasing extends openapi/the-things-network-applicationupstorage-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for The Things Network / The Things Stack's API. It is a proposal applied on top of the contract, not a document The Things Network / The Things Stack publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/as/applications/{application_ids.application_id}/packages/storage/{type}'].get

$.paths['/as/applications/{application_ids.application_id}/packages/storage/{type}/count'].get

$.paths['/as/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}/packages/storage/{type}'].get

$.paths['/as/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}/packages/storage/{type}/count'].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 Things Stack — Application Server Application Up Storage API
  version: 1.0.0
extends: openapi/the-things-network-applicationupstorage-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: 4
- target: $.paths['/as/applications/{application_ids.application_id}/packages/storage/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read stored messages for an application
      effect: read
      questions:
      - How do I pull historical uplinks stored for my whole application?
      - Can I fetch stored messages from the last few hours only?
      - Which stored messages came in on a particular FPort across all devices?
      instructions:
      - text: Get stored {type} messages for application {application_id}.
        slots:
          type: path.type
          application_id: path.application_ids.application_id
      - text: Fetch stored {type} messages for {application_id} from the last {last}.
        slots:
          type: path.type
          application_id: path.application_ids.application_id
          last: query.last
      - text: Get application {application_id}'s stored {type} messages on FPort {f_port} after {after}.
        slots:
          application_id: path.application_ids.application_id
          type: path.type
          f_port: query.f_port
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/as/applications/{application_ids.application_id}/packages/storage/{type}/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count stored messages for an application
      effect: read
      questions:
      - How many messages has storage kept for my application?
      - Can I count stored messages within a time window?
      instructions:
      - text: Count stored {type} messages for application {application_id}.
        slots:
          type: path.type
          application_id: path.application_ids.application_id
      - text: Count {application_id}'s stored {type} messages before {before}.
        slots:
          application_id: path.application_ids.application_id
          type: path.type
          before: query.before
      method: generated
      generated: '2026-09-26'
- target: $.paths['/as/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}/packages/storage/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read stored messages for one device
      effect: read
      questions:
      - How do I get the stored uplink history for a single end device?
      - Can I limit how many stored device messages come back?
      instructions:
      - text: Get stored {type} messages for device {device_id} in application {application_id}.
        slots:
          type: path.type
          device_id: path.end_device_ids.device_id
          application_id: path.end_device_ids.application_ids.application_id
      - text: Fetch the latest {limit} stored {type} messages from device {device_id} in {application_id}.
        slots:
          limit: query.limit
          type: path.type
          device_id: path.end_device_ids.device_id
          application_id: path.end_device_ids.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/as/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}/packages/storage/{type}/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count stored messages for one device
      effect: read
      questions:
      - How many messages have been stored for one of my devices?
      - Can I count a device's stored messages over the last day?
      instructions:
      - text: Count stored {type} messages for device {device_id} in application {application_id}.
        slots:
          type: path.type
          device_id: path.end_device_ids.device_id
          application_id: path.end_device_ids.application_ids.application_id
      - text: Count device {device_id}'s stored {type} messages in {application_id} over the last {last}.
        slots:
          device_id: path.end_device_ids.device_id
          type: path.type
          application_id: path.end_device_ids.application_ids.application_id
          last: query.last
      method: generated
      generated: '2026-09-26'