What is the primary use of the Nexus API Navigator skill?

It is designed to help developers navigate and understand the Oxide external API within the omicron repository by tracing code from endpoints to handlers.

How does it handle extremely large OpenAPI schemas?

The skill uses a 'tags first' approach, finding concise operation IDs in nexus_tags.txt before searching the larger, more complex schema files.

Which files does this skill reference to find API information?

It specifically uses nexus_tags.txt for operation IDs, lib.rs for trait definitions, http_entrypoints.rs for handlers, and the OpenAPI schema.

Can this skill help with Rust-based API development?

Yes, it is optimized for the Oxide stack, specifically tracing Dropshot API traits and Rust endpoint handlers in the omicron codebase.

Oxide API Navigator

Name: Oxide API Navigator
Author: oxidecomputer

byoxidecomputer

API Development

Navigates the Oxide omicron repository to provide detailed answers and code paths for the external Nexus API.

About

This skill empowers developers working on the Oxide omicron repository by providing a structured approach to understanding the external Nexus API. It facilitates deep-dive exploration of the codebase by tracing call chains from endpoint handlers to underlying implementations. By utilizing specific entry points such as nexus_tags.txt for operation IDs and Dropshot trait definitions in lib.rs, the skill helps developers quickly identify request/response types, query parameters, and API behaviors without getting lost in large schema files or massive repositories.

Key Features

Traces API call chains from endpoint handlers to core implementations
Analyzes Dropshot API trait definitions for request and response types
Locates operation IDs quickly using the nexus_tags.txt index
Navigates and interprets large OpenAPI schemas for the Nexus API
References integration tests to confirm specific API behaviors
0 GitHub stars

Use Cases

Identifying which Rust handler function implements a specific API endpoint
Determining the exact request body and query parameters for a Nexus operation
Verifying API behavior by analyzing relevant integration tests in the omicron repo

About

Key Features

Traces API call chains from endpoint handlers to core implementations
Analyzes Dropshot API trait definitions for request and response types
Locates operation IDs quickly using the nexus_tags.txt index
Navigates and interprets large OpenAPI schemas for the Nexus API
References integration tests to confirm specific API behaviors
0 GitHub stars

Use Cases

Identifying which Rust handler function implements a specific API endpoint
Determining the exact request body and query parameters for a Nexus operation
Verifying API behavior by analyzing relevant integration tests in the omicron repo