fix: add localBiblio fallback for SpecRef-resolved references - #273
Closed
ssteinbuss wants to merge 1 commit into
Closed
fix: add localBiblio fallback for SpecRef-resolved references#273ssteinbuss wants to merge 1 commit into
ssteinbuss wants to merge 1 commit into
Conversation
api.specref.org's DNS is broken (CNAME to a dead Heroku subdomain), which makes ReSpec unable to resolve json-schema, RFC2119, RFC8174, rfc3987, rfc8615, did-core, vocab-dcat-3, and odrl-model at build/view time. Pin their bibliographic data locally so the document renders correctly regardless of that external service's availability. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
Author
|
Services returned to normal operation. This fix is not needed. |
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
1 participant
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.
Status
Standby fix — not merging yet. api.specref.org's DNS is currently broken
(confirmed: even the last published release, 2025-1-err1, shows the same
"Reference not found" errors for every SpecRef-resolved reference). We're
waiting to see if the service recovers on its own before deciding whether
to merge this. Keeping it ready as a draft in case it doesn't.
What this PR changes/adds
Adds
localBiblioentries for the 8 references that were resolving throughSpecRef:
json-schema,RFC2119,RFC8174,rfc3987,rfc8615,did-core,vocab-dcat-3,odrl-model.Why it does that
api.specref.org's DNS points to a Heroku subdomain(
api.specref.org.herokudns.com) that doesn't resolve any further — a deadbackend, not a transient blip. This makes the whole document independent of
that external service's availability, regardless of whether/when it comes
back.
Note:
RFC2119andRFC8174aren't cited anywhere in our markdown —ReSpec auto-injects them into the Conformance section for any document
using RFC 2119 keywords (MUST/SHOULD/MAY), which this spec does throughout.
Verification
Bibliographic data pulled from each spec's own canonical page (W3C TR pages,
RFC Editor, json-schema.org), not from the (currently unreachable) SpecRef
API. Verified the
respecConfigobject still parses as valid JS with all 11localBibliokeys present.