Matomo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Matomo Reporting API for plugin Marketplace API

3 actions 3 updates phrasing extends openapi/matomo-marketplace-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/index.php?module=API&method=Marketplace.deleteLicenseKey'].get

$.paths['/index.php?module=API&method=Marketplace.saveLicenseKey'].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 Matomo Reporting API for plugin Marketplace API
  version: 1.0.0
extends: openapi/matomo-marketplace-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['/index.php?module=API&method=Marketplace.deleteLicenseKey'].get
  update:
    x-apievangelist-phrasing:
      intent: Remove the Marketplace license key
      effect: destructive
      questions:
      - Is it possible to remove the license key from this installation?
      - Can I unset my premium plugins license key?
      instructions:
      - text: Delete the stored Marketplace license key.
      - text: Remove the license key from this instance.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Marketplace.saveLicenseKey'].get
  update:
    x-apievangelist-phrasing:
      intent: Save a Marketplace license key
      effect: write
      questions:
      - How do I activate premium plugins with my Matomo Marketplace license key?
      - Will an expired license key be accepted when I save it?
      instructions:
      - text: Save license key {licenseKey}.
        slots:
          licenseKey: query.licenseKey
      - text: Validate and store Marketplace license {licenseKey}.
        slots:
          licenseKey: query.licenseKey
      method: generated
      generated: '2026-10-01'