Skip to content

Documentation Navigation Guide

📚 Reading Path Recommendations

For Beginners

  1. Start Here: Main Index - Overview and quick start
  2. Learn the Basics: API Overview - Core concepts and authentication
  3. Explore APIs: API Endpoints - Available endpoints and operations
  4. Try Examples: Basic Examples - Simple automation scripts

For Intermediate Users

  1. Data Understanding: Data Models - JSON structures and schemas
  2. Advanced Examples: Examples and Use Cases - Complete automation scripts
  3. Complex Workflows: Advanced Use Cases - SVM and NFS management

For Advanced Users / Architects

  1. Workflow Design: Advanced Use Cases - Sequence diagrams and complex automation
  2. Reference Material: API Endpoints + Data Models
  3. Production Scripts: Focus on the Python classes and error handling patterns

🎯 Use Case Navigation

Infrastructure Management

Storage Operations

Security & Credentials

Automation & Integration

🔍 Quick Reference

API Endpoints by Category

Category Documentation Section
Administration API Endpoints - Administration
Datacenter API Endpoints - Datacenter
Storage Provider API Endpoints - Storage Provider
Management Server API Endpoints - Management Server
Gateways API Endpoints - Gateways

Common Data Models

Model Documentation Section
Access Endpoints Data Models - Access Endpoint
Performance Metrics Data Models - Performance Metrics
Cluster Information Data Models - Cluster Information
Storage Metrics Data Models - Storage Metrics
Event Management Data Models - Event Management

Sequence Diagrams

Workflow Diagram Location
SVM Creation Advanced Use Cases - SVM Creation Sequence
NFS Share Creation Advanced Use Cases - NFS Share Creation Sequence
Credential Updates Advanced Use Cases - NFS Credential Update Sequence
Complete Workflow Advanced Use Cases - Complete Workflow Integration

🛠️ Implementation Guides

Python Development

  1. Basic Setup: Examples - Authentication
  2. Class Examples: Examples - Health Check Script
  3. Advanced Classes: Advanced Use Cases - Python Implementation
  4. Error Handling: Examples - Error Handling Best Practices

cURL Examples

  1. Basic Commands: Examples - Common Use Cases
  2. Complex Operations: Advanced Use Cases - Step-by-Step

Integration Patterns

  1. Health Monitoring: Examples - Health Check Script
  2. Automated Deployment: Advanced Use Cases - Master Deployment Script
  3. Event Management: Examples - Event Dashboard

📖 Learning Progression

Phase 1: Foundation (30 minutes)

Phase 2: Practical Application (1-2 hours)

Phase 3: Advanced Implementation (2-4 hours)

Phase 4: Production Readiness (4+ hours)

  • Implement error handling patterns
  • Create custom automation scripts
  • Design complete workflows with proper validation

📞 Getting Help

Documentation Issues

  • Check the README for source information
  • Review external links in each section

API Issues

  • Consult the interactive Swagger documentation at https://<your-um-host>/apidocs/
  • Check official NetApp documentation links provided

Implementation Issues

  • Review error handling examples
  • Check authentication configuration
  • Validate endpoint URLs and parameters

This navigation guide helps you find the right documentation section based on your role, use case, and experience level.