SF API Topic and Action Enablement

general > no-additional-properties-response

Guidance / Message

Responses for API operations enabled as agent actions can not have additional properties

Examples

valid

openapi: "3.0.0"
info:
  title: example API
  version: "1.0.0"
  description: "This is the API description"
paths:
  /path:
    get:
      operationId: get-operation
      x-sfdc:
        agent:
          action:
            publishAsAgentAction: true
      responses:
        "200":
          description: operation description
          content:
            application/json:
              schema:
                type: object
                properties:
                  something:
                    type: string
                additionalProperties: false

invalid

openapi: "3.0.0"
info:
  title: example API
  version: "1.0.0"
  description: "This is the API description"
paths:
  /path:
    get:
      operationId: get-operation
      x-sfdc:
        agent:
          action:
            publishAsAgentAction: true
      responses:
        "200":
          description: operation description
          content:
            application/json:
              schema:
                type: object
                properties:
                  something:
                    type: string

Applies to Operation

Constraint

Type: Declarative Validation