modifying-http-endpoints

What problem does it solve?

This Skill provides a structured approach to adding or modifying HTTP REST API endpoints within Golem services, ensuring consistency and maintainability of the Golem API.

Core Features & Use Cases

• Endpoint Definition: Guides on defining new endpoints using Poem and poem-openapi annotations.
• Service Integration: Explains where to locate and how to integrate new API definitions within worker and registry services.
• Type Management: Details on defining and mapping request/response types for OpenAPI compatibility.
• Regeneration & Verification: Outlines the essential steps for regenerating OpenAPI specifications and rebuilding client crates.
• Use Case: When a new feature requires a new API endpoint in the Golem worker service, this Skill will guide the developer through defining the endpoint, its request/response types, and the necessary regeneration steps.

Quick Start

Use the modifying-http-endpoints skill to add a new POST endpoint to the worker service at the path /v1/my-new-action.