Skip to content

Clarification on hoisting resource fields in batch requests #1591

@farkasferi

Description

@farkasferi

Hello AIP Governance Team,

I am looking for clarification on the current AIP guidance regarding hoisting resource-level fields into batch request messages.

Specifically, in the context of a BatchCreate (or similar batch) endpoint, what is the recommended stance on promoting a field that conceptually belongs to the resource into the request message itself?

For example, consider a BatchCreateOrders method intended to create or load all orders for a given date. The date is naturally a field on the Order resource. If the batch request operates on a single date, would hoisting this date field to the batch request be considered an antipattern under AIP, assuming the must-match rule is strictly enforced between the request field and the corresponding field on each resource?

I am trying to understand whether AIP-233 prefers:

keeping such fields exclusively on the resource, even if redundant across all entries in the batch, or

allowing request-level hoisting when it improves clarity and avoids repetition, provided consistency is guaranteed.

Any guidance would be greatly appreciated.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions