typespec-api-operations

Define RESTful API operations with routing, parameters, and adaptive cards in TypeSpec.

Updated Nov 21, 2025
One-click install
npx skills add https://github.com/lluppesms/dadabase.demo --skill typespec-api-operations
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: typespec-api-operations
Source: https://github.com/lluppesms/dadabase.demo/tree/main/.github/skills/typespec-api-operations
Command: npx skills add https://github.com/lluppesms/dadabase.demo --skill typespec-api-operations

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill simplifies the process of defining and implementing standard RESTful API operations (GET, POST, PATCH, DELETE) within TypeSpec, ensuring proper routing, parameter handling, and user confirmation dialogues.

Core Features & Use Cases

  • Define CRUD Operations: Easily add GET, POST, PATCH, and DELETE endpoints to your TypeSpec API.
  • Parameter Handling: Supports path, query, and body parameters with clear type definitions.
  • Adaptive Cards: Integrate adaptive cards for user confirmation on sensitive operations (POST, PATCH, DELETE) and for displaying data in a user-friendly format (GET).
  • Use Case: You are building an API for a task management system. Use this Skill to define endpoints for listing, creating, updating, and deleting tasks, complete with user confirmations for deletions and a nice card display for task details.

Quick Start

Use the typespec-api-operations skill to add a GET operation to list all items with a path parameter for filtering by user ID.

Frequently Asked Questions about typespec-api-operations

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I define RESTful CRUD operations in TypeSpec?

You define RESTful CRUD operations in TypeSpec by specifying routing, parameters, and body models for GET, POST, PATCH, and DELETE endpoints. This approach standardizes API creation while supporting custom response models and error handling.

How do I add user confirmation dialogues for sensitive API operations in TypeSpec?

To add user confirmation dialogues for sensitive API operations like POST, PATCH, and DELETE, you integrate adaptive cards directly within your TypeSpec definitions to prompt users before execution.

Can I define TypeSpec APIs with multiple query parameters for Microsoft 365 Copilot?

Yes, you can define TypeSpec APIs with multiple query parameters for Microsoft 365 Copilot. The framework supports path, query, and body parameters to create functional API plugins.

What is the best way to display GET request data using TypeSpec for Copilot plugins?

The best way to display GET request data in TypeSpec Copilot plugins is by integrating adaptive cards, which format the retrieved data into a user-friendly interface for enhanced interaction.

Does TypeSpec support custom response models and error handling for REST endpoints?

Yes, TypeSpec supports custom response models and error handling for REST endpoints. You can define specific response structures and error logic directly within your API operations.