SF API Topic and Action Enablement

general > no-nested-object-response

Guidance / Message

Nested objects are not allowed in responses

Examples

valid

get:
  x-sfdc:
    agent:
      action:
        publishAsAgentAction: true
  responses:
    "200":
      description: operation description
      content:
        application/json:
          schema:
            type: object
            properties:
              simple:
                type: string

invalid

get:
  x-sfdc:
    agent:
      action:
        publishAsAgentAction: true
  responses:
    "200":
      description: operation description
      content:
        application/json:
          schema:
            type: object
            properties:
              complex:
                type: object
                properties:
                  invalidNested:
                    type: string

Applies to Operation

Constraint

Type: Declarative Validation