Skip to content

Playbooks

Playbooks are standard operating procedures (SOPs) for PMC. Use calls.md for payload shape and required fields.

Surface availability (explicit)

  • API Gateway: Available.
  • Direct Lambda: Not offered.
  • CLI: Available (g3n pmc ..., API Gateway).
  • MCP: Available.

Playbook: Publish run (client-driven)

Goal: Publish PVM variants into PMC product revisions and set the online revision.

Why this sequence:

  • PMC publish is client-driven; the caller must step the run.
  • Online revision is explicitly set or cleared per product identity.

Preconditions

  • PVM variants are active and publishable for the target channel.
  • A valid session/API key with pmc_publish role.

SOP (happy path)

  1. Confirm publish profile (GET /publish-profile/get or POST /publish-profile/set).
    • Reason: ensures required attributes/coverage are enforced consistently.
  2. Create content pack (POST /pack/create).
    • Reason: packages content for the publish run (inline or presigned).
  3. Complete pack upload (POST /pack/complete) if presigned.
    • Reason: finalizes pack storage and readiness.
  4. Start publish run (POST /publish/run/start).
    • Reason: defines the selector and creates the run record.
  5. Step the run (POST /publish/run/step) until complete.
    • Reason: publish is client-driven and paged.
  6. Fetch run status (GET /publish/run/get) and manifest parts (GET /publish/run/manifest/list + /manifest/presign).
    • Reason: inspect what was published and retrieve outputs.
  7. Set online revision (POST /product/online/set) for target products.
    • Reason: explicitly makes a revision live.
  8. Verify (GET /product/get, /product/list, /product/search).
    • Reason: confirm visibility and online state.

Outputs

  • Publish run with completed manifest parts.
  • Online revisions set for the target product identities.

Failure modes / remediation

  • conflict / expected-revision-required: re-read the record and retry with current revision.
  • Ineligible variants: review publish profile and upstream PVM status.

Cross-service relationships

  • PVM: source of variant data and publishability status.
  • OFM: sales channel context (channel_code/logical).