skills.rest
smartsheet
smartsheetOFFICIAL
Explore all skills by this author →
WebsiteGitHub

review-api-endpoint

Review Smartsheet JavaScript SDK API endpoints for OpenAPI and TypeScript compliance.

21|23|Updated Oct 25, 2022
Search Tags:#code review#OpenAPI#API endpoint#Smartsheet#JavaScript SDK
One-click install
npx skills add https://github.com/smartsheet/smartsheet-javascript-sdk --skill review-api-endpoint
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: review-api-endpoint
Source: https://github.com/smartsheet/smartsheet-javascript-sdk/tree/main/.claude/skills/review-api-endpoint
Command: npx skills add https://github.com/smartsheet/smartsheet-javascript-sdk --skill review-api-endpoint

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill provides a structured review process for API endpoint implementations in the Smartsheet JavaScript SDK, ensuring adherence to OpenAPI specs and TypeScript correctness.

Core Features & Use Cases

  • Code Review Workflow: Offers a systematic code review process for API endpoints.
  • Spec Alignment: Verifies alignment with OpenAPI specs and TypeScript interfaces.
  • Test Coverage: Ensures complete test coverage with required and optional tests.
  • Use Case: When reviewing a pull request with endpoint changes in the Smartsheet JavaScript SDK.

Quick Start

Run the skill to initiate a review of the API endpoint changes in the current pull request.

Frequently Asked Questions about review-api-endpoint

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

FAQPage Schema
How do I review API endpoint changes in a Smartsheet JavaScript SDK pull request?▼

To review API endpoint changes in a Smartsheet JavaScript SDK pull request, you can use an automated review process that checks implementations against OpenAPI specs and TypeScript interfaces. This ensures endpoint compliance and correctness before merging.

What does an OpenAPI spec compliance check cover for JavaScript SDK endpoints?▼

An OpenAPI spec compliance check for JavaScript SDK endpoints verifies that the implementation aligns with the defined OpenAPI specifications and TypeScript interfaces. It ensures the endpoint structure matches the documented API contract.

How do I ensure test coverage for Smartsheet API endpoint implementations?▼

You ensure test coverage for Smartsheet API endpoint implementations by running a structured code review process that validates both required and optional tests. This confirms thorough endpoint testing before pull request merges.

Can I use this code review workflow for TypeScript interfaces in any JavaScript SDK?▼

This code review workflow is specifically designed for the Smartsheet JavaScript SDK and validates TypeScript interface correctness against OpenAPI specs. It is primarily used for pulling request reviews and merges within that context.

What is the best way to validate TypeScript correctness for Smartsheet API endpoints?▼

The best way to validate TypeScript correctness for Smartsheet API endpoints is through a systematic code review process that verifies alignment with OpenAPI specs and TypeScript interfaces. This structured approach ensures implementation accuracy.

Related Skills

Explore More Software Engineering Skills→
H2OSLabsH2OSLabs
1

schema-to-openapi

Converts Synnovator data schemas into OpenAPI 3.0 YAML or JSON specifications.

Official
Intermediate
smartsheetsmartsheet
21

releasing-smartsheet-javascript-sdk

Automate Smartsheet JavaScript SDK releases with version bumps, changelogs, and GitHub Releases.

Official
Intermediate
alangebalangeb

code-review-workflow

Run pyscan, pyanalyze, ruff, and black to generate a unified markdown report.

Community
Intermediate
eykdeykd

quality-review

Review GitHub pull requests for correctness, style, test coverage, and standards.

Community
Advanced