Skip to content

Threat Intelligence Standard + Extended: OpenAPI specs, interactive reference, Postman#27

Merged
ejntaylor merged 4 commits into
mainfrom
retrofit-standard-extended-threat-intel-docs
Apr 24, 2026
Merged

Threat Intelligence Standard + Extended: OpenAPI specs, interactive reference, Postman#27
ejntaylor merged 4 commits into
mainfrom
retrofit-standard-extended-threat-intel-docs

Conversation

@ejntaylor
Copy link
Copy Markdown
Contributor

Summary

  • Brings the Standard and Extended tiers up to the same doc pattern as the Beta (Npm Dataset) tier landed in Threat Intelligence Beta: OpenAPI spec, interactive reference, Postman #22: hand-authored OpenAPI 3.1 specs drive an interactive reference, and deterministic Postman collections are generated at build time.
  • Guide pages slimmed to narrative content (auth, rate limits, errors, curl samples, tier-specific concepts); shared Postman / LLM / SDK tooling content is consolidated into a single section on the Overview so all three Guides link to one source of truth.
  • Sidebar nests each tier as Guide + Reference via per-schema createOpenAPISidebarGroup() placeholders. Removes a CSS rule that deliberately de-emphasised badged sidebar group labels — it made Beta look lighter than its Standard/Extended peers after this restructure.

New files

  • public/schemas/threat-intel-standard.yaml — OpenAPI 3.1, 2 operations (/product/{type}/{name}/{version}, /.../exists)
  • public/schemas/threat-intel-extended.yaml — OpenAPI 3.1, 5 operations (/latest, /product/..., /.../exists, /batch, /vulnerability/{id})
  • Generated Postman collections for both

Changed

  • astro.config.mjs — three OpenAPI schemas registered, sidebar reworked
  • overview.md — comparison table removed; three tier pointer blocks + consolidated tooling section
  • standard.md, extended.md — slimmed to tier-specific content
  • beta.md — shared tooling section removed, links to Overview
  • src/styles/custom.css — dropped the sidebar badge de-emphasis rule

Needs QA / API-team review

  • Spec accuracy. The Standard and Extended YAMLs were hand-authored from the existing markdown. Fields, error codes, and response shapes should be sanity-checked against the live v2 API before partners start importing the spec as truth.
  • Visual walk of the sidebar + reference pages. Especially the new Reference operation pages under /api-reference/threat-intelligence-standard/ and /api-reference/threat-intelligence-extended/.

Test plan

  • npm run build succeeds
  • Sidebar renders Overview → Standard API (Guide + Reference) → Extended API (Guide + Reference) → NPM standard API [Beta] (Guide + Reference) → API properties
  • All three tier group labels render at the same visual weight
  • Each Reference operation page renders parameters, request bodies, response schemas, and examples
  • Postman collection import works (drag threat-intel-standard.postman_collection.json and threat-intel-extended.postman_collection.json into Postman, set PSKey, run a request)
  • Generated Postman JSONs are byte-identical across consecutive builds (verified locally, worth one more confirmation post-merge)
  • Inbound deep links to #find-vulnerability etc. will now land on the page but not a section anchor — confirm acceptable
  • API team signs off on spec accuracy for Standard and Extended

🤖 Generated with Claude Code

ejntaylor and others added 3 commits April 23, 2026 10:36
…eference, Postman

Bring Standard and Extended tiers up to the Beta doc pattern: hand-authored
OpenAPI 3.1 specs drive the interactive reference and generate deterministic
Postman collections at build. Guide pages are slimmed to narrative content
(auth, rate limits, errors, code samples) and the Overview comparison table
is replaced with per-tier pointer blocks now that all three tiers are
documented the same way.

Sidebar nests each tier as Guide + Reference via per-schema
createOpenAPISidebarGroup() placeholders.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Postman / Insomnia / Bruno / Hoppscotch import instructions, LLM-assistant
guidance, and SDK-generation snippets were duplicated across the three tier
Guides. Moved to a single "Using the APIs with your tools" section on the
Overview, with each Guide linking to it. Tier-specific content (base URL,
auth, rate limits, errors, curl samples, tier-unique concepts) stays on the
Guide pages.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Previously the Beta group was the only sibling with a badge, so de-emphasising
its label let the green [Beta] pill carry the emphasis. Now that Standard,
Extended and Beta API are peer groups, the rule made the Beta row read as
lighter than the other two. Drop it so all three groups render at the same
weight; the badge is still there to signal Beta status.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 23, 2026

Deploy Preview for deluxe-meerkat-8daf24 ready!

Name Link
🔨 Latest commit 54c44d4
🔍 Latest deploy log https://app.netlify.com/projects/deluxe-meerkat-8daf24/deploys/69ea0009d135f40007736e11
😎 Deploy Preview https://deploy-preview-27--deluxe-meerkat-8daf24.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Copy Markdown
Contributor

@mariojgt mariojgt left a comment

Choose a reason for hiding this comment

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

@ejntaylor LGTM - one minor improvement is that the .json collection could open on another page, also, this may be a rabbit hole, but we could have a .txt version of all the pages, I see lots of companies doing that now for LLMs.

- Getting Started → "patch prioriy and severiy score" → "priority and severity"
- FAQ → ISO 127001 → ISO 27001, in the page title and the URL slug.
  Renamed the file to match, redirected the old URL to the new one, and
  updated the existing /docs/ → /faq-troubleshooting/ redirect to land on
  the corrected URL.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@ejntaylor ejntaylor merged commit f4477ef into main Apr 24, 2026
4 checks passed
@ejntaylor ejntaylor deleted the retrofit-standard-extended-threat-intel-docs branch April 24, 2026 08:18
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.

3 participants