Contentstack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contentstack Content Delivery Global Fields API

3 actions 3 updates phrasing extends openapi/contentstack-global-fields-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/global_fields'].get

$.paths['/global_fields/{global_field_uid}'].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 Contentstack Content Delivery Global Fields API
  version: 1.0.0
extends: openapi/contentstack-global-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: 2
- target: $.paths['/global_fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List reusable global fields
      effect: read
      questions:
      - What global fields are available to reuse in my content types?
      - How do I see all shared field groups defined in a stack?
      instructions:
      - text: List the global fields in stack {api_key}.
        slots:
          api_key: header.api_key
      - text: Show every reusable global field definition in stack {api_key}.
        slots:
          api_key: header.api_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/global_fields/{global_field_uid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a global field's schema
      effect: read
      questions:
      - How do I view the schema of one global field?
      - What sub-fields does a particular global field contain?
      instructions:
      - text: Get global field {field}.
        slots:
          field: path.global_field_uid
      - text: Show the schema and metadata of global field {field} in stack {api_key}.
        slots:
          field: path.global_field_uid
          api_key: header.api_key
      method: generated
      generated: '2026-09-26'