implement-api-endpoint

Implement Smartsheet JavaScript SDK API endpoints with OpenAPI compliance and TypeScript tests.

21|23|Updated Oct 25, 2022
One-click install
npx skills add https://github.com/smartsheet/smartsheet-javascript-sdk --skill implement-api-endpoint-smartsheet
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: implement-api-endpoint
Source: https://github.com/smartsheet/smartsheet-javascript-sdk/tree/main/.claude/skills/implement-api-endpoint
Command: npx skills add https://github.com/smartsheet/smartsheet-javascript-sdk --skill implement-api-endpoint-smartsheet

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures a disciplined and compliant workflow for implementing API endpoints in the Smartsheet JavaScript SDK, reducing errors and improving consistency.

Core Features & Use Cases

  • Compliance with OpenAPI Spec: Ensures implementation matches the OpenAPI specification.
  • TypeScript Patterns: Follows TypeScript best practices for API method implementation.
  • Test Coverage: Enforces mandatory test coverage following specified patterns.
  • Use Case: Before implementing a new API endpoint, this Skill provides a structured approach to follow, ensuring all necessary steps are taken and best practices are adhered to.

Quick Start

Run the 'implement-api-endpoint' skill to start the workflow for implementing a new API endpoint in the Smartsheet JavaScript SDK.

Frequently Asked Questions about implement-api-endpoint

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

FAQPage Schema
How do I implement API endpoints in the Smartsheet JavaScript SDK?

To implement API endpoints in the Smartsheet JavaScript SDK, follow a structured workflow ensuring compliance with the OpenAPI spec, applying correct TypeScript patterns, and maintaining mandatory test coverage using provided scripts and references.

What is the best way to ensure TypeScript API methods match the OpenAPI spec?

Ensuring TypeScript API methods match the OpenAPI spec requires a disciplined workflow that validates implementation against the specification, enforcing consistent patterns and mandatory test coverage to reduce errors during SDK development.

Do I need WireMock mappings to test Smartsheet API endpoint implementations?

Yes, WireMock mappings are required for testing Smartsheet API endpoint implementations. The workflow mandates test coverage using these mappings alongside the OpenAPI spec to validate endpoint behavior accurately.

Can I use this structured workflow for adding new endpoints to an existing TypeScript SDK?

Yes, you can use this structured workflow for adding new endpoints to an existing TypeScript SDK. It provides a consistent approach ensuring all necessary steps, OpenAPI compliance, and test coverage are followed before implementation.

Why does my Smartsheet API endpoint implementation lack consistency across different methods?

Smartsheet API endpoint implementation lacks consistency when not following a disciplined workflow. Adhering to structured TypeScript patterns and OpenAPI spec compliance reduces errors and enforces consistency across SDK methods.

What are the limitations of implementing Smartsheet SDK endpoints without a structured workflow?

Implementing Smartsheet SDK endpoints without a structured workflow risks non-compliance with the OpenAPI spec, inconsistent TypeScript patterns, and missing mandatory test coverage, leading to increased errors and integration issues.