contracts

Plan Contract

Plan an import: parse YAML + diff against current asset state.

Does not mutate anything. The request body is raw YAML (same content-type flexibility as /validate). Returns per-domain DomainDiff objects plus a count summary.

post/api/v1/contracts/{asset_public_id}/plan

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/api/v1/contracts/{asset_public_id}/plan
  • Auth: none declared

Path parameters

asset_public_idstring uuid required

Query parameters

mode'extended' | 'odcs-pure'

Portability mode for exports.

Values match the CLI --mode flag and the REST mode query parameter exactly, so string round-trips via FastAPI's query parser work without custom coercion.

Portability mode. Matches the mode the existing state is compared against. Default extended preserves AA-specific fields; odcs-pure compares only ODCS-native config.

includestring nullable

Comma-separated domains to include in the diff.

excludestring nullable

Comma-separated domains to exclude.

Headers

Authorizationstring

Response

Successful Response

successboolean required
dataunknown
messagestring nullable
errorstring nullable
metaobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.