Vendasta · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Platform REST Product Custom Fields API

4 actions 4 updates phrasing extends openapi/vendasta-product-custom-fields-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Vendasta's API. It is a proposal applied on top of the contract, not a document Vendasta publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/productCustomFields/{id}'].get
$.paths['/productCustomFields/{id}'].patch
$.paths['/productCustomFields/{id}'].options

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 Platform REST Product Custom Fields API
  version: 1.0.0
extends: openapi/vendasta-product-custom-fields-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: 3
- target: $.paths['/productCustomFields/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product's custom fields
      effect: read
      questions:
      - Can I read the custom fields attached to a product?
      - Where are product custom field values configured?
      instructions:
      - text: Get custom fields for product {id}.
        slots:
          id: path.id
      - text: Show the custom field values set on product {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/productCustomFields/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a product's custom fields
      effect: write
      questions:
      - How do I change custom field values on a product?
      - Can I attach extra information to a product through custom fields?
      instructions:
      - text: Update product {id}'s custom fields with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Set custom field values {data} on product {id}.
        slots:
          data: requestBody.data
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/productCustomFields/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods on product custom fields
      effect: read
      questions:
      - Which HTTP verbs are allowed on a product's custom fields endpoint?
      - What does a CORS preflight on product custom fields return?
      instructions:
      - text: Run a CORS preflight against product custom fields {id}.
        slots:
          id: path.id
      - text: Show allowed methods for product {id}'s custom fields endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/vendasta-product-custom-fields-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.