skills.rest
databrickslabs
databrickslabsOFFICIAL
Explore all skills by this author →
WebsiteGitHub

research-source-api

Research source APIs and document endpoints, authentication, schemas, and pagination.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill helps you research and document the API for a new data source connector, ensuring all necessary details for implementation are captured.

Core Features & Use Cases

  • API Research: Gathers information on endpoints, authentication, schemas, and pagination.
  • Documentation Generation: Creates a structured API documentation file.
  • Use Case: Before building a connector for a new SaaS product, use this skill to thoroughly understand its read APIs, authentication methods, and data structures.

Quick Start

Use the research-source-api skill to research the API for the 'salesforce' source.

Frequently Asked Questions about research-source-api

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

FAQPage Schema
How do I document a source API for a new data connector?▼

To document a source API for a data connector, gather comprehensive details on endpoints, authentication methods, schemas, pagination, and incremental sync strategies, ensuring you capture complete read operations and prefer stable APIs.

What details are needed to build a SaaS data source connector?▼

Building a SaaS data source connector requires researching read APIs, single authentication methods, complete data schemas, and pagination logic to ensure all necessary implementation details are captured for development.

Can I use API research for data connector development on any SaaS product?▼

API research for data connector development applies to any SaaS product with available read APIs. The process focuses on gathering endpoint and schema details while strictly adhering to read operations only.

What are the constraints when researching APIs for connector implementation?▼

Constraints when researching APIs for connector implementation include a strict policy of no invention, preference for a single authentication method, capturing complete schemas, and limiting scope to read operations only.

How does API documentation help with incremental sync strategies in data connectors?▼

API documentation helps with incremental sync strategies by explicitly gathering and recording pagination logic and endpoint details, ensuring the data connector implementation accurately replicates the source API's data retrieval patterns.

Why prefer stable APIs when researching source APIs for connector development?▼

Preferring stable APIs during source API research ensures the data connector implementation relies on durable endpoints and schemas, minimizing maintenance disruptions caused by breaking changes or deprecated read operations.

Related Skills

Explore More Software Engineering Skills→
vana-comvana-com
9

create-connector

Scaffold, test, and validate new data connectors against platform APIs.

Official
Advanced
microsoftmicrosoft
483

add-azuredevops

Add the Azure DevOps connector to Power Apps code apps and fix the HttpRequest method.

Official
Intermediate
mikkeymoomikkeymoo
1

mm-api-design

Audit and design RESTful APIs for compliance with REST conventions.

Community
Advanced
HieubkavHieubkav

api-documentation-writer

Generates API documentation with OpenAPI specs, endpoint descriptions, and code examples.

Community
Advanced