Also · OpenAPI Overlay 1.0.0

API Evangelist enhancements for the ALSO Storefront JSON API

7 actions 7 updates update extends openapi/also-storefront-json-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-agentic-accessx-apievangelist-notex-apievangelist-providerx-apievangelist-enrichedx-apievangelist-contract-surfaces

Targets 7

$.info

$.paths['/products.json'].get

$.paths['/products/{handle}.json'].get

$.paths['/collections.json'].get

$.paths['/collections/{handle}/products.json'].get

$.paths['/cart.js'].get

$.paths['/search'].get

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for the ALSO Storefront JSON API
  version: 1.0.0
extends: openapi/also-storefront-json-openapi.yml
x-generated: '2026-08-02'
x-method: generated
actions:
- target: $.info
  update:
    x-apievangelist-provider: also
    x-apievangelist-enriched: '2026-08-02'
    x-apievangelist-contract-surfaces:
      graphql: graphql/also-storefront-2026-07.graphql
      mcp: mcp/also-mcp.yml
      crosswalk: mcp/also-tool-crosswalk.yml
    x-apievangelist-note: ALSO publishes no OpenAPI. This description was generated
      by API Evangelist from the endpoints ALSO advertises to agents in its own
      /agents.md, with every path probed live.
- target: $.paths['/products.json'].get
  update:
    x-agentic-access:
      action-class: connected
      consequence: read
      token: {ttl-max: 3600}
- target: $.paths['/products/{handle}.json'].get
  update:
    x-agentic-access:
      action-class: connected
      consequence: read
      token: {ttl-max: 3600}
- target: $.paths['/collections.json'].get
  update:
    x-agentic-access:
      action-class: connected
      consequence: read
      token: {ttl-max: 3600}
- target: $.paths['/collections/{handle}/products.json'].get
  update:
    x-agentic-access:
      action-class: connected
      consequence: read
      token: {ttl-max: 3600}
- target: $.paths['/cart.js'].get
  update:
    x-agentic-access:
      action-class: connected
      consequence: read
      token: {ttl-max: 900}
    x-apievangelist-note: Session-scoped; returns the cart bound to the caller's cookie.
- target: $.paths['/search'].get
  update:
    x-agentic-access:
      action-class: connected
      consequence: read
      token: {ttl-max: 3600}
    x-apievangelist-note: Returns HTML, not JSON. Prefer the GraphQL `search` or
      `predictiveSearch` query for machine consumption.