# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Salesforce Describe API
  version: 1.0.0
extends: openapi/salesforce-describe-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: 11
- target: $.paths['/data/v64.0/tooling/sobjects/EventRelayConfig/describe'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe the EventRelayConfig object
      effect: read
      questions:
      - What fields does an event relay configuration have?
      - Can I describe EventRelayConfig through the Tooling API before creating a relay?
      instructions:
      - text: Describe the EventRelayConfig Tooling object.
      - text: List the fields available when configuring an event relay.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/sobjects/EventRelayFeedback/describe'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe the EventRelayFeedback object
      effect: read
      questions:
      - Which fields report an event relay's status and errors?
      - Can I see the shape of EventRelayFeedback records?
      instructions:
      - text: Describe the EventRelayFeedback object.
      - text: Show the fields that event relay feedback records carry.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/sobjects/ManagedEventSubscription/describe'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe the ManagedEventSubscription object
      effect: read
      questions:
      - What fields make up a managed event subscription?
      - Can I describe ManagedEventSubscription before subscribing to platform events?
      instructions:
      - text: Describe the ManagedEventSubscription Tooling object.
      - text: List the fields needed to define a managed event subscription.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/sobjects'].get
  update:
    x-apievangelist-phrasing:
      intent: List every object in the org
      effect: read
      questions:
      - Which standard and custom objects exist in my Salesforce org?
      - What is the maximum batch size my org allows in queries?
      instructions:
      - text: List all objects available in my org with their metadata.
      - text: Show the org encoding and every sObject I can access.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/sobjects/{SOBJECT_API_NAME}/describe'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe an object's fields in full
      effect: read
      questions:
      - What are all the fields, picklist values and relationships on Opportunity?
      - Can I get the complete field-level describe for a custom object?
      instructions:
      - text: Describe the {object} object in full.
        slots:
          object: path.SOBJECT_API_NAME
      - text: List every field with its type and picklist values on {object}.
        slots:
          object: path.SOBJECT_API_NAME
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/sobjects/Global/describe/layouts'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe global publisher layouts
      effect: read
      questions:
      - What global quick-action layouts are defined in my org?
      - Can I list the global layouts and their fields?
      instructions:
      - text: Describe the global layouts in my org.
      - text: Show the fields on each global publisher layout.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/sobjects/{SOBJECT_API_NAME}/describe/layouts'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe all layouts for an object
      effect: read
      questions:
      - Which page layouts are assigned for the Lead object?
      - Can I list every layout of an object with its fields?
      instructions:
      - text: Describe the layouts for {object}.
        slots:
          object: path.SOBJECT_API_NAME
      - text: List each page layout name and its fields on {object}.
        slots:
          object: path.SOBJECT_API_NAME
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/sobjects/{SOBJECT_API_NAME}/describe/layouts/{RECORD_TYPE_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe an object's layout for one record type
      effect: read
      questions:
      - What layout does a specific record type of Case use?
      - Can I describe the page layout tied to one record type ID?
      instructions:
      - text: Describe the {object} layout for record type {record_type}.
        slots:
          object: path.SOBJECT_API_NAME
          record_type: path.RECORD_TYPE_ID
      - text: Show the fields on the layout record type {record_type} uses for {object}.
        slots:
          record_type: path.RECORD_TYPE_ID
          object: path.SOBJECT_API_NAME
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/sobjects/{SOBJECT_API_NAME}/listviews/{QUERY_LOCATOR}/describe'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe a list view's columns and SOQL
      effect: read
      questions:
      - What SOQL query sits behind a list view?
      - Can I see a list view's ID and columns from the sObject describe resource?
      instructions:
      - text: Describe list view {list_view} on {object} including its SOQL.
        slots:
          list_view: path.QUERY_LOCATOR
          object: path.SOBJECT_API_NAME
      - text: Show the columns and underlying query of the {object} list view {list_view}.
        slots:
          object: path.SOBJECT_API_NAME
          list_view: path.QUERY_LOCATOR
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/sobjects'].get
  update:
    x-apievangelist-phrasing:
      intent: List all Tooling API objects
      effect: read
      questions:
      - Which objects does the Tooling API expose?
      - Can I get a global describe of Tooling API metadata types?
      instructions:
      - text: List every Tooling API object and its metadata.
      - text: Run a Tooling API global describe.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/sobjects/{SOBJECT_API_NAME}/describe'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe a Tooling API object's fields
      effect: read
      questions:
      - What fields does the ApexClass Tooling object have?
      - Can I get a full describe of a Tooling API sObject?
      instructions:
      - text: Describe the Tooling API object {object}.
        slots:
          object: path.SOBJECT_API_NAME
      - text: List all fields on Tooling object {object}.
        slots:
          object: path.SOBJECT_API_NAME
      method: generated
      generated: '2026-09-26'