Skip to content

docs(static-dedup): document custom-dedup-fields → schema enums; note k8s-proxy auth WIP#846

Merged
khareyash05 merged 3 commits intomainfrom
docs/static-dedup-trim-and-k8s-auth-note
Apr 30, 2026
Merged

docs(static-dedup): document custom-dedup-fields → schema enums; note k8s-proxy auth WIP#846
khareyash05 merged 3 commits intomainfrom
docs/static-dedup-trim-and-k8s-auth-note

Conversation

@khareyash05
Copy link
Copy Markdown
Member

@khareyash05 khareyash05 commented Apr 29, 2026

What has changed?

Three related updates to the Keploy Cloud / Enterprise docs:

  1. Static Deduplication — custom-dedup-fields → OpenAPI enum values (new section). Documents the dual role the custom-dedup-fields config now plays:

    • Sharpens the dedup signature (existing behaviour) so two requests with the same shape but different values for marked fields stay as distinct test cases.
    • New: during auto-replay schema generation, the distinct scalar values observed for each marked field are emitted as an enum array on the matching response (or request) property, so the values surface in the generated OpenAPI document and in the console's Schemas section. Includes the config example, a before/after schema snippet for GetProducts200Response, and the caveats: scalar leaves only, 50-distinct-value saturation cap (drop-rather-than-truncate), and object-response shape (top-level JSON arrays don't match response.X paths).
  2. Static Deduplication trim (already in this branch). Removes the prior, out-of-date Custom dedup fields and Observe dedup effectiveness (/dedup/stats) sections so the page reflects what's actually shipped today. The new section above replaces the removed custom-dedup-fields material with up-to-date content tied to the schema-enum behaviour.

  3. Kubernetes Proxy API — Authentication WIP notice (already in this branch). Adds an :::info In development admonition above the Authentication section of running-keploy/k8s-proxy-api.md so readers don't try to wire the shared-token flow into automation while it's still moving.

Type of change

  • New feature (non-breaking change which adds functionality) — documents the new schema-enum emission path for custom-dedup-fields.
  • Documentation update.

How Has This Been Tested?

  • Verified end-to-end against a self-hosted k8s-proxy + agent recording of a small Go service with three configured dedup fields (response.id, response.version, response.product_id).
  • Stop-recording → auto-replay → schema generation produced an OpenAPI document with enum arrays on the marked properties exactly as documented in the new section. Sample observed values: "product_id": { "enum": ["1","5","7","42","100","999","2024"], "type": "string" }.
  • Fetched the same schema through the api-server-compatible /k8s-proxy/get/schema endpoint and confirmed the enum arrays survive the read path that backs the console's Schemas page.
  • Local npm run build / npm run serve checks still recommended before merge.

Checklist

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.

khareyash05 and others added 2 commits April 29, 2026 14:57
Remove the custom dedup fields and observe-effectiveness sections from
the Static Deduplication guide, and add an in-development notice to the
Kubernetes Proxy Authentication section.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add a "Custom dedup fields → OpenAPI enum values" section to the
Static Deduplication guide explaining the dual role the
`custom-dedup-fields` config now plays: sharpening dedup signatures
and emitting observed scalar values as `enum` arrays in the
auto-generated OpenAPI schema (and therefore in the console's
Schemas section). Includes config example, before/after schema
diff, and the scalar-only / 50-value-saturation / object-response
caveats.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@khareyash05 khareyash05 changed the title docs: trim static dedup and note k8s-proxy auth in development docs(static-dedup): document custom-dedup-fields → schema enums; note k8s-proxy auth WIP Apr 30, 2026
Match the project style (no spaces around em-dashes) on the new
custom-dedup-fields section; also wrap the JSON primitive names in
backticks so Vale's spell-checker doesn't trip on `boolean`.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy link
Copy Markdown
Member

@officialasishkumar officialasishkumar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@khareyash05 khareyash05 merged commit 68eb9e1 into main Apr 30, 2026
7 checks passed
@khareyash05 khareyash05 deleted the docs/static-dedup-trim-and-k8s-auth-note branch April 30, 2026 10:50
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