GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 Meta Fields API

6 actions 6 updates phrasing extends openapi/getresponse-meta-fields-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/shops/{shopId}/meta-fields'].get

$.paths['/shops/{shopId}/meta-fields'].post

$.paths['/shops/{shopId}/meta-fields/{metaFieldId}'].get

$.paths['/shops/{shopId}/meta-fields/{metaFieldId}'].post

$.paths['/shops/{shopId}/meta-fields/{metaFieldId}'].delete

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 GetResponse APIv3 Meta Fields API
  version: 1.0.0
extends: openapi/getresponse-meta-fields-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: 5
- target: $.paths['/shops/{shopId}/meta-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List a shop's meta fields
      effect: read
      questions:
      - What meta fields are defined for my shop?
      - Can I filter shop meta fields by name or value?
      instructions:
      - text: List meta fields in shop {shop}.
        slots:
          shop: path.shopId
      - text: Find meta fields named {name} in shop {shop}.
        slots:
          name: query.query[name]
          shop: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/meta-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shop meta field
      effect: write
      questions:
      - How do I add a custom meta field to my shop?
      - What value types can a shop meta field hold?
      instructions:
      - text: Create meta field {name} with value {value} in shop {shop}.
        slots:
          name: requestBody.name
          value: requestBody.value
          shop: path.shopId
      - text: Add a meta field {name} of type {valueType} to shop {shop}.
        slots:
          name: requestBody.name
          valueType: requestBody.valueType
          shop: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/meta-fields/{metaFieldId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shop meta field
      effect: read
      questions:
      - Can I look up one meta field by ID in my shop?
      - What value is stored on a specific shop meta field?
      instructions:
      - text: Get meta field {metaField} in shop {shop}.
        slots:
          metaField: path.metaFieldId
          shop: path.shopId
      - text: Show meta field {metaField} of shop {shop}.
        slots:
          metaField: path.metaFieldId
          shop: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/meta-fields/{metaFieldId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a shop meta field
      effect: write
      questions:
      - Can I change the value of an existing shop meta field?
      - Do meta field properties I omit stay unchanged?
      instructions:
      - text: Update meta field {metaField} in shop {shop}.
        slots:
          metaField: path.metaFieldId
          shop: path.shopId
      - text: Change the value of meta field {metaField} for shop {shop}.
        slots:
          metaField: path.metaFieldId
          shop: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/meta-fields/{metaFieldId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shop meta field
      effect: destructive
      questions:
      - How do I remove a meta field from my shop?
      - Is deleting a shop meta field permanent?
      instructions:
      - text: Delete meta field {metaField} from shop {shop}.
        slots:
          metaField: path.metaFieldId
          shop: path.shopId
      - text: Remove shop {shop}'s meta field {metaField}.
        slots:
          metaField: path.metaFieldId
          shop: path.shopId
      method: generated
      generated: '2026-09-26'