research-write-api-of-source

Research and document POST/PUT write API endpoints for source systems.

60|116|Updated Nov 13, 2025
One-click install
npx skills add https://github.com/databrickslabs/lakeflow-community-connectors --skill research-write-api-of-source
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: research-write-api-of-source
Source: https://github.com/databrickslabs/lakeflow-community-connectors/tree/main/.claude/skills/research-write-api-of-source
Command: npx skills add https://github.com/databrickslabs/lakeflow-community-connectors --skill research-write-api-of-source

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the process of researching and documenting write/create API endpoints for source systems, which is crucial for enabling write-back testing functionality.

Core Features & Use Cases

  • API Endpoint Discovery: Identifies POST/PUT/create endpoints for each table in a source system.
  • Payload Structure Verification: Cross-references payload structures and required fields from multiple sources.
  • Documentation Generation: Appends a detailed 'Write-Back APIs (For Testing Only)' section to existing API documentation files.
  • Use Case: When developing a new data connector that requires write-back capabilities for testing, this skill helps quickly gather the necessary API details to generate test data.

Quick Start

Use the research-write-api-of-source skill to document the write APIs for the 'salesforce' source.

Frequently Asked Questions about research-write-api-of-source

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

FAQPage Schema
How do I document write-back API endpoints for source system testing?

Documenting write-back APIs involves identifying POST/PUT endpoints for source system tables and cross-referencing payload structures. This generates detailed documentation with example payloads, field transformations, and write-specific constraints for testing.

What is a write-back API and when do I need it for data connector development?

A write-back API provides POST/PUT endpoints to create or update records in a source system. You need it for data connector development when enabling comprehensive end-to-end testing that requires writing test data back to the source.

How do I find the required payload fields for a source system's create API?

To find required payload fields for a source system's create API, search official documentation for POST/PUT endpoints and cross-reference payload structures from multiple sources to verify required fields, transformations, and write-specific constraints.

Can I automate API endpoint discovery for source system tables?

Yes, API endpoint discovery for source system tables can be automated by identifying POST/PUT/create endpoints for each table and appending a detailed 'Write-Back APIs (For Testing Only)' documentation section to existing API documentation files.

Does this approach support testing write operations for existing API documentation files?

Yes, testing write operations is supported by appending a detailed 'Write-Back APIs (For Testing Only)' section to existing API documentation files. This includes example payloads, field transformations, and write-specific constraints for comprehensive end-to-end connector testing.