Skip to content

feat(ip-fabric): add tables/snapshots/path-lookup/jobs Integration Model - #68

Merged
michaelelrom merged 2 commits into
itential:mainfrom
michaelelrom:feat/ip-fabric-api-integration-model
Aug 13, 2026
Merged

feat(ip-fabric): add tables/snapshots/path-lookup/jobs Integration Model#68
michaelelrom merged 2 commits into
itential:mainfrom
michaelelrom:feat/ip-fabric-api-integration-model

Conversation

@michaelelrom

@michaelelrom michaelelrom commented Aug 13, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • IP Fabric doesn't publish a standalone downloadable OpenAPI file — each instance self-generates one from its own backend (RapiDoc). This spec is built from IP Fabric's official public Postman collection (gitlab.com/ip-fabric/integrations/postman, v7.8) and official API reference docs (docs.ipfabric.io).
  • IP Fabric's REST API has 200+ near-identical "tables" endpoints (one per data category, same request shape). Rather than model all 200+ 1:1, this groups them into 32 category-and-depth operations across 19 categories (matching IP Fabric's own path taxonomy), each taking the table's remaining path as individual path parameters (seg1/seg2/seg3) — a single embedded-slash parameter gets URL-encoded by Itential Platform's OpenAPI adapter and would silently send the wrong URL for multi-segment tables. Verified against a live HTTP echo endpoint.
  • Adds the 12-op snapshot lifecycle, the consolidated path-lookup (graphs) endpoint, and 3 job-control ops — 48 new operations total.
  • Fully migrates the Studio Project to the Integration Model: adds 48 new workflows (Tables, Snapshots, Path Lookup, Jobs) and removes the 6 workflows/root components still on the legacy IP Fabric Adapter (Create Network Snapshot, Compare Snapshot Inventory, Compare Network Routes From Snapshots, Analyze Service Path, and their payload helper tasks).
  • Rewrites IP Fabric/README.md — no adapter references remain.

Test plan

  • All 48 workflows created and schema-validated against a running Itential Platform instance
  • Multi-segment path-parameter behavior verified against a live HTTP echo endpoint (confirmed segments are sent unencoded)
  • Not executed against a live IP Fabric instance (none available for this pass)

IP Fabric doesn't publish a standalone OpenAPI file, so this is built
from IP Fabric's official Postman collection (v7.8) and API reference
docs, cross-validated against the legacy adapter's full operation set
to catch renamed/removed endpoints (deviceDiff -> tables/management/
changes/devices).

Groups the 200+ near-identical "tables" endpoints into 32 category-
and-depth operations using individual path parameters per segment,
since Itential Platform's OpenAPI adapter URL-encodes slashes inside
a single path parameter and would otherwise send the wrong URL for
multi-segment tables. Adds 48 new workflows (Tables, Snapshots, Path
Lookup, Jobs) to the existing Studio Project, alongside the untouched
legacy adapter-based folders.
…gration Model

Removes the 6 workflows/root components still on the legacy IP Fabric
Adapter (Create Network Snapshot, Compare Snapshot Inventory, Compare
Network Routes From Snapshots, Analyze Service Path, and their payload
helper tasks) along with all adapter references in the README and spec,
so the project is fully Integration Model-based.
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.

2 participants