Skip to content

README omits operation-tracing from the default_pipeline policy list #48

Description

@OmarAlJarrah

Problem

The README's "A configured pipeline" section lists the canonical policy stack returned by default_pipeline() as "(redirect, idempotency, retry, set-date, client-identity, logging, tracing)". That inventory omits operation-tracing, which default_pipeline unconditionally appends as the outermost policy. Operation-tracing is treated as part of the canonical stack everywhere else — CLAUDE.md, docs/pipelines.md, and the README's own architecture diagram, which shows an OPERATION pillar — so the quick-start parenthetical is the one place it goes missing.

Where

README.md:88-91:

`default_pipeline()` returns a `StagedPipelineBuilder` pre-wired with the
canonical policy stack (redirect, idempotency, retry, set-date,
client-identity, logging, tracing).

packages/dexpace-sdk-core/src/dexpace/sdk/core/pipeline/defaults.py:82-94:

builder = StagedPipelineBuilder(client)
# Sorts to Stage.OPERATION (outermost) ...
builder.append(OperationTracingPolicy())
builder.append(redirect or RedirectPolicy())
...

Impact

Documentation accuracy only. A reader counting the policies in a default pipeline (or wondering where the per-operation tracer lifecycle comes from) sees an inventory that is one policy short of what the code wires.

Suggested fix

Add operation-tracing to the parenthetical so it matches default_pipeline's actual output and the rest of the docs, e.g. "(operation-tracing, redirect, idempotency, retry, set-date, client-identity, logging, tracing)".

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions