Skip to content

docs(flagship): update API envelope docs and add A/B/n rollout pattern#59

Open
akshitsinha wants to merge 2 commits into
cloudflare:mainfrom
akshitsinha:asinha/flagship-abn-testing-docs
Open

docs(flagship): update API envelope docs and add A/B/n rollout pattern#59
akshitsinha wants to merge 2 commits into
cloudflare:mainfrom
akshitsinha:asinha/flagship-abn-testing-docs

Conversation

@akshitsinha

@akshitsinha akshitsinha commented Jun 4, 2026

Copy link
Copy Markdown
Member

Updates Flagship Cloudflare skill references for current control-plane behavior and adds guidance for multi-variant A/B/n experiments.

Changes:

  • Document current Cloudflare v4 response envelope for management endpoints:
    • payloads under result
    • pagination cursor under result_info.cursor
    • errors under errors[].message
  • Remove unsupported legacy response-field usage from examples.
  • Update REST examples to use jq '.result'.
  • Clarify management API response casing:
    • snake_case fields such as created_at, updated_at, updated_by, default_variation, serve_variation, and changelog flag_key
  • Clarify /evaluate response behavior:
    • not wrapped in management envelope
    • OpenFeature-style camelCase (flagKey, variant, reason)
  • Add response-shape examples for apps, flags, and changelog entries.
  • Add gotchas for envelope access and casing differences between management responses and evaluation responses.
  • Add A/B/n multi-variant testing pattern:
    • one rule per variant
    • cumulative rollout thresholds
    • example 30% / 40% / 30% split across variants A/B/C
    • guidance to use conditions: [] and set final threshold to 100

Validation:

  • Reviewed branch diff against origin/main.
  • Verified no unsupported .data, nextCursor, or single .error references remain in Flagship docs.

@akshitsinha akshitsinha marked this pull request as draft June 4, 2026 09:31
@akshitsinha akshitsinha changed the title feat(flagship): add A/B/n multi-variant testing pattern with cumulative rollout example docs(flagship): update API envelope docs and add A/B/n rollout pattern Jun 9, 2026
@akshitsinha akshitsinha marked this pull request as ready for review June 9, 2026 07:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants