Skip to content
This repository was archived by the owner on May 26, 2026. It is now read-only.

KR-P2-CLASS-C-DOC: document Class C wire-format-stable identifier convention#99

Merged
rafe-walker merged 1 commit into
mainfrom
feat/kora-KR-P2-CLASS-C-DOC
May 22, 2026
Merged

KR-P2-CLASS-C-DOC: document Class C wire-format-stable identifier convention#99
rafe-walker merged 1 commit into
mainfrom
feat/kora-KR-P2-CLASS-C-DOC

Conversation

@rafe-walker

Copy link
Copy Markdown
Owner

Summary

Closes the open documentation thread from KR-P2-B/B2 — the K-DG
taxonomy decided in CC#3's KR-P2-B2 STOP-ASK (commit `64eaaae`)
never got formal documentation. This is the in-code half.

Extends `gateway/platforms/api_server.py` module docstring with:

  • What Class C is — stable HTTP / wire-format identifiers
  • The 3 Class C identifiers in this file — `X-Hermes-Session-Id`,
    `X-Hermes-Session-Key`, `hermes-agent` (with file:line refs)
  • Default rule for new identifiers — Kora-prefixed unless
    external compatibility genuinely requires Hermes-prefixed
  • Cross-reference to the canonical taxonomy doc in kora-docs

Companion PR

Parallel PR in rafe-walker/kora-docs adds
`kora_docs/00_canonical_current_state/identity_literal_taxonomy.md` —
the full taxonomy reference + cross-class examples + lineage
(KR-P2-B → B2 → this doc → pending B3).

Test plan

  • Docstring lint passes (ruff clean)
  • No code changes — documentation only

🤖 Generated with Claude Code

…er convention

Extends the module docstring of `gateway/platforms/api_server.py`
with an in-place explanation of the K-DG identity-literal taxonomy
Class C convention.

Class C identifiers (preserved permanently):
  - X-Hermes-Session-Id request header
  - X-Hermes-Session-Key request header
  - hermes-agent user-agent / platform string

Renaming any of these breaks external HTTP consumers that have
integrated against them (OpenAI-compat frontends + monitoring
tools that index on the platform string).

Documents the "default to Kora-prefixed for new identifiers"
guidance — Class C is a small closed set; every addition is a
permanent contract.

Cross-references the full taxonomy doc at
`kora_docs/00_canonical_current_state/identity_literal_taxonomy.md`
(parallel PR in rafe-walker/kora-docs).

Cites CC#3 commit 64eaaae where the 3-class taxonomy was first
articulated.

No code changes — docstring-only.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@rafe-walker rafe-walker merged commit 336765f into main May 22, 2026
@rafe-walker rafe-walker deleted the feat/kora-KR-P2-CLASS-C-DOC branch May 22, 2026 03:26
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant