Skip to content

docs(readme): sync Supported entities list with docs/examples#102

Merged
leoparente merged 1 commit into
developfrom
chore/readme-sync-supported-entities
Jul 21, 2026
Merged

docs(readme): sync Supported entities list with docs/examples#102
leoparente merged 1 commit into
developfrom
chore/readme-sync-supported-entities

Conversation

@leoparente

Copy link
Copy Markdown
Contributor

Summary

The README's Supported entities (object types) list had drifted behind the
per-entity examples in docs/examples/. This syncs the list
so it matches the examples exactly.

What changes

Adds the 16 object types that have a docs/examples/ file (and are Entity
oneof members) but were missing from the README list:

Cable, Cable Bundle, Cable Path, Cable Termination, Custom Field,
Custom Field Choice Set, Custom Link, Device Config, Journal Entry,
Module Type Profile, Owner, Owner Group, Rack Group, Rack Reservation,
Script Module, Virtual Machine Type.

Inserted in the existing alphabetical positions. Docs-only change.

Verification

  • The list now matches docs/examples/ 1:1 — 100 object types, no extras,
    none missing (verified by canonicalized set comparison).
  • Every added entry is a member of the Entity proto oneof (i.e. a real
    ingestable object type, not a usage-only example).
  • Nothing removed: the previous list was a strict subset of the examples.

The README's "Supported entities (object types)" list had drifted behind the
per-entity examples in docs/examples/. Add the 16 object types that have an
example (and are Entity oneof members) but were missing from the list:

Cable, Cable Bundle, Cable Path, Cable Termination, Custom Field,
Custom Field Choice Set, Custom Link, Device Config, Journal Entry,
Module Type Profile, Owner, Owner Group, Rack Group, Rack Reservation,
Script Module, Virtual Machine Type.

The list now matches docs/examples/ exactly (100 object types, 1:1).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jul 21, 2026

Copy link
Copy Markdown

Coverage

Coverage Report
FileStmtsMissCoverMissing
/opt/hostedtoolcache/Python/3.10.20/x64/lib/python3.10/site-packages/netboxlabs/diode/sdk
   chunking.py33197%112
   client.py5684293%202–203, 222–224, 227–230, 516, 583, 588, 592, 675–680, 725–727, 757, 761, 765, 787, 808, 810, 884, 915, 923, 983–984, 993, 1026, 1053, 1058–1059, 1092, 1097–1100
   exceptions.py44393%69, 82–83
TOTAL6604693% 

Tests Skipped Failures Errors Time
203 0 💤 0 ❌ 0 🔥 1.854s ⏱️

@leoparente
leoparente merged commit 3eed35a into develop Jul 21, 2026
6 checks passed
@leoparente
leoparente deleted the chore/readme-sync-supported-entities branch July 21, 2026 14:44
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 1.13.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants