SF API Topic and Action Enablement

general > operation-request-must-have-description

Guidance / Message

Request body for API operations enabled as agent actions must have descriptions

Examples

valid

get:
  operationId: get-operation
  x-sfdc:
    agent:
      action:
        publishAsAgentAction: true
  requestBody:
    description: this is a description
    content:
      application/json:
        schema:
          type: string

invalid

get:
  operationId: get-operation
  x-sfdc:
    agent:
      action:
        publishAsAgentAction: true
  requestBody:
    content:
      application/json:
        schema:
          type: string

Applies to Operation

Constraint

Type: Declarative Validation