Skip to content

feat: format+has_errata, drop see_also for red API#10392

Merged
jennifer-richards merged 6 commits intoietf-tools:mainfrom
jennifer-richards:red-formats
Feb 11, 2026
Merged

feat: format+has_errata, drop see_also for red API#10392
jennifer-richards merged 6 commits intoietf-tools:mainfrom
jennifer-richards:red-formats

Conversation

@jennifer-richards
Copy link
Member

This pull request cleans up the red RFC list API. Specifically

  • replaces the fake (always empty) errata list with a boolean has_errata flag that is true when the RFC document has the verified-errata tag in datatracker
  • replaces the fake (always ["txt", "xml"]) formats list with a structured list of available formats and the name of the blob for each format.
  • eliminates the see_also field

The formats section of the response is derived from the StoredObject table. It lists all available formats the datatracker has, including json and notprepped. If some of these shouldn't be included in red's output, that decision belongs to red and it should filter them there. It now includes the name of the blob so that red does not have to hard-code the naming convention that datatracker uses.

The see_also field will not be used. Subseries memberships are conveyed through the subseries value already.

Red should link to the correct errata site page for a URL when has_errata is true.

For reference, this is the formats section of the updated API for an example RFC:

      "formats": [
        {
          "fmt": "xml",
          "name": "xml/rfc10101.xml"
        },
        {
          "fmt": "txt",
          "name": "txt/rfc10101.txt"
        },
        {
          "fmt": "html",
          "name": "html/rfc10101.html"
        },
        {
          "fmt": "pdf",
          "name": "pdf/rfc10101.pdf"
        },
        {
          "fmt": "json",
          "name": "json/rfc10101.json"
        },
        {
          "fmt": "notprepped",
          "name": "notprepped/rfc10101.notprepped.xml"
        }
      ],

@codecov
Copy link

codecov bot commented Feb 11, 2026

Codecov Report

❌ Patch coverage is 72.72727% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 88.36%. Comparing base (a174f43) to head (00ef06b).
⚠️ Report is 6 commits behind head on main.

Files with missing lines Patch % Lines
ietf/doc/models.py 25.00% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #10392      +/-   ##
==========================================
- Coverage   88.38%   88.36%   -0.03%     
==========================================
  Files         325      325              
  Lines       43525    43644     +119     
==========================================
+ Hits        38470    38565      +95     
- Misses       5055     5079      +24     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

rjsparks
rjsparks previously approved these changes Feb 11, 2026
@jennifer-richards jennifer-richards merged commit 832c62e into ietf-tools:main Feb 11, 2026
10 checks passed
@jennifer-richards jennifer-richards deleted the red-formats branch February 11, 2026 15:42
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 15, 2026
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.

3 participants