netapi Documentation
Project Summary
| Field | Value |
|---|---|
PRJ ID |
PRJ-SPOKE-012 |
Owner |
Evan Rosado |
Priority |
P1 (High) |
Status |
Active — Scaling to Universal API Support |
Repository |
|
Antora Component |
|
Antora Title |
netapi - Network Automation Library |
Category |
Network Security / API Automation |
2026 Commits |
122+ |
Site URL |
Phase Progress
| Phase | Description | Status | Notes |
|---|---|---|---|
Phase 1 |
Foundation — Universal patterns, nav restructure, CLI design docs |
⚠️ In Progress |
Auth, resilience, discovery pages created. Nav restructured. |
Phase 2 |
Proof — Document GitHub + Cloudflare using universal patterns only |
❌ Not Started |
Code already has clients for both (482 + stub lines) |
Phase 3 |
Code Abstractions — Base client class, vendor registry, protocols layer |
❌ Not Started |
Requires changes in |
Phase 4 |
Generator — Scaffold vendor integrations from OpenAPI specs |
❌ Not Started |
Depends on Phase 3 abstractions |
Phase 5 |
Public APIs — YouTube, HN, Reddit, Wikipedia, Google Search, and more |
⚠️ In Progress |
3 of 10 vendors documented (YouTube, HN, Reddit) |
Purpose
The netapi documentation spoke is the Antora-rendered documentation site for the netapi network automation library.
Original scope: CLI reference and API integration patterns for Cisco ISE (ERS, MnT, DataConnect, pxGrid).
Scaling goal: Document netapi as a universal API automation tool. The codebase already supports 23 vendors and 8 auth providers — the documentation needs to reflect this breadth and provide vendor-agnostic patterns that work with any API on the internet.
This repo is the documentation component. The actual Python library lives at ~/atelier/_projects/personal/netapi. Project management and phase tracking live here in domus-captures.
Scope
In Scope
-
Universal API patterns — authentication (OAuth2, API keys, bearer, mTLS, HMAC), response handling (jq, XML), pagination, rate limiting, retry strategies, API discovery
-
CLI reference for all 18 vendor command groups (ISE, pfSense, GitHub, GitLab, Gitea, WLC, IOS, Keycloak, Vault, Synology, Infoblox, Cloudflare, Wazuh, Monad, DNAC, Prime, FMC, KVM)
-
CLI design specification — universal
netapi <vendor> <resource> <verb>grammar -
Vendor definition format — declarative YAML for adding new API integrations
-
"Integrating Any API" guide — end-to-end walkthrough from discovery to automation
-
ISE deep-dive documentation (ERS 199 endpoints, OpenAPI 100 endpoints, MnT, DataConnect 376+ views, pxGrid 2.0)
-
Credential management (dsec/dsource integration)
Out of Scope
-
netapi Python library internals (covered by
~/atelier/_projects/personal/netapi) -
ISE policy design (covered by
ise-ops) -
Network topology (covered by
infra-ops) -
Code changes to the netapi library (tracked separately)
Status
| Indicator | Detail |
|---|---|
Activity Level |
Active — scaling from ISE-focused to universal API documentation |
Maturity |
Production — ISE docs comprehensive; universal patterns in progress |
Current Phase |
Phase 1: Foundation (universal patterns, nav restructure, CLI design) |
Key Milestone |
Nav restructured from ISE-flat to Universal Patterns + Vendors hierarchy |
Code State |
netapi v0.2.0 — 23 vendors, 8 auth providers, 18 CLI command groups already implemented |
Doc-Code Gap |
Documentation covers ~6 of 23 vendors. Universal patterns now documented but not yet proven against non-ISE vendors. |
Deployment Status |
Documentation live at docs.domusdigitalis.dev/netapi/ |
Metadata
| Field | Value |
|---|---|
PRJ ID |
PRJ-SPOKE-012 |
Author |
Evan Rosado |
Date Created |
2026-03-30 |
Last Updated |
2026-04-06 |
Status |
Active — Phase 1 (Foundation) |
Next Review |
2026-04-20 |
Related Repos |
|