SF API Topic and Action Enablement

general > operation-parameters-must-have-descriptions

Guidance / Message

Uri parameters, query parameters and header parameters of API operations enabled as agent actions must have descriptions

Examples

valid

get:
  operationId: get-operation
  x-sfdc:
    agent:
      action:
        publishAsAgentAction: true
  parameters:
    - name: param1
      description: a param
      in: path
      schema:
        type: string

invalid

get:
  operationId: get-operation
  x-sfdc:
    agent:
      action:
        publishAsAgentAction: true
  parameters:
    - name: param1
      in: path
      schema:
        type: string

Applies to Operation

Constraint

Type: Declarative Validation