apunkt/SurfSense
1
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2026-07-08 22:22:17 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat(schema): add API schema definitions for connectors

Browse source 
- Introduced a new schema structure for API connectors, including request and response fields.
- Updated connector implementations for Google Maps, Google Search, Reddit, Web Crawl, and YouTube to include detailed schema information.
- Enhanced the ConnectorPage component to render request and response schemas dynamically.
- Added SchemaField interface to standardize schema field definitions across connectors.
This commit is contained in:
DESKTOP-RTLN3BA\$punk 2026-07-05 21:49:30 -07:00
parent af7cdd3ca5
commit a7c3b2ae63
7 changed files with 636 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

80
surfsense_web/components/connectors-marketing/connector-page.tsx
View file

@ -6,7 +6,7 @@ import { BreadcrumbNav } from "@/components/seo/breadcrumb-nav";
import { Badge } from "@/components/ui/badge";
import { Button } from "@/components/ui/button";
import { Separator } from "@/components/ui/separator";
import type { ConnectorPageContent } from "@/lib/connectors-marketing/types";
import type { ConnectorPageContent, SchemaField } from "@/lib/connectors-marketing/types";
import { AgentTranscript } from "./agent-transcript";
import { ApiMcpTabs } from "./api-mcp-tabs";
import { ConnectorFaq } from "./connector-faq";
@ -14,6 +14,46 @@ import { Reveal } from "./reveal";
const GITHUB_URL = "https://github.com/MODSetter/SurfSense";
function SchemaTable({ caption, fields }: { caption: string; fields: SchemaField[] }) {
return (
<div className="overflow-x-auto rounded-xl border bg-card">
<table className="w-full min-w-xl text-sm">
<caption className="sr-only">{caption}</caption>
<thead>
<tr className="border-b bg-muted/40 text-left">
<th className="p-4 font-medium">Field</th>
<th className="p-4 font-medium">Type</th>
<th className="p-4 font-medium">Description</th>
</tr>
</thead>
<tbody>
{fields.map((field) => (
<tr key={field.name} className="border-b align-top last:border-b-0">
<th scope="row" className="p-4 text-left">
<code className="font-mono text-[13px] font-semibold">{field.name}</code>
</th>
<td className="whitespace-nowrap p-4">
<code className="font-mono text-[13px] text-muted-foreground">{field.type}</code>
{field.required ? (
<span className="ml-2 rounded-full bg-brand/10 px-2 py-0.5 text-xs font-medium text-brand">
required
</span>
) : null}
{field.defaultValue !== undefined ? (
<div className="mt-1 text-xs text-muted-foreground">
default <code className="font-mono">{field.defaultValue}</code>
</div>
) : null}
</td>
<td className="p-4 text-muted-foreground leading-relaxed">{field.description}</td>
</tr>
))}
</tbody>
</table>
</div>
);
}
export function ConnectorPage({ content }: { content: ConnectorPageContent }) {
const Icon = content.icon;
const label = content.cardTitle ?? `${content.name} API`;
@ -136,6 +176,44 @@ export function ConnectorPage({ content }: { content: ConnectorPageContent }) {
</Reveal>
</MarketingSection>
{/* Request / response schema */}
<MarketingSection>
<Reveal>
<h2 className="text-2xl font-bold tracking-tight sm:text-3xl">
{content.name} API request and response schema
</h2>
<p className="mt-3 max-w-2xl text-muted-foreground leading-relaxed">
The exact contract behind{" "}
<code className="rounded bg-muted px-1.5 py-0.5 font-mono text-sm">
POST /workspaces/{"{workspace_id}"}/scrapers/{content.api.platform}/{content.api.verb}
</code>
. The same fields power the{" "}
<code className="rounded bg-muted px-1.5 py-0.5 font-mono text-sm">
{content.api.mcpTool}
</code>{" "}
MCP tool.
</p>
</Reveal>
<Reveal>
<h3 className="mt-8 text-lg font-semibold">Request parameters</h3>
<p className="mt-2 max-w-2xl text-sm text-muted-foreground leading-relaxed">
{content.schema.requestNote}
</p>
<div className="mt-4">
<SchemaTable caption="Request parameters" fields={content.schema.request} />
</div>
</Reveal>
<Reveal>
<h3 className="mt-10 text-lg font-semibold">Response fields</h3>
<p className="mt-2 max-w-2xl text-sm text-muted-foreground leading-relaxed">
{content.schema.responseNote}
</p>
<div className="mt-4">
<SchemaTable caption="Response fields" fields={content.schema.response} />
</div>
</Reveal>
</MarketingSection>
{/* Comparison */}
<MarketingSection>
<Reveal>