add specUrl to OpenAPI source templates and refine template types

- Split SourceTemplate into OpenApiSourceTemplate and NonOpenApiSourceTemplate discriminated union for type-safe specUrl access - Add specUrl to GitHub, OpenAI, Vercel, and Stripe templates - Wire specUrl through both add-source and source-editor form defaults

Rhys Sullivan committed 8 months ago

Commit 74ceb1c1 parent 5ca042b3 files · +19 −4Browse files

Unified · Split

3 files

apps/web/src/views/add-source.tsx +2 −1
apps/web/src/views/source-editor.tsx +1 −1
apps/web/src/views/source-templates.ts +16 −2

apps/web/src/views/add-source.tsx+2−1

 const connectFormFromTemplate = (template: SourceTemplate): ConnectFormState => ({
   ...defaultConnectForm(),
-  kind: template.kind === "internal" ? "openapi" : template.kind,
+  kind: template.kind,
   endpoint: template.endpoint,
+  specUrl: "specUrl" in template ? template.specUrl : "",
   name: template.name,
   namespace: namespaceFromUrl(template.endpoint),
   transport: template.kind === "mcp" ? "auto" : "",

apps/web/src/views/source-editor.tsx+1−1

@@ -260,7 +260,7 @@ const defaultFormState = (template?: SourceTemplate): SourceFormState => ({ · 259 unmodified lines
260	transport: template?.kind === "mcp" ? "auto" : "",	260	transport: template?.kind === "mcp" ? "auto" : "",
261	queryParamsText: "",	261	queryParamsText: "",
262	headersText: "",	262	headersText: "",
263	specUrl: "",	263	specUrl: template && "specUrl" in template ? template.specUrl : "",
264	defaultHeadersText: "",	264	defaultHeadersText: "",
265	authKind: "none",	265	authKind: "none",
266	authHeaderName: "Authorization",	266	authHeaderName: "Authorization",

apps/web/src/views/source-templates.ts+16−2

 import type { Source } from "@executor-v3/react";
-export type SourceTemplate = {
+type SourceTemplateBase = {
   id: string;
   name: string;
   summary: string;
-  kind: Source["kind"];
   endpoint: string;
 };
+export type OpenApiSourceTemplate = SourceTemplateBase & {
+  kind: "openapi";
+  specUrl: string;
+};
+export type NonOpenApiSourceTemplate = SourceTemplateBase & {
+  kind: Exclude<Source["kind"], "openapi" | "internal">;
+};
+export type SourceTemplate = OpenApiSourceTemplate | NonOpenApiSourceTemplate;
 export const sourceTemplates: ReadonlyArray<SourceTemplate> = [
   {
     id: "deepwiki-mcp",
     summary: "Repos, issues, pull requests, actions, and org settings.",
     kind: "openapi",
     endpoint: "https://api.github.com",
+    specUrl: "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.yaml",
   },
   {
     id: "github-graphql",
     summary: "Models, files, responses, and fine-tuning.",
     kind: "openapi",
     endpoint: "https://api.openai.com/v1",
+    specUrl: "https://app.stainless.com/api/spec/documented/openai/openapi.documented.yml",
   },
   {
     id: "vercel-api",
     summary: "Deployments, projects, domains, and environments.",
     kind: "openapi",
     endpoint: "https://api.vercel.com",
+    specUrl: "https://openapi.vercel.sh",
   },
   {
     id: "stripe-api",
     summary: "Payments, billing, subscriptions, and invoices.",
     kind: "openapi",
     endpoint: "https://api.stripe.com",
+    specUrl: "https://raw.githubusercontent.com/stripe/openapi/master/openapi/spec3.json",
   },
   {
     id: "linear-graphql",