eagle-spec

Generated Eagle API spec assets.

This repository has two responsibilities:

1. Keep eagle.d.ts in sync with the Eagle Plugin API documentation.
2. Keep the Git-friendly HTTP request files under postman in sync with the Eagle Web API documentation.

Repository Layout

• eagle.d.ts: TypeScript declarations for the Eagle Plugin API.
• postman: Git-friendly HTTP request files, organized by Web API area.
• .github/agents/eagle-spec-sync.agent.md: Workspace agent for spec synchronization tasks.

Request File Format

The files under postman use the Git-friendly YAML request format, with one .request.yaml file per documented endpoint.

Example:

$kind: http-request
url: "{{baseurl}}/api/v2/item/query"
method: POST
body:
	type: json
	content: |-
		{
				"query": "sunset landscape",
				"offset": 0,
				"limit": 20
		}
order: 3200

Source of Truth

• Web API request files are generated from the Eagle Web API MCP documentation.
• eagle.d.ts is updated from the Eagle Plugin API MCP documentation.

Sync Rules

• Do not invent undocumented endpoints, request bodies, response fields, or TypeScript APIs.
• Keep edits minimal and aligned with the published documentation.
• Prefer one-file-at-a-time patches so failures stay localized.
• Use the .request.yaml format for Web API endpoint files, not legacy collection JSON.