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

@@ -216,8 +216,9 @@ const defaultConnectForm = (discovery?: SourceDiscoveryResult): ConnectFormState · 215 unmodified lines
216	216
217	217	const connectFormFromTemplate = (template: SourceTemplate): ConnectFormState => ({
218	218	...defaultConnectForm(),
219		− kind: template.kind === "internal" ? "openapi" : template.kind,
	219	+ kind: template.kind,
220	220	endpoint: template.endpoint,
	221	+ specUrl: "specUrl" in template ? template.specUrl : "",
221	222	name: template.name,
222	223	namespace: namespaceFromUrl(template.endpoint),
223	224	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	260	transport: template?.kind === "mcp" ? "auto" : "",
261	261	queryParamsText: "",
262	262	headersText: "",
263		− specUrl: "",
	263	+ specUrl: template && "specUrl" in template ? template.specUrl : "",
264	264	defaultHeadersText: "",
265	265	authKind: "none",
266	266	authHeaderName: "Authorization",

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

@@ -1,13 +1,23 @@
1	1	import type { Source } from "@executor-v3/react";
2	2
3		−export type SourceTemplate = {
	3	+type SourceTemplateBase = {
4	4	id: string;
5	5	name: string;
6	6	summary: string;
7		− kind: Source["kind"];
8	7	endpoint: string;
9	8	};
10	9
	10	+export type OpenApiSourceTemplate = SourceTemplateBase & {
	11	+ kind: "openapi";
	12	+ specUrl: string;
	13	+};
	14	+
	15	+export type NonOpenApiSourceTemplate = SourceTemplateBase & {
	16	+ kind: Exclude<Source["kind"], "openapi" \| "internal">;
	17	+};
	18	+
	19	+export type SourceTemplate = OpenApiSourceTemplate \| NonOpenApiSourceTemplate;
	20	+
11	21	export const sourceTemplates: ReadonlyArray<SourceTemplate> = [
12	22	{
13	23	id: "deepwiki-mcp",
@@ -29,6 +39,7 @@ export const sourceTemplates: ReadonlyArray<SourceTemplate> = [ · 15 unmodified lines
29	39	summary: "Repos, issues, pull requests, actions, and org settings.",
30	40	kind: "openapi",
31	41	endpoint: "https://api.github.com",
	42	+ specUrl: "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.yaml",
32	43	},
33	44	{
34	45	id: "github-graphql",
@@ -50,6 +61,7 @@ export const sourceTemplates: ReadonlyArray<SourceTemplate> = [ · 15 unmodified lines
50	61	summary: "Models, files, responses, and fine-tuning.",
51	62	kind: "openapi",
52	63	endpoint: "https://api.openai.com/v1",
	64	+ specUrl: "https://app.stainless.com/api/spec/documented/openai/openapi.documented.yml",
53	65	},
54	66	{
55	67	id: "vercel-api",
@@ -57,6 +69,7 @@ export const sourceTemplates: ReadonlyArray<SourceTemplate> = [ · 1 unmodified line
57	69	summary: "Deployments, projects, domains, and environments.",
58	70	kind: "openapi",
59	71	endpoint: "https://api.vercel.com",
	72	+ specUrl: "https://openapi.vercel.sh",
60	73	},
61	74	{
62	75	id: "stripe-api",
@@ -64,6 +77,7 @@ export const sourceTemplates: ReadonlyArray<SourceTemplate> = [ · 1 unmodified line
64	77	summary: "Payments, billing, subscriptions, and invoices.",
65	78	kind: "openapi",
66	79	endpoint: "https://api.stripe.com",
	80	+ specUrl: "https://raw.githubusercontent.com/stripe/openapi/master/openapi/spec3.json",
67	81	},
68	82	{
69	83	id: "linear-graphql",