Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canonical Snap Store Device Search API

2 actions 2 updates phrasing extends openapi/canonical-search-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/api/v1/search'].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 Canonical Snap Store Device Search API
  version: 1.0.0
extends: openapi/canonical-search-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: 1
- target: $.paths['/api/v1/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search the store (legacy v1)
      effect: read
      questions:
      - Can I still search the Snap Store through the old v1 search endpoint?
      - Which device series header does the legacy search require?
      instructions:
      - text: Search the legacy v1 store for {q} on series {series}.
        slots:
          q: query.q
          series: header.Snap-Device-Series
      - text: Run a legacy v1 search for {q} in section {section} for device series {series}.
        slots:
          q: query.q
          section: query.section
          series: header.Snap-Device-Series
      method: generated
      generated: '2026-10-01'