map

OpenAPI Map

Discover and track where your generated API code is used throughout your codebase. Essential for understanding impact of API changes.

---

EXECUTION INSTRUCTIONS

When /oas:map is invoked, Claude MUST perform these steps in order:

Step 0: MCP Dependency Check

Invoke skill: mcp-dependency

• Verify OpenAPI Sync MCP server is installed
• If not available, offer to install via npm install -g @jhlee0409/openapi-sync-mcp
• Only proceed after MCP is confirmed available

1. Load config - Read .openapi-sync.json for generated file locations
2. Identify API exports - Find all exported functions, hooks, types
3. Search codebase - Find all files that import these exports
4. Build usage graph - Map API → Components/Pages/Hooks
5. Store mapping - Save to .openapi-sync.state.json
6. Report results - Show usage summary

---

Usage

# Full codebase mapping
/oas:map

# Map specific domain only
/oas:map --tag=users

# Map specific export
/oas:map --export=useUser

# Show detailed usage
/oas:map --verbose

---

Step 1: Load Configuration

1. Read .openapi-sync.json
2. Identify generated domains from entities/ or api/ directory
3. For each domain, find:
   - API functions (e.g., userApi.getUser)
   - Query hooks (e.g., useUser, useCreateUser)
   - Types (e.g., User, CreateUserRequest)

---

Step 2: Identify API Exports

Scan generated API files and extract exports:

// From src/entities/users/api/users-queries.ts
export const useUsers = ...     // Hook export
export const useUser = ...      // Hook export
export const useCreateUser = ...// Hook export

// From src/entities/users/api/users-api.ts
export const userApi = {        // API object export
  list: ...,
  get: ...,
  create: ...,
}

// From src/entities/users/model/types.ts
export interface User { ... }           // Type export
export interface CreateUserRequest { }  // Type export

Build export registry:

{
  "users": {
    "hooks": ["useUsers", "useUser", "useCreateUser", "useUpdateUser", "useDeleteUser"],
    "api": ["userApi"],
    "types": ["User", "CreateUserRequest", "UpdateUserRequest", "UserFilters"]
  }
}