Retire brand kit

Outcome

Retire a Brand kit so new resolution no longer selects it.

Before you start

• Verify whoami and the pinned credential context, then inspect the exact discovered action before preparing input.
• Discover a granted Brand workspace. Pass its resourceType/workspace identifier separately from input; a copied fixture identifier grants no access.
• The declared permission is brand:write. The active credential, application scope, resource binding and runtime authority must all authorize the request.
• Review the exact mutation and recovery, including destructive scope, and execute only after the intended effect is authorized.

Discover the target

topolo whoami --json
topolo actions get app_topolo_brand.brand_kits.retire --detail --json
topolo resources topolo-brand --json
topolo workspaces list topolo-brand --json

Request

POST /api/brand-kits/{id}/retire

Resource context is the selected Brand workspace. CLI/SDK action input includes path identifiers; direct HTTP JSON bodies exclude path parameters. Read the reviewed plan for the exact request.

Input fields

Exact published input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "Exact kit or binding identifier from the corresponding list action; its meaning is determined by this action."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Effects

Sets kit status to retired and records a lifecycle audit; stored versions and asset records remain.

Interpret the response

retired:true confirms the kit transition. Consumers retaining an earlier exact version are separate from new resolution. This action set has no kit-reactivation endpoint.

Response identifier contract:

{
  "kind": "brand_kits_retire",
  "identifierSource": "none",
  "explanation": "retired:true confirms the kit transition. Consumers retaining an earlier exact version are separate from new resolution. This action set has no kit-reactivation endpoint."
}

Worked examples

These complete synthetic responses were captured from the local worker over canonical SQL migrations. Auth and R2 dependencies are simulated; notification delivery is not exercised. Set BRAND_WORKSPACE_ID from granted workspace discovery. Save reviewed input as payload.json, validate and inspect the unchanged plan. The final mutation command and MCP confirm flag assume the intended effect has already been authorized.

Minimal example

Input · payload.json:

{
  "id": "brand_c794be50-0306-4933-8de8-5609340bed9e"
}

CLI:

topolo actions validate app_topolo_brand.brand_kits.retire --data @payload.json --json
topolo actions plan app_topolo_brand.brand_kits.retire --resource-type workspace --resource-id "$BRAND_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_brand.brand_kits.retire --resource-type workspace --resource-id "$BRAND_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_brand.brand_kits.retire",
    "input": {
      "id": "brand_c794be50-0306-4933-8de8-5609340bed9e"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "retired": true
}

retired:true confirms the kit transition. Consumers retaining an earlier exact version are separate from new resolution. This action set has no kit-reactivation endpoint.

Workflow example

Input · payload.json:

{
  "id": "brand_55886012-13a4-4e95-ad31-3fe2b52cdf20"
}

CLI:

topolo actions validate app_topolo_brand.brand_kits.retire --data @payload.json --json
topolo actions plan app_topolo_brand.brand_kits.retire --resource-type workspace --resource-id "$BRAND_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_brand.brand_kits.retire --resource-type workspace --resource-id "$BRAND_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_brand.brand_kits.retire",
    "input": {
      "id": "brand_55886012-13a4-4e95-ad31-3fe2b52cdf20"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "retired": true
}

retired:true confirms the kit transition. Consumers retaining an earlier exact version are separate from new resolution. This action set has no kit-reactivation endpoint.

Verify the result

Read the kit and require status:retired; test the intended exact/contextual resolution separately, which may choose another eligible binding.

Errors and recovery

refused · HTTP 404

{
  "input": {
    "id": "missing-fixture"
  },
  "response": {
    "error": "brand_kit_not_found"
  }
}

• auth_error (HTTP 401): CLI/SDK authentication classification when Auth returns a non-code message: restore the authorized credential, then verify whoami and context. Preserve the exact service message.

• permission_denied (HTTP 403): Use the exact permission and granted resource required by the reviewed action; organization membership alone is insufficient.

• workspace_required (HTTP 400): Discover and select a granted Brand workspace before preparing the request.

• brand_storage_unavailable (HTTP 503): The Brand storage bindings are unavailable. Preserve the request identifier and report the service fault; do not retry an unverified mutation.

• brand_kit_not_found (HTTP 404): Discover the exact parent/resource again and inspect its lifecycle status. Missing, inaccessible or immutable resources can share this refusal.

Recovery boundary

Brand exposes no kit-reactivation action. Preserve historical versions and separately review any new active kit and consumer binding changes.

Related actions

• app_topolo_brand.brand_kits.get: Read one Brand kit and the presentation of its current published version.
• app_topolo_brand.brand_kits.resolve_context: Resolve the first eligible brand for a consumer context.

Evidence

Four real local SQLite stores use all canonical migrations; Auth identity/grants and archival plus R2 object storage are explicitly simulated. Notifications are disabled in fixtures. No notification delivery, live mutation, gateway credential parity or deployed environment proof is claimed. Fixture identifiers and timestamps are synthetic and must be replaced by exact authorized resource discovery.