docs(spec): align the DNS-TXT discovery example with the implemented format#41
Merged
Conversation
…format §12.5 documented the record as `v=EEP1 did=<DID>` (space-separated, uppercase version, `did=` key), but the manifest schema (`discovery_hints.dns_txt_record`) and the reference parser (`@eep-dev/discovery` parseDnsTxtRecord) implement and test `v=eep1; manifest=<https-url>`. The spec's own example was therefore rejected by the reference parser. Rewrite §12.5 to use the implemented, tested format and note the DID is resolved from the manifest. Surfaced by the EEP protocol audit (finding dns-txt-three-incompatible-formats). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Ugur Cekmez <ucekmez@gmail.com>
There was a problem hiding this comment.
Pull request overview
Aligns the spec’s DNS TXT discovery example/description with the already-implemented discovery format used by the manifest schema and the @eep-dev/discovery reference parser, so the spec no longer documents a record value that would be rejected by the reference implementation.
Changes:
- Update §12.5 to describe DNS TXT discovery as pointing to the manifest URL at
_eep.<domain>. - Replace the example record value with the implemented format:
v=eep1; manifest=<https-url>, and document the HTTPS requirement plus DID resolution via the fetched manifest.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
§12.5 documented the
_eep.<domain>TXT record asv=EEP1 did=did:web:...(space-separated, uppercaseEEP1,did=key). But the manifest schema'sdiscovery_hints.dns_txt_recordpattern and the reference parser (@eep-dev/discoveryparseDnsTxtRecord, with tests) implementv=eep1; manifest=https://...(semicolon-separated, lowercase,manifest=key, HTTPS required). The spec's own example is rejected by the reference parser — three incompatible formats for one record.Fix
v=eep1; manifest=<https-url>.Docs-only; aligns the spec with the schema + reference parser. Surfaced by the EEP protocol audit (finding dns-txt-three-incompatible-formats). Touches a §12.5 region disjoint from #40 (§16.4), so the two merge cleanly.
🤖 Generated with Claude Code