API Doc

Documents

api-doc

API Doc is an Agent Skill for documents published in the meshery/meshery repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Document REST API endpoints and GraphQL operations in the Meshery server.

View on GitHub ↗

QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

Open your project in Codex.
Copy and paste the prompt below.
Review files and risks before approving any action.

Prompt to paste

Inspect the Agent Skill at https://github.com/meshery/meshery/blob/HEAD/.agents/skills/api-doc/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/api-doc, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Skill: api-doc

Document REST API endpoints and GraphQL operations in the Meshery server.

Usage

Invoke this skill with a target handler file or directory:

/api-doc server/handlers/design_handler.go
/api-doc server/handlers/ (document all handlers)

Instructions

Read the target handler file(s) to identify all HTTP endpoint functions.
Read the router configuration in server/router/ to find URL paths and HTTP methods mapped to each handler.
Read the request/response model types in server/models/ referenced by the handlers.
Generate documentation in the format below.

Output Format

For each endpoint, document:

### `METHOD /api/path`

**Description**: Brief description of what the endpoint does.

**Authentication**: Required / Not required

**Parameters**:

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| id | path | string | yes | Resource identifier |
| page | query | int | no | Page number (default: 1) |

**Request Body** (if applicable):

```json
{
  "field": "type — description"
}
```

**Response** `200 OK`:

```json
{
  "field": "type — description"
}
```

**Error Responses**:

| Status | Description |
|--------|-------------|
| 400 | Invalid request body |
| 401 | Authentication required |
| 404 | Resource not found |

Guidelines

Derive descriptions from handler logic and comments — do not invent behavior
Include all query parameters, path parameters, and headers the handler reads
Document the actual JSON structure by reading the Go struct tags (json:"field_name")
Note any middleware applied (auth, rate limiting) visible in the router setup
For GraphQL, document queries and mutations with their input/output types
Group endpoints by resource type (designs, patterns, filters, connections, etc.)