History

Add real spec coverage for source projections

Rhys Sullivan committed 8 months ago

Commit ec5148f1 parent 086d39d38 files · +293830 −464Browse files

Unified · Split

22 files
  1. apps/web/src/components/shell.tsx +85 −5
  2. apps/web/src/lib/schema-display.ts +121 −0
  3. apps/web/src/views/source-detail.tsx +13 −4
  4. packages/ai-sdk-adapter/src/example-dynamic.ts +4 −4
  5. packages/codemode-core/src/discovery.ts +4 −4
  6. packages/codemode-core/src/index.test.ts +8 −8
  7. packages/codemode-core/src/schema-types.test.ts +98 −0
  8. packages/codemode-core/src/schema-types.ts +165 −56
  9. packages/codemode-core/src/tool-map.ts +4 −4
  10. packages/codemode-core/src/types.ts +6 −6
  11. packages/codemode-google-discovery/src/google-discovery-tools.test.ts +46 −0
  12. packages/codemode-google-discovery/src/google-discovery-tools.ts +72 −23
  13. packages/codemode-google-discovery/src/index.ts +1 −0
  14. packages/codemode-openapi/src/openapi-extraction.ts +134 −1
  15. packages/codemode-openapi/src/openapi-real-spec-coverage.test.ts +342 −0
  16. packages/codemode-openapi/src/openapi-tool-presentation.test.ts +107 −0
  17. packages/codemode-openapi/src/openapi-tool-presentation.ts +91 −12
  18. packages/codemode-openapi/src/openapi-tools.ts +3 −2
  19. packages/control-plane/src/runtime/executor-tools.ts +2 −2
  20. packages/control-plane/src/runtime/fixtures/google-sheets-discovery.json +8314 −0
  21. packages/control-plane/src/runtime/fixtures/linear-introspection.json +129477 −0
  22. packages/control-plane/src/runtime/fixtures/neon-openapi.json +14358 −0
apps/web/src/components/shell.tsx+85−5
@@ -1,7 +1,8 @@
11 import { Link, Outlet, useMatchRoute } from "@tanstack/react-router";
2+import { useCallback, useEffect, useState } from "react";
23 import { useSources, type Source } from "@executor/react";
34 import { cn } from "../lib/utils";
4−import { IconPlus } from "./icons";
5+import { IconPlus, IconCopy, IconCheck } from "./icons";
56 import { LoadableBlock } from "./loadable";
67 import { SourceFavicon } from "./source-favicon";
78
@@ -24,12 +25,86 @@ const { VITE_APP_VERSION, VITE_GITHUB_URL } = (import.meta as ImportMeta & { · 16 unmodified lines
2425 readonly env: AppMetaEnv;
2526 }).env;
2627
28+// ── useLatestVersion ─────────────────────────────────────────────────────
29+
30+function useLatestVersion(currentVersion: string) {
31+ const [latestVersion, setLatestVersion] = useState<string | null>(null);
32+
33+ useEffect(() => {
34+ let cancelled = false;
35+ fetch("https://registry.npmjs.org/executor/latest")
36+ .then((res) => res.json())
37+ .then((data: { version?: string }) => {
38+ if (!cancelled && data.version) setLatestVersion(data.version);
39+ })
40+ .catch(() => {});
41+ return () => {
42+ cancelled = true;
43+ };
44+ }, []);
45+
46+ const updateAvailable =
47+ latestVersion !== null && latestVersion !== currentVersion;
48+
49+ return { latestVersion, updateAvailable };
50+}
51+
52+// ── UpdateCard ───────────────────────────────────────────────────────────
53+
54+function UpdateCard(props: { latestVersion: string }) {
55+ const command = `npm i -g executor@latest`;
56+ const [copied, setCopied] = useState(false);
57+
58+ const handleCopy = useCallback(() => {
59+ void navigator.clipboard.writeText(command).then(() => {
60+ setCopied(true);
61+ setTimeout(() => setCopied(false), 1500);
62+ });
63+ }, [command]);
64+
65+ return (
66+ <div className="mx-2 mb-2 rounded-xl border border-primary/25 bg-primary/[0.06] p-3">
67+ <div className="flex items-center gap-2">
68+ <div className="flex size-5 shrink-0 items-center justify-center rounded-full bg-primary/15">
69+ <svg viewBox="0 0 16 16" fill="none" className="size-3 text-primary">
70+ <path d="M8 3v7M5 7l3 3 3-3" stroke="currentColor" strokeWidth="1.4" strokeLinecap="round" strokeLinejoin="round" />
71+ <path d="M3 12h10" stroke="currentColor" strokeWidth="1.4" strokeLinecap="round" />
72+ </svg>
73+ </div>
74+ <div className="min-w-0">
75+ <p className="text-[11px] font-semibold text-foreground">Update available</p>
76+ <p className="text-[10px] text-muted-foreground">
77+ v{props.latestVersion}
78+ </p>
79+ </div>
80+ </div>
81+ <button
82+ type="button"
83+ onClick={handleCopy}
84+ className="mt-2.5 flex w-full items-center justify-between gap-2 rounded-lg border border-border/60 bg-background/50 px-2.5 py-1.5 text-left transition-colors hover:bg-background/80"
85+ >
86+ <code className="truncate font-mono text-[10px] text-sidebar-foreground">
87+ {command}
88+ </code>
89+ <span className="shrink-0 text-muted-foreground transition-colors group-hover:text-foreground">
90+ {copied ? (
91+ <IconCheck className="size-3 text-primary" />
92+ ) : (
93+ <IconCopy className="size-3" />
94+ )}
95+ </span>
96+ </button>
97+ </div>
98+ );
99+}
100+
27101 // ── AppShell ─────────────────────────────────────────────────────────────
28102 export function AppShell() {
29103 const sources = useSources();
30104 const matchRoute = useMatchRoute();
31105 const isHome = matchRoute({ to: "/" });
32106 const isSecrets = matchRoute({ to: "/secrets" });
107+ const { latestVersion, updateAvailable } = useLatestVersion(VITE_APP_VERSION);
33108 return (
34109 <div className="flex h-screen overflow-hidden">
35110 {/* Sidebar */}
@@ -81,17 +156,22 @@ export function AppShell() { · 45 unmodified lines
81156 </LoadableBlock>
82157 </nav>
83158
159+ {/* Update available */}
160+ {updateAvailable && latestVersion && (
161+ <UpdateCard latestVersion={latestVersion} />
162+ )}
163+
84164 {/* Footer */}
85165 <div className="shrink-0 border-t border-sidebar-border px-4 py-2.5">
86− <div className="flex flex-col items-start gap-1 text-[10px] leading-none">
87− <span className="text-muted-foreground/35">v{VITE_APP_VERSION}</span>
166+ <div className="flex items-center justify-between text-[10px] leading-none">
167+ <span className="text-muted-foreground/70 tabular-nums">v{VITE_APP_VERSION}</span>
88168 <a
89169 href={VITE_GITHUB_URL}
90170 target="_blank"
91171 rel="noreferrer"
92− className="text-muted-foreground/50 transition-colors hover:text-foreground"
172+ className="text-muted-foreground/70 transition-colors hover:text-foreground"
93173 >
94− Star on GitHub
174+ GitHub
95175 </a>
96176 </div>
97177 </div>
apps/web/src/lib/schema-display.ts+121−0
@@ -0,0 +1,121 @@
1+type JsonRecord = Record<string, unknown>;
2+
3+const asRecord = (value: unknown): JsonRecord =>
4+ typeof value === "object" && value !== null && !Array.isArray(value)
5+ ? (value as JsonRecord)
6+ : {};
7+
8+const decodeRefSegment = (segment: string): string =>
9+ segment.replace(/~1/g, "/").replace(/~0/g, "~");
10+
11+const resolveLocalRef = (
12+ root: JsonRecord,
13+ ref: string,
14+): JsonRecord | null => {
15+ if (!ref.startsWith("#/")) {
16+ return null;
17+ }
18+
19+ const segments = ref.slice(2).split("/").map(decodeRefSegment);
20+ let current: unknown = root;
21+ for (const segment of segments) {
22+ const record = asRecord(current);
23+ if (!(segment in record)) {
24+ return null;
25+ }
26+ current = record[segment];
27+ }
28+
29+ const resolved = asRecord(current);
30+ return Object.keys(resolved).length > 0 ? resolved : null;
31+};
32+
33+const expandNodeForDisplay = (
34+ node: unknown,
35+ root: JsonRecord,
36+ depth: number,
37+ seenRefs: ReadonlySet<string>,
38+): unknown => {
39+ const record = asRecord(node);
40+ if (Object.keys(record).length === 0 || depth < 0) {
41+ return node;
42+ }
43+
44+ if (typeof record.$ref === "string") {
45+ const ref = record.$ref;
46+ if (seenRefs.has(ref)) {
47+ return node;
48+ }
49+
50+ const target = resolveLocalRef(root, ref);
51+ if (!target) {
52+ return node;
53+ }
54+
55+ const { $ref: _ignored, ...overlay } = record;
56+ const expandedTarget = asRecord(
57+ expandNodeForDisplay(target, root, depth - 1, new Set([...seenRefs, ref])),
58+ );
59+ return {
60+ ...expandedTarget,
61+ ...overlay,
62+ };
63+ }
64+
65+ const nextDepth = depth - 1;
66+ const expanded: JsonRecord = {};
67+
68+ for (const [key, value] of Object.entries(record)) {
69+ if (key === "$defs") {
70+ expanded[key] = value;
71+ continue;
72+ }
73+
74+ if (key === "properties" || key === "patternProperties") {
75+ const childRecord = asRecord(value);
76+ expanded[key] = Object.fromEntries(
77+ Object.entries(childRecord).map(([childKey, childValue]) => [
78+ childKey,
79+ expandNodeForDisplay(childValue, root, nextDepth, seenRefs),
80+ ]),
81+ );
82+ continue;
83+ }
84+
85+ if (key === "items" || key === "additionalProperties") {
86+ expanded[key] =
87+ typeof value === "boolean"
88+ ? value
89+ : expandNodeForDisplay(value, root, nextDepth, seenRefs);
90+ continue;
91+ }
92+
93+ if (key === "anyOf" || key === "oneOf" || key === "allOf") {
94+ expanded[key] = Array.isArray(value)
95+ ? value.map((entry) => expandNodeForDisplay(entry, root, nextDepth, seenRefs))
96+ : value;
97+ continue;
98+ }
99+
100+ expanded[key] = value;
101+ }
102+
103+ return expanded;
104+};
105+
106+export const formatSchemaJsonForDisplay = (
107+ schemaJson: string | null | undefined,
108+): string | null => {
109+ if (!schemaJson) {
110+ return null;
111+ }
112+
113+ try {
114+ const parsed = JSON.parse(schemaJson) as unknown;
115+ const root = asRecord(parsed);
116+ const expanded = expandNodeForDisplay(root, root, 3, new Set<string>());
117+ return JSON.stringify(expanded, null, 2);
118+ } catch {
119+ return schemaJson;
120+ }
121+};
apps/web/src/views/source-detail.tsx+13−4
@@ -13,6 +13,7 @@ import { · 12 unmodified lines
1313 type SourceInspectionDiscoverResult,
1414 } from "@executor/react";
1515 import { cn } from "../lib/utils";
16+import { formatSchemaJsonForDisplay } from "../lib/schema-display";
1617 import { Badge, MethodBadge } from "../components/ui/badge";
1718 import { Button } from "../components/ui/button";
1819 import { LoadableBlock, EmptyState } from "../components/loadable";
@@ -536,6 +537,14 @@ function ToolListItem(props: { · 517 unmodified lines
536537 function ToolDetailPanel(props: { detail: SourceInspectionToolDetail }) {
537538 const { detail } = props;
538539 const [copiedField, setCopiedField] = useState<string | null>(null);
540+ const displayedCallSchema = useMemo(
541+ () => formatSchemaJsonForDisplay(detail.callSchemaJson),
542+ [detail.callSchemaJson],
543+ );
544+ const displayedResultSchema = useMemo(
545+ () => formatSchemaJsonForDisplay(detail.resultSchemaJson),
546+ [detail.resultSchemaJson],
547+ );
539548
540549 const copy = useCallback((text: string, field: string) => {
541550 void navigator.clipboard.writeText(text).then(() => {
@@ -581,14 +590,14 @@ function ToolDetailPanel(props: { detail: SourceInspectionToolDetail }) { · 39 unmodified lines
581590
582591 {/* Type signatures */}
583592 <div className="grid grid-cols-1 gap-3 xl:grid-cols-2">
584− <DocumentPanel title="Input" body={detail.summary.inputType ?? null} lang="typescript" empty="No input." />
585− <DocumentPanel title="Output" body={detail.summary.outputType ?? null} lang="typescript" empty="No output." />
593+ <DocumentPanel title="Input" body={detail.summary.fullInputType ?? null} lang="typescript" empty="No input." />
594+ <DocumentPanel title="Output" body={detail.summary.fullOutputType ?? null} lang="typescript" empty="No output." />
586595 </div>
587596
588597 {/* Schemas */}
589598 <div className="grid grid-cols-1 gap-2 xl:grid-cols-2">
590− <DocumentPanel title="Input schema" body={detail.callSchemaJson} empty="No input schema." compact />
591− <DocumentPanel title="Output schema" body={detail.resultSchemaJson} empty="No output schema." compact />
599+ <DocumentPanel title="Input schema" body={displayedCallSchema} empty="No input schema." compact />
600+ <DocumentPanel title="Output schema" body={displayedResultSchema} empty="No output schema." compact />
592601 {detail.exampleCallJson && (
593602 <DocumentPanel title="Example request" body={detail.exampleCallJson} empty="" compact />
594603 )}
packages/ai-sdk-adapter/src/example-dynamic.ts+4−4
@@ -21,8 +21,8 @@ const catalog: ToolCatalog = { · 20 unmodified lines
2121 path: asToolPath("source.src_api.github.issues.list"),
2222 sourceKey: "source.src_api",
2323 description: "Hydrated metadata for selected path",
24− inputType: "object",
25− outputType: "object",
24+ previewInputType: "object",
25+ previewOutputType: "object",
2626 },
2727 ].filter((tool) => !namespace || tool.path.startsWith(`source.${namespace}.`)));
2828 },
@@ -31,8 +31,8 @@ const catalog: ToolCatalog = { · 2 unmodified lines
3131 path,
3232 sourceKey: "source.src_api",
3333 description: "Hydrated metadata for selected path",
34− inputType: "object",
35− outputType: "object",
34+ previewInputType: "object",
35+ previewOutputType: "object",
3636 });
3737 },
3838 searchTools({ limit }) {
packages/codemode-core/src/discovery.ts+4−4
@@ -27,8 +27,8 @@ const searchableTextForTool = (tool: ToolDescriptor): string => · 26 unmodified lines
2727 tool.path,
2828 tool.sourceKey,
2929 tool.description ?? "",
30− tool.inputType ?? "",
31− tool.outputType ?? "",
30+ tool.previewInputType ?? "",
31+ tool.previewOutputType ?? "",
3232 ]
3333 .join(" ")
3434 .toLowerCase();
@@ -383,8 +383,8 @@ export function createDiscoveryPrimitivesFromToolCatalog(input: { · 348 unmodified lines
383383 score: hit.score,
384384 description: descriptor.description,
385385 interaction: descriptor.interaction ?? "auto",
386− inputType: descriptor.inputType,
387− outputType: descriptor.outputType,
386+ previewInputType: descriptor.previewInputType,
387+ previewOutputType: descriptor.previewOutputType,
388388 ...(includeSchemas
389389 ? {
390390 inputSchema: descriptor.inputSchema,
packages/codemode-core/src/index.test.ts+8−8
@@ -288,16 +288,16 @@ describe("codemode-core", () => { · 287 unmodified lines
288288 path: asToolPath("source.docs.search"),
289289 sourceKey: "source.docs",
290290 description: "Search docs",
291− inputType: "object",
292− outputType: "object",
291+ previewInputType: "object",
292+ previewOutputType: "object",
293293 },
294294 "source.issues.create": {
295295 path: asToolPath("source.issues.create"),
296296 sourceKey: "source.issues",
297297 description: "Create issue",
298298 interaction: "required",
299− inputType: "object",
300− outputType: "object",
299+ previewInputType: "object",
300+ previewOutputType: "object",
301301 },
302302 };
303303
@@ -366,8 +366,8 @@ describe("codemode-core", () => { · 62 unmodified lines
366366 path: asToolPath("github.repos.getRepo"),
367367 sourceKey: "source.github",
368368 description: "Get repository details",
369− inputType: "{ owner: string; repo: string }",
370− outputType: "Repository",
369+ previewInputType: "{ owner: string; repo: string }",
370+ previewOutputType: "Repository",
371371 inputSchema: { type: "object" },
372372 },
373373 },
@@ -382,8 +382,8 @@ describe("codemode-core", () => { · 8 unmodified lines
382382 path: asToolPath("github.issues.list"),
383383 sourceKey: "source.github",
384384 description: "List repository issues",
385− inputType: "{ owner: string; repo: string }",
386− outputType: "Issue[]",
385+ previewInputType: "{ owner: string; repo: string }",
386+ previewOutputType: "Issue[]",
387387 },
388388 },
389389 ],
packages/codemode-core/src/schema-types.test.ts+98−0
@@ -0,0 +1,98 @@
1+import { describe, expect, it } from "@effect/vitest";
2+
3+import { typeSignatureFromSchema } from "./schema-types";
4+
5+describe("schema-types", () => {
6+ it("expands local $defs refs in type signatures", () => {
7+ const schema = {
8+ type: "object",
9+ properties: {
10+ args: {
11+ type: "object",
12+ properties: {
13+ input: {
14+ $ref: "#/$defs/input",
15+ },
16+ },
17+ required: ["input"],
18+ additionalProperties: false,
19+ },
20+ },
21+ required: ["args"],
22+ additionalProperties: false,
23+ $defs: {
24+ input: {
25+ type: "object",
26+ properties: {
27+ issueId: {
28+ type: "string",
29+ },
30+ externalLink: {
31+ type: "string",
32+ },
33+ },
34+ required: ["issueId"],
35+ additionalProperties: false,
36+ },
37+ },
38+ };
39+
40+ expect(typeSignatureFromSchema(schema, "unknown", Infinity)).toBe(
41+ "{ args: { input: { issueId: string, externalLink?: string } } }",
42+ );
43+ });
44+
45+ it("renders GraphQL error arrays with object item shapes", () => {
46+ const schema = {
47+ type: "object",
48+ properties: {
49+ data: {
50+ type: "object",
51+ properties: {
52+ success: {
53+ type: "boolean",
54+ },
55+ },
56+ required: ["success"],
57+ additionalProperties: false,
58+ },
59+ errors: {
60+ type: "array",
61+ items: {
62+ type: "object",
63+ properties: {
64+ message: {
65+ type: "string",
66+ },
67+ },
68+ required: ["message"],
69+ additionalProperties: true,
70+ },
71+ },
72+ },
73+ required: ["data", "errors"],
74+ additionalProperties: false,
75+ };
76+
77+ expect(typeSignatureFromSchema(schema, "unknown", Infinity)).toContain(
78+ "errors: { message: string }[]",
79+ );
80+ });
81+
82+ it("quotes invalid object property names", () => {
83+ const schema = {
84+ type: "object",
85+ properties: {
86+ "x-request-id": {
87+ type: "string",
88+ },
89+ },
90+ required: ["x-request-id"],
91+ additionalProperties: false,
92+ };
93+
94+ expect(typeSignatureFromSchema(schema, "unknown", Infinity)).toBe(
95+ '{ "x-request-id": string }',
96+ );
97+ });
98+});
packages/codemode-core/src/schema-types.ts+165−56
@@ -1,5 +1,11 @@
11 type JsonSchemaRecord = Record<string, unknown>;
22
3+export type TypeSignatureRenderOptions = {
4+ maxLength?: number;
5+ maxDepth?: number;
6+ maxProperties?: number;
7+};
8+
39 const asRecord = (value: unknown): JsonSchemaRecord =>
410 typeof value === "object" && value !== null && !Array.isArray(value)
511 ? (value as JsonSchemaRecord)
@@ -15,17 +21,15 @@ const truncate = (value: string, maxLength: number): string => · 9 unmodified lines
1521 ? value
1622 : `${value.slice(0, Math.max(0, maxLength - 4))} ...`;
1723
18−const propertyLabel = (
19− name: string,
20− schema: JsonSchemaRecord,
21− optional: boolean,
22− maxLength: number,
23−): string =>
24− `${name}${optional ? "?" : ""}: ${schemaToTypeSignature(schema, maxLength)}`;
24+const VALID_IDENTIFIER_PATTERN = /^[A-Za-z_$][A-Za-z0-9_$]*$/;
25+
26+const formatPropertyKey = (value: string): string =>
27+ VALID_IDENTIFIER_PATTERN.test(value) ? value : JSON.stringify(value);
2528
2629 const compositeLabel = (
2730 key: "oneOf" | "anyOf" | "allOf",
2831 schema: JsonSchemaRecord,
32+ render: (input: unknown) => string,
2933 maxLength: number,
3034 ): string | null => {
3135 const items = Array.isArray(schema[key]) ? schema[key].map(asRecord) : [];
@@ -34,7 +38,7 @@ const compositeLabel = ( · 2 unmodified lines
3438 }
3539
3640 const labels = items
37− .map((item) => schemaToTypeSignature(item, maxLength))
41+ .map((item) => render(item))
3842 .filter((label) => label.length > 0);
3943
4044 if (labels.length === 0) {
@@ -44,70 +48,159 @@ const compositeLabel = ( · 3 unmodified lines
4448 return labels.join(key === "allOf" ? " & " : " | ");
4549 };
4650
47−export const schemaToTypeSignature = (
48− input: unknown,
49− maxLength: number = 220,
50−): string => {
51− const schema = asRecord(input);
52−
53− if (typeof schema.$ref === "string") {
54− const ref = schema.$ref.trim();
55− return ref.length > 0 ? ref.split("/").at(-1) ?? ref : "unknown";
51+const refSegments = (ref: string): Array<string> | null => {
52+ if (!ref.startsWith("#/")) {
53+ return null;
5654 }
5755
58− if ("const" in schema) {
59− return JSON.stringify(schema.const);
60− }
56+ return ref
57+ .slice(2)
58+ .split("/")
59+ .map((segment) => segment.replace(/~1/g, "/").replace(/~0/g, "~"));
60+};
6161
62− const enumValues = Array.isArray(schema.enum) ? schema.enum : [];
63− if (enumValues.length > 0) {
64− return truncate(
65− enumValues.map((value) => JSON.stringify(value)).join(" | "),
66− maxLength,
67− );
62+const resolveLocalRef = (
63+ root: JsonSchemaRecord,
64+ ref: string,
65+): JsonSchemaRecord | null => {
66+ const segments = refSegments(ref);
67+ if (!segments || segments.length === 0) {
68+ return null;
6869 }
6970
70− const composite =
71− compositeLabel("oneOf", schema, maxLength)
72− ?? compositeLabel("anyOf", schema, maxLength)
73− ?? compositeLabel("allOf", schema, maxLength);
74− if (composite) {
75− return truncate(composite, maxLength);
71+ let current: unknown = root;
72+ for (const segment of segments) {
73+ const record = asRecord(current);
74+ if (!(segment in record)) {
75+ return null;
76+ }
77+ current = record[segment];
7678 }
7779
78− if (schema.type === "array") {
79− const itemLabel = schema.items
80− ? schemaToTypeSignature(schema.items, maxLength)
81− : "unknown";
82− return truncate(`${itemLabel}[]`, maxLength);
83− }
80+ const resolved = asRecord(current);
81+ return Object.keys(resolved).length > 0 ? resolved : null;
82+};
83+
84+const refFallbackLabel = (ref: string): string => {
85+ const segments = refSegments(ref);
86+ return segments?.at(-1) ?? ref;
87+};
8488
85− if (schema.type === "object" || schema.properties) {
86− const properties = asRecord(schema.properties);
87− const keys = Object.keys(properties);
88− if (keys.length === 0) {
89− return schema.additionalProperties ? "Record<string, unknown>" : "object";
89+export const schemaToTypeSignatureWithOptions = (
90+ input: unknown,
91+ options: TypeSignatureRenderOptions = {},
92+): string => {
93+ const root = asRecord(input);
94+ const maxLength = options.maxLength ?? 220;
95+ const boundedSummary = Number.isFinite(maxLength);
96+ const maxDepth = options.maxDepth ?? (boundedSummary ? 4 : Number.POSITIVE_INFINITY);
97+ const maxProperties = options.maxProperties ?? (boundedSummary ? 6 : Number.POSITIVE_INFINITY);
98+
99+ const render = (
100+ currentInput: unknown,
101+ seenRefs: ReadonlySet<string>,
102+ depthRemaining: number,
103+ ): string => {
104+ const schema = asRecord(currentInput);
105+
106+ if (depthRemaining <= 0) {
107+ if (typeof schema.title === "string" && schema.title.length > 0) {
108+ return schema.title;
109+ }
110+
111+ if (schema.type === "array") {
112+ return "unknown[]";
113+ }
114+
115+ if (schema.type === "object" || schema.properties) {
116+ return schema.additionalProperties ? "Record<string, unknown>" : "object";
117+ }
90118 }
91119
92− const required = new Set(asStringArray(schema.required));
93− const parts = keys.map((key) =>
94− propertyLabel(key, asRecord(properties[key]), !required.has(key), maxLength)
95− );
120+ if (typeof schema.$ref === "string") {
121+ const ref = schema.$ref.trim();
122+ if (ref.length === 0) {
123+ return "unknown";
124+ }
96125
97− return truncate(`{ ${parts.join(", ")} }`, maxLength);
98− }
126+ if (seenRefs.has(ref)) {
127+ return refFallbackLabel(ref);
128+ }
99129
100− if (Array.isArray(schema.type)) {
101− return truncate(schema.type.join(" | "), maxLength);
102− }
130+ const target = resolveLocalRef(root, ref);
131+ if (!target) {
132+ return refFallbackLabel(ref);
133+ }
103134
104− if (typeof schema.type === "string") {
105− return schema.type;
106− }
135+ return render(target, new Set([...seenRefs, ref]), depthRemaining - 1);
136+ }
137+
138+ if ("const" in schema) {
139+ return JSON.stringify(schema.const);
140+ }
141+
142+ const enumValues = Array.isArray(schema.enum) ? schema.enum : [];
143+ if (enumValues.length > 0) {
144+ return truncate(
145+ enumValues.map((value) => JSON.stringify(value)).join(" | "),
146+ maxLength,
147+ );
148+ }
107149
108− return "unknown";
150+ const composite =
151+ compositeLabel("oneOf", schema, (value) => render(value, seenRefs, depthRemaining - 1), maxLength)
152+ ?? compositeLabel("anyOf", schema, (value) => render(value, seenRefs, depthRemaining - 1), maxLength)
153+ ?? compositeLabel("allOf", schema, (value) => render(value, seenRefs, depthRemaining - 1), maxLength);
154+ if (composite) {
155+ return truncate(composite, maxLength);
156+ }
157+
158+ if (schema.type === "array") {
159+ const itemLabel = schema.items
160+ ? render(schema.items, seenRefs, depthRemaining - 1)
161+ : "unknown";
162+ return truncate(`${itemLabel}[]`, maxLength);
163+ }
164+
165+ if (schema.type === "object" || schema.properties) {
166+ const properties = asRecord(schema.properties);
167+ const keys = Object.keys(properties);
168+ if (keys.length === 0) {
169+ return schema.additionalProperties ? "Record<string, unknown>" : "object";
170+ }
171+
172+ const required = new Set(asStringArray(schema.required));
173+ const visibleKeys = keys.slice(0, maxProperties);
174+ const parts = visibleKeys.map((key) =>
175+ `${formatPropertyKey(key)}${required.has(key) ? "" : "?"}: ${render(properties[key], seenRefs, depthRemaining - 1)}`
176+ );
177+ if (visibleKeys.length < keys.length) {
178+ parts.push("...");
179+ }
180+
181+ return truncate(`{ ${parts.join(", ")} }`, maxLength);
182+ }
183+
184+ if (Array.isArray(schema.type)) {
185+ return truncate(schema.type.join(" | "), maxLength);
186+ }
187+
188+ if (typeof schema.type === "string") {
189+ return schema.type;
190+ }
191+
192+ return "unknown";
193+ };
194+
195+ return render(root, new Set(), maxDepth);
109196 };
110197
198+export const schemaToTypeSignature = (
199+ input: unknown,
200+ maxLength: number = 220,
201+): string =>
202+ schemaToTypeSignatureWithOptions(input, { maxLength });
203+
111204 export const typeSignatureFromSchemaJson = (
112205 schemaJson: string | undefined,
113206 fallback: string,
@@ -139,3 +232,19 @@ export const typeSignatureFromSchema = ( · 25 unmodified lines
139232 return fallback;
140233 }
141234 };
235+
236+export const typeSignatureFromSchemaWithOptions = (
237+ schema: unknown,
238+ fallback: string,
239+ options: TypeSignatureRenderOptions = {},
240+): string => {
241+ if (schema === undefined) {
242+ return fallback;
243+ }
244+
245+ try {
246+ return schemaToTypeSignatureWithOptions(schema, options);
247+ } catch {
248+ return fallback;
249+ }
250+};
packages/codemode-core/src/tool-map.ts+4−4
@@ -432,10 +432,10 @@ export function toolDescriptorsFromTools(input: { · 431 unmodified lines
432432 description: definition.description,
433433 interaction: metadata?.interaction,
434434 elicitation: metadata?.elicitation,
435− inputType:
436− metadata?.inputType ?? inferTypeFromSchemaValue(inputSchema, "unknown"),
437− outputType:
438− metadata?.outputType ?? inferTypeFromSchemaValue(outputSchema, "unknown"),
435+ previewInputType:
436+ metadata?.previewInputType ?? inferTypeFromSchemaValue(inputSchema, "unknown"),
437+ previewOutputType:
438+ metadata?.previewOutputType ?? inferTypeFromSchemaValue(outputSchema, "unknown"),
439439 ...(inputSchema !== undefined ? { inputSchema } : {}),
440440 ...(outputSchema !== undefined ? { outputSchema } : {}),
441441 ...(metadata?.exampleInput !== undefined
packages/codemode-core/src/types.ts+6−6
@@ -78,8 +78,8 @@ export type OnElicitation = ( · 77 unmodified lines
7878 export type ToolMetadata = {
7979 interaction?: "auto" | "required";
8080 elicitation?: ElicitationRequest;
81− inputType?: string;
82− outputType?: string;
81+ previewInputType?: string;
82+ previewOutputType?: string;
8383 inputSchema?: unknown;
8484 outputSchema?: unknown;
8585 exampleInput?: unknown;
@@ -131,8 +131,8 @@ export type ToolDescriptor = { · 45 unmodified lines
131131 description?: string;
132132 interaction?: "auto" | "required";
133133 elicitation?: ElicitationRequest;
134− inputType?: string;
135− outputType?: string;
134+ previewInputType?: string;
135+ previewOutputType?: string;
136136 inputSchema?: unknown;
137137 outputSchema?: unknown;
138138 exampleInput?: unknown;
@@ -149,8 +149,8 @@ export const ToolDescriptorSchema = Schema.Struct({ · 10 unmodified lines
149149 Schema.Union(Schema.Literal("auto"), Schema.Literal("required")),
150150 ),
151151 elicitation: Schema.optional(Schema.Unknown),
152− inputType: Schema.optional(Schema.String),
153− outputType: Schema.optional(Schema.String),
152+ previewInputType: Schema.optional(Schema.String),
153+ previewOutputType: Schema.optional(Schema.String),
154154 inputSchema: Schema.optional(Schema.Unknown),
155155 outputSchema: Schema.optional(Schema.Unknown),
156156 exampleInput: Schema.optional(Schema.Unknown),
packages/codemode-google-discovery/src/google-discovery-tools.test.ts+46−0
@@ -6,6 +6,7 @@ import { makeToolInvokerFromTools } from "@executor/codemode-core"; · 5 unmodified lines
66 import * as Effect from "effect/Effect";
77
88 import {
9+ buildGoogleDiscoveryToolPresentation,
910 compileGoogleDiscoveryToolDefinitions,
1011 createGoogleDiscoveryToolFromDefinition,
1112 extractGoogleDiscoveryManifest,
@@ -124,6 +125,51 @@ describe("google discovery tools", () => { · 112 unmodified lines
124125 );
125126 }).pipe(Effect.runPromise));
126127
128+ it("materializes schema refs for projected tool presentation from a real Google discovery document", () =>
129+ Effect.gen(function* () {
130+ const discoveryDocument = yield* Effect.tryPromise({
131+ try: () =>
132+ fetchLiveDiscoveryDocument(
133+ "https://www.googleapis.com/discovery/v1/apis/sheets/v4/rest",
134+ ),
135+ catch: (cause) =>
136+ cause instanceof Error ? cause : new Error(String(cause)),
137+ });
138+
139+ const manifest = yield* extractGoogleDiscoveryManifest(
140+ "Google Sheets",
141+ discoveryDocument,
142+ );
143+ const definitions = compileGoogleDiscoveryToolDefinitions(manifest);
144+ const batchUpdate = definitions.find(
145+ (definition) => definition.toolId === "spreadsheets.batchUpdate",
146+ );
147+
148+ expect(batchUpdate).toBeDefined();
149+
150+ const presentation = buildGoogleDiscoveryToolPresentation({
151+ manifest,
152+ definition: batchUpdate!,
153+ });
154+
155+ expect(presentation.previewInputType).toContain("spreadsheetId: string");
156+ expect(presentation.previewInputType).toContain("repeatCell?");
157+ expect(presentation.previewOutputType).toContain("spreadsheetId");
158+ expect(presentation.inputSchema).toMatchObject({
159+ type: "object",
160+ properties: {
161+ spreadsheetId: {
162+ type: "string",
163+ },
164+ body: {
165+ type: "object",
166+ },
167+ },
168+ });
169+ expect(JSON.stringify(presentation.inputSchema)).toContain("\"repeatCell\"");
170+ expect(JSON.stringify(presentation.outputSchema)).toContain("\"spreadsheetId\"");
171+ }).pipe(Effect.runPromise));
172+
127173 it("invokes a tool compiled from a real Google discovery document", () =>
128174 Effect.tryPromise({
129175 try: async () => {
packages/codemode-google-discovery/src/google-discovery-tools.ts+72−23
@@ -9,6 +9,7 @@ import { · 8 unmodified lines
99 applyHttpQueryPlacementsToUrl,
1010 applyJsonBodyPlacements,
1111 standardSchemaFromJsonSchema,
12+ typeSignatureFromSchema,
1213 toTool,
1314 type HttpRequestPlacements,
1415 type ToolMetadata,
@@ -356,44 +357,92 @@ export type CreateGoogleDiscoveryToolFromDefinitionInput = { · 341 unmodified lines
356357 httpClientLayer?: Layer.Layer<HttpClient.HttpClient, never, never>;
357358 };
358359
360+export type GoogleDiscoveryToolPresentation = {
361+ previewInputType: string;
362+ previewOutputType: string;
363+ inputSchema?: unknown;
364+ outputSchema?: unknown;
365+ providerData: typeof GoogleDiscoveryToolProviderDataSchema.Type;
366+};
367+
368+export const buildGoogleDiscoveryToolPresentation = (input: {
369+ manifest: {
370+ service: string;
371+ versionName: string;
372+ rootUrl: string;
373+ servicePath: string;
374+ schemaRefTable?: Readonly<GoogleDiscoverySchemaRefTable>;
375+ };
376+ definition: GoogleDiscoveryToolDefinition;
377+}): GoogleDiscoveryToolPresentation => {
378+ const refTable = Object.fromEntries(
379+ Object.entries(input.manifest.schemaRefTable ?? {}).map(([ref, value]) => {
380+ try {
381+ return [ref, JSON.parse(value) as unknown];
382+ } catch {
383+ return [ref, value];
384+ }
385+ }),
386+ );
387+ const inputSchema =
388+ input.definition.inputSchema === undefined
389+ ? undefined
390+ : materializeSchemaWithRefDefinitions({
391+ schema: input.definition.inputSchema,
392+ refTable,
393+ });
394+ const outputSchema =
395+ input.definition.outputSchema === undefined
396+ ? undefined
397+ : materializeSchemaWithRefDefinitions({
398+ schema: input.definition.outputSchema,
399+ refTable,
400+ });
401+
402+ return {
403+ previewInputType: typeSignatureFromSchema(inputSchema, "unknown", Infinity),
404+ previewOutputType: typeSignatureFromSchema(outputSchema, "unknown", Infinity),
405+ ...(inputSchema !== undefined ? { inputSchema } : {}),
406+ ...(outputSchema !== undefined ? { outputSchema } : {}),
407+ providerData: googleDiscoveryProviderDataFromDefinition({
408+ service: input.manifest.service,
409+ version: input.manifest.versionName,
410+ rootUrl: input.manifest.rootUrl,
411+ servicePath: input.manifest.servicePath,
412+ definition: input.definition,
413+ }),
414+ };
415+};
416+
359417 export const createGoogleDiscoveryToolFromDefinition = (
360418 input: CreateGoogleDiscoveryToolFromDefinitionInput,
361419 ) => {
362− const providerData = googleDiscoveryProviderDataFromDefinition({
363− service: input.service,
364− version: input.version,
365− rootUrl: input.rootUrl,
366− servicePath: input.servicePath,
420+ const presentation = buildGoogleDiscoveryToolPresentation({
421+ manifest: {
422+ service: input.service,
423+ versionName: input.version,
424+ rootUrl: input.rootUrl,
425+ servicePath: input.servicePath,
426+ schemaRefTable: input.schemaRefTable,
427+ },
367428 definition: input.definition,
368429 });
430+ const providerData = presentation.providerData;
369431 const credentialPlacements = normalizeCredentialPlacements({
370432 credentialHeaders: input.credentialHeaders,
371433 credentialPlacements: input.credentialPlacements,
372434 });
373435 const httpClientLayer = input.httpClientLayer ?? FetchHttpClient.layer;
374− const refTable = Object.fromEntries(
375− Object.entries(input.schemaRefTable ?? {}).map(([ref, value]) => {
376− try {
377− return [ref, JSON.parse(value) as unknown];
378− } catch {
379− return [ref, value];
380− }
381− }),
382− );
383− const inputSchema = materializeSchemaWithRefDefinitions({
384− schema: input.definition.inputSchema,
385− refTable,
386− });
387436
388437 const metadata: ToolMetadata = {
389438 interaction: input.definition.method === "get" || input.definition.method === "head"
390439 ? "auto"
391440 : "required",
392− ...(input.definition.inputSchema !== undefined
393− ? { inputSchema: input.definition.inputSchema }
441+ ...(presentation.inputSchema !== undefined
442+ ? { inputSchema: presentation.inputSchema }
394443 : {}),
395− ...(input.definition.outputSchema !== undefined
396− ? { outputSchema: input.definition.outputSchema }
444+ ...(presentation.outputSchema !== undefined
445+ ? { outputSchema: presentation.outputSchema }
397446 : {}),
398447 sourceKey: input.sourceKey,
399448 providerKind: "google_discovery",
@@ -403,7 +452,7 @@ export const createGoogleDiscoveryToolFromDefinition = ( · 3 unmodified lines
403452 return toTool({
404453 tool: {
405454 description: input.definition.description ?? undefined,
406− inputSchema: standardSchemaFromJsonSchema(inputSchema),
455+ inputSchema: standardSchemaFromJsonSchema(presentation.inputSchema ?? {}),
407456 execute: (args: unknown) =>
408457 Effect.runPromise(
409458 Effect.gen(function* () {
packages/codemode-google-discovery/src/index.ts+1−0
@@ -3,6 +3,7 @@ export { · 2 unmodified lines
33 compileGoogleDiscoveryToolDefinitions,
44 } from "./google-discovery-document";
55 export {
6+ buildGoogleDiscoveryToolPresentation,
67 createGoogleDiscoveryToolFromDefinition,
78 decodeGoogleDiscoverySchemaRefTableJson,
89 googleDiscoveryProviderDataFromDefinition,
packages/codemode-openapi/src/openapi-extraction.ts+134−1
@@ -4,9 +4,12 @@ import { pipe } from "effect/Function"; · 3 unmodified lines
44 import * as ParseResult from "effect/ParseResult";
55 import * as Schema from "effect/Schema";
66
7+import { parseOpenApiDocument } from "./openapi-document";
78 import { extractOpenApiManifestJsonWithWasm } from "./openapi-extractor-wasm";
89 import {
910 OpenApiToolManifestSchema,
11+ type OpenApiExtractedTool,
12+ type OpenApiJsonObject,
1013 type OpenApiSpecInput,
1114 type OpenApiToolManifest,
1215 } from "./openapi-types";
@@ -59,6 +62,129 @@ const normalizeOpenApiDocumentText = ( · 46 unmodified lines
5962 });
6063 };
6164
65+const asObject = (value: unknown): Record<string, unknown> =>
66+ value !== null && typeof value === "object" && !Array.isArray(value)
67+ ? (value as Record<string, unknown>)
68+ : {};
69+
70+const resolvePointerSegment = (segment: string): string =>
71+ segment.replaceAll("~1", "/").replaceAll("~0", "~");
72+
73+const resolveLocalRef = (
74+ document: OpenApiJsonObject,
75+ value: unknown,
76+ activeRefs: ReadonlySet<string> = new Set<string>(),
77+): unknown => {
78+ const object = asObject(value);
79+ const ref = typeof object.$ref === "string" ? object.$ref : null;
80+ if (!ref || !ref.startsWith("#/") || activeRefs.has(ref)) {
81+ return value;
82+ }
83+
84+ const resolved = ref
85+ .slice(2)
86+ .split("/")
87+ .reduce<unknown>((current, segment) => {
88+ if (current === undefined || current === null) {
89+ return undefined;
90+ }
91+
92+ return asObject(current)[resolvePointerSegment(segment)];
93+ }, document);
94+
95+ if (resolved === undefined) {
96+ return value;
97+ }
98+
99+ const nextActiveRefs = new Set(activeRefs);
100+ nextActiveRefs.add(ref);
101+
102+ const resolvedObject = asObject(resolveLocalRef(document, resolved, nextActiveRefs));
103+ const { $ref: _ignoredRef, ...rest } = object;
104+
105+ return Object.keys(rest).length > 0
106+ ? { ...resolvedObject, ...rest }
107+ : resolvedObject;
108+};
109+
110+const contentSchemaFromOperationContent = (
111+ content: unknown,
112+): unknown | undefined => {
113+ const entries = Object.entries(asObject(content));
114+ const preferredEntry = entries.find(([mediaType]) => mediaType === "application/json")
115+ ?? entries.find(([mediaType]) => mediaType.toLowerCase().includes("+json"))
116+ ?? entries.find(([mediaType]) => mediaType.toLowerCase().includes("json"));
117+
118+ return preferredEntry ? asObject(preferredEntry[1]).schema : undefined;
119+};
120+
121+const requestBodySchemaForTool = (
122+ document: OpenApiJsonObject,
123+ tool: OpenApiExtractedTool,
124+): unknown | undefined => {
125+ const operation = asObject(
126+ asObject(asObject(document.paths)[tool.path])[tool.method],
127+ );
128+ if (Object.keys(operation).length === 0) {
129+ return undefined;
130+ }
131+
132+ const requestBody = resolveLocalRef(document, operation.requestBody);
133+ return contentSchemaFromOperationContent(asObject(requestBody).content);
134+};
135+
136+const responseSchemaForTool = (
137+ document: OpenApiJsonObject,
138+ tool: OpenApiExtractedTool,
139+): unknown | undefined => {
140+ const operation = asObject(
141+ asObject(asObject(document.paths)[tool.path])[tool.method],
142+ );
143+ if (Object.keys(operation).length === 0) {
144+ return undefined;
145+ }
146+
147+ const responseEntries = Object.entries(asObject(operation.responses));
148+ const preferredResponses = responseEntries
149+ .filter(([status]) => /^2\d\d$/.test(status))
150+ .sort(([left], [right]) => left.localeCompare(right));
151+ const fallbackResponses = responseEntries.filter(([status]) => status === "default");
152+
153+ for (const [, responseValue] of [...preferredResponses, ...fallbackResponses]) {
154+ const response = resolveLocalRef(document, responseValue);
155+ const schema = contentSchemaFromOperationContent(asObject(response).content);
156+ if (schema !== undefined) {
157+ return schema;
158+ }
159+ }
160+
161+ return undefined;
162+};
163+
164+const enrichManifestFromDocument = (
165+ document: OpenApiJsonObject,
166+ manifest: OpenApiToolManifest,
167+): OpenApiToolManifest => ({
168+ ...manifest,
169+ tools: manifest.tools.map((tool) => {
170+ const inputSchema = tool.typing?.inputSchema ?? requestBodySchemaForTool(document, tool);
171+ const outputSchema = tool.typing?.outputSchema ?? responseSchemaForTool(document, tool);
172+
173+ if (inputSchema === undefined && outputSchema === undefined) {
174+ return tool;
175+ }
176+
177+ return {
178+ ...tool,
179+ typing: {
180+ ...(tool.typing ?? {}),
181+ ...(inputSchema !== undefined ? { inputSchema } : {}),
182+ ...(outputSchema !== undefined ? { outputSchema } : {}),
183+ },
184+ };
185+ }),
186+});
187+
62188 export const extractOpenApiManifest = (
63189 sourceName: string,
64190 openApiSpec: OpenApiSpecInput,
@@ -74,8 +200,15 @@ export const extractOpenApiManifest = ( · 9 unmodified lines
74200 catch: (cause) => toExtractionError(sourceName, "extract", cause),
75201 });
76202
77− return yield* pipe(
203+ const manifest = yield* pipe(
78204 decodeManifestFromJson(manifestJson),
79205 Effect.mapError((cause) => toExtractionError(sourceName, "extract", cause)),
80206 );
207+
208+ const parsedDocument = yield* Effect.try({
209+ try: () => parseOpenApiDocument(openApiDocumentText),
210+ catch: (cause) => toExtractionError(sourceName, "validate", cause),
211+ });
212+
213+ return enrichManifestFromDocument(parsedDocument, manifest);
81214 });
packages/codemode-openapi/src/openapi-real-spec-coverage.test.ts+342−0
@@ -0,0 +1,342 @@
1+import { readFileSync } from "node:fs";
2+
3+import { describe, expect, it } from "@effect/vitest";
4+import * as Effect from "effect/Effect";
5+
6+import { compileOpenApiToolDefinitions } from "./openapi-definitions";
7+import { parseOpenApiDocument } from "./openapi-document";
8+import { extractOpenApiManifest } from "./openapi-extraction";
9+import { buildOpenApiToolPresentation } from "./openapi-tool-presentation";
10+import type {
11+ OpenApiExtractedTool,
12+ OpenApiJsonObject,
13+ OpenApiToolManifest,
14+} from "./openapi-types";
15+
16+const readFixture = (name: string): string =>
17+ readFileSync(
18+ new URL(`../../control-plane/src/runtime/fixtures/${name}`, import.meta.url),
19+ "utf8",
20+ );
21+
22+const asObject = (value: unknown): Record<string, unknown> =>
23+ value !== null && typeof value === "object" && !Array.isArray(value)
24+ ? (value as Record<string, unknown>)
25+ : {};
26+
27+const pointerSegment = (segment: string): string =>
28+ segment.replaceAll("~1", "/").replaceAll("~0", "~");
29+
30+const resolveLocalRef = (
31+ document: OpenApiJsonObject,
32+ value: unknown,
33+ activeRefs: ReadonlySet<string> = new Set<string>(),
34+): unknown => {
35+ const object = asObject(value);
36+ const ref = typeof object.$ref === "string" ? object.$ref : null;
37+ if (!ref || !ref.startsWith("#/") || activeRefs.has(ref)) {
38+ return value;
39+ }
40+
41+ const resolved = ref
42+ .slice(2)
43+ .split("/")
44+ .reduce<unknown>((current, segment) => {
45+ if (current === undefined || current === null) {
46+ return undefined;
47+ }
48+
49+ return asObject(current)[pointerSegment(segment)];
50+ }, document);
51+
52+ if (resolved === undefined) {
53+ return value;
54+ }
55+
56+ const nextActiveRefs = new Set(activeRefs);
57+ nextActiveRefs.add(ref);
58+ const resolvedObject = asObject(resolveLocalRef(document, resolved, nextActiveRefs));
59+ const { $ref: _ignoredRef, ...rest } = object;
60+
61+ return Object.keys(rest).length > 0
62+ ? { ...resolvedObject, ...rest }
63+ : resolvedObject;
64+};
65+
66+const jsonContentSchema = (
67+ content: unknown,
68+): unknown | undefined => {
69+ const entries = Object.entries(asObject(content));
70+ const preferredEntry = entries.find(([mediaType]) => mediaType === "application/json")
71+ ?? entries.find(([mediaType]) => mediaType.toLowerCase().includes("+json"))
72+ ?? entries.find(([mediaType]) => mediaType.toLowerCase().includes("json"));
73+
74+ return preferredEntry ? asObject(preferredEntry[1]).schema : undefined;
75+};
76+
77+const operationForTool = (
78+ document: OpenApiJsonObject,
79+ tool: OpenApiExtractedTool,
80+): Record<string, unknown> =>
81+ asObject(asObject(asObject(document.paths)[tool.path])[tool.method]);
82+
83+const requestBodySchemaForTool = (
84+ document: OpenApiJsonObject,
85+ tool: OpenApiExtractedTool,
86+): unknown | undefined => {
87+ const requestBody = resolveLocalRef(document, operationForTool(document, tool).requestBody);
88+ return jsonContentSchema(asObject(requestBody).content);
89+};
90+
91+const responseSchemaForTool = (
92+ document: OpenApiJsonObject,
93+ tool: OpenApiExtractedTool,
94+): unknown | undefined => {
95+ const responseEntries = Object.entries(asObject(operationForTool(document, tool).responses));
96+ const preferredResponses = responseEntries
97+ .filter(([status]) => /^2\d\d$/.test(status))
98+ .sort(([left], [right]) => left.localeCompare(right));
99+ const fallbackResponses = responseEntries.filter(([status]) => status === "default");
100+
101+ for (const [, responseValue] of [...preferredResponses, ...fallbackResponses]) {
102+ const response = resolveLocalRef(document, responseValue);
103+ const schema = jsonContentSchema(asObject(response).content);
104+ if (schema !== undefined) {
105+ return schema;
106+ }
107+ }
108+
109+ return undefined;
110+};
111+
112+const normalizeSchema = (
113+ document: OpenApiJsonObject,
114+ schema: unknown,
115+ depth: number = 4,
116+ activeRefs: ReadonlySet<string> = new Set<string>(),
117+): unknown => {
118+ if (depth < 0) {
119+ return "...";
120+ }
121+
122+ if (Array.isArray(schema)) {
123+ return schema.map((entry) => normalizeSchema(document, entry, depth - 1, activeRefs));
124+ }
125+
126+ const object = asObject(schema);
127+ const ref = typeof object.$ref === "string" ? object.$ref : null;
128+ if (ref && ref.startsWith("#/")) {
129+ if (activeRefs.has(ref)) {
130+ return { $ref: ref };
131+ }
132+
133+ return normalizeSchema(
134+ document,
135+ resolveLocalRef(document, object, activeRefs),
136+ depth,
137+ new Set([...activeRefs, ref]),
138+ );
139+ }
140+
141+ if (Object.keys(object).length === 0) {
142+ return object;
143+ }
144+
145+ const normalized: Record<string, unknown> = {};
146+
147+ if (typeof object.type === "string") {
148+ normalized.type = object.type;
149+ }
150+ if (typeof object.format === "string") {
151+ normalized.format = object.format;
152+ }
153+ if (typeof object.nullable === "boolean") {
154+ normalized.nullable = object.nullable;
155+ }
156+ if (object.const !== undefined) {
157+ normalized.const = object.const;
158+ }
159+ if (Array.isArray(object.enum)) {
160+ normalized.enum = [...object.enum];
161+ }
162+ if (Array.isArray(object.required)) {
163+ normalized.required = [...object.required].sort();
164+ }
165+ if (object.additionalProperties !== undefined) {
166+ normalized.additionalProperties =
167+ typeof object.additionalProperties === "boolean"
168+ ? object.additionalProperties
169+ : normalizeSchema(document, object.additionalProperties, depth - 1, activeRefs);
170+ }
171+ if (object.items !== undefined) {
172+ normalized.items = normalizeSchema(document, object.items, depth - 1, activeRefs);
173+ }
174+ if (Array.isArray(object.oneOf)) {
175+ normalized.oneOf = object.oneOf.map((entry) =>
176+ normalizeSchema(document, entry, depth - 1, activeRefs)
177+ );
178+ }
179+ if (Array.isArray(object.anyOf)) {
180+ normalized.anyOf = object.anyOf.map((entry) =>
181+ normalizeSchema(document, entry, depth - 1, activeRefs)
182+ );
183+ }
184+ if (Array.isArray(object.allOf)) {
185+ normalized.allOf = object.allOf.map((entry) =>
186+ normalizeSchema(document, entry, depth - 1, activeRefs)
187+ );
188+ }
189+
190+ const properties = asObject(object.properties);
191+ if (Object.keys(properties).length > 0) {
192+ normalized.properties = Object.fromEntries(
193+ Object.keys(properties)
194+ .sort()
195+ .map((key) => [
196+ key,
197+ normalizeSchema(document, properties[key], depth - 1, activeRefs),
198+ ]),
199+ );
200+ }
201+
202+ return normalized;
203+};
204+
205+const schemaMatchesExpected = (expected: unknown, actual: unknown): boolean => {
206+ if (expected === actual) {
207+ return true;
208+ }
209+
210+ if (
211+ expected !== null
212+ && typeof expected === "object"
213+ && !Array.isArray(expected)
214+ && typeof asObject(expected).$ref === "string"
215+ ) {
216+ return actual !== undefined;
217+ }
218+
219+ if (Array.isArray(expected)) {
220+ return Array.isArray(actual)
221+ && expected.length === actual.length
222+ && expected.every((entry, index) =>
223+ schemaMatchesExpected(entry, actual[index]),
224+ );
225+ }
226+
227+ if (
228+ expected !== null
229+ && typeof expected === "object"
230+ && !Array.isArray(expected)
231+ ) {
232+ const expectedObject = asObject(expected);
233+ const actualObject = asObject(actual);
234+
235+ return Object.entries(expectedObject).every(([key, value]) =>
236+ schemaMatchesExpected(value, actualObject[key]),
237+ );
238+ }
239+
240+ return false;
241+};
242+
243+const manifestToolMap = (
244+ manifest: OpenApiToolManifest,
245+): Map<string, OpenApiExtractedTool> =>
246+ new Map(
247+ manifest.tools.map((tool) => [`${tool.method} ${tool.path} ${tool.operationHash}`, tool]),
248+ );
249+
250+const collectOpenApiPresentationMismatches = (input: {
251+ document: OpenApiJsonObject;
252+ manifest: OpenApiToolManifest;
253+}): string[] => {
254+ const manifestToolByKey = manifestToolMap(input.manifest);
255+ const mismatches: string[] = [];
256+
257+ for (const definition of compileOpenApiToolDefinitions(input.manifest)) {
258+ const manifestTool = manifestToolByKey.get(
259+ `${definition.method} ${definition.path} ${definition.operationHash}`,
260+ );
261+ if (!manifestTool) {
262+ mismatches.push(`missing manifest tool for ${definition.toolId}`);
263+ continue;
264+ }
265+
266+ const presentation = buildOpenApiToolPresentation({
267+ definition,
268+ refHintTable: input.manifest.refHintTable,
269+ });
270+
271+ const expectedRequestSchema = requestBodySchemaForTool(input.document, manifestTool);
272+ if (expectedRequestSchema !== undefined) {
273+ const actualBodySchema = asObject(asObject(presentation.inputSchema).properties).body;
274+ if (actualBodySchema === undefined) {
275+ mismatches.push(`${definition.toolId}: missing body schema`);
276+ } else if (!schemaMatchesExpected(
277+ normalizeSchema(input.document, expectedRequestSchema),
278+ normalizeSchema(input.document, actualBodySchema),
279+ )) {
280+ mismatches.push(`${definition.toolId}: request body schema mismatch`);
281+ }
282+
283+ if (manifestTool.typing?.inputSchema === undefined) {
284+ mismatches.push(`${definition.toolId}: missing typing.inputSchema`);
285+ }
286+ }
287+
288+ const expectedResponseSchema = responseSchemaForTool(input.document, manifestTool);
289+ if (expectedResponseSchema !== undefined) {
290+ if (presentation.outputSchema === undefined) {
291+ mismatches.push(`${definition.toolId}: missing output schema`);
292+ } else if (!schemaMatchesExpected(
293+ normalizeSchema(input.document, expectedResponseSchema),
294+ normalizeSchema(input.document, presentation.outputSchema),
295+ )) {
296+ mismatches.push(`${definition.toolId}: response schema mismatch`);
297+ }
298+
299+ if (manifestTool.typing?.outputSchema === undefined) {
300+ mismatches.push(`${definition.toolId}: missing typing.outputSchema`);
301+ }
302+ }
303+ }
304+
305+ return mismatches;
306+};
307+
308+describe("openapi real spec coverage", () => {
309+ for (const fixture of [
310+ {
311+ name: "Vercel",
312+ filename: "vercel-openapi.json",
313+ expectedMinimumTools: 250,
314+ },
315+ {
316+ name: "Neon",
317+ filename: "neon-openapi.json",
318+ expectedMinimumTools: 50,
319+ },
320+ ] as const) {
321+ it.effect(
322+ `projects every ${fixture.name} operation with request/response schemas that match the raw spec`,
323+ () =>
324+ Effect.gen(function* () {
325+ const specText = readFixture(fixture.filename);
326+ const document = parseOpenApiDocument(specText);
327+ const manifest = yield* extractOpenApiManifest(
328+ fixture.name.toLowerCase(),
329+ specText,
330+ );
331+ const mismatches = collectOpenApiPresentationMismatches({
332+ document,
333+ manifest,
334+ });
335+
336+ expect(manifest.tools.length).toBeGreaterThan(fixture.expectedMinimumTools);
337+ expect(mismatches).toEqual([]);
338+ }),
339+ 120_000,
340+ );
341+ }
342+});
packages/codemode-openapi/src/openapi-tool-presentation.test.ts+107−0
@@ -0,0 +1,107 @@
1+import { readFileSync } from "node:fs";
2+
3+import { describe, expect, it } from "@effect/vitest";
4+import * as Effect from "effect/Effect";
5+
6+import { compileOpenApiToolDefinitions } from "./openapi-definitions";
7+import { extractOpenApiManifest } from "./openapi-extraction";
8+import { buildOpenApiToolPresentation } from "./openapi-tool-presentation";
9+
10+const readFixture = (name: string): string =>
11+ readFileSync(
12+ new URL(`../../control-plane/src/runtime/fixtures/${name}`, import.meta.url),
13+ "utf8",
14+ );
15+
16+describe("buildOpenApiToolPresentation", () => {
17+ it.effect(
18+ "resolves request and response schemas from ref hints for the real Neon OpenAPI spec",
19+ () =>
20+ Effect.gen(function* () {
21+ const specText = readFixture("neon-openapi.json");
22+ const manifest = yield* extractOpenApiManifest("neon", specText);
23+ const definition = compileOpenApiToolDefinitions(manifest).find(
24+ (candidate) => candidate.toolId === "apiKey.createApiKey",
25+ );
26+
27+ expect(definition).toBeDefined();
28+
29+ const presentation = buildOpenApiToolPresentation({
30+ definition: definition!,
31+ refHintTable: manifest.refHintTable,
32+ });
33+
34+ expect(presentation.previewInputType).toContain("body");
35+ expect(presentation.previewInputType).toContain("key_name");
36+ expect(presentation.previewOutputType).toContain("key");
37+ expect(presentation.inputSchema).toMatchObject({
38+ type: "object",
39+ properties: {
40+ body: {
41+ type: "object",
42+ properties: {
43+ key_name: {
44+ type: "string",
45+ },
46+ },
47+ required: ["key_name"],
48+ },
49+ },
50+ required: ["body"],
51+ });
52+ expect(presentation.outputSchema).toMatchObject({
53+ type: "object",
54+ properties: {
55+ id: {
56+ type: "integer",
57+ },
58+ key: {
59+ type: "string",
60+ },
61+ name: {
62+ type: "string",
63+ },
64+ },
65+ });
66+ }),
67+ 120_000,
68+ );
69+
70+ it.effect(
71+ "preserves response wrappers for response-only Neon operations",
72+ () =>
73+ Effect.gen(function* () {
74+ const specText = readFixture("neon-openapi.json");
75+ const manifest = yield* extractOpenApiManifest("neon", specText);
76+ const definition = compileOpenApiToolDefinitions(manifest).find(
77+ (candidate) => candidate.toolId === "apiKey.listApiKeys",
78+ );
79+
80+ expect(definition).toBeDefined();
81+
82+ const presentation = buildOpenApiToolPresentation({
83+ definition: definition!,
84+ refHintTable: manifest.refHintTable,
85+ });
86+
87+ expect(presentation.previewInputType).toBe("unknown");
88+ expect(presentation.previewOutputType).toContain("id");
89+ expect(presentation.previewOutputType).toContain("name");
90+ expect(presentation.outputSchema).toMatchObject({
91+ type: "array",
92+ items: {
93+ type: "object",
94+ properties: {
95+ id: {
96+ type: "integer",
97+ },
98+ name: {
99+ type: "string",
100+ },
101+ },
102+ },
103+ });
104+ }),
105+ 120_000,
106+ );
107+});
packages/codemode-openapi/src/openapi-tool-presentation.ts+91−12
@@ -1,8 +1,10 @@
1+import * as Match from "effect/Match";
12 import { typeSignatureFromSchema } from "@executor/codemode-core";
23
34 import type {
45 OpenApiExample,
56 OpenApiInvocationPayload,
7+ OpenApiRefHintTable,
68 OpenApiToolDocumentation,
79 OpenApiToolProviderData,
810 } from "./openapi-types";
@@ -10,6 +12,10 @@ import { · 1 unmodified line
1012 openApiProviderDataFromDefinition,
1113 type OpenApiToolDefinition,
1214 } from "./openapi-definitions";
15+import {
16+ resolveSchemaWithRefHints,
17+ resolveTypingSchemasWithRefHints,
18+} from "./openapi-schema-refs";
1319
1420 const asRecord = (value: unknown): Record<string, unknown> =>
1521 typeof value === "object" && value !== null && !Array.isArray(value)
@@ -45,9 +51,11 @@ const firstExample = ( · 29 unmodified lines
4551 examples: ReadonlyArray<OpenApiExample> | undefined,
4652 ): OpenApiExample | undefined => examples?.[0];
4753
48−const fallbackInputSchemaFromInvocation = (
49− invocation: OpenApiInvocationPayload,
50−): Record<string, unknown> | undefined => {
54+const callInputSchemaFromInvocation = (input: {
55+ invocation: OpenApiInvocationPayload;
56+ requestBodySchema?: unknown;
57+}): Record<string, unknown> | undefined => {
58+ const invocation = input.invocation;
5159 const properties: Record<string, unknown> = {};
5260 const required: string[] = [];
5361
@@ -61,7 +69,7 @@ const fallbackInputSchemaFromInvocation = ( · 7 unmodified lines
6169 }
6270
6371 if (invocation.requestBody) {
64− properties.body = {
72+ properties.body = input.requestBodySchema ?? {
6573 type: "object",
6674 };
6775 if (invocation.requestBody.required) {
@@ -79,6 +87,79 @@ const fallbackInputSchemaFromInvocation = ( · 11 unmodified lines
7987 : undefined;
8088 };
8189
90+const schemaRefPlaceholder = (
91+ refHintKey: string | undefined,
92+): Record<string, string> | undefined =>
93+ typeof refHintKey === "string" && refHintKey.length > 0
94+ ? { $ref: refHintKey }
95+ : undefined;
96+
97+const inferRefHintPlaceholders = (
98+ definition: OpenApiToolDefinition,
99+): {
100+ requestBodySchema?: Record<string, string>;
101+ outputSchema?: Record<string, string>;
102+} => {
103+ const refHintKeys = definition.typing?.refHintKeys ?? [];
104+
105+ return Match.value(definition.invocation.requestBody).pipe(
106+ Match.when(null, () => ({
107+ outputSchema: schemaRefPlaceholder(refHintKeys[0]),
108+ })),
109+ Match.orElse(() => ({
110+ requestBodySchema: schemaRefPlaceholder(refHintKeys[0]),
111+ outputSchema: schemaRefPlaceholder(refHintKeys[1]),
112+ })),
113+ );
114+};
115+
116+const resolvePresentationSchemas = (input: {
117+ definition: OpenApiToolDefinition;
118+ refHintTable?: Readonly<OpenApiRefHintTable>;
119+}): {
120+ inputSchema?: unknown;
121+ outputSchema?: unknown;
122+} => {
123+ const resolvedTyping = resolveTypingSchemasWithRefHints(
124+ input.definition.typing,
125+ input.refHintTable,
126+ );
127+ const inferredRefPlaceholders = inferRefHintPlaceholders(input.definition);
128+ const resolvedRequestBodySchema = resolveSchemaWithRefHints(
129+ inferredRefPlaceholders.requestBodySchema,
130+ input.refHintTable,
131+ );
132+ const requestBodySchema =
133+ resolvedTyping.inputSchema
134+ ?? (resolvedRequestBodySchema !== undefined && resolvedRequestBodySchema !== null
135+ ? resolvedRequestBodySchema
136+ : undefined);
137+
138+ const inputSchema =
139+ input.definition.invocation.requestBody !== null
140+ ? callInputSchemaFromInvocation({
141+ invocation: input.definition.invocation,
142+ ...(requestBodySchema !== undefined
143+ ? { requestBodySchema }
144+ : {}),
145+ })
146+ : resolvedTyping.inputSchema
147+ ?? callInputSchemaFromInvocation({
148+ invocation: input.definition.invocation,
149+ });
150+ const outputSchema =
151+ resolvedTyping.outputSchema
152+ ?? resolveSchemaWithRefHints(
153+ inferredRefPlaceholders.outputSchema,
154+ input.refHintTable,
155+ );
156+
157+ return {
158+ ...(inputSchema !== undefined && inputSchema !== null ? { inputSchema } : {}),
159+ ...(outputSchema !== undefined && outputSchema !== null ? { outputSchema } : {}),
160+ };
161+};
162+
82163 const buildExampleInput = (
83164 documentation: OpenApiToolDocumentation | undefined,
84165 ): Record<string, unknown> | undefined => {
@@ -113,8 +194,8 @@ const buildExampleOutput = ( · 28 unmodified lines
113194 };
114195
115196 export type OpenApiToolPresentation = {
116− inputType: string;
117− outputType: string;
197+ previewInputType: string;
198+ previewOutputType: string;
118199 inputSchema?: unknown;
119200 outputSchema?: unknown;
120201 exampleInput?: unknown;
@@ -124,17 +205,15 @@ export type OpenApiToolPresentation = { · 3 unmodified lines
124205
125206 export const buildOpenApiToolPresentation = (input: {
126207 definition: OpenApiToolDefinition;
208+ refHintTable?: Readonly<OpenApiRefHintTable>;
127209 }): OpenApiToolPresentation => {
128− const inputSchema =
129− input.definition.typing?.inputSchema
130− ?? fallbackInputSchemaFromInvocation(input.definition.invocation);
131− const outputSchema = input.definition.typing?.outputSchema;
210+ const { inputSchema, outputSchema } = resolvePresentationSchemas(input);
132211 const exampleInput = buildExampleInput(input.definition.documentation);
133212 const exampleOutput = buildExampleOutput(input.definition.documentation);
134213
135214 return {
136− inputType: typeSignatureFromSchema(inputSchema, "unknown", Infinity),
137− outputType: openApiOutputTypeSignatureFromSchema(outputSchema, Infinity),
215+ previewInputType: typeSignatureFromSchema(inputSchema, "unknown", Infinity),
216+ previewOutputType: openApiOutputTypeSignatureFromSchema(outputSchema, Infinity),
138217 ...(inputSchema !== undefined ? { inputSchema } : {}),
139218 ...(outputSchema !== undefined ? { outputSchema } : {}),
140219 ...(exampleInput !== undefined ? { exampleInput } : {}),
packages/codemode-openapi/src/openapi-tools.ts+3−2
@@ -464,6 +464,7 @@ export const createOpenApiToolFromDefinition = ( · 463 unmodified lines
464464 const httpClientLayer = input.httpClientLayer ?? FetchHttpClient.layer;
465465 const presentation = buildOpenApiToolPresentation({
466466 definition: input.definition,
467+ refHintTable: input.refHintTable,
467468 });
468469
469470 return toTool({
@@ -524,8 +525,8 @@ export const createOpenApiToolFromDefinition = ( · 54 unmodified lines
524525 },
525526 metadata: {
526527 sourceKey: input.sourceKey,
527− inputType: presentation.inputType,
528− outputType: presentation.outputType,
528+ previewInputType: presentation.previewInputType,
529+ previewOutputType: presentation.previewOutputType,
529530 ...((presentation.inputSchema ?? input.definition.typing?.inputSchema) !== undefined
530531 ? { inputSchema: presentation.inputSchema ?? input.definition.typing?.inputSchema }
531532 : {}),
packages/control-plane/src/runtime/executor-tools.ts+2−2
@@ -435,8 +435,8 @@ export const createExecutorToolMap = (input: { · 434 unmodified lines
435435 },
436436 },
437437 metadata: {
438− inputType: EXECUTOR_SOURCES_ADD_INPUT_HINT,
439− outputType: EXECUTOR_SOURCES_ADD_OUTPUT_SIGNATURE,
438+ previewInputType: EXECUTOR_SOURCES_ADD_INPUT_HINT,
439+ previewOutputType: EXECUTOR_SOURCES_ADD_OUTPUT_SIGNATURE,
440440 inputSchema: EXECUTOR_SOURCES_ADD_INPUT_SCHEMA,
441441 outputSchema: EXECUTOR_SOURCES_ADD_OUTPUT_SCHEMA,
442442 sourceKey: "executor",
packages/control-plane/src/runtime/fixtures/google-sheets-discovery.json+8314−0
@@ -0,0 +1,8314 @@
1+{
2+ "servicePath": "",
3+ "id": "sheets:v4",
4+ "rootUrl": "https://sheets.googleapis.com/",
5+ "basePath": "",
6+ "resources": {
7+ "spreadsheets": {
8+ "resources": {
9+ "values": {
10+ "methods": {
11+ "update": {
12+ "description": "Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.",
13+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
14+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
15+ "parameterOrder": [
16+ "spreadsheetId",
17+ "range"
18+ ],
19+ "httpMethod": "PUT",
20+ "scopes": [
21+ "https://www.googleapis.com/auth/drive",
22+ "https://www.googleapis.com/auth/drive.file",
23+ "https://www.googleapis.com/auth/spreadsheets"
24+ ],
25+ "parameters": {
26+ "valueInputOption": {
27+ "location": "query",
28+ "description": "How the input data should be interpreted.",
29+ "type": "string",
30+ "enumDescriptions": [
31+ "Default input value. This value must not be used.",
32+ "The values the user has entered will not be parsed and will be stored as-is.",
33+ "The values will be parsed as if the user typed them into the UI. Numbers will stay as numbers, but strings may be converted to numbers, dates, etc. following the same rules that are applied when entering text into a cell via the Google Sheets UI."
34+ ],
35+ "enum": [
36+ "INPUT_VALUE_OPTION_UNSPECIFIED",
37+ "RAW",
38+ "USER_ENTERED"
39+ ]
40+ },
41+ "includeValuesInResponse": {
42+ "description": "Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).",
43+ "location": "query",
44+ "type": "boolean"
45+ },
46+ "spreadsheetId": {
47+ "required": true,
48+ "description": "The ID of the spreadsheet to update.",
49+ "location": "path",
50+ "type": "string"
51+ },
52+ "responseValueRenderOption": {
53+ "location": "query",
54+ "enum": [
55+ "FORMATTED_VALUE",
56+ "UNFORMATTED_VALUE",
57+ "FORMULA"
58+ ],
59+ "description": "Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.",
60+ "type": "string",
61+ "enumDescriptions": [
62+ "Values will be calculated & formatted in the response according to the cell's formatting. Formatting is based on the spreadsheet's locale, not the requesting user's locale. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return `\"$1.23\"`.",
63+ "Values will be calculated, but not formatted in the reply. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return the number `1.23`.",
64+ "Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `\"=A1\"`. Sheets treats date and time values as decimal values. This lets you perform arithmetic on them in formulas. For more information on interpreting date and time values, see [About date & time values](https://developers.google.com/workspace/sheets/api/guides/formats#about_date_time_values)."
65+ ]
66+ },
67+ "range": {
68+ "required": true,
69+ "description": "The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to update.",
70+ "location": "path",
71+ "type": "string"
72+ },
73+ "responseDateTimeRenderOption": {
74+ "enum": [
75+ "SERIAL_NUMBER",
76+ "FORMATTED_STRING"
77+ ],
78+ "description": "Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.",
79+ "type": "string",
80+ "enumDescriptions": [
81+ "Instructs date, time, datetime, and duration fields to be output as doubles in \"serial number\" format, as popularized by Lotus 1-2-3. The whole number portion of the value (left of the decimal) counts the days since December 30th 1899. The fractional portion (right of the decimal) counts the time as a fraction of the day. For example, January 1st 1900 at noon would be 2.5, 2 because it's 2 days after December 30th 1899, and .5 because noon is half a day. February 1st 1900 at 3pm would be 33.625. This correctly treats the year 1900 as not a leap year.",
82+ "Instructs date, time, datetime, and duration fields to be output as strings in their given number format (which depends on the spreadsheet locale)."
83+ ],
84+ "location": "query"
85+ }
86+ },
87+ "request": {
88+ "$ref": "ValueRange"
89+ },
90+ "response": {
91+ "$ref": "UpdateValuesResponse"
92+ },
93+ "id": "sheets.spreadsheets.values.update"
94+ },
95+ "clear": {
96+ "httpMethod": "POST",
97+ "scopes": [
98+ "https://www.googleapis.com/auth/drive",
99+ "https://www.googleapis.com/auth/drive.file",
100+ "https://www.googleapis.com/auth/spreadsheets"
101+ ],
102+ "parameterOrder": [
103+ "spreadsheetId",
104+ "range"
105+ ],
106+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
107+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
108+ "description": "Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.",
109+ "id": "sheets.spreadsheets.values.clear",
110+ "response": {
111+ "$ref": "ClearValuesResponse"
112+ },
113+ "request": {
114+ "$ref": "ClearValuesRequest"
115+ },
116+ "parameters": {
117+ "spreadsheetId": {
118+ "description": "The ID of the spreadsheet to update.",
119+ "location": "path",
120+ "type": "string",
121+ "required": true
122+ },
123+ "range": {
124+ "description": "The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to clear.",
125+ "location": "path",
126+ "type": "string",
127+ "required": true
128+ }
129+ }
130+ },
131+ "batchClear": {
132+ "parameters": {
133+ "spreadsheetId": {
134+ "required": true,
135+ "description": "The ID of the spreadsheet to update.",
136+ "location": "path",
137+ "type": "string"
138+ }
139+ },
140+ "request": {
141+ "$ref": "BatchClearValuesRequest"
142+ },
143+ "response": {
144+ "$ref": "BatchClearValuesResponse"
145+ },
146+ "id": "sheets.spreadsheets.values.batchClear",
147+ "description": "Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as formatting and data validation) are kept.",
148+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
149+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
150+ "parameterOrder": [
151+ "spreadsheetId"
152+ ],
153+ "httpMethod": "POST",
154+ "scopes": [
155+ "https://www.googleapis.com/auth/drive",
156+ "https://www.googleapis.com/auth/drive.file",
157+ "https://www.googleapis.com/auth/spreadsheets"
158+ ]
159+ },
160+ "batchGetByDataFilter": {
161+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter",
162+ "description": "Returns one or more ranges of values that match the specified data filters. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned.",
163+ "httpMethod": "POST",
164+ "scopes": [
165+ "https://www.googleapis.com/auth/drive",
166+ "https://www.googleapis.com/auth/drive.file",
167+ "https://www.googleapis.com/auth/spreadsheets"
168+ ],
169+ "parameterOrder": [
170+ "spreadsheetId"
171+ ],
172+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter",
173+ "request": {
174+ "$ref": "BatchGetValuesByDataFilterRequest"
175+ },
176+ "parameters": {
177+ "spreadsheetId": {
178+ "description": "The ID of the spreadsheet to retrieve data from.",
179+ "location": "path",
180+ "type": "string",
181+ "required": true
182+ }
183+ },
184+ "id": "sheets.spreadsheets.values.batchGetByDataFilter",
185+ "response": {
186+ "$ref": "BatchGetValuesByDataFilterResponse"
187+ }
188+ },
189+ "batchUpdateByDataFilter": {
190+ "id": "sheets.spreadsheets.values.batchUpdateByDataFilter",
191+ "response": {
192+ "$ref": "BatchUpdateValuesByDataFilterResponse"
193+ },
194+ "parameters": {
195+ "spreadsheetId": {
196+ "required": true,
197+ "description": "The ID of the spreadsheet to update.",
198+ "location": "path",
199+ "type": "string"
200+ }
201+ },
202+ "request": {
203+ "$ref": "BatchUpdateValuesByDataFilterRequest"
204+ },
205+ "httpMethod": "POST",
206+ "scopes": [
207+ "https://www.googleapis.com/auth/drive",
208+ "https://www.googleapis.com/auth/drive.file",
209+ "https://www.googleapis.com/auth/spreadsheets"
210+ ],
211+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter",
212+ "parameterOrder": [
213+ "spreadsheetId"
214+ ],
215+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter",
216+ "description": "Sets values in one or more ranges of a spreadsheet. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges."
217+ },
218+ "append": {
219+ "httpMethod": "POST",
220+ "scopes": [
221+ "https://www.googleapis.com/auth/drive",
222+ "https://www.googleapis.com/auth/drive.file",
223+ "https://www.googleapis.com/auth/spreadsheets"
224+ ],
225+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:append",
226+ "parameterOrder": [
227+ "spreadsheetId",
228+ "range"
229+ ],
230+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:append",
231+ "description": "Appends values to a spreadsheet. The input range is used to search for existing data and find a \"table\" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the [guide](https://developers.google.com/workspace/sheets/api/guides/values#appending_values) and [sample code](https://developers.google.com/workspace/sheets/api/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to.",
232+ "id": "sheets.spreadsheets.values.append",
233+ "response": {
234+ "$ref": "AppendValuesResponse"
235+ },
236+ "parameters": {
237+ "insertDataOption": {
238+ "enum": [
239+ "OVERWRITE",
240+ "INSERT_ROWS"
241+ ],
242+ "description": "How the input data should be inserted.",
243+ "type": "string",
244+ "enumDescriptions": [
245+ "The new data overwrites existing data in the areas it is written. (Note: adding data to the end of the sheet will still insert new rows or columns so the data can be written.)",
246+ "Rows are inserted for the new data."
247+ ],
248+ "location": "query"
249+ },
250+ "responseValueRenderOption": {
251+ "description": "Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.",
252+ "type": "string",
253+ "enumDescriptions": [
254+ "Values will be calculated & formatted in the response according to the cell's formatting. Formatting is based on the spreadsheet's locale, not the requesting user's locale. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return `\"$1.23\"`.",
255+ "Values will be calculated, but not formatted in the reply. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return the number `1.23`.",
256+ "Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `\"=A1\"`. Sheets treats date and time values as decimal values. This lets you perform arithmetic on them in formulas. For more information on interpreting date and time values, see [About date & time values](https://developers.google.com/workspace/sheets/api/guides/formats#about_date_time_values)."
257+ ],
258+ "enum": [
259+ "FORMATTED_VALUE",
260+ "UNFORMATTED_VALUE",
261+ "FORMULA"
262+ ],
263+ "location": "query"
264+ },
265+ "range": {
266+ "description": "The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table.",
267+ "location": "path",
268+ "type": "string",
269+ "required": true
270+ },
271+ "responseDateTimeRenderOption": {
272+ "location": "query",
273+ "description": "Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.",
274+ "type": "string",
275+ "enumDescriptions": [
276+ "Instructs date, time, datetime, and duration fields to be output as doubles in \"serial number\" format, as popularized by Lotus 1-2-3. The whole number portion of the value (left of the decimal) counts the days since December 30th 1899. The fractional portion (right of the decimal) counts the time as a fraction of the day. For example, January 1st 1900 at noon would be 2.5, 2 because it's 2 days after December 30th 1899, and .5 because noon is half a day. February 1st 1900 at 3pm would be 33.625. This correctly treats the year 1900 as not a leap year.",
277+ "Instructs date, time, datetime, and duration fields to be output as strings in their given number format (which depends on the spreadsheet locale)."
278+ ],
279+ "enum": [
280+ "SERIAL_NUMBER",
281+ "FORMATTED_STRING"
282+ ]
283+ },
284+ "valueInputOption": {
285+ "description": "How the input data should be interpreted.",
286+ "type": "string",
287+ "enumDescriptions": [
288+ "Default input value. This value must not be used.",
289+ "The values the user has entered will not be parsed and will be stored as-is.",
290+ "The values will be parsed as if the user typed them into the UI. Numbers will stay as numbers, but strings may be converted to numbers, dates, etc. following the same rules that are applied when entering text into a cell via the Google Sheets UI."
291+ ],
292+ "enum": [
293+ "INPUT_VALUE_OPTION_UNSPECIFIED",
294+ "RAW",
295+ "USER_ENTERED"
296+ ],
297+ "location": "query"
298+ },
299+ "includeValuesInResponse": {
300+ "description": "Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values.",
301+ "location": "query",
302+ "type": "boolean"
303+ },
304+ "spreadsheetId": {
305+ "description": "The ID of the spreadsheet to update.",
306+ "location": "path",
307+ "type": "string",
308+ "required": true
309+ }
310+ },
311+ "request": {
312+ "$ref": "ValueRange"
313+ }
314+ },
315+ "get": {
316+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
317+ "description": "Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.",
318+ "httpMethod": "GET",
319+ "scopes": [
320+ "https://www.googleapis.com/auth/drive",
321+ "https://www.googleapis.com/auth/drive.file",
322+ "https://www.googleapis.com/auth/drive.readonly",
323+ "https://www.googleapis.com/auth/spreadsheets",
324+ "https://www.googleapis.com/auth/spreadsheets.readonly"
325+ ],
326+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
327+ "parameterOrder": [
328+ "spreadsheetId",
329+ "range"
330+ ],
331+ "parameters": {
332+ "dateTimeRenderOption": {
333+ "description": "How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.",
334+ "type": "string",
335+ "enumDescriptions": [
336+ "Instructs date, time, datetime, and duration fields to be output as doubles in \"serial number\" format, as popularized by Lotus 1-2-3. The whole number portion of the value (left of the decimal) counts the days since December 30th 1899. The fractional portion (right of the decimal) counts the time as a fraction of the day. For example, January 1st 1900 at noon would be 2.5, 2 because it's 2 days after December 30th 1899, and .5 because noon is half a day. February 1st 1900 at 3pm would be 33.625. This correctly treats the year 1900 as not a leap year.",
337+ "Instructs date, time, datetime, and duration fields to be output as strings in their given number format (which depends on the spreadsheet locale)."
338+ ],
339+ "enum": [
340+ "SERIAL_NUMBER",
341+ "FORMATTED_STRING"
342+ ],
343+ "location": "query"
344+ },
345+ "majorDimension": {
346+ "enum": [
347+ "DIMENSION_UNSPECIFIED",
348+ "ROWS",
349+ "COLUMNS"
350+ ],
351+ "description": "The major dimension that results should use. For example, if the spreadsheet data in Sheet1 is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=Sheet1!A1:B2?majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=Sheet1!A1:B2?majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.",
352+ "type": "string",
353+ "enumDescriptions": [
354+ "The default value, do not use.",
355+ "Operates on the rows of a sheet.",
356+ "Operates on the columns of a sheet."
357+ ],
358+ "location": "query"
359+ },
360+ "spreadsheetId": {
361+ "description": "The ID of the spreadsheet to retrieve data from.",
362+ "location": "path",
363+ "type": "string",
364+ "required": true
365+ },
366+ "valueRenderOption": {
367+ "description": "How values should be represented in the output. The default render option is FORMATTED_VALUE.",
368+ "type": "string",
369+ "enumDescriptions": [
370+ "Values will be calculated & formatted in the response according to the cell's formatting. Formatting is based on the spreadsheet's locale, not the requesting user's locale. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return `\"$1.23\"`.",
371+ "Values will be calculated, but not formatted in the reply. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return the number `1.23`.",
372+ "Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `\"=A1\"`. Sheets treats date and time values as decimal values. This lets you perform arithmetic on them in formulas. For more information on interpreting date and time values, see [About date & time values](https://developers.google.com/workspace/sheets/api/guides/formats#about_date_time_values)."
373+ ],
374+ "enum": [
375+ "FORMATTED_VALUE",
376+ "UNFORMATTED_VALUE",
377+ "FORMULA"
378+ ],
379+ "location": "query"
380+ },
381+ "range": {
382+ "description": "The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from.",
383+ "location": "path",
384+ "type": "string",
385+ "required": true
386+ }
387+ },
388+ "id": "sheets.spreadsheets.values.get",
389+ "response": {
390+ "$ref": "ValueRange"
391+ }
392+ },
393+ "batchGet": {
394+ "response": {
395+ "$ref": "BatchGetValuesResponse"
396+ },
397+ "id": "sheets.spreadsheets.values.batchGet",
398+ "parameters": {
399+ "majorDimension": {
400+ "location": "query",
401+ "enum": [
402+ "DIMENSION_UNSPECIFIED",
403+ "ROWS",
404+ "COLUMNS"
405+ ],
406+ "description": "The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `ranges=[\"A1:B2\"],majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `ranges=[\"A1:B2\"],majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.",
407+ "type": "string",
408+ "enumDescriptions": [
409+ "The default value, do not use.",
410+ "Operates on the rows of a sheet.",
411+ "Operates on the columns of a sheet."
412+ ]
413+ },
414+ "spreadsheetId": {
415+ "required": true,
416+ "description": "The ID of the spreadsheet to retrieve data from.",
417+ "location": "path",
418+ "type": "string"
419+ },
420+ "valueRenderOption": {
421+ "location": "query",
422+ "description": "How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.",
423+ "type": "string",
424+ "enumDescriptions": [
425+ "Values will be calculated & formatted in the response according to the cell's formatting. Formatting is based on the spreadsheet's locale, not the requesting user's locale. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return `\"$1.23\"`.",
426+ "Values will be calculated, but not formatted in the reply. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return the number `1.23`.",
427+ "Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `\"=A1\"`. Sheets treats date and time values as decimal values. This lets you perform arithmetic on them in formulas. For more information on interpreting date and time values, see [About date & time values](https://developers.google.com/workspace/sheets/api/guides/formats#about_date_time_values)."
428+ ],
429+ "enum": [
430+ "FORMATTED_VALUE",
431+ "UNFORMATTED_VALUE",
432+ "FORMULA"
433+ ]
434+ },
435+ "ranges": {
436+ "description": "The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from.",
437+ "location": "query",
438+ "repeated": true,
439+ "type": "string"
440+ },
441+ "dateTimeRenderOption": {
442+ "enum": [
443+ "SERIAL_NUMBER",
444+ "FORMATTED_STRING"
445+ ],
446+ "description": "How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.",
447+ "type": "string",
448+ "enumDescriptions": [
449+ "Instructs date, time, datetime, and duration fields to be output as doubles in \"serial number\" format, as popularized by Lotus 1-2-3. The whole number portion of the value (left of the decimal) counts the days since December 30th 1899. The fractional portion (right of the decimal) counts the time as a fraction of the day. For example, January 1st 1900 at noon would be 2.5, 2 because it's 2 days after December 30th 1899, and .5 because noon is half a day. February 1st 1900 at 3pm would be 33.625. This correctly treats the year 1900 as not a leap year.",
450+ "Instructs date, time, datetime, and duration fields to be output as strings in their given number format (which depends on the spreadsheet locale)."
451+ ],
452+ "location": "query"
453+ }
454+ },
455+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchGet",
456+ "parameterOrder": [
457+ "spreadsheetId"
458+ ],
459+ "httpMethod": "GET",
460+ "scopes": [
461+ "https://www.googleapis.com/auth/drive",
462+ "https://www.googleapis.com/auth/drive.file",
463+ "https://www.googleapis.com/auth/drive.readonly",
464+ "https://www.googleapis.com/auth/spreadsheets",
465+ "https://www.googleapis.com/auth/spreadsheets.readonly"
466+ ],
467+ "description": "Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.",
468+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchGet"
469+ },
470+ "batchUpdate": {
471+ "httpMethod": "POST",
472+ "scopes": [
473+ "https://www.googleapis.com/auth/drive",
474+ "https://www.googleapis.com/auth/drive.file",
475+ "https://www.googleapis.com/auth/spreadsheets"
476+ ],
477+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
478+ "parameterOrder": [
479+ "spreadsheetId"
480+ ],
481+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
482+ "description": "Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges.",
483+ "id": "sheets.spreadsheets.values.batchUpdate",
484+ "response": {
485+ "$ref": "BatchUpdateValuesResponse"
486+ },
487+ "parameters": {
488+ "spreadsheetId": {
489+ "description": "The ID of the spreadsheet to update.",
490+ "location": "path",
491+ "type": "string",
492+ "required": true
493+ }
494+ },
495+ "request": {
496+ "$ref": "BatchUpdateValuesRequest"
497+ }
498+ },
499+ "batchClearByDataFilter": {
500+ "id": "sheets.spreadsheets.values.batchClearByDataFilter",
501+ "response": {
502+ "$ref": "BatchClearValuesByDataFilterResponse"
503+ },
504+ "parameters": {
505+ "spreadsheetId": {
506+ "description": "The ID of the spreadsheet to update.",
507+ "location": "path",
508+ "type": "string",
509+ "required": true
510+ }
511+ },
512+ "request": {
513+ "$ref": "BatchClearValuesByDataFilterRequest"
514+ },
515+ "httpMethod": "POST",
516+ "scopes": [
517+ "https://www.googleapis.com/auth/drive",
518+ "https://www.googleapis.com/auth/drive.file",
519+ "https://www.googleapis.com/auth/spreadsheets"
520+ ],
521+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter",
522+ "parameterOrder": [
523+ "spreadsheetId"
524+ ],
525+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter",
526+ "description": "Clears one or more ranges of values from a spreadsheet. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc.) are kept."
527+ }
528+ }
529+ },
530+ "developerMetadata": {
531+ "methods": {
532+ "get": {
533+ "flatPath": "v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}",
534+ "description": "Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata).",
535+ "httpMethod": "GET",
536+ "scopes": [
537+ "https://www.googleapis.com/auth/drive",
538+ "https://www.googleapis.com/auth/drive.file",
539+ "https://www.googleapis.com/auth/spreadsheets"
540+ ],
541+ "parameterOrder": [
542+ "spreadsheetId",
543+ "metadataId"
544+ ],
545+ "path": "v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}",
546+ "parameters": {
547+ "spreadsheetId": {
548+ "description": "The ID of the spreadsheet to retrieve metadata from.",
549+ "location": "path",
550+ "type": "string",
551+ "required": true
552+ },
553+ "metadataId": {
554+ "description": "The ID of the developer metadata to retrieve.",
555+ "type": "integer",
556+ "location": "path",
557+ "required": true,
558+ "format": "int32"
559+ }
560+ },
561+ "id": "sheets.spreadsheets.developerMetadata.get",
562+ "response": {
563+ "$ref": "DeveloperMetadata"
564+ }
565+ },
566+ "search": {
567+ "flatPath": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search",
568+ "description": "Returns all developer metadata matching the specified DataFilter. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region.",
569+ "httpMethod": "POST",
570+ "scopes": [
571+ "https://www.googleapis.com/auth/drive",
572+ "https://www.googleapis.com/auth/drive.file",
573+ "https://www.googleapis.com/auth/spreadsheets"
574+ ],
575+ "path": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search",
576+ "parameterOrder": [
577+ "spreadsheetId"
578+ ],
579+ "parameters": {
580+ "spreadsheetId": {
581+ "description": "The ID of the spreadsheet to retrieve metadata from.",
582+ "location": "path",
583+ "type": "string",
584+ "required": true
585+ }
586+ },
587+ "request": {
588+ "$ref": "SearchDeveloperMetadataRequest"
589+ },
590+ "id": "sheets.spreadsheets.developerMetadata.search",
591+ "response": {
592+ "$ref": "SearchDeveloperMetadataResponse"
593+ }
594+ }
595+ }
596+ },
597+ "sheets": {
598+ "methods": {
599+ "copyTo": {
600+ "response": {
601+ "$ref": "SheetProperties"
602+ },
603+ "id": "sheets.spreadsheets.sheets.copyTo",
604+ "request": {
605+ "$ref": "CopySheetToAnotherSpreadsheetRequest"
606+ },
607+ "parameters": {
608+ "spreadsheetId": {
609+ "description": "The ID of the spreadsheet containing the sheet to copy.",
610+ "location": "path",
611+ "type": "string",
612+ "required": true
613+ },
614+ "sheetId": {
615+ "location": "path",
616+ "required": true,
617+ "format": "int32",
618+ "description": "The ID of the sheet to copy.",
619+ "type": "integer"
620+ }
621+ },
622+ "parameterOrder": [
623+ "spreadsheetId",
624+ "sheetId"
625+ ],
626+ "path": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
627+ "httpMethod": "POST",
628+ "scopes": [
629+ "https://www.googleapis.com/auth/drive",
630+ "https://www.googleapis.com/auth/drive.file",
631+ "https://www.googleapis.com/auth/spreadsheets"
632+ ],
633+ "description": "Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet.",
634+ "flatPath": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo"
635+ }
636+ }
637+ }
638+ },
639+ "methods": {
640+ "get": {
641+ "id": "sheets.spreadsheets.get",
642+ "response": {
643+ "$ref": "Spreadsheet"
644+ },
645+ "parameters": {
646+ "ranges": {
647+ "description": "The ranges to retrieve from the spreadsheet.",
648+ "location": "query",
649+ "repeated": true,
650+ "type": "string"
651+ },
652+ "includeGridData": {
653+ "description": "True if grid data should be returned. This parameter is ignored if a field mask was set in the request.",
654+ "location": "query",
655+ "type": "boolean"
656+ },
657+ "spreadsheetId": {
658+ "description": "The spreadsheet to request.",
659+ "location": "path",
660+ "type": "string",
661+ "required": true
662+ },
663+ "excludeTablesInBandedRanges": {
664+ "description": "True if tables should be excluded in the banded ranges. False if not set.",
665+ "location": "query",
666+ "type": "boolean"
667+ }
668+ },
669+ "httpMethod": "GET",
670+ "scopes": [
671+ "https://www.googleapis.com/auth/drive",
672+ "https://www.googleapis.com/auth/drive.file",
673+ "https://www.googleapis.com/auth/drive.readonly",
674+ "https://www.googleapis.com/auth/spreadsheets",
675+ "https://www.googleapis.com/auth/spreadsheets.readonly"
676+ ],
677+ "parameterOrder": [
678+ "spreadsheetId"
679+ ],
680+ "path": "v4/spreadsheets/{spreadsheetId}",
681+ "flatPath": "v4/spreadsheets/{spreadsheetId}",
682+ "description": "Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: * Specify a [field mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example, `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges."
683+ },
684+ "batchUpdate": {
685+ "parameterOrder": [
686+ "spreadsheetId"
687+ ],
688+ "path": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
689+ "httpMethod": "POST",
690+ "scopes": [
691+ "https://www.googleapis.com/auth/drive",
692+ "https://www.googleapis.com/auth/drive.file",
693+ "https://www.googleapis.com/auth/spreadsheets"
694+ ],
695+ "description": "Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes.",
696+ "flatPath": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
697+ "response": {
698+ "$ref": "BatchUpdateSpreadsheetResponse"
699+ },
700+ "id": "sheets.spreadsheets.batchUpdate",
701+ "request": {
702+ "$ref": "BatchUpdateSpreadsheetRequest"
703+ },
704+ "parameters": {
705+ "spreadsheetId": {
706+ "description": "The spreadsheet to apply the updates to.",
707+ "location": "path",
708+ "type": "string",
709+ "required": true
710+ }
711+ }
712+ },
713+ "getByDataFilter": {
714+ "description": "Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data in one of two ways: * Specify a [field mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP. * Set the includeGridData parameter to `true`. If a field mask is set, the `includeGridData` parameter is ignored. For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want.",
715+ "flatPath": "v4/spreadsheets/{spreadsheetId}:getByDataFilter",
716+ "parameterOrder": [
717+ "spreadsheetId"
718+ ],
719+ "path": "v4/spreadsheets/{spreadsheetId}:getByDataFilter",
720+ "httpMethod": "POST",
721+ "scopes": [
722+ "https://www.googleapis.com/auth/drive",
723+ "https://www.googleapis.com/auth/drive.file",
724+ "https://www.googleapis.com/auth/spreadsheets"
725+ ],
726+ "request": {
727+ "$ref": "GetSpreadsheetByDataFilterRequest"
728+ },
729+ "parameters": {
730+ "spreadsheetId": {
731+ "required": true,
732+ "description": "The spreadsheet to request.",
733+ "location": "path",
734+ "type": "string"
735+ }
736+ },
737+ "response": {
738+ "$ref": "Spreadsheet"
739+ },
740+ "id": "sheets.spreadsheets.getByDataFilter"
741+ },
742+ "create": {
743+ "parameterOrder": [],
744+ "path": "v4/spreadsheets",
745+ "httpMethod": "POST",
746+ "scopes": [
747+ "https://www.googleapis.com/auth/drive",
748+ "https://www.googleapis.com/auth/drive.file",
749+ "https://www.googleapis.com/auth/spreadsheets"
750+ ],
751+ "description": "Creates a spreadsheet, returning the newly created spreadsheet.",
752+ "flatPath": "v4/spreadsheets",
753+ "response": {
754+ "$ref": "Spreadsheet"
755+ },
756+ "id": "sheets.spreadsheets.create",
757+ "request": {
758+ "$ref": "Spreadsheet"
759+ },
760+ "parameters": {}
761+ }
762+ }
763+ }
764+ },
765+ "ownerName": "Google",
766+ "kind": "discovery#restDescription",
767+ "discoveryVersion": "v1",
768+ "documentationLink": "https://developers.google.com/workspace/sheets/",
769+ "version": "v4",
770+ "schemas": {
771+ "DuplicateFilterViewRequest": {
772+ "id": "DuplicateFilterViewRequest",
773+ "description": "Duplicates a particular filter view.",
774+ "type": "object",
775+ "properties": {
776+ "filterId": {
777+ "description": "The ID of the filter being duplicated.",
778+ "type": "integer",
779+ "format": "int32"
780+ }
781+ }
782+ },
783+ "RandomizeRangeRequest": {
784+ "id": "RandomizeRangeRequest",
785+ "description": "Randomizes the order of the rows in a range.",
786+ "type": "object",
787+ "properties": {
788+ "range": {
789+ "description": "The range to randomize.",
790+ "$ref": "GridRange"
791+ }
792+ }
793+ },
794+ "DataSourceSheetDimensionRange": {
795+ "description": "A range along a single dimension on a DATA_SOURCE sheet.",
796+ "type": "object",
797+ "properties": {
798+ "sheetId": {
799+ "format": "int32",
800+ "description": "The ID of the data source sheet the range is on.",
801+ "type": "integer"
802+ },
803+ "columnReferences": {
804+ "items": {
805+ "$ref": "DataSourceColumnReference"
806+ },
807+ "description": "The columns on the data source sheet.",
808+ "type": "array"
809+ }
810+ },
811+ "id": "DataSourceSheetDimensionRange"
812+ },
813+ "FilterSpec": {
814+ "id": "FilterSpec",
815+ "description": "The filter criteria associated with a specific column.",
816+ "type": "object",
817+ "properties": {
818+ "dataSourceColumnReference": {
819+ "description": "Reference to a data source column.",
820+ "$ref": "DataSourceColumnReference"
821+ },
822+ "columnIndex": {
823+ "description": "The zero-based column index.",
824+ "type": "integer",
825+ "format": "int32"
826+ },
827+ "filterCriteria": {
828+ "description": "The criteria for the column.",
829+ "$ref": "FilterCriteria"
830+ }
831+ }
832+ },
833+ "TextFormatRun": {
834+ "description": "A run of a text format. The format of this run continues until the start index of the next run. When updating, all fields must be set.",
835+ "type": "object",
836+ "properties": {
837+ "startIndex": {
838+ "format": "int32",
839+ "description": "The zero-based character index where this run starts, in UTF-16 code units.",
840+ "type": "integer"
841+ },
842+ "format": {
843+ "description": "The format of this run. Absent values inherit the cell's format.",
844+ "$ref": "TextFormat"
845+ }
846+ },
847+ "id": "TextFormatRun"
848+ },
849+ "IterativeCalculationSettings": {
850+ "id": "IterativeCalculationSettings",
851+ "description": "Settings to control how circular dependencies are resolved with iterative calculation.",
852+ "type": "object",
853+ "properties": {
854+ "convergenceThreshold": {
855+ "format": "double",
856+ "description": "When iterative calculation is enabled and successive results differ by less than this threshold value, the calculation rounds stop.",
857+ "type": "number"
858+ },
859+ "maxIterations": {
860+ "format": "int32",
861+ "description": "When iterative calculation is enabled, the maximum number of calculation rounds to perform.",
862+ "type": "integer"
863+ }
864+ }
865+ },
866+ "UpdateDeveloperMetadataResponse": {
867+ "id": "UpdateDeveloperMetadataResponse",
868+ "description": "The response from updating developer metadata.",
869+ "type": "object",
870+ "properties": {
871+ "developerMetadata": {
872+ "items": {
873+ "$ref": "DeveloperMetadata"
874+ },
875+ "description": "The updated developer metadata.",
876+ "type": "array"
877+ }
878+ }
879+ },
880+ "SearchDeveloperMetadataResponse": {
881+ "id": "SearchDeveloperMetadataResponse",
882+ "description": "A reply to a developer metadata search request.",
883+ "type": "object",
884+ "properties": {
885+ "matchedDeveloperMetadata": {
886+ "items": {
887+ "$ref": "MatchedDeveloperMetadata"
888+ },
889+ "description": "The metadata matching the criteria of the search request.",
890+ "type": "array"
891+ }
892+ }
893+ },
894+ "DimensionGroup": {
895+ "id": "DimensionGroup",
896+ "description": "A group over an interval of rows or columns on a sheet, which can contain or be contained within other groups. A group can be collapsed or expanded as a unit on the sheet.",
897+ "type": "object",
898+ "properties": {
899+ "range": {
900+ "description": "The range over which this group exists.",
901+ "$ref": "DimensionRange"
902+ },
903+ "depth": {
904+ "format": "int32",
905+ "description": "The depth of the group, representing how many groups have a range that wholly contains the range of this group.",
906+ "type": "integer"
907+ },
908+ "collapsed": {
909+ "description": "This field is true if this group is collapsed. A collapsed group remains collapsed if an overlapping group at a shallower depth is expanded. A true value does not imply that all dimensions within the group are hidden, since a dimension's visibility can change independently from this group property. However, when this property is updated, all dimensions within it are set to hidden if this field is true, or set to visible if this field is false.",
910+ "type": "boolean"
911+ }
912+ }
913+ },
914+ "AddDimensionGroupRequest": {
915+ "description": "Creates a group over the specified range. If the requested range is a superset of the range of an existing group G, then the depth of G is incremented and this new group G' has the depth of that group. For example, a group [C:D, depth 1] + [B:E] results in groups [B:E, depth 1] and [C:D, depth 2]. If the requested range is a subset of the range of an existing group G, then the depth of the new group G' becomes one greater than the depth of G. For example, a group [B:E, depth 1] + [C:D] results in groups [B:E, depth 1] and [C:D, depth 2]. If the requested range starts before and ends within, or starts within and ends after, the range of an existing group G, then the range of the existing group G becomes the union of the ranges, and the new group G' has depth one greater than the depth of G and range as the intersection of the ranges. For example, a group [B:D, depth 1] + [C:E] results in groups [B:E, depth 1] and [C:D, depth 2].",
916+ "type": "object",
917+ "properties": {
918+ "range": {
919+ "description": "The range over which to create a group.",
920+ "$ref": "DimensionRange"
921+ }
922+ },
923+ "id": "AddDimensionGroupRequest"
924+ },
925+ "CancelDataSourceRefreshResponse": {
926+ "id": "CancelDataSourceRefreshResponse",
927+ "description": "The response from cancelling one or multiple data source object refreshes.",
928+ "type": "object",
929+ "properties": {
930+ "statuses": {
931+ "description": "The cancellation statuses of refreshes of all data source objects specified in the request. If is_all is specified, the field contains only those in failure status. Refreshing and canceling refresh the same data source object is also not allowed in the same `batchUpdate`.",
932+ "type": "array",
933+ "items": {
934+ "$ref": "CancelDataSourceRefreshStatus"
935+ }
936+ }
937+ }
938+ },
939+ "BatchGetValuesResponse": {
940+ "description": "The response when retrieving more than one range of values in a spreadsheet.",
941+ "type": "object",
942+ "properties": {
943+ "spreadsheetId": {
944+ "description": "The ID of the spreadsheet the data was retrieved from.",
945+ "type": "string"
946+ },
947+ "valueRanges": {
948+ "items": {
949+ "$ref": "ValueRange"
950+ },
951+ "description": "The requested values. The order of the ValueRanges is the same as the order of the requested ranges.",
952+ "type": "array"
953+ }
954+ },
955+ "id": "BatchGetValuesResponse"
956+ },
957+ "RefreshDataSourceObjectExecutionStatus": {
958+ "id": "RefreshDataSourceObjectExecutionStatus",
959+ "description": "The execution status of refreshing one data source object.",
960+ "type": "object",
961+ "properties": {
962+ "reference": {
963+ "description": "Reference to a data source object being refreshed.",
964+ "$ref": "DataSourceObjectReference"
965+ },
966+ "dataExecutionStatus": {
967+ "description": "The data execution status.",
968+ "$ref": "DataExecutionStatus"
969+ }
970+ }
971+ },
972+ "DimensionRange": {
973+ "id": "DimensionRange",
974+ "description": "A range along a single dimension on a sheet. All indexes are zero-based. Indexes are half open: the start index is inclusive and the end index is exclusive. Missing indexes indicate the range is unbounded on that side.",
975+ "type": "object",
976+ "properties": {
977+ "dimension": {
978+ "description": "The dimension of the span.",
979+ "type": "string",
980+ "enumDescriptions": [
981+ "The default value, do not use.",
982+ "Operates on the rows of a sheet.",
983+ "Operates on the columns of a sheet."
984+ ],
985+ "enum": [
986+ "DIMENSION_UNSPECIFIED",
987+ "ROWS",
988+ "COLUMNS"
989+ ]
990+ },
991+ "endIndex": {
992+ "description": "The end (exclusive) of the span, or not set if unbounded.",
993+ "type": "integer",
994+ "format": "int32"
995+ },
996+ "startIndex": {
997+ "format": "int32",
998+ "description": "The start (inclusive) of the span, or not set if unbounded.",
999+ "type": "integer"
1000+ },
1001+ "sheetId": {
1002+ "description": "The sheet this span is on.",
1003+ "type": "integer",
1004+ "format": "int32"
1005+ }
1006+ }
1007+ },
1008+ "InsertDimensionRequest": {
1009+ "id": "InsertDimensionRequest",
1010+ "description": "Inserts rows or columns in a sheet at a particular index.",
1011+ "type": "object",
1012+ "properties": {
1013+ "range": {
1014+ "description": "The dimensions to insert. Both the start and end indexes must be bounded.",
1015+ "$ref": "DimensionRange"
1016+ },
1017+ "inheritFromBefore": {
1018+ "description": "Whether dimension properties should be extended from the dimensions before or after the newly inserted dimensions. True to inherit from the dimensions before (in which case the start index must be greater than 0), and false to inherit from the dimensions after. For example, if row index 0 has red background and row index 1 has a green background, then inserting 2 rows at index 1 can inherit either the green or red background. If `inheritFromBefore` is true, the two new rows will be red (because the row before the insertion point was red), whereas if `inheritFromBefore` is false, the two new rows will be green (because the row after the insertion point was green).",
1019+ "type": "boolean"
1020+ }
1021+ }
1022+ },
1023+ "AddDimensionGroupResponse": {
1024+ "id": "AddDimensionGroupResponse",
1025+ "description": "The result of adding a group.",
1026+ "type": "object",
1027+ "properties": {
1028+ "dimensionGroups": {
1029+ "items": {
1030+ "$ref": "DimensionGroup"
1031+ },
1032+ "description": "All groups of a dimension after adding a group to that dimension.",
1033+ "type": "array"
1034+ }
1035+ }
1036+ },
1037+ "DataExecutionStatus": {
1038+ "description": "The data execution status. A data execution is created to sync a data source object with the latest data from a DataSource. It is usually scheduled to run at background, you can check its state to tell if an execution completes There are several scenarios where a data execution is triggered to run: * Adding a data source creates an associated data source sheet as well as a data execution to sync the data from the data source to the sheet. * Updating a data source creates a data execution to refresh the associated data source sheet similarly. * You can send refresh request to explicitly refresh one or multiple data source objects.",
1039+ "type": "object",
1040+ "properties": {
1041+ "errorCode": {
1042+ "enum": [
1043+ "DATA_EXECUTION_ERROR_CODE_UNSPECIFIED",
1044+ "TIMED_OUT",
1045+ "TOO_MANY_ROWS",
1046+ "TOO_MANY_COLUMNS",
1047+ "TOO_MANY_CELLS",
1048+ "ENGINE",
1049+ "PARAMETER_INVALID",
1050+ "UNSUPPORTED_DATA_TYPE",
1051+ "DUPLICATE_COLUMN_NAMES",
1052+ "INTERRUPTED",
1053+ "CONCURRENT_QUERY",
1054+ "OTHER",
1055+ "TOO_MANY_CHARS_PER_CELL",
1056+ "DATA_NOT_FOUND",
1057+ "PERMISSION_DENIED",
1058+ "MISSING_COLUMN_ALIAS",
1059+ "OBJECT_NOT_FOUND",
1060+ "OBJECT_IN_ERROR_STATE",
1061+ "OBJECT_SPEC_INVALID",
1062+ "DATA_EXECUTION_CANCELLED"
1063+ ],
1064+ "description": "The error code.",
1065+ "type": "string",
1066+ "enumDescriptions": [
1067+ "Default value, do not use.",
1068+ "The data execution timed out.",
1069+ "The data execution returns more rows than the limit.",
1070+ "The data execution returns more columns than the limit.",
1071+ "The data execution returns more cells than the limit.",
1072+ "Error is received from the backend data execution engine (e.g. BigQuery). Check error_message for details.",
1073+ "One or some of the provided data source parameters are invalid.",
1074+ "The data execution returns an unsupported data type.",
1075+ "The data execution returns duplicate column names or aliases.",
1076+ "The data execution is interrupted. Please refresh later.",
1077+ "The data execution is currently in progress, can not be refreshed until it completes.",
1078+ "Other errors.",
1079+ "The data execution returns values that exceed the maximum characters allowed in a single cell.",
1080+ "The database referenced by the data source is not found. */",
1081+ "The user does not have access to the database referenced by the data source.",
1082+ "The data execution returns columns with missing aliases.",
1083+ "The data source object does not exist.",
1084+ "The data source object is currently in error state. To force refresh, set force in RefreshDataSourceRequest.",
1085+ "The data source object specification is invalid.",
1086+ "The data execution has been cancelled."
1087+ ]
1088+ },
1089+ "state": {
1090+ "description": "The state of the data execution.",
1091+ "type": "string",
1092+ "enumDescriptions": [
1093+ "Default value, do not use.",
1094+ "The data execution has not started.",
1095+ "The data execution has started and is running.",
1096+ "The data execution is currently being cancelled.",
1097+ "The data execution has completed successfully.",
1098+ "The data execution has completed with errors."
1099+ ],
1100+ "enum": [
1101+ "DATA_EXECUTION_STATE_UNSPECIFIED",
1102+ "NOT_STARTED",
1103+ "RUNNING",
1104+ "CANCELLING",
1105+ "SUCCEEDED",
1106+ "FAILED"
1107+ ]
1108+ },
1109+ "errorMessage": {
1110+ "description": "The error message, which may be empty.",
1111+ "type": "string"
1112+ },
1113+ "lastRefreshTime": {
1114+ "format": "google-datetime",
1115+ "description": "Gets the time the data last successfully refreshed.",
1116+ "type": "string"
1117+ }
1118+ },
1119+ "id": "DataExecutionStatus"
1120+ },
1121+ "HistogramSeries": {
1122+ "id": "HistogramSeries",
1123+ "description": "A histogram series containing the series color and data.",
1124+ "type": "object",
1125+ "properties": {
1126+ "data": {
1127+ "description": "The data for this histogram series.",
1128+ "$ref": "ChartData"
1129+ },
1130+ "barColor": {
1131+ "description": "The color of the column representing this series in each bucket. This field is optional. Deprecated: Use bar_color_style.",
1132+ "deprecated": true,
1133+ "$ref": "Color"
1134+ },
1135+ "barColorStyle": {
1136+ "description": "The color of the column representing this series in each bucket. This field is optional. If bar_color is also set, this field takes precedence.",
1137+ "$ref": "ColorStyle"
1138+ }
1139+ }
1140+ },
1141+ "ExtendedValue": {
1142+ "id": "ExtendedValue",
1143+ "description": "The kinds of value that a cell in a spreadsheet can have.",
1144+ "type": "object",
1145+ "properties": {
1146+ "numberValue": {
1147+ "format": "double",
1148+ "description": "Represents a double value. Note: Dates, Times and DateTimes are represented as doubles in SERIAL_NUMBER format.",
1149+ "type": "number"
1150+ },
1151+ "stringValue": {
1152+ "description": "Represents a string value. Leading single quotes are not included. For example, if the user typed `'123` into the UI, this would be represented as a `stringValue` of `\"123\"`.",
1153+ "type": "string"
1154+ },
1155+ "errorValue": {
1156+ "description": "Represents an error. This field is read-only.",
1157+ "$ref": "ErrorValue"
1158+ },
1159+ "formulaValue": {
1160+ "description": "Represents a formula.",
1161+ "type": "string"
1162+ },
1163+ "boolValue": {
1164+ "description": "Represents a boolean value.",
1165+ "type": "boolean"
1166+ }
1167+ }
1168+ },
1169+ "DeleteRangeRequest": {
1170+ "description": "Deletes a range of cells, shifting other cells into the deleted area.",
1171+ "type": "object",
1172+ "properties": {
1173+ "range": {
1174+ "description": "The range of cells to delete.",
1175+ "$ref": "GridRange"
1176+ },
1177+ "shiftDimension": {
1178+ "enum": [
1179+ "DIMENSION_UNSPECIFIED",
1180+ "ROWS",
1181+ "COLUMNS"
1182+ ],
1183+ "description": "The dimension from which deleted cells will be replaced with. If ROWS, existing cells will be shifted upward to replace the deleted cells. If COLUMNS, existing cells will be shifted left to replace the deleted cells.",
1184+ "type": "string",
1185+ "enumDescriptions": [
1186+ "The default value, do not use.",
1187+ "Operates on the rows of a sheet.",
1188+ "Operates on the columns of a sheet."
1189+ ]
1190+ }
1191+ },
1192+ "id": "DeleteRangeRequest"
1193+ },
1194+ "ConditionValue": {
1195+ "id": "ConditionValue",
1196+ "description": "The value of the condition.",
1197+ "type": "object",
1198+ "properties": {
1199+ "userEnteredValue": {
1200+ "description": "A value the condition is based on. The value is parsed as if the user typed into a cell. Formulas are supported (and must begin with an `=` or a '+').",
1201+ "type": "string"
1202+ },
1203+ "relativeDate": {
1204+ "enum": [
1205+ "RELATIVE_DATE_UNSPECIFIED",
1206+ "PAST_YEAR",
1207+ "PAST_MONTH",
1208+ "PAST_WEEK",
1209+ "YESTERDAY",
1210+ "TODAY",
1211+ "TOMORROW"
1212+ ],
1213+ "description": "A relative date (based on the current date). Valid only if the type is DATE_BEFORE, DATE_AFTER, DATE_ON_OR_BEFORE or DATE_ON_OR_AFTER. Relative dates are not supported in data validation. They are supported only in conditional formatting and conditional filters.",
1214+ "type": "string",
1215+ "enumDescriptions": [
1216+ "Default value, do not use.",
1217+ "The value is one year before today.",
1218+ "The value is one month before today.",
1219+ "The value is one week before today.",
1220+ "The value is yesterday.",
1221+ "The value is today.",
1222+ "The value is tomorrow."
1223+ ]
1224+ }
1225+ }
1226+ },
1227+ "BasicFilter": {
1228+ "id": "BasicFilter",
1229+ "description": "The default filter associated with a sheet. For more information, see [Manage data visibility with filters](https://developers.google.com/workspace/sheets/api/guides/filters).",
1230+ "type": "object",
1231+ "properties": {
1232+ "range": {
1233+ "description": "The range the filter covers.",
1234+ "$ref": "GridRange"
1235+ },
1236+ "sortSpecs": {
1237+ "description": "The sort order per column. Later specifications are used when values are equal in the earlier specifications.",
1238+ "type": "array",
1239+ "items": {
1240+ "$ref": "SortSpec"
1241+ }
1242+ },
1243+ "criteria": {
1244+ "description": "The criteria for showing/hiding values per column. The map's key is the column index, and the value is the criteria for that column. This field is deprecated in favor of filter_specs.",
1245+ "deprecated": true,
1246+ "type": "object",
1247+ "additionalProperties": {
1248+ "$ref": "FilterCriteria"
1249+ }
1250+ },
1251+ "filterSpecs": {
1252+ "items": {
1253+ "$ref": "FilterSpec"
1254+ },
1255+ "description": "The filter criteria per column. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence.",
1256+ "type": "array"
1257+ },
1258+ "tableId": {
1259+ "description": "The table this filter is backed by, if any. When writing, only one of range or table_id may be set.",
1260+ "type": "string"
1261+ }
1262+ }
1263+ },
1264+ "DeleteSheetRequest": {
1265+ "id": "DeleteSheetRequest",
1266+ "description": "Deletes the requested sheet.",
1267+ "type": "object",
1268+ "properties": {
1269+ "sheetId": {
1270+ "format": "int32",
1271+ "description": "The ID of the sheet to delete. If the sheet is of DATA_SOURCE type, the associated DataSource is also deleted.",
1272+ "type": "integer"
1273+ }
1274+ }
1275+ },
1276+ "DataSourceFormula": {
1277+ "description": "A data source formula.",
1278+ "type": "object",
1279+ "properties": {
1280+ "dataSourceId": {
1281+ "description": "The ID of the data source the formula is associated with.",
1282+ "type": "string"
1283+ },
1284+ "dataExecutionStatus": {
1285+ "description": "Output only. The data execution status.",
1286+ "readOnly": true,
1287+ "$ref": "DataExecutionStatus"
1288+ }
1289+ },
1290+ "id": "DataSourceFormula"
1291+ },
1292+ "EmbeddedChart": {
1293+ "id": "EmbeddedChart",
1294+ "description": "A chart embedded in a sheet.",
1295+ "type": "object",
1296+ "properties": {
1297+ "spec": {
1298+ "description": "The specification of the chart.",
1299+ "$ref": "ChartSpec"
1300+ },
1301+ "border": {
1302+ "description": "The border of the chart.",
1303+ "$ref": "EmbeddedObjectBorder"
1304+ },
1305+ "position": {
1306+ "description": "The position of the chart.",
1307+ "$ref": "EmbeddedObjectPosition"
1308+ },
1309+ "chartId": {
1310+ "format": "int32",
1311+ "description": "The ID of the chart.",
1312+ "type": "integer"
1313+ }
1314+ }
1315+ },
1316+ "UpdateEmbeddedObjectPositionRequest": {
1317+ "description": "Update an embedded object's position (such as a moving or resizing a chart or image).",
1318+ "type": "object",
1319+ "properties": {
1320+ "newPosition": {
1321+ "description": "An explicit position to move the embedded object to. If newPosition.sheetId is set, a new sheet with that ID will be created. If newPosition.newSheet is set to true, a new sheet will be created with an ID that will be chosen for you.",
1322+ "$ref": "EmbeddedObjectPosition"
1323+ },
1324+ "objectId": {
1325+ "description": "The ID of the object to moved.",
1326+ "type": "integer",
1327+ "format": "int32"
1328+ },
1329+ "fields": {
1330+ "format": "google-fieldmask",
1331+ "description": "The fields of OverlayPosition that should be updated when setting a new position. Used only if newPosition.overlayPosition is set, in which case at least one field must be specified. The root `newPosition.overlayPosition` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.",
1332+ "type": "string"
1333+ }
1334+ },
1335+ "id": "UpdateEmbeddedObjectPositionRequest"
1336+ },
1337+ "GetSpreadsheetByDataFilterRequest": {
1338+ "description": "The request for retrieving a Spreadsheet.",
1339+ "type": "object",
1340+ "properties": {
1341+ "excludeTablesInBandedRanges": {
1342+ "description": "True if tables should be excluded in the banded ranges. False if not set.",
1343+ "type": "boolean"
1344+ },
1345+ "dataFilters": {
1346+ "items": {
1347+ "$ref": "DataFilter"
1348+ },
1349+ "description": "The DataFilters used to select which ranges to retrieve from the spreadsheet.",
1350+ "type": "array"
1351+ },
1352+ "includeGridData": {
1353+ "description": "True if grid data should be returned. This parameter is ignored if a field mask was set in the request.",
1354+ "type": "boolean"
1355+ }
1356+ },
1357+ "id": "GetSpreadsheetByDataFilterRequest"
1358+ },
1359+ "AddProtectedRangeResponse": {
1360+ "id": "AddProtectedRangeResponse",
1361+ "description": "The result of adding a new protected range.",
1362+ "type": "object",
1363+ "properties": {
1364+ "protectedRange": {
1365+ "description": "The newly added protected range.",
1366+ "$ref": "ProtectedRange"
1367+ }
1368+ }
1369+ },
1370+ "ChartCustomNumberFormatOptions": {
1371+ "id": "ChartCustomNumberFormatOptions",
1372+ "description": "Custom number formatting options for chart attributes.",
1373+ "type": "object",
1374+ "properties": {
1375+ "prefix": {
1376+ "description": "Custom prefix to be prepended to the chart attribute. This field is optional.",
1377+ "type": "string"
1378+ },
1379+ "suffix": {
1380+ "description": "Custom suffix to be appended to the chart attribute. This field is optional.",
1381+ "type": "string"
1382+ }
1383+ }
1384+ },
1385+ "BasicChartDomain": {
1386+ "id": "BasicChartDomain",
1387+ "description": "The domain of a chart. For example, if charting stock prices over time, this would be the date.",
1388+ "type": "object",
1389+ "properties": {
1390+ "domain": {
1391+ "description": "The data of the domain. For example, if charting stock prices over time, this is the data representing the dates.",
1392+ "$ref": "ChartData"
1393+ },
1394+ "reversed": {
1395+ "description": "True to reverse the order of the domain values (horizontal axis).",
1396+ "type": "boolean"
1397+ }
1398+ }
1399+ },
1400+ "SheetProperties": {
1401+ "id": "SheetProperties",
1402+ "description": "Properties of a sheet.",
1403+ "type": "object",
1404+ "properties": {
1405+ "sheetType": {
1406+ "description": "The type of sheet. Defaults to GRID. This field cannot be changed once set.",
1407+ "type": "string",
1408+ "enumDescriptions": [
1409+ "Default value, do not use.",
1410+ "The sheet is a grid.",
1411+ "The sheet has no grid and instead has an object like a chart or image.",
1412+ "The sheet connects with an external DataSource and shows the preview of data."
1413+ ],
1414+ "enum": [
1415+ "SHEET_TYPE_UNSPECIFIED",
1416+ "GRID",
1417+ "OBJECT",
1418+ "DATA_SOURCE"
1419+ ]
1420+ },
1421+ "index": {
1422+ "format": "int32",
1423+ "description": "The index of the sheet within the spreadsheet. When adding or updating sheet properties, if this field is excluded then the sheet is added or moved to the end of the sheet list. When updating sheet indices or inserting sheets, movement is considered in \"before the move\" indexes. For example, if there were three sheets (S1, S2, S3) in order to move S1 ahead of S2 the index would have to be set to 2. A sheet index update request is ignored if the requested index is identical to the sheets current index or if the requested new index is equal to the current sheet index + 1.",
1424+ "type": "integer"
1425+ },
1426+ "hidden": {
1427+ "description": "True if the sheet is hidden in the UI, false if it's visible.",
1428+ "type": "boolean"
1429+ },
1430+ "gridProperties": {
1431+ "description": "Additional properties of the sheet if this sheet is a grid. (If the sheet is an object sheet, containing a chart or image, then this field will be absent.) When writing it is an error to set any grid properties on non-grid sheets. If this sheet is a DATA_SOURCE sheet, this field is output only but contains the properties that reflect how a data source sheet is rendered in the UI, e.g. row_count.",
1432+ "$ref": "GridProperties"
1433+ },
1434+ "tabColorStyle": {
1435+ "description": "The color of the tab in the UI. If tab_color is also set, this field takes precedence.",
1436+ "$ref": "ColorStyle"
1437+ },
1438+ "rightToLeft": {
1439+ "description": "True if the sheet is an RTL sheet instead of an LTR sheet.",
1440+ "type": "boolean"
1441+ },
1442+ "dataSourceSheetProperties": {
1443+ "description": "Output only. If present, the field contains DATA_SOURCE sheet specific properties.",
1444+ "readOnly": true,
1445+ "$ref": "DataSourceSheetProperties"
1446+ },
1447+ "sheetId": {
1448+ "format": "int32",
1449+ "description": "The ID of the sheet. Must be non-negative. This field cannot be changed once set.",
1450+ "type": "integer"
1451+ },
1452+ "title": {
1453+ "description": "The name of the sheet.",
1454+ "type": "string"
1455+ },
1456+ "tabColor": {
1457+ "description": "The color of the tab in the UI. Deprecated: Use tab_color_style.",
1458+ "deprecated": true,
1459+ "$ref": "Color"
1460+ }
1461+ }
1462+ },
1463+ "UpdateBandingRequest": {
1464+ "id": "UpdateBandingRequest",
1465+ "description": "Updates properties of the supplied banded range.",
1466+ "type": "object",
1467+ "properties": {
1468+ "bandedRange": {
1469+ "description": "The banded range to update with the new properties.",
1470+ "$ref": "BandedRange"
1471+ },
1472+ "fields": {
1473+ "format": "google-fieldmask",
1474+ "description": "The fields that should be updated. At least one field must be specified. The root `bandedRange` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.",
1475+ "type": "string"
1476+ }
1477+ }
1478+ },
1479+ "UpdateFilterViewRequest": {
1480+ "description": "Updates properties of the filter view.",
1481+ "type": "object",
1482+ "properties": {
1483+ "fields": {
1484+ "format": "google-fieldmask",
1485+ "description": "The fields that should be updated. At least one field must be specified. The root `filter` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.",
1486+ "type": "string"
1487+ },
1488+ "filter": {
1489+ "description": "The new properties of the filter view.",
1490+ "$ref": "FilterView"
1491+ }
1492+ },
1493+ "id": "UpdateFilterViewRequest"
1494+ },
1495+ "DataSource": {
1496+ "id": "DataSource",
1497+ "description": "Information about an external data source in the spreadsheet.",
1498+ "type": "object",
1499+ "properties": {
1500+ "dataSourceId": {
1501+ "description": "The spreadsheet-scoped unique ID that identifies the data source. Example: 1080547365.",
1502+ "type": "string"
1503+ },
1504+ "calculatedColumns": {
1505+ "items": {
1506+ "$ref": "DataSourceColumn"
1507+ },
1508+ "description": "All calculated columns in the data source.",
1509+ "type": "array"
1510+ },
1511+ "sheetId": {
1512+ "description": "The ID of the Sheet connected with the data source. The field cannot be changed once set. When creating a data source, an associated DATA_SOURCE sheet is also created, if the field is not specified, the ID of the created sheet will be randomly generated.",
1513+ "type": "integer",
1514+ "format": "int32"
1515+ },
1516+ "spec": {
1517+ "description": "The DataSourceSpec for the data source connected with this spreadsheet.",
1518+ "$ref": "DataSourceSpec"
1519+ }
1520+ }
1521+ },
1522+ "AddDataSourceRequest": {
1523+ "id": "AddDataSourceRequest",
1524+ "description": "Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope if you are adding a BigQuery data source.",
1525+ "type": "object",
1526+ "properties": {
1527+ "dataSource": {
1528+ "description": "The data source to add.",
1529+ "$ref": "DataSource"
1530+ }
1531+ }
1532+ },
1533+ "DeleteFilterViewRequest": {
1534+ "description": "Deletes a particular filter view.",
1535+ "type": "object",
1536+ "properties": {
1537+ "filterId": {
1538+ "description": "The ID of the filter to delete.",
1539+ "type": "integer",
1540+ "format": "int32"
1541+ }
1542+ },
1543+ "id": "DeleteFilterViewRequest"
1544+ },
1545+ "UpdateEmbeddedObjectPositionResponse": {
1546+ "description": "The result of updating an embedded object's position.",
1547+ "type": "object",
1548+ "properties": {
1549+ "position": {
1550+ "description": "The new position of the embedded object.",
1551+ "$ref": "EmbeddedObjectPosition"
1552+ }
1553+ },
1554+ "id": "UpdateEmbeddedObjectPositionResponse"
1555+ },
1556+ "DataSourceSpec": {
1557+ "id": "DataSourceSpec",
1558+ "description": "This specifies the details of the data source. For example, for BigQuery, this specifies information about the BigQuery source.",
1559+ "type": "object",
1560+ "properties": {
1561+ "parameters": {
1562+ "items": {
1563+ "$ref": "DataSourceParameter"
1564+ },
1565+ "description": "The parameters of the data source, used when querying the data source.",
1566+ "type": "array"
1567+ },
1568+ "bigQuery": {
1569+ "description": "A BigQueryDataSourceSpec.",
1570+ "$ref": "BigQueryDataSourceSpec"
1571+ },
1572+ "looker": {
1573+ "description": "A LookerDatasourceSpec.",
1574+ "$ref": "LookerDataSourceSpec"
1575+ }
1576+ }
1577+ },
1578+ "MatchedValueRange": {
1579+ "id": "MatchedValueRange",
1580+ "description": "A value range that was matched by one or more data filers.",
1581+ "type": "object",
1582+ "properties": {
1583+ "dataFilters": {
1584+ "description": "The DataFilters from the request that matched the range of values.",
1585+ "type": "array",
1586+ "items": {
1587+ "$ref": "DataFilter"
1588+ }
1589+ },
1590+ "valueRange": {
1591+ "description": "The values matched by the DataFilter.",
1592+ "$ref": "ValueRange"
1593+ }
1594+ }
1595+ },
1596+ "UpdateValuesByDataFilterResponse": {
1597+ "id": "UpdateValuesByDataFilterResponse",
1598+ "description": "The response when updating a range of values by a data filter in a spreadsheet.",
1599+ "type": "object",
1600+ "properties": {
1601+ "updatedColumns": {
1602+ "description": "The number of columns where at least one cell in the column was updated.",
1603+ "type": "integer",
1604+ "format": "int32"
1605+ },
1606+ "dataFilter": {
1607+ "description": "The data filter that selected the range that was updated.",
1608+ "$ref": "DataFilter"
1609+ },
1610+ "updatedCells": {
1611+ "format": "int32",
1612+ "description": "The number of cells updated.",
1613+ "type": "integer"
1614+ },
1615+ "updatedRange": {
1616+ "description": "The range (in [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell)) that updates were applied to.",
1617+ "type": "string"
1618+ },
1619+ "updatedRows": {
1620+ "description": "The number of rows where at least one cell in the row was updated.",
1621+ "type": "integer",
1622+ "format": "int32"
1623+ },
1624+ "updatedData": {
1625+ "description": "The values of the cells in the range matched by the dataFilter after all updates were applied. This is only included if the request's `includeValuesInResponse` field was `true`.",
1626+ "$ref": "ValueRange"
1627+ }
1628+ }
1629+ },
1630+ "DeveloperMetadata": {
1631+ "id": "DeveloperMetadata",
1632+ "description": "Developer metadata associated with a location or object in a spreadsheet. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). Developer metadata may be used to associate arbitrary data with various parts of a spreadsheet and it will remain associated at those locations as they move around and the spreadsheet is edited. For example, if developer metadata is associated with row 5 and another row is then subsequently inserted above row 5, that original metadata is still associated with the row it was first associated with (what is now row 6). If the associated object is deleted then its metadata is deleted too.",
1633+ "type": "object",
1634+ "properties": {
1635+ "metadataKey": {
1636+ "description": "The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified.",
1637+ "type": "string"
1638+ },
1639+ "visibility": {
1640+ "description": "The metadata visibility. Developer metadata must always have visibility specified.",
1641+ "type": "string",
1642+ "enumDescriptions": [
1643+ "Default value.",
1644+ "Document-visible metadata is accessible from any developer project with access to the document.",
1645+ "Project-visible metadata is only visible to and accessible by the developer project that created the metadata."
1646+ ],
1647+ "enum": [
1648+ "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED",
1649+ "DOCUMENT",
1650+ "PROJECT"
1651+ ]
1652+ },
1653+ "metadataValue": {
1654+ "description": "Data associated with the metadata's key.",
1655+ "type": "string"
1656+ },
1657+ "location": {
1658+ "description": "The location where the metadata is associated.",
1659+ "$ref": "DeveloperMetadataLocation"
1660+ },
1661+ "metadataId": {
1662+ "format": "int32",
1663+ "description": "The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive.",
1664+ "type": "integer"
1665+ }
1666+ }
1667+ },
1668+ "SearchDeveloperMetadataRequest": {
1669+ "description": "A request to retrieve all developer metadata matching the set of specified criteria.",
1670+ "type": "object",
1671+ "properties": {
1672+ "dataFilters": {
1673+ "items": {
1674+ "$ref": "DataFilter"
1675+ },
1676+ "description": "The data filters describing the criteria used to determine which DeveloperMetadata entries to return. DeveloperMetadata matching any of the specified filters are included in the response.",
1677+ "type": "array"
1678+ }
1679+ },
1680+ "id": "SearchDeveloperMetadataRequest"
1681+ },
1682+ "Interval": {
1683+ "description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.",
1684+ "type": "object",
1685+ "properties": {
1686+ "startTime": {
1687+ "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.",
1688+ "type": "string",
1689+ "format": "google-datetime"
1690+ },
1691+ "endTime": {
1692+ "format": "google-datetime",
1693+ "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.",
1694+ "type": "string"
1695+ }
1696+ },
1697+ "id": "Interval"
1698+ },
1699+ "UpdateSpreadsheetPropertiesRequest": {
1700+ "id": "UpdateSpreadsheetPropertiesRequest",
1701+ "description": "Updates properties of a spreadsheet.",
1702+ "type": "object",
1703+ "properties": {
1704+ "properties": {
1705+ "description": "The properties to update.",
1706+ "$ref": "SpreadsheetProperties"
1707+ },
1708+ "fields": {
1709+ "description": "The fields that should be updated. At least one field must be specified. The root 'properties' is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.",
1710+ "type": "string",
1711+ "format": "google-fieldmask"
1712+ }
1713+ }
1714+ },
1715+ "ChartDateTimeRule": {
1716+ "description": "Allows you to organize the date-time values in a source data column into buckets based on selected parts of their date or time values.",
1717+ "type": "object",
1718+ "properties": {
1719+ "type": {
1720+ "description": "The type of date-time grouping to apply.",
1721+ "type": "string",
1722+ "enumDescriptions": [
1723+ "The default type, do not use.",
1724+ "Group dates by second, from 0 to 59.",
1725+ "Group dates by minute, from 0 to 59.",
1726+ "Group dates by hour using a 24-hour system, from 0 to 23.",
1727+ "Group dates by hour and minute using a 24-hour system, for example 19:45.",
1728+ "Group dates by hour and minute using a 12-hour system, for example 7:45 PM. The AM/PM designation is translated based on the spreadsheet locale.",
1729+ "Group dates by day of week, for example Sunday. The days of the week will be translated based on the spreadsheet locale.",
1730+ "Group dates by day of year, from 1 to 366. Note that dates after Feb. 29 fall in different buckets in leap years than in non-leap years.",
1731+ "Group dates by day of month, from 1 to 31.",
1732+ "Group dates by day and month, for example 22-Nov. The month is translated based on the spreadsheet locale.",
1733+ "Group dates by month, for example Nov. The month is translated based on the spreadsheet locale.",
1734+ "Group dates by quarter, for example Q1 (which represents Jan-Mar).",
1735+ "Group dates by year, for example 2008.",
1736+ "Group dates by year and month, for example 2008-Nov. The month is translated based on the spreadsheet locale.",
1737+ "Group dates by year and quarter, for example 2008 Q4.",
1738+ "Group dates by year, month, and day, for example 2008-11-22."
1739+ ],
1740+ "enum": [
1741+ "CHART_DATE_TIME_RULE_TYPE_UNSPECIFIED",
1742+ "SECOND",
1743+ "MINUTE",
1744+ "HOUR",
1745+ "HOUR_MINUTE",
1746+ "HOUR_MINUTE_AMPM",
1747+ "DAY_OF_WEEK",
1748+ "DAY_OF_YEAR",
1749+ "DAY_OF_MONTH",
1750+ "DAY_MONTH",
1751+ "MONTH",
1752+ "QUARTER",
1753+ "YEAR",
1754+ "YEAR_MONTH",
1755+ "YEAR_QUARTER",
1756+ "YEAR_MONTH_DAY"
1757+ ]
1758+ }
1759+ },
1760+ "id": "ChartDateTimeRule"
1761+ },
1762+ "ChartAxisViewWindowOptions": {
1763+ "description": "The options that define a \"view window\" for a chart (such as the visible values in an axis).",
1764+ "type": "object",
1765+ "properties": {
1766+ "viewWindowMax": {
1767+ "description": "The maximum numeric value to be shown in this view window. If unset, will automatically determine a maximum value that looks good for the data.",
1768+ "type": "number",
1769+ "format": "double"
1770+ },
1771+ "viewWindowMin": {
1772+ "description": "The minimum numeric value to be shown in this view window. If unset, will automatically determine a minimum value that looks good for the data.",
1773+ "type": "number",
1774+ "format": "double"
1775+ },
1776+ "viewWindowMode": {
1777+ "enum": [
1778+ "DEFAULT_VIEW_WINDOW_MODE",
1779+ "VIEW_WINDOW_MODE_UNSUPPORTED",
1780+ "EXPLICIT",
1781+ "PRETTY"
1782+ ],
1783+ "description": "The view window's mode.",
1784+ "type": "string",
1785+ "enumDescriptions": [
1786+ "The default view window mode used in the Sheets editor for this chart type. In most cases, if set, the default mode is equivalent to `PRETTY`.",
1787+ "Do not use. Represents that the currently set mode is not supported by the API.",
1788+ "Follows the min and max exactly if specified. If a value is unspecified, it will fall back to the `PRETTY` value.",
1789+ "Chooses a min and max that make the chart look good. Both min and max are ignored in this mode."
1790+ ]
1791+ }
1792+ },
1793+ "id": "ChartAxisViewWindowOptions"
1794+ },
1795+ "AddProtectedRangeRequest": {
1796+ "description": "Adds a new protected range.",
1797+ "type": "object",
1798+ "properties": {
1799+ "protectedRange": {
1800+ "description": "The protected range to be added. The protectedRangeId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of a range that already exists.)",
1801+ "$ref": "ProtectedRange"
1802+ }
1803+ },
1804+ "id": "AddProtectedRangeRequest"
1805+ },
1806+ "HistogramRule": {
1807+ "description": "Allows you to organize the numeric values in a source data column into buckets of a constant size. All values from HistogramRule.start to HistogramRule.end are placed into groups of size HistogramRule.interval. In addition, all values below HistogramRule.start are placed in one group, and all values above HistogramRule.end are placed in another. Only HistogramRule.interval is required, though if HistogramRule.start and HistogramRule.end are both provided, HistogramRule.start must be less than HistogramRule.end. For example, a pivot table showing average purchase amount by age that has 50+ rows: +-----+-------------------+ | Age | AVERAGE of Amount | +-----+-------------------+ | 16 | $27.13 | | 17 | $5.24 | | 18 | $20.15 | ... +-----+-------------------+ could be turned into a pivot table that looks like the one below by applying a histogram group rule with a HistogramRule.start of 25, an HistogramRule.interval of 20, and an HistogramRule.end of 65. +-------------+-------------------+ | Grouped Age | AVERAGE of Amount | +-------------+-------------------+ | \u003c 25 | $19.34 | | 25-45 | $31.43 | | 45-65 | $35.87 | | \u003e 65 | $27.55 | +-------------+-------------------+ | Grand Total | $29.12 | +-------------+-------------------+",
1808+ "type": "object",
1809+ "properties": {
1810+ "interval": {
1811+ "format": "double",
1812+ "description": "The size of the buckets that are created. Must be positive.",
1813+ "type": "number"
1814+ },
1815+ "start": {
1816+ "description": "The minimum value at which items are placed into buckets of constant size. Values below start are lumped into a single bucket. This field is optional.",
1817+ "type": "number",
1818+ "format": "double"
1819+ },
1820+ "end": {
1821+ "description": "The maximum value at which items are placed into buckets of constant size. Values above end are lumped into a single bucket. This field is optional.",
1822+ "type": "number",
1823+ "format": "double"
1824+ }
1825+ },
1826+ "id": "HistogramRule"
1827+ },
1828+ "BooleanRule": {
1829+ "description": "A rule that may or may not match, depending on the condition.",
1830+ "type": "object",
1831+ "properties": {
1832+ "condition": {
1833+ "description": "The condition of the rule. If the condition evaluates to true, the format is applied.",
1834+ "$ref": "BooleanCondition"
1835+ },
1836+ "format": {
1837+ "description": "The format to apply. Conditional formatting can only apply a subset of formatting: bold, italic, strikethrough, foreground color and, background color.",
1838+ "$ref": "CellFormat"
1839+ }
1840+ },
1841+ "id": "BooleanRule"
1842+ },
1843+ "Table": {
1844+ "description": "A table.",
1845+ "type": "object",
1846+ "properties": {
1847+ "name": {
1848+ "description": "The table name. This is unique to all tables in the same spreadsheet.",
1849+ "type": "string"
1850+ },
1851+ "range": {
1852+ "description": "The table range.",
1853+ "$ref": "GridRange"
1854+ },
1855+ "columnProperties": {
1856+ "items": {
1857+ "$ref": "TableColumnProperties"
1858+ },
1859+ "description": "The table column properties.",
1860+ "type": "array"
1861+ },
1862+ "rowsProperties": {
1863+ "description": "The table rows properties.",
1864+ "$ref": "TableRowsProperties"
1865+ },
1866+ "tableId": {
1867+ "description": "The id of the table.",
1868+ "type": "string"
1869+ }
1870+ },
1871+ "id": "Table"
1872+ },
1873+ "Padding": {
1874+ "description": "The amount of padding around the cell, in pixels. When updating padding, every field must be specified.",
1875+ "type": "object",
1876+ "properties": {
1877+ "top": {
1878+ "description": "The top padding of the cell.",
1879+ "type": "integer",
1880+ "format": "int32"
1881+ },
1882+ "right": {
1883+ "format": "int32",
1884+ "description": "The right padding of the cell.",
1885+ "type": "integer"
1886+ },
1887+ "bottom": {
1888+ "format": "int32",
1889+ "description": "The bottom padding of the cell.",
1890+ "type": "integer"
1891+ },
1892+ "left": {
1893+ "description": "The left padding of the cell.",
1894+ "type": "integer",
1895+ "format": "int32"
1896+ }
1897+ },
1898+ "id": "Padding"
1899+ },
1900+ "OrgChartSpec": {
1901+ "description": "An org chart. Org charts require a unique set of labels in labels and may optionally include parent_labels and tooltips. parent_labels contain, for each node, the label identifying the parent node. tooltips contain, for each node, an optional tooltip. For example, to describe an OrgChart with Alice as the CEO, Bob as the President (reporting to Alice) and Cathy as VP of Sales (also reporting to Alice), have labels contain \"Alice\", \"Bob\", \"Cathy\", parent_labels contain \"\", \"Alice\", \"Alice\" and tooltips contain \"CEO\", \"President\", \"VP Sales\".",
1902+ "type": "object",
1903+ "properties": {
1904+ "nodeColorStyle": {
1905+ "description": "The color of the org chart nodes. If node_color is also set, this field takes precedence.",
1906+ "$ref": "ColorStyle"
1907+ },
1908+ "selectedNodeColor": {
1909+ "description": "The color of the selected org chart nodes. Deprecated: Use selected_node_color_style.",
1910+ "deprecated": true,
1911+ "$ref": "Color"
1912+ },
1913+ "parentLabels": {
1914+ "description": "The data containing the label of the parent for the corresponding node. A blank value indicates that the node has no parent and is a top-level node. This field is optional.",
1915+ "$ref": "ChartData"
1916+ },
1917+ "nodeSize": {
1918+ "description": "The size of the org chart nodes.",
1919+ "type": "string",
1920+ "enumDescriptions": [
1921+ "Default value, do not use.",
1922+ "The small org chart node size.",
1923+ "The medium org chart node size.",
1924+ "The large org chart node size."
1925+ ],
1926+ "enum": [
1927+ "ORG_CHART_LABEL_SIZE_UNSPECIFIED",
1928+ "SMALL",
1929+ "MEDIUM",
1930+ "LARGE"
1931+ ]
1932+ },
1933+ "nodeColor": {
1934+ "description": "The color of the org chart nodes. Deprecated: Use node_color_style.",
1935+ "deprecated": true,
1936+ "$ref": "Color"
1937+ },
1938+ "labels": {
1939+ "description": "The data containing the labels for all the nodes in the chart. Labels must be unique.",
1940+ "$ref": "ChartData"
1941+ },
1942+ "selectedNodeColorStyle": {
1943+ "description": "The color of the selected org chart nodes. If selected_node_color is also set, this field takes precedence.",
1944+ "$ref": "ColorStyle"
1945+ },
1946+ "tooltips": {
1947+ "description": "The data containing the tooltip for the corresponding node. A blank value results in no tooltip being displayed for the node. This field is optional.",
1948+ "$ref": "ChartData"
1949+ }
1950+ },
1951+ "id": "OrgChartSpec"
1952+ },
1953+ "EmbeddedObjectBorder": {
1954+ "description": "A border along an embedded object.",
1955+ "type": "object",
1956+ "properties": {
1957+ "color": {
1958+ "description": "The color of the border. Deprecated: Use color_style.",
1959+ "deprecated": true,
1960+ "$ref": "Color"
1961+ },
1962+ "colorStyle": {
1963+ "description": "The color of the border. If color is also set, this field takes precedence.",
1964+ "$ref": "ColorStyle"
1965+ }
1966+ },
1967+ "id": "EmbeddedObjectBorder"
1968+ },
1969+ "DeleteDuplicatesResponse": {
1970+ "description": "The result of removing duplicates in a range.",
1971+ "type": "object",
1972+ "properties": {
1973+ "duplicatesRemovedCount": {
1974+ "format": "int32",
1975+ "description": "The number of duplicate rows removed.",
1976+ "type": "integer"
1977+ }
1978+ },
1979+ "id": "DeleteDuplicatesResponse"
1980+ },
1981+ "DataSourceTable": {
1982+ "id": "DataSourceTable",
1983+ "description": "A data source table, which allows the user to import a static table of data from the DataSource into Sheets. This is also known as \"Extract\" in the Sheets editor.",
1984+ "type": "object",
1985+ "properties": {
1986+ "dataSourceId": {
1987+ "description": "The ID of the data source the data source table is associated with.",
1988+ "type": "string"
1989+ },
1990+ "columnSelectionType": {
1991+ "description": "The type to select columns for the data source table. Defaults to SELECTED.",
1992+ "type": "string",
1993+ "enumDescriptions": [
1994+ "The default column selection type, do not use.",
1995+ "Select columns specified by columns field.",
1996+ "Sync all current and future columns in the data source. If set, the data source table fetches all the columns in the data source at the time of refresh."
1997+ ],
1998+ "enum": [
1999+ "DATA_SOURCE_TABLE_COLUMN_SELECTION_TYPE_UNSPECIFIED",
2000+ "SELECTED",
2001+ "SYNC_ALL"
2002+ ]
2003+ },
2004+ "sortSpecs": {
2005+ "description": "Sort specifications in the data source table. The result of the data source table is sorted based on the sort specifications in order.",
2006+ "type": "array",
2007+ "items": {
2008+ "$ref": "SortSpec"
2009+ }
2010+ },
2011+ "dataExecutionStatus": {
2012+ "description": "Output only. The data execution status.",
2013+ "readOnly": true,
2014+ "$ref": "DataExecutionStatus"
2015+ },
2016+ "filterSpecs": {
2017+ "items": {
2018+ "$ref": "FilterSpec"
2019+ },
2020+ "description": "Filter specifications in the data source table.",
2021+ "type": "array"
2022+ },
2023+ "columns": {
2024+ "items": {
2025+ "$ref": "DataSourceColumnReference"
2026+ },
2027+ "description": "Columns selected for the data source table. The column_selection_type must be SELECTED.",
2028+ "type": "array"
2029+ },
2030+ "rowLimit": {
2031+ "description": "The limit of rows to return. If not set, a default limit is applied. Please refer to the Sheets editor for the default and max limit.",
2032+ "type": "integer",
2033+ "format": "int32"
2034+ }
2035+ }
2036+ },
2037+ "BandedRange": {
2038+ "description": "A banded (alternating colors) range in a sheet.",
2039+ "type": "object",
2040+ "properties": {
2041+ "bandedRangeId": {
2042+ "description": "The ID of the banded range. If unset, refer to banded_range_reference.",
2043+ "type": "integer",
2044+ "format": "int32"
2045+ },
2046+ "rowProperties": {
2047+ "description": "Properties for row bands. These properties are applied on a row-by-row basis throughout all the rows in the range. At least one of row_properties or column_properties must be specified.",
2048+ "$ref": "BandingProperties"
2049+ },
2050+ "range": {
2051+ "description": "The range over which these properties are applied.",
2052+ "$ref": "GridRange"
2053+ },
2054+ "bandedRangeReference": {
2055+ "description": "Output only. The reference of the banded range, used to identify the ID that is not supported by the banded_range_id.",
2056+ "readOnly": true,
2057+ "type": "string"
2058+ },
2059+ "columnProperties": {
2060+ "description": "Properties for column bands. These properties are applied on a column- by-column basis throughout all the columns in the range. At least one of row_properties or column_properties must be specified.",
2061+ "$ref": "BandingProperties"
2062+ }
2063+ },
2064+ "id": "BandedRange"
2065+ },
2066+ "DeleteProtectedRangeRequest": {
2067+ "id": "DeleteProtectedRangeRequest",
2068+ "description": "Deletes the protected range with the given ID.",
2069+ "type": "object",
2070+ "properties": {
2071+ "protectedRangeId": {
2072+ "format": "int32",
2073+ "description": "The ID of the protected range to delete.",
2074+ "type": "integer"
2075+ }
2076+ }
2077+ },
2078+ "PivotGroupLimit": {
2079+ "description": "The count limit on rows or columns in the pivot group.",
2080+ "type": "object",
2081+ "properties": {
2082+ "countLimit": {
2083+ "description": "The count limit.",
2084+ "type": "integer",
2085+ "format": "int32"
2086+ },
2087+ "applyOrder": {
2088+ "format": "int32",
2089+ "description": "The order in which the group limit is applied to the pivot table. Pivot group limits are applied from lower to higher order number. Order numbers are normalized to consecutive integers from 0. For write request, to fully customize the applying orders, all pivot group limits should have this field set with an unique number. Otherwise, the order is determined by the index in the PivotTable.rows list and then the PivotTable.columns list.",
2090+ "type": "integer"
2091+ }
2092+ },
2093+ "id": "PivotGroupLimit"
2094+ },
2095+ "BatchUpdateValuesByDataFilterRequest": {
2096+ "id": "BatchUpdateValuesByDataFilterRequest",
2097+ "description": "The request for updating more than one range of values in a spreadsheet.",
2098+ "type": "object",
2099+ "properties": {
2100+ "responseValueRenderOption": {
2101+ "description": "Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.",
2102+ "type": "string",
2103+ "enumDescriptions": [
2104+ "Values will be calculated & formatted in the response according to the cell's formatting. Formatting is based on the spreadsheet's locale, not the requesting user's locale. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return `\"$1.23\"`.",
2105+ "Values will be calculated, but not formatted in the reply. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return the number `1.23`.",
2106+ "Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `\"=A1\"`. Sheets treats date and time values as decimal values. This lets you perform arithmetic on them in formulas. For more information on interpreting date and time values, see [About date & time values](https://developers.google.com/workspace/sheets/api/guides/formats#about_date_time_values)."
2107+ ],
2108+ "enum": [
2109+ "FORMATTED_VALUE",
2110+ "UNFORMATTED_VALUE",
2111+ "FORMULA"
2112+ ]
2113+ },
2114+ "data": {
2115+ "description": "The new values to apply to the spreadsheet. If more than one range is matched by the specified DataFilter the specified values are applied to all of those ranges.",
2116+ "type": "array",
2117+ "items": {
2118+ "$ref": "DataFilterValueRange"
2119+ }
2120+ },
2121+ "responseDateTimeRenderOption": {
2122+ "description": "Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.",
2123+ "type": "string",
2124+ "enumDescriptions": [
2125+ "Instructs date, time, datetime, and duration fields to be output as doubles in \"serial number\" format, as popularized by Lotus 1-2-3. The whole number portion of the value (left of the decimal) counts the days since December 30th 1899. The fractional portion (right of the decimal) counts the time as a fraction of the day. For example, January 1st 1900 at noon would be 2.5, 2 because it's 2 days after December 30th 1899, and .5 because noon is half a day. February 1st 1900 at 3pm would be 33.625. This correctly treats the year 1900 as not a leap year.",
2126+ "Instructs date, time, datetime, and duration fields to be output as strings in their given number format (which depends on the spreadsheet locale)."
2127+ ],
2128+ "enum": [
2129+ "SERIAL_NUMBER",
2130+ "FORMATTED_STRING"
2131+ ]
2132+ },
2133+ "valueInputOption": {
2134+ "enum": [
2135+ "INPUT_VALUE_OPTION_UNSPECIFIED",
2136+ "RAW",
2137+ "USER_ENTERED"
2138+ ],
2139+ "description": "How the input data should be interpreted.",
2140+ "type": "string",
2141+ "enumDescriptions": [
2142+ "Default input value. This value must not be used.",
2143+ "The values the user has entered will not be parsed and will be stored as-is.",
2144+ "The values will be parsed as if the user typed them into the UI. Numbers will stay as numbers, but strings may be converted to numbers, dates, etc. following the same rules that are applied when entering text into a cell via the Google Sheets UI."
2145+ ]
2146+ },
2147+ "includeValuesInResponse": {
2148+ "description": "Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses contains the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).",
2149+ "type": "boolean"
2150+ }
2151+ }
2152+ },
2153+ "UpdateNamedRangeRequest": {
2154+ "id": "UpdateNamedRangeRequest",
2155+ "description": "Updates properties of the named range with the specified namedRangeId.",
2156+ "type": "object",
2157+ "properties": {
2158+ "namedRange": {
2159+ "description": "The named range to update with the new properties.",
2160+ "$ref": "NamedRange"
2161+ },
2162+ "fields": {
2163+ "description": "The fields that should be updated. At least one field must be specified. The root `namedRange` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.",
2164+ "type": "string",
2165+ "format": "google-fieldmask"
2166+ }
2167+ }
2168+ },
2169+ "DeleteConditionalFormatRuleResponse": {
2170+ "id": "DeleteConditionalFormatRuleResponse",
2171+ "description": "The result of deleting a conditional format rule.",
2172+ "type": "object",
2173+ "properties": {
2174+ "rule": {
2175+ "description": "The rule that was deleted.",
2176+ "$ref": "ConditionalFormatRule"
2177+ }
2178+ }
2179+ },
2180+ "TrimWhitespaceRequest": {
2181+ "description": "Trims the whitespace (such as spaces, tabs, or new lines) in every cell in the specified range. This request removes all whitespace from the start and end of each cell's text, and reduces any subsequence of remaining whitespace characters to a single space. If the resulting trimmed text starts with a '+' or '=' character, the text remains as a string value and isn't interpreted as a formula.",
2182+ "type": "object",
2183+ "properties": {
2184+ "range": {
2185+ "description": "The range whose cells to trim.",
2186+ "$ref": "GridRange"
2187+ }
2188+ },
2189+ "id": "TrimWhitespaceRequest"
2190+ },
2191+ "AddSlicerResponse": {
2192+ "id": "AddSlicerResponse",
2193+ "description": "The result of adding a slicer to a spreadsheet.",
2194+ "type": "object",
2195+ "properties": {
2196+ "slicer": {
2197+ "description": "The newly added slicer.",
2198+ "$ref": "Slicer"
2199+ }
2200+ }
2201+ },
2202+ "GradientRule": {
2203+ "id": "GradientRule",
2204+ "description": "A rule that applies a gradient color scale format, based on the interpolation points listed. The format of a cell will vary based on its contents as compared to the values of the interpolation points.",
2205+ "type": "object",
2206+ "properties": {
2207+ "minpoint": {
2208+ "description": "The starting interpolation point.",
2209+ "$ref": "InterpolationPoint"
2210+ },
2211+ "midpoint": {
2212+ "description": "An optional midway interpolation point.",
2213+ "$ref": "InterpolationPoint"
2214+ },
2215+ "maxpoint": {
2216+ "description": "The final interpolation point.",
2217+ "$ref": "InterpolationPoint"
2218+ }
2219+ }
2220+ },
2221+ "BubbleChartSpec": {
2222+ "id": "BubbleChartSpec",
2223+ "description": "A bubble chart.",
2224+ "type": "object",
2225+ "properties": {
2226+ "bubbleLabels": {
2227+ "description": "The data containing the bubble labels. These do not need to be unique.",
2228+ "$ref": "ChartData"
2229+ },
2230+ "domain": {
2231+ "description": "The data containing the bubble x-values. These values locate the bubbles in the chart horizontally.",
2232+ "$ref": "ChartData"
2233+ },
2234+ "series": {
2235+ "description": "The data containing the bubble y-values. These values locate the bubbles in the chart vertically.",
2236+ "$ref": "ChartData"
2237+ },
2238+ "bubbleSizes": {
2239+ "description": "The data containing the bubble sizes. Bubble sizes are used to draw the bubbles at different sizes relative to each other. If specified, group_ids must also be specified. This field is optional.",
2240+ "$ref": "ChartData"
2241+ },
2242+ "bubbleOpacity": {
2243+ "description": "The opacity of the bubbles between 0 and 1.0. 0 is fully transparent and 1 is fully opaque.",
2244+ "type": "number",
2245+ "format": "float"
2246+ },
2247+ "bubbleBorderColorStyle": {
2248+ "description": "The bubble border color. If bubble_border_color is also set, this field takes precedence.",
2249+ "$ref": "ColorStyle"
2250+ },
2251+ "bubbleMaxRadiusSize": {
2252+ "description": "The max radius size of the bubbles, in pixels. If specified, the field must be a positive value.",
2253+ "type": "integer",
2254+ "format": "int32"
2255+ },
2256+ "bubbleBorderColor": {
2257+ "description": "The bubble border color. Deprecated: Use bubble_border_color_style.",
2258+ "deprecated": true,
2259+ "$ref": "Color"
2260+ },
2261+ "bubbleTextStyle": {
2262+ "description": "The format of the text inside the bubbles. Strikethrough, underline, and link are not supported.",
2263+ "$ref": "TextFormat"
2264+ },
2265+ "bubbleMinRadiusSize": {
2266+ "format": "int32",
2267+ "description": "The minimum radius size of the bubbles, in pixels. If specific, the field must be a positive value.",
2268+ "type": "integer"
2269+ },
2270+ "groupIds": {
2271+ "description": "The data containing the bubble group IDs. All bubbles with the same group ID are drawn in the same color. If bubble_sizes is specified then this field must also be specified but may contain blank values. This field is optional.",
2272+ "$ref": "ChartData"
2273+ },
2274+ "legendPosition": {
2275+ "description": "Where the legend of the chart should be drawn.",
2276+ "type": "string",
2277+ "enumDescriptions": [
2278+ "Default value, do not use.",
2279+ "The legend is rendered on the bottom of the chart.",
2280+ "The legend is rendered on the left of the chart.",
2281+ "The legend is rendered on the right of the chart.",
2282+ "The legend is rendered on the top of the chart.",
2283+ "No legend is rendered.",
2284+ "The legend is rendered inside the chart area."
2285+ ],
2286+ "enum": [
2287+ "BUBBLE_CHART_LEGEND_POSITION_UNSPECIFIED",
2288+ "BOTTOM_LEGEND",
2289+ "LEFT_LEGEND",
2290+ "RIGHT_LEGEND",
2291+ "TOP_LEGEND",
2292+ "NO_LEGEND",
2293+ "INSIDE_LEGEND"
2294+ ]
2295+ }
2296+ }
2297+ },
2298+ "DataFilter": {
2299+ "description": "Filter that describes what data should be selected or returned from a request. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata).",
2300+ "type": "object",
2301+ "properties": {
2302+ "gridRange": {
2303+ "description": "Selects data that matches the range described by the GridRange.",
2304+ "$ref": "GridRange"
2305+ },
2306+ "a1Range": {
2307+ "description": "Selects data that matches the specified A1 range.",
2308+ "type": "string"
2309+ },
2310+ "developerMetadataLookup": {
2311+ "description": "Selects data associated with the developer metadata matching the criteria described by this DeveloperMetadataLookup.",
2312+ "$ref": "DeveloperMetadataLookup"
2313+ }
2314+ },
2315+ "id": "DataFilter"
2316+ },
2317+ "CreateDeveloperMetadataResponse": {
2318+ "id": "CreateDeveloperMetadataResponse",
2319+ "description": "The response from creating developer metadata.",
2320+ "type": "object",
2321+ "properties": {
2322+ "developerMetadata": {
2323+ "description": "The developer metadata that was created.",
2324+ "$ref": "DeveloperMetadata"
2325+ }
2326+ }
2327+ },
2328+ "CellFormat": {
2329+ "description": "The format of a cell.",
2330+ "type": "object",
2331+ "properties": {
2332+ "textFormat": {
2333+ "description": "The format of the text in the cell (unless overridden by a format run). Setting a cell-level link here clears the cell's existing links. Setting the link field in a TextFormatRun takes precedence over the cell-level link.",
2334+ "$ref": "TextFormat"
2335+ },
2336+ "numberFormat": {
2337+ "description": "A format describing how number values should be represented to the user.",
2338+ "$ref": "NumberFormat"
2339+ },
2340+ "borders": {
2341+ "description": "The borders of the cell.",
2342+ "$ref": "Borders"
2343+ },
2344+ "padding": {
2345+ "description": "The padding of the cell.",
2346+ "$ref": "Padding"
2347+ },
2348+ "hyperlinkDisplayType": {
2349+ "description": "If one exists, how a hyperlink should be displayed in the cell.",
2350+ "type": "string",
2351+ "enumDescriptions": [
2352+ "The default value: the hyperlink is rendered. Do not use this.",
2353+ "A hyperlink should be explicitly rendered.",
2354+ "A hyperlink should not be rendered."
2355+ ],
2356+ "enum": [
2357+ "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED",
2358+ "LINKED",
2359+ "PLAIN_TEXT"
2360+ ]
2361+ },
2362+ "backgroundColorStyle": {
2363+ "description": "The background color of the cell. If background_color is also set, this field takes precedence.",
2364+ "$ref": "ColorStyle"
2365+ },
2366+ "wrapStrategy": {
2367+ "enum": [
2368+ "WRAP_STRATEGY_UNSPECIFIED",
2369+ "OVERFLOW_CELL",
2370+ "LEGACY_WRAP",
2371+ "CLIP",
2372+ "WRAP"
2373+ ],
2374+ "description": "The wrap strategy for the value in the cell.",
2375+ "type": "string",
2376+ "enumDescriptions": [
2377+ "The default value, do not use.",
2378+ "Lines that are longer than the cell width will be written in the next cell over, so long as that cell is empty. If the next cell over is non-empty, this behaves the same as `CLIP`. The text will never wrap to the next line unless the user manually inserts a new line. Example: | First sentence. | | Manual newline that is very long. \u003c- Text continues into next cell | Next newline. |",
2379+ "This wrap strategy represents the old Google Sheets wrap strategy where words that are longer than a line are clipped rather than broken. This strategy is not supported on all platforms and is being phased out. Example: | Cell has a | | loooooooooo| \u003c- Word is clipped. | word. |",
2380+ "Lines that are longer than the cell width will be clipped. The text will never wrap to the next line unless the user manually inserts a new line. Example: | First sentence. | | Manual newline t| \u003c- Text is clipped | Next newline. |",
2381+ "Words that are longer than a line are wrapped at the character level rather than clipped. Example: | Cell has a | | loooooooooo| \u003c- Word is broken. | ong word. |"
2382+ ]
2383+ },
2384+ "horizontalAlignment": {
2385+ "description": "The horizontal alignment of the value in the cell.",
2386+ "type": "string",
2387+ "enumDescriptions": [
2388+ "The horizontal alignment is not specified. Do not use this.",
2389+ "The text is explicitly aligned to the left of the cell.",
2390+ "The text is explicitly aligned to the center of the cell.",
2391+ "The text is explicitly aligned to the right of the cell."
2392+ ],
2393+ "enum": [
2394+ "HORIZONTAL_ALIGN_UNSPECIFIED",
2395+ "LEFT",
2396+ "CENTER",
2397+ "RIGHT"
2398+ ]
2399+ },
2400+ "textDirection": {
2401+ "description": "The direction of the text in the cell.",
2402+ "type": "string",
2403+ "enumDescriptions": [
2404+ "The text direction is not specified. Do not use this.",
2405+ "The text direction of left-to-right was set by the user.",
2406+ "The text direction of right-to-left was set by the user."
2407+ ],
2408+ "enum": [
2409+ "TEXT_DIRECTION_UNSPECIFIED",
2410+ "LEFT_TO_RIGHT",
2411+ "RIGHT_TO_LEFT"
2412+ ]
2413+ },
2414+ "textRotation": {
2415+ "description": "The rotation applied to text in the cell.",
2416+ "$ref": "TextRotation"
2417+ },
2418+ "backgroundColor": {
2419+ "description": "The background color of the cell. Deprecated: Use background_color_style.",
2420+ "deprecated": true,
2421+ "$ref": "Color"
2422+ },
2423+ "verticalAlignment": {
2424+ "description": "The vertical alignment of the value in the cell.",
2425+ "type": "string",
2426+ "enumDescriptions": [
2427+ "The vertical alignment is not specified. Do not use this.",
2428+ "The text is explicitly aligned to the top of the cell.",
2429+ "The text is explicitly aligned to the middle of the cell.",
2430+ "The text is explicitly aligned to the bottom of the cell."
2431+ ],
2432+ "enum": [
2433+ "VERTICAL_ALIGN_UNSPECIFIED",
2434+ "TOP",
2435+ "MIDDLE",
2436+ "BOTTOM"
2437+ ]
2438+ }
2439+ },
2440+ "id": "CellFormat"
2441+ },
2442+ "CandlestickDomain": {
2443+ "description": "The domain of a CandlestickChart.",
2444+ "type": "object",
2445+ "properties": {
2446+ "reversed": {
2447+ "description": "True to reverse the order of the domain values (horizontal axis).",
2448+ "type": "boolean"
2449+ },
2450+ "data": {
2451+ "description": "The data of the CandlestickDomain.",
2452+ "$ref": "ChartData"
2453+ }
2454+ },
2455+ "id": "CandlestickDomain"
2456+ },
2457+ "LookerDataSourceSpec": {
2458+ "id": "LookerDataSourceSpec",
2459+ "description": "The specification of a Looker data source.",
2460+ "type": "object",
2461+ "properties": {
2462+ "explore": {
2463+ "description": "Name of a Looker model explore.",
2464+ "type": "string"
2465+ },
2466+ "model": {
2467+ "description": "Name of a Looker model.",
2468+ "type": "string"
2469+ },
2470+ "instanceUri": {
2471+ "description": "A Looker instance URL.",
2472+ "type": "string"
2473+ }
2474+ }
2475+ },
2476+ "WaterfallChartSeries": {
2477+ "id": "WaterfallChartSeries",
2478+ "description": "A single series of data for a waterfall chart.",
2479+ "type": "object",
2480+ "properties": {
2481+ "subtotalColumnsStyle": {
2482+ "description": "Styles for all subtotal columns in this series.",
2483+ "$ref": "WaterfallChartColumnStyle"
2484+ },
2485+ "data": {
2486+ "description": "The data being visualized in this series.",
2487+ "$ref": "ChartData"
2488+ },
2489+ "positiveColumnsStyle": {
2490+ "description": "Styles for all columns in this series with positive values.",
2491+ "$ref": "WaterfallChartColumnStyle"
2492+ },
2493+ "hideTrailingSubtotal": {
2494+ "description": "True to hide the subtotal column from the end of the series. By default, a subtotal column will appear at the end of each series. Setting this field to true will hide that subtotal column for this series.",
2495+ "type": "boolean"
2496+ },
2497+ "dataLabel": {
2498+ "description": "Information about the data labels for this series.",
2499+ "$ref": "DataLabel"
2500+ },
2501+ "customSubtotals": {
2502+ "description": "Custom subtotal columns appearing in this series. The order in which subtotals are defined is not significant. Only one subtotal may be defined for each data point.",
2503+ "type": "array",
2504+ "items": {
2505+ "$ref": "WaterfallChartCustomSubtotal"
2506+ }
2507+ },
2508+ "negativeColumnsStyle": {
2509+ "description": "Styles for all columns in this series with negative values.",
2510+ "$ref": "WaterfallChartColumnStyle"
2511+ }
2512+ }
2513+ },
2514+ "BandingProperties": {
2515+ "id": "BandingProperties",
2516+ "description": "Properties referring a single dimension (either row or column). If both BandedRange.row_properties and BandedRange.column_properties are set, the fill colors are applied to cells according to the following rules: * header_color and footer_color take priority over band colors. * first_band_color takes priority over second_band_color. * row_properties takes priority over column_properties. For example, the first row color takes priority over the first column color, but the first column color takes priority over the second row color. Similarly, the row header takes priority over the column header in the top left cell, but the column header takes priority over the first row color if the row header is not set.",
2517+ "type": "object",
2518+ "properties": {
2519+ "headerColorStyle": {
2520+ "description": "The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column is filled with first_band_color and the colors proceed to alternate as they normally would. If header_color is also set, this field takes precedence.",
2521+ "$ref": "ColorStyle"
2522+ },
2523+ "headerColor": {
2524+ "description": "The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column is filled with first_band_color and the colors proceed to alternate as they normally would. Deprecated: Use header_color_style.",
2525+ "deprecated": true,
2526+ "$ref": "Color"
2527+ },
2528+ "secondBandColor": {
2529+ "description": "The second color that is alternating. (Required) Deprecated: Use second_band_color_style.",
2530+ "deprecated": true,
2531+ "$ref": "Color"
2532+ },
2533+ "firstBandColor": {
2534+ "description": "The first color that is alternating. (Required) Deprecated: Use first_band_color_style.",
2535+ "deprecated": true,
2536+ "$ref": "Color"
2537+ },
2538+ "footerColor": {
2539+ "description": "The color of the last row or column. If this field is not set, the last row or column is filled with either first_band_color or second_band_color, depending on the color of the previous row or column. Deprecated: Use footer_color_style.",
2540+ "deprecated": true,
2541+ "$ref": "Color"
2542+ },
2543+ "footerColorStyle": {
2544+ "description": "The color of the last row or column. If this field is not set, the last row or column is filled with either first_band_color or second_band_color, depending on the color of the previous row or column. If footer_color is also set, this field takes precedence.",
2545+ "$ref": "ColorStyle"
2546+ },
2547+ "firstBandColorStyle": {
2548+ "description": "The first color that is alternating. (Required) If first_band_color is also set, this field takes precedence.",
2549+ "$ref": "ColorStyle"
2550+ },
2551+ "secondBandColorStyle": {
2552+ "description": "The second color that is alternating. (Required) If second_band_color is also set, this field takes precedence.",
2553+ "$ref": "ColorStyle"
2554+ }
2555+ }
2556+ },
2557+ "SetDataValidationRequest": {
2558+ "id": "SetDataValidationRequest",
2559+ "description": "Sets a data validation rule to every cell in the range. To clear validation in a range, call this with no rule specified.",
2560+ "type": "object",
2561+ "properties": {
2562+ "filteredRowsIncluded": {
2563+ "description": "Optional. If true, the data validation rule will be applied to the filtered rows as well.",
2564+ "type": "boolean"
2565+ },
2566+ "range": {
2567+ "description": "The range the data validation rule should apply to.",
2568+ "$ref": "GridRange"
2569+ },
2570+ "rule": {
2571+ "description": "The data validation rule to set on each cell in the range, or empty to clear the data validation in the range.",
2572+ "$ref": "DataValidationRule"
2573+ }
2574+ }
2575+ },
2576+ "BatchUpdateValuesResponse": {
2577+ "description": "The response when updating a range of values in a spreadsheet.",
2578+ "type": "object",
2579+ "properties": {
2580+ "spreadsheetId": {
2581+ "description": "The spreadsheet the updates were applied to.",
2582+ "type": "string"
2583+ },
2584+ "responses": {
2585+ "items": {
2586+ "$ref": "UpdateValuesResponse"
2587+ },
2588+ "description": "One UpdateValuesResponse per requested range, in the same order as the requests appeared.",
2589+ "type": "array"
2590+ },
2591+ "totalUpdatedCells": {
2592+ "description": "The total number of cells updated.",
2593+ "type": "integer",
2594+ "format": "int32"
2595+ },
2596+ "totalUpdatedSheets": {
2597+ "format": "int32",
2598+ "description": "The total number of sheets where at least one cell in the sheet was updated.",
2599+ "type": "integer"
2600+ },
2601+ "totalUpdatedRows": {
2602+ "description": "The total number of rows where at least one cell in the row was updated.",
2603+ "type": "integer",
2604+ "format": "int32"
2605+ },
2606+ "totalUpdatedColumns": {
2607+ "format": "int32",
2608+ "description": "The total number of columns where at least one cell in the column was updated.",
2609+ "type": "integer"
2610+ }
2611+ },
2612+ "id": "BatchUpdateValuesResponse"
2613+ },
2614+ "AddBandingResponse": {
2615+ "description": "The result of adding a banded range.",
2616+ "type": "object",
2617+ "properties": {
2618+ "bandedRange": {
2619+ "description": "The banded range that was added.",
2620+ "$ref": "BandedRange"
2621+ }
2622+ },
2623+ "id": "AddBandingResponse"
2624+ },
2625+ "TableRowsProperties": {
2626+ "description": "The table row properties.",
2627+ "type": "object",
2628+ "properties": {
2629+ "secondBandColorStyle": {
2630+ "description": "The second color that is alternating. If this field is set, the second banded row is filled with the specified color. Otherwise, the second banded row is filled with a default color.",
2631+ "$ref": "ColorStyle"
2632+ },
2633+ "firstBandColorStyle": {
2634+ "description": "The first color that is alternating. If this field is set, the first banded row is filled with the specified color. Otherwise, the first banded row is filled with a default color.",
2635+ "$ref": "ColorStyle"
2636+ },
2637+ "headerColorStyle": {
2638+ "description": "The color of the header row. If this field is set, the header row is filled with the specified color. Otherwise, the header row is filled with a default color.",
2639+ "$ref": "ColorStyle"
2640+ },
2641+ "footerColorStyle": {
2642+ "description": "The color of the last row. If this field is not set a footer is not added, the last row is filled with either first_band_color_style or second_band_color_style, depending on the color of the previous row. If updating an existing table without a footer to have a footer, the range will be expanded by 1 row. If updating an existing table with a footer and removing a footer, the range will be shrunk by 1 row.",
2643+ "$ref": "ColorStyle"
2644+ }
2645+ },
2646+ "id": "TableRowsProperties"
2647+ },
2648+ "PivotTable": {
2649+ "description": "A pivot table.",
2650+ "type": "object",
2651+ "properties": {
2652+ "values": {
2653+ "items": {
2654+ "$ref": "PivotValue"
2655+ },
2656+ "description": "A list of values to include in the pivot table.",
2657+ "type": "array"
2658+ },
2659+ "criteria": {
2660+ "description": "An optional mapping of filters per source column offset. The filters are applied before aggregating data into the pivot table. The map's key is the column offset of the source range that you want to filter, and the value is the criteria for that column. For example, if the source was `C10:E15`, a key of `0` will have the filter for column `C`, whereas the key `1` is for column `D`. This field is deprecated in favor of filter_specs.",
2661+ "deprecated": true,
2662+ "type": "object",
2663+ "additionalProperties": {
2664+ "$ref": "PivotFilterCriteria"
2665+ }
2666+ },
2667+ "valueLayout": {
2668+ "enum": [
2669+ "HORIZONTAL",
2670+ "VERTICAL"
2671+ ],
2672+ "description": "Whether values should be listed horizontally (as columns) or vertically (as rows).",
2673+ "type": "string",
2674+ "enumDescriptions": [
2675+ "Values are laid out horizontally (as columns).",
2676+ "Values are laid out vertically (as rows)."
2677+ ]
2678+ },
2679+ "filterSpecs": {
2680+ "description": "The filters applied to the source columns before aggregating data for the pivot table. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence.",
2681+ "type": "array",
2682+ "items": {
2683+ "$ref": "PivotFilterSpec"
2684+ }
2685+ },
2686+ "source": {
2687+ "description": "The range the pivot table is reading data from.",
2688+ "$ref": "GridRange"
2689+ },
2690+ "columns": {
2691+ "items": {
2692+ "$ref": "PivotGroup"
2693+ },
2694+ "description": "Each column grouping in the pivot table.",
2695+ "type": "array"
2696+ },
2697+ "dataSourceId": {
2698+ "description": "The ID of the data source the pivot table is reading data from.",
2699+ "type": "string"
2700+ },
2701+ "rows": {
2702+ "items": {
2703+ "$ref": "PivotGroup"
2704+ },
2705+ "description": "Each row grouping in the pivot table.",
2706+ "type": "array"
2707+ },
2708+ "dataExecutionStatus": {
2709+ "description": "Output only. The data execution status for data source pivot tables.",
2710+ "readOnly": true,
2711+ "$ref": "DataExecutionStatus"
2712+ }
2713+ },
2714+ "id": "PivotTable"
2715+ },
2716+ "DataSourceObjectReferences": {
2717+ "id": "DataSourceObjectReferences",
2718+ "description": "A list of references to data source objects.",
2719+ "type": "object",
2720+ "properties": {
2721+ "references": {
2722+ "description": "The references.",
2723+ "type": "array",
2724+ "items": {
2725+ "$ref": "DataSourceObjectReference"
2726+ }
2727+ }
2728+ }
2729+ },
2730+ "BatchUpdateValuesRequest": {
2731+ "id": "BatchUpdateValuesRequest",
2732+ "description": "The request for updating more than one range of values in a spreadsheet.",
2733+ "type": "object",
2734+ "properties": {
2735+ "responseValueRenderOption": {
2736+ "description": "Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.",
2737+ "type": "string",
2738+ "enumDescriptions": [
2739+ "Values will be calculated & formatted in the response according to the cell's formatting. Formatting is based on the spreadsheet's locale, not the requesting user's locale. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return `\"$1.23\"`.",
2740+ "Values will be calculated, but not formatted in the reply. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return the number `1.23`.",
2741+ "Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `\"=A1\"`. Sheets treats date and time values as decimal values. This lets you perform arithmetic on them in formulas. For more information on interpreting date and time values, see [About date & time values](https://developers.google.com/workspace/sheets/api/guides/formats#about_date_time_values)."
2742+ ],
2743+ "enum": [
2744+ "FORMATTED_VALUE",
2745+ "UNFORMATTED_VALUE",
2746+ "FORMULA"
2747+ ]
2748+ },
2749+ "data": {
2750+ "items": {
2751+ "$ref": "ValueRange"
2752+ },
2753+ "description": "The new values to apply to the spreadsheet.",
2754+ "type": "array"
2755+ },
2756+ "responseDateTimeRenderOption": {
2757+ "enum": [
2758+ "SERIAL_NUMBER",
2759+ "FORMATTED_STRING"
2760+ ],
2761+ "description": "Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.",
2762+ "type": "string",
2763+ "enumDescriptions": [
2764+ "Instructs date, time, datetime, and duration fields to be output as doubles in \"serial number\" format, as popularized by Lotus 1-2-3. The whole number portion of the value (left of the decimal) counts the days since December 30th 1899. The fractional portion (right of the decimal) counts the time as a fraction of the day. For example, January 1st 1900 at noon would be 2.5, 2 because it's 2 days after December 30th 1899, and .5 because noon is half a day. February 1st 1900 at 3pm would be 33.625. This correctly treats the year 1900 as not a leap year.",
2765+ "Instructs date, time, datetime, and duration fields to be output as strings in their given number format (which depends on the spreadsheet locale)."
2766+ ]
2767+ },
2768+ "valueInputOption": {
2769+ "description": "How the input data should be interpreted.",
2770+ "type": "string",
2771+ "enumDescriptions": [
2772+ "Default input value. This value must not be used.",
2773+ "The values the user has entered will not be parsed and will be stored as-is.",
2774+ "The values will be parsed as if the user typed them into the UI. Numbers will stay as numbers, but strings may be converted to numbers, dates, etc. following the same rules that are applied when entering text into a cell via the Google Sheets UI."
2775+ ],
2776+ "enum": [
2777+ "INPUT_VALUE_OPTION_UNSPECIFIED",
2778+ "RAW",
2779+ "USER_ENTERED"
2780+ ]
2781+ },
2782+ "includeValuesInResponse": {
2783+ "description": "Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses contains the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).",
2784+ "type": "boolean"
2785+ }
2786+ }
2787+ },
2788+ "DataSourceRefreshSchedule": {
2789+ "id": "DataSourceRefreshSchedule",
2790+ "description": "Schedule for refreshing the data source. Data sources in the spreadsheet are refreshed within a time interval. You can specify the start time by clicking the Scheduled Refresh button in the Sheets editor, but the interval is fixed at 4 hours. For example, if you specify a start time of 8 AM , the refresh will take place between 8 AM and 12 PM every day.",
2791+ "type": "object",
2792+ "properties": {
2793+ "refreshScope": {
2794+ "description": "The scope of the refresh. Must be ALL_DATA_SOURCES.",
2795+ "type": "string",
2796+ "enumDescriptions": [
2797+ "Default value, do not use.",
2798+ "Refreshes all data sources and their associated data source objects in the spreadsheet."
2799+ ],
2800+ "enum": [
2801+ "DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED",
2802+ "ALL_DATA_SOURCES"
2803+ ]
2804+ },
2805+ "enabled": {
2806+ "description": "True if the refresh schedule is enabled, or false otherwise.",
2807+ "type": "boolean"
2808+ },
2809+ "weeklySchedule": {
2810+ "description": "Weekly refresh schedule.",
2811+ "$ref": "DataSourceRefreshWeeklySchedule"
2812+ },
2813+ "monthlySchedule": {
2814+ "description": "Monthly refresh schedule.",
2815+ "$ref": "DataSourceRefreshMonthlySchedule"
2816+ },
2817+ "dailySchedule": {
2818+ "description": "Daily refresh schedule.",
2819+ "$ref": "DataSourceRefreshDailySchedule"
2820+ },
2821+ "nextRun": {
2822+ "description": "Output only. The time interval of the next run.",
2823+ "readOnly": true,
2824+ "$ref": "Interval"
2825+ }
2826+ }
2827+ },
2828+ "InterpolationPoint": {
2829+ "id": "InterpolationPoint",
2830+ "description": "A single interpolation point on a gradient conditional format. These pin the gradient color scale according to the color, type and value chosen.",
2831+ "type": "object",
2832+ "properties": {
2833+ "color": {
2834+ "description": "The color this interpolation point should use. Deprecated: Use color_style.",
2835+ "deprecated": true,
2836+ "$ref": "Color"
2837+ },
2838+ "colorStyle": {
2839+ "description": "The color this interpolation point should use. If color is also set, this field takes precedence.",
2840+ "$ref": "ColorStyle"
2841+ },
2842+ "type": {
2843+ "enum": [
2844+ "INTERPOLATION_POINT_TYPE_UNSPECIFIED",
2845+ "MIN",
2846+ "MAX",
2847+ "NUMBER",
2848+ "PERCENT",
2849+ "PERCENTILE"
2850+ ],
2851+ "description": "How the value should be interpreted.",
2852+ "type": "string",
2853+ "enumDescriptions": [
2854+ "The default value, do not use.",
2855+ "The interpolation point uses the minimum value in the cells over the range of the conditional format.",
2856+ "The interpolation point uses the maximum value in the cells over the range of the conditional format.",
2857+ "The interpolation point uses exactly the value in InterpolationPoint.value.",
2858+ "The interpolation point is the given percentage over all the cells in the range of the conditional format. This is equivalent to `NUMBER` if the value was: `=(MAX(FLATTEN(range)) * (value / 100)) + (MIN(FLATTEN(range)) * (1 - (value / 100)))` (where errors in the range are ignored when flattening).",
2859+ "The interpolation point is the given percentile over all the cells in the range of the conditional format. This is equivalent to `NUMBER` if the value was: `=PERCENTILE(FLATTEN(range), value / 100)` (where errors in the range are ignored when flattening)."
2860+ ]
2861+ },
2862+ "value": {
2863+ "description": "The value this interpolation point uses. May be a formula. Unused if type is MIN or MAX.",
2864+ "type": "string"
2865+ }
2866+ }
2867+ },
2868+ "PivotValue": {
2869+ "description": "The definition of how a value in a pivot table should be calculated.",
2870+ "type": "object",
2871+ "properties": {
2872+ "calculatedDisplayType": {
2873+ "description": "If specified, indicates that pivot values should be displayed as the result of a calculation with another pivot value. For example, if calculated_display_type is specified as PERCENT_OF_GRAND_TOTAL, all the pivot values are displayed as the percentage of the grand total. In the Sheets editor, this is referred to as \"Show As\" in the value section of a pivot table.",
2874+ "type": "string",
2875+ "enumDescriptions": [
2876+ "Default value, do not use.",
2877+ "Shows the pivot values as percentage of the row total values.",
2878+ "Shows the pivot values as percentage of the column total values.",
2879+ "Shows the pivot values as percentage of the grand total values."
2880+ ],
2881+ "enum": [
2882+ "PIVOT_VALUE_CALCULATED_DISPLAY_TYPE_UNSPECIFIED",
2883+ "PERCENT_OF_ROW_TOTAL",
2884+ "PERCENT_OF_COLUMN_TOTAL",
2885+ "PERCENT_OF_GRAND_TOTAL"
2886+ ]
2887+ },
2888+ "formula": {
2889+ "description": "A custom formula to calculate the value. The formula must start with an `=` character.",
2890+ "type": "string"
2891+ },
2892+ "name": {
2893+ "description": "A name to use for the value.",
2894+ "type": "string"
2895+ },
2896+ "sourceColumnOffset": {
2897+ "description": "The column offset of the source range that this value reads from. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this value refers to column `C`, whereas the offset `1` would refer to column `D`.",
2898+ "type": "integer",
2899+ "format": "int32"
2900+ },
2901+ "dataSourceColumnReference": {
2902+ "description": "The reference to the data source column that this value reads from.",
2903+ "$ref": "DataSourceColumnReference"
2904+ },
2905+ "summarizeFunction": {
2906+ "description": "A function to summarize the value. If formula is set, the only supported values are SUM and CUSTOM. If sourceColumnOffset is set, then `CUSTOM` is not supported.",
2907+ "type": "string",
2908+ "enumDescriptions": [
2909+ "The default, do not use.",
2910+ "Corresponds to the `SUM` function.",
2911+ "Corresponds to the `COUNTA` function.",
2912+ "Corresponds to the `COUNT` function.",
2913+ "Corresponds to the `COUNTUNIQUE` function.",
2914+ "Corresponds to the `AVERAGE` function.",
2915+ "Corresponds to the `MAX` function.",
2916+ "Corresponds to the `MIN` function.",
2917+ "Corresponds to the `MEDIAN` function.",
2918+ "Corresponds to the `PRODUCT` function.",
2919+ "Corresponds to the `STDEV` function.",
2920+ "Corresponds to the `STDEVP` function.",
2921+ "Corresponds to the `VAR` function.",
2922+ "Corresponds to the `VARP` function.",
2923+ "Indicates the formula should be used as-is. Only valid if PivotValue.formula was set.",
2924+ "Indicates that the value is already summarized, and the summarization function is not explicitly specified. Used for Looker data source pivot tables where the value is already summarized."
2925+ ],
2926+ "enum": [
2927+ "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED",
2928+ "SUM",
2929+ "COUNTA",
2930+ "COUNT",
2931+ "COUNTUNIQUE",
2932+ "AVERAGE",
2933+ "MAX",
2934+ "MIN",
2935+ "MEDIAN",
2936+ "PRODUCT",
2937+ "STDEV",
2938+ "STDEVP",
2939+ "VAR",
2940+ "VARP",
2941+ "CUSTOM",
2942+ "NONE"
2943+ ]
2944+ }
2945+ },
2946+ "id": "PivotValue"
2947+ },
2948+ "AddChartResponse": {
2949+ "id": "AddChartResponse",
2950+ "description": "The result of adding a chart to a spreadsheet.",
2951+ "type": "object",
2952+ "properties": {
2953+ "chart": {
2954+ "description": "The newly added chart.",
2955+ "$ref": "EmbeddedChart"
2956+ }
2957+ }
2958+ },
2959+ "GridRange": {
2960+ "id": "GridRange",
2961+ "description": "A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if `\"Sheet1\"` is sheet ID 123456, then: `Sheet1!A1:A1 == sheet_id: 123456, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 123456, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 123456, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 123456, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id: 123456` The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as `#REF!`.",
2962+ "type": "object",
2963+ "properties": {
2964+ "sheetId": {
2965+ "description": "The sheet this range is on.",
2966+ "type": "integer",
2967+ "format": "int32"
2968+ },
2969+ "endRowIndex": {
2970+ "format": "int32",
2971+ "description": "The end row (exclusive) of the range, or not set if unbounded.",
2972+ "type": "integer"
2973+ },
2974+ "startColumnIndex": {
2975+ "description": "The start column (inclusive) of the range, or not set if unbounded.",
2976+ "type": "integer",
2977+ "format": "int32"
2978+ },
2979+ "startRowIndex": {
2980+ "description": "The start row (inclusive) of the range, or not set if unbounded.",
2981+ "type": "integer",
2982+ "format": "int32"
2983+ },
2984+ "endColumnIndex": {
2985+ "format": "int32",
2986+ "description": "The end column (exclusive) of the range, or not set if unbounded.",
2987+ "type": "integer"
2988+ }
2989+ }
2990+ },
2991+ "DataSourceParameter": {
2992+ "id": "DataSourceParameter",
2993+ "description": "A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query.",
2994+ "type": "object",
2995+ "properties": {
2996+ "namedRangeId": {
2997+ "description": "ID of a NamedRange. Its size must be 1x1.",
2998+ "type": "string"
2999+ },
3000+ "range": {
3001+ "description": "A range that contains the value of the parameter. Its size must be 1x1.",
3002+ "$ref": "GridRange"
3003+ },
3004+ "name": {
3005+ "description": "Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers).",
3006+ "type": "string"
3007+ }
3008+ }
3009+ },
3010+ "ChartHistogramRule": {
3011+ "description": "Allows you to organize numeric values in a source data column into buckets of constant size.",
3012+ "type": "object",
3013+ "properties": {
3014+ "intervalSize": {
3015+ "format": "double",
3016+ "description": "The size of the buckets that are created. Must be positive.",
3017+ "type": "number"
3018+ },
3019+ "minValue": {
3020+ "description": "The minimum value at which items are placed into buckets. Values that are less than the minimum are grouped into a single bucket. If omitted, it is determined by the minimum item value.",
3021+ "type": "number",
3022+ "format": "double"
3023+ },
3024+ "maxValue": {
3025+ "format": "double",
3026+ "description": "The maximum value at which items are placed into buckets. Values greater than the maximum are grouped into a single bucket. If omitted, it is determined by the maximum item value.",
3027+ "type": "number"
3028+ }
3029+ },
3030+ "id": "ChartHistogramRule"
3031+ },
3032+ "TreemapChartColorScale": {
3033+ "description": "A color scale for a treemap chart.",
3034+ "type": "object",
3035+ "properties": {
3036+ "maxValueColor": {
3037+ "description": "The background color for cells with a color value greater than or equal to maxValue. Defaults to #109618 if not specified. Deprecated: Use max_value_color_style.",
3038+ "deprecated": true,
3039+ "$ref": "Color"
3040+ },
3041+ "noDataColor": {
3042+ "description": "The background color for cells that have no color data associated with them. Defaults to #000000 if not specified. Deprecated: Use no_data_color_style.",
3043+ "deprecated": true,
3044+ "$ref": "Color"
3045+ },
3046+ "minValueColor": {
3047+ "description": "The background color for cells with a color value less than or equal to minValue. Defaults to #dc3912 if not specified. Deprecated: Use min_value_color_style.",
3048+ "deprecated": true,
3049+ "$ref": "Color"
3050+ },
3051+ "minValueColorStyle": {
3052+ "description": "The background color for cells with a color value less than or equal to minValue. Defaults to #dc3912 if not specified. If min_value_color is also set, this field takes precedence.",
3053+ "$ref": "ColorStyle"
3054+ },
3055+ "maxValueColorStyle": {
3056+ "description": "The background color for cells with a color value greater than or equal to maxValue. Defaults to #109618 if not specified. If max_value_color is also set, this field takes precedence.",
3057+ "$ref": "ColorStyle"
3058+ },
3059+ "noDataColorStyle": {
3060+ "description": "The background color for cells that have no color data associated with them. Defaults to #000000 if not specified. If no_data_color is also set, this field takes precedence.",
3061+ "$ref": "ColorStyle"
3062+ },
3063+ "midValueColor": {
3064+ "description": "The background color for cells with a color value at the midpoint between minValue and maxValue. Defaults to #efe6dc if not specified. Deprecated: Use mid_value_color_style.",
3065+ "deprecated": true,
3066+ "$ref": "Color"
3067+ },
3068+ "midValueColorStyle": {
3069+ "description": "The background color for cells with a color value at the midpoint between minValue and maxValue. Defaults to #efe6dc if not specified. If mid_value_color is also set, this field takes precedence.",
3070+ "$ref": "ColorStyle"
3071+ }
3072+ },
3073+ "id": "TreemapChartColorScale"
3074+ },
3075+ "PivotFilterCriteria": {
3076+ "description": "Criteria for showing/hiding rows in a pivot table.",
3077+ "type": "object",
3078+ "properties": {
3079+ "condition": {
3080+ "description": "A condition that must be true for values to be shown. (`visibleValues` does not override this -- even if a value is listed there, it is still hidden if it does not meet the condition.) Condition values that refer to ranges in A1-notation are evaluated relative to the pivot table sheet. References are treated absolutely, so are not filled down the pivot table. For example, a condition value of `=A1` on \"Pivot Table 1\" is treated as `'Pivot Table 1'!$A$1`. The source data of the pivot table can be referenced by column header name. For example, if the source data has columns named \"Revenue\" and \"Cost\" and a condition is applied to the \"Revenue\" column with type `NUMBER_GREATER` and value `=Cost`, then only columns where \"Revenue\" \u003e \"Cost\" are included.",
3081+ "$ref": "BooleanCondition"
3082+ },
3083+ "visibleValues": {
3084+ "description": "Values that should be included. Values not listed here are excluded.",
3085+ "type": "array",
3086+ "items": {
3087+ "type": "string"
3088+ }
3089+ },
3090+ "visibleByDefault": {
3091+ "description": "Whether values are visible by default. If true, the visible_values are ignored, all values that meet condition (if specified) are shown. If false, values that are both in visible_values and meet condition are shown.",
3092+ "type": "boolean"
3093+ }
3094+ },
3095+ "id": "PivotFilterCriteria"
3096+ },
3097+ "TextToColumnsRequest": {
3098+ "id": "TextToColumnsRequest",
3099+ "description": "Splits a column of text into multiple columns, based on a delimiter in each cell.",
3100+ "type": "object",
3101+ "properties": {
3102+ "delimiterType": {
3103+ "enum": [
3104+ "DELIMITER_TYPE_UNSPECIFIED",
3105+ "COMMA",
3106+ "SEMICOLON",
3107+ "PERIOD",
3108+ "SPACE",
3109+ "CUSTOM",
3110+ "AUTODETECT"
3111+ ],
3112+ "description": "The delimiter type to use.",
3113+ "type": "string",
3114+ "enumDescriptions": [
3115+ "Default value. This value must not be used.",
3116+ "\",\"",
3117+ "\";\"",
3118+ "\".\"",
3119+ "\" \"",
3120+ "A custom value as defined in delimiter.",
3121+ "Automatically detect columns."
3122+ ]
3123+ },
3124+ "source": {
3125+ "description": "The source data range. This must span exactly one column.",
3126+ "$ref": "GridRange"
3127+ },
3128+ "delimiter": {
3129+ "description": "The delimiter to use. Used only if delimiterType is CUSTOM.",
3130+ "type": "string"
3131+ }
3132+ }
3133+ },
3134+ "Request": {
3135+ "id": "Request",
3136+ "description": "A single kind of update to apply to a spreadsheet.",
3137+ "type": "object",
3138+ "properties": {
3139+ "deleteNamedRange": {
3140+ "description": "Deletes a named range.",
3141+ "$ref": "DeleteNamedRangeRequest"
3142+ },
3143+ "refreshDataSource": {
3144+ "description": "Refreshes one or multiple data sources and associated dbobjects.",
3145+ "$ref": "RefreshDataSourceRequest"
3146+ },
3147+ "updateCells": {
3148+ "description": "Updates many cells at once.",
3149+ "$ref": "UpdateCellsRequest"
3150+ },
3151+ "updateNamedRange": {
3152+ "description": "Updates a named range.",
3153+ "$ref": "UpdateNamedRangeRequest"
3154+ },
3155+ "setBasicFilter": {
3156+ "description": "Sets the basic filter on a sheet.",
3157+ "$ref": "SetBasicFilterRequest"
3158+ },
3159+ "updateSpreadsheetProperties": {
3160+ "description": "Updates the spreadsheet's properties.",
3161+ "$ref": "UpdateSpreadsheetPropertiesRequest"
3162+ },
3163+ "cancelDataSourceRefresh": {
3164+ "description": "Cancels refreshes of one or multiple data sources and associated dbobjects.",
3165+ "$ref": "CancelDataSourceRefreshRequest"
3166+ },
3167+ "updateDimensionProperties": {
3168+ "description": "Updates dimensions' properties.",
3169+ "$ref": "UpdateDimensionPropertiesRequest"
3170+ },
3171+ "updateTable": {
3172+ "description": "Updates a table.",
3173+ "$ref": "UpdateTableRequest"
3174+ },
3175+ "updateSheetProperties": {
3176+ "description": "Updates a sheet's properties.",
3177+ "$ref": "UpdateSheetPropertiesRequest"
3178+ },
3179+ "duplicateFilterView": {
3180+ "description": "Duplicates a filter view.",
3181+ "$ref": "DuplicateFilterViewRequest"
3182+ },
3183+ "deleteBanding": {
3184+ "description": "Removes a banded range",
3185+ "$ref": "DeleteBandingRequest"
3186+ },
3187+ "deleteDuplicates": {
3188+ "description": "Removes rows containing duplicate values in specified columns of a cell range.",
3189+ "$ref": "DeleteDuplicatesRequest"
3190+ },
3191+ "deleteSheet": {
3192+ "description": "Deletes a sheet.",
3193+ "$ref": "DeleteSheetRequest"
3194+ },
3195+ "createDeveloperMetadata": {
3196+ "description": "Creates new developer metadata",
3197+ "$ref": "CreateDeveloperMetadataRequest"
3198+ },
3199+ "addDimensionGroup": {
3200+ "description": "Creates a group over the specified range.",
3201+ "$ref": "AddDimensionGroupRequest"
3202+ },
3203+ "updateEmbeddedObjectBorder": {
3204+ "description": "Updates an embedded object's border.",
3205+ "$ref": "UpdateEmbeddedObjectBorderRequest"
3206+ },
3207+ "deleteDimensionGroup": {
3208+ "description": "Deletes a group over the specified range.",
3209+ "$ref": "DeleteDimensionGroupRequest"
3210+ },
3211+ "addSheet": {
3212+ "description": "Adds a sheet.",
3213+ "$ref": "AddSheetRequest"
3214+ },
3215+ "addDataSource": {
3216+ "description": "Adds a data source.",
3217+ "$ref": "AddDataSourceRequest"
3218+ },
3219+ "updateConditionalFormatRule": {
3220+ "description": "Updates an existing conditional format rule.",
3221+ "$ref": "UpdateConditionalFormatRuleRequest"
3222+ },
3223+ "randomizeRange": {
3224+ "description": "Randomizes the order of the rows in a range.",
3225+ "$ref": "RandomizeRangeRequest"
3226+ },
3227+ "repeatCell": {
3228+ "description": "Repeats a single cell across a range.",
3229+ "$ref": "RepeatCellRequest"
3230+ },
3231+ "insertDimension": {
3232+ "description": "Inserts new rows or columns in a sheet.",
3233+ "$ref": "InsertDimensionRequest"
3234+ },
3235+ "setDataValidation": {
3236+ "description": "Sets data validation for one or more cells.",
3237+ "$ref": "SetDataValidationRequest"
3238+ },
3239+ "addSlicer": {
3240+ "description": "Adds a slicer.",
3241+ "$ref": "AddSlicerRequest"
3242+ },
3243+ "updateEmbeddedObjectPosition": {
3244+ "description": "Updates an embedded object's (e.g. chart, image) position.",
3245+ "$ref": "UpdateEmbeddedObjectPositionRequest"
3246+ },
3247+ "updateChartSpec": {
3248+ "description": "Updates a chart's specifications.",
3249+ "$ref": "UpdateChartSpecRequest"
3250+ },
3251+ "addConditionalFormatRule": {
3252+ "description": "Adds a new conditional format rule.",
3253+ "$ref": "AddConditionalFormatRuleRequest"
3254+ },
3255+ "addProtectedRange": {
3256+ "description": "Adds a protected range.",
3257+ "$ref": "AddProtectedRangeRequest"
3258+ },
3259+ "insertRange": {
3260+ "description": "Inserts new cells in a sheet, shifting the existing cells.",
3261+ "$ref": "InsertRangeRequest"
3262+ },
3263+ "updateProtectedRange": {
3264+ "description": "Updates a protected range.",
3265+ "$ref": "UpdateProtectedRangeRequest"
3266+ },
3267+ "addChart": {
3268+ "description": "Adds a chart.",
3269+ "$ref": "AddChartRequest"
3270+ },
3271+ "updateDimensionGroup": {
3272+ "description": "Updates the state of the specified group.",
3273+ "$ref": "UpdateDimensionGroupRequest"
3274+ },
3275+ "addTable": {
3276+ "description": "Adds a table.",
3277+ "$ref": "AddTableRequest"
3278+ },
3279+ "updateFilterView": {
3280+ "description": "Updates the properties of a filter view.",
3281+ "$ref": "UpdateFilterViewRequest"
3282+ },
3283+ "updateSlicerSpec": {
3284+ "description": "Updates a slicer's specifications.",
3285+ "$ref": "UpdateSlicerSpecRequest"
3286+ },
3287+ "deleteFilterView": {
3288+ "description": "Deletes a filter view from a sheet.",
3289+ "$ref": "DeleteFilterViewRequest"
3290+ },
3291+ "deleteProtectedRange": {
3292+ "description": "Deletes a protected range.",
3293+ "$ref": "DeleteProtectedRangeRequest"
3294+ },
3295+ "deleteRange": {
3296+ "description": "Deletes a range of cells from a sheet, shifting the remaining cells.",
3297+ "$ref": "DeleteRangeRequest"
3298+ },
3299+ "textToColumns": {
3300+ "description": "Converts a column of text into many columns of text.",
3301+ "$ref": "TextToColumnsRequest"
3302+ },
3303+ "findReplace": {
3304+ "description": "Finds and replaces occurrences of some text with other text.",
3305+ "$ref": "FindReplaceRequest"
3306+ },
3307+ "copyPaste": {
3308+ "description": "Copies data from one area and pastes it to another.",
3309+ "$ref": "CopyPasteRequest"
3310+ },
3311+ "updateDataSource": {
3312+ "description": "Updates a data source.",
3313+ "$ref": "UpdateDataSourceRequest"
3314+ },
3315+ "clearBasicFilter": {
3316+ "description": "Clears the basic filter on a sheet.",
3317+ "$ref": "ClearBasicFilterRequest"
3318+ },
3319+ "appendDimension": {
3320+ "description": "Appends dimensions to the end of a sheet.",
3321+ "$ref": "AppendDimensionRequest"
3322+ },
3323+ "updateBorders": {
3324+ "description": "Updates the borders in a range of cells.",
3325+ "$ref": "UpdateBordersRequest"
3326+ },
3327+ "mergeCells": {
3328+ "description": "Merges cells together.",
3329+ "$ref": "MergeCellsRequest"
3330+ },
3331+ "duplicateSheet": {
3332+ "description": "Duplicates a sheet.",
3333+ "$ref": "DuplicateSheetRequest"
3334+ },
3335+ "updateBanding": {
3336+ "description": "Updates a banded range",
3337+ "$ref": "UpdateBandingRequest"
3338+ },
3339+ "autoFill": {
3340+ "description": "Automatically fills in more data based on existing data.",
3341+ "$ref": "AutoFillRequest"
3342+ },
3343+ "deleteDeveloperMetadata": {
3344+ "description": "Deletes developer metadata",
3345+ "$ref": "DeleteDeveloperMetadataRequest"
3346+ },
3347+ "autoResizeDimensions": {
3348+ "description": "Automatically resizes one or more dimensions based on the contents of the cells in that dimension.",
3349+ "$ref": "AutoResizeDimensionsRequest"
3350+ },
3351+ "appendCells": {
3352+ "description": "Appends cells after the last row with data in a sheet.",
3353+ "$ref": "AppendCellsRequest"
3354+ },
3355+ "sortRange": {
3356+ "description": "Sorts data in a range.",
3357+ "$ref": "SortRangeRequest"
3358+ },
3359+ "unmergeCells": {
3360+ "description": "Unmerges merged cells.",
3361+ "$ref": "UnmergeCellsRequest"
3362+ },
3363+ "moveDimension": {
3364+ "description": "Moves rows or columns to another location in a sheet.",
3365+ "$ref": "MoveDimensionRequest"
3366+ },
3367+ "deleteTable": {
3368+ "description": "A request for deleting a table.",
3369+ "$ref": "DeleteTableRequest"
3370+ },
3371+ "addNamedRange": {
3372+ "description": "Adds a named range.",
3373+ "$ref": "AddNamedRangeRequest"
3374+ },
3375+ "deleteDimension": {
3376+ "description": "Deletes rows or columns in a sheet.",
3377+ "$ref": "DeleteDimensionRequest"
3378+ },
3379+ "deleteEmbeddedObject": {
3380+ "description": "Deletes an embedded object (e.g, chart, image) in a sheet.",
3381+ "$ref": "DeleteEmbeddedObjectRequest"
3382+ },
3383+ "addFilterView": {
3384+ "description": "Adds a filter view.",
3385+ "$ref": "AddFilterViewRequest"
3386+ },
3387+ "cutPaste": {
3388+ "description": "Cuts data from one area and pastes it to another.",
3389+ "$ref": "CutPasteRequest"
3390+ },
3391+ "trimWhitespace": {
3392+ "description": "Trims cells of whitespace (such as spaces, tabs, or new lines).",
3393+ "$ref": "TrimWhitespaceRequest"
3394+ },
3395+ "pasteData": {
3396+ "description": "Pastes data (HTML or delimited) into a sheet.",
3397+ "$ref": "PasteDataRequest"
3398+ },
3399+ "addBanding": {
3400+ "description": "Adds a new banded range",
3401+ "$ref": "AddBandingRequest"
3402+ },
3403+ "deleteDataSource": {
3404+ "description": "Deletes a data source.",
3405+ "$ref": "DeleteDataSourceRequest"
3406+ },
3407+ "updateDeveloperMetadata": {
3408+ "description": "Updates an existing developer metadata entry",
3409+ "$ref": "UpdateDeveloperMetadataRequest"
3410+ },
3411+ "deleteConditionalFormatRule": {
3412+ "description": "Deletes an existing conditional format rule.",
3413+ "$ref": "DeleteConditionalFormatRuleRequest"
3414+ }
3415+ }
3416+ },
3417+ "LineStyle": {
3418+ "id": "LineStyle",
3419+ "description": "Properties that describe the style of a line.",
3420+ "type": "object",
3421+ "properties": {
3422+ "type": {
3423+ "description": "The dash type of the line.",
3424+ "type": "string",
3425+ "enumDescriptions": [
3426+ "Default value, do not use.",
3427+ "No dash type, which is equivalent to a non-visible line.",
3428+ "A custom dash for a line. Modifying the exact custom dash style is currently unsupported.",
3429+ "A solid line.",
3430+ "A dotted line.",
3431+ "A dashed line where the dashes have \"medium\" length.",
3432+ "A line that alternates between a \"medium\" dash and a dot.",
3433+ "A dashed line where the dashes have \"long\" length.",
3434+ "A line that alternates between a \"long\" dash and a dot."
3435+ ],
3436+ "enum": [
3437+ "LINE_DASH_TYPE_UNSPECIFIED",
3438+ "INVISIBLE",
3439+ "CUSTOM",
3440+ "SOLID",
3441+ "DOTTED",
3442+ "MEDIUM_DASHED",
3443+ "MEDIUM_DASHED_DOTTED",
3444+ "LONG_DASHED",
3445+ "LONG_DASHED_DOTTED"
3446+ ]
3447+ },
3448+ "width": {
3449+ "description": "The thickness of the line, in px.",
3450+ "type": "integer",
3451+ "format": "int32"
3452+ }
3453+ }
3454+ },
3455+ "WaterfallChartDomain": {
3456+ "description": "The domain of a waterfall chart.",
3457+ "type": "object",
3458+ "properties": {
3459+ "reversed": {
3460+ "description": "True to reverse the order of the domain values (horizontal axis).",
3461+ "type": "boolean"
3462+ },
3463+ "data": {
3464+ "description": "The data of the WaterfallChartDomain.",
3465+ "$ref": "ChartData"
3466+ }
3467+ },
3468+ "id": "WaterfallChartDomain"
3469+ },
3470+ "DataSourceSheetProperties": {
3471+ "id": "DataSourceSheetProperties",
3472+ "description": "Additional properties of a DATA_SOURCE sheet.",
3473+ "type": "object",
3474+ "properties": {
3475+ "dataSourceId": {
3476+ "description": "ID of the DataSource the sheet is connected to.",
3477+ "type": "string"
3478+ },
3479+ "dataExecutionStatus": {
3480+ "description": "The data execution status.",
3481+ "$ref": "DataExecutionStatus"
3482+ },
3483+ "columns": {
3484+ "description": "The columns displayed on the sheet, corresponding to the values in RowData.",
3485+ "type": "array",
3486+ "items": {
3487+ "$ref": "DataSourceColumn"
3488+ }
3489+ }
3490+ }
3491+ },
3492+ "ChartGroupRule": {
3493+ "description": "An optional setting on the ChartData of the domain of a data source chart that defines buckets for the values in the domain rather than breaking out each individual value. For example, when plotting a data source chart, you can specify a histogram rule on the domain (it should only contain numeric values), grouping its values into buckets. Any values of a chart series that fall into the same bucket are aggregated based on the aggregate_type.",
3494+ "type": "object",
3495+ "properties": {
3496+ "dateTimeRule": {
3497+ "description": "A ChartDateTimeRule.",
3498+ "$ref": "ChartDateTimeRule"
3499+ },
3500+ "histogramRule": {
3501+ "description": "A ChartHistogramRule",
3502+ "$ref": "ChartHistogramRule"
3503+ }
3504+ },
3505+ "id": "ChartGroupRule"
3506+ },
3507+ "DeleteDimensionRequest": {
3508+ "description": " Deletes the dimensions from the sheet.",
3509+ "type": "object",
3510+ "properties": {
3511+ "range": {
3512+ "description": "The dimensions to delete from the sheet.",
3513+ "$ref": "DimensionRange"
3514+ }
3515+ },
3516+ "id": "DeleteDimensionRequest"
3517+ },
3518+ "UpdateDataSourceRequest": {
3519+ "description": "Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional `bigquery.readonly` OAuth scope if you are updating a BigQuery data source.",
3520+ "type": "object",
3521+ "properties": {
3522+ "dataSource": {
3523+ "description": "The data source to update.",
3524+ "$ref": "DataSource"
3525+ },
3526+ "fields": {
3527+ "format": "google-fieldmask",
3528+ "description": "The fields that should be updated. At least one field must be specified. The root `dataSource` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.",
3529+ "type": "string"
3530+ }
3531+ },
3532+ "id": "UpdateDataSourceRequest"
3533+ },
3534+ "UpdateBordersRequest": {
3535+ "description": "Updates the borders of a range. If a field is not set in the request, that means the border remains as-is. For example, with two subsequent UpdateBordersRequest: 1. range: A1:A5 `{ top: RED, bottom: WHITE }` 2. range: A1:A5 `{ left: BLUE }` That would result in A1:A5 having a borders of `{ top: RED, bottom: WHITE, left: BLUE }`. If you want to clear a border, explicitly set the style to NONE.",
3536+ "type": "object",
3537+ "properties": {
3538+ "right": {
3539+ "description": "The border to put at the right of the range.",
3540+ "$ref": "Border"
3541+ },
3542+ "innerHorizontal": {
3543+ "description": "The horizontal border to put within the range.",
3544+ "$ref": "Border"
3545+ },
3546+ "bottom": {
3547+ "description": "The border to put at the bottom of the range.",
3548+ "$ref": "Border"
3549+ },
3550+ "range": {
3551+ "description": "The range whose borders should be updated.",
3552+ "$ref": "GridRange"
3553+ },
3554+ "top": {
3555+ "description": "The border to put at the top of the range.",
3556+ "$ref": "Border"
3557+ },
3558+ "innerVertical": {
3559+ "description": "The vertical border to put within the range.",
3560+ "$ref": "Border"
3561+ },
3562+ "left": {
3563+ "description": "The border to put at the left of the range.",
3564+ "$ref": "Border"
3565+ }
3566+ },
3567+ "id": "UpdateBordersRequest"
3568+ },
3569+ "BatchClearValuesByDataFilterResponse": {
3570+ "description": "The response when clearing a range of values selected with DataFilters in a spreadsheet.",
3571+ "type": "object",
3572+ "properties": {
3573+ "spreadsheetId": {
3574+ "description": "The spreadsheet the updates were applied to.",
3575+ "type": "string"
3576+ },
3577+ "clearedRanges": {
3578+ "description": "The ranges that were cleared, in [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). If the requests are for an unbounded range or a range larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet's limits.",
3579+ "type": "array",
3580+ "items": {
3581+ "type": "string"
3582+ }
3583+ }
3584+ },
3585+ "id": "BatchClearValuesByDataFilterResponse"
3586+ },
3587+ "DataValidationRule": {
3588+ "id": "DataValidationRule",
3589+ "description": "A data validation rule.",
3590+ "type": "object",
3591+ "properties": {
3592+ "inputMessage": {
3593+ "description": "A message to show the user when adding data to the cell.",
3594+ "type": "string"
3595+ },
3596+ "strict": {
3597+ "description": "True if invalid data should be rejected.",
3598+ "type": "boolean"
3599+ },
3600+ "showCustomUi": {
3601+ "description": "True if the UI should be customized based on the kind of condition. If true, \"List\" conditions will show a dropdown.",
3602+ "type": "boolean"
3603+ },
3604+ "condition": {
3605+ "description": "The condition that data in the cell must match.",
3606+ "$ref": "BooleanCondition"
3607+ }
3608+ }
3609+ },
3610+ "SlicerSpec": {
3611+ "id": "SlicerSpec",
3612+ "description": "The specifications of a slicer.",
3613+ "type": "object",
3614+ "properties": {
3615+ "dataRange": {
3616+ "description": "The data range of the slicer.",
3617+ "$ref": "GridRange"
3618+ },
3619+ "title": {
3620+ "description": "The title of the slicer.",
3621+ "type": "string"
3622+ },
3623+ "filterCriteria": {
3624+ "description": "The filtering criteria of the slicer.",
3625+ "$ref": "FilterCriteria"
3626+ },
3627+ "textFormat": {
3628+ "description": "The text format of title in the slicer. The link field is not supported.",
3629+ "$ref": "TextFormat"
3630+ },
3631+ "columnIndex": {
3632+ "format": "int32",
3633+ "description": "The zero-based column index in the data table on which the filter is applied to.",
3634+ "type": "integer"
3635+ },
3636+ "backgroundColor": {
3637+ "description": "The background color of the slicer. Deprecated: Use background_color_style.",
3638+ "deprecated": true,
3639+ "$ref": "Color"
3640+ },
3641+ "applyToPivotTables": {
3642+ "description": "True if the filter should apply to pivot tables. If not set, default to `True`.",
3643+ "type": "boolean"
3644+ },
3645+ "horizontalAlignment": {
3646+ "enum": [
3647+ "HORIZONTAL_ALIGN_UNSPECIFIED",
3648+ "LEFT",
3649+ "CENTER",
3650+ "RIGHT"
3651+ ],
3652+ "description": "The horizontal alignment of title in the slicer. If unspecified, defaults to `LEFT`",
3653+ "type": "string",
3654+ "enumDescriptions": [
3655+ "The horizontal alignment is not specified. Do not use this.",
3656+ "The text is explicitly aligned to the left of the cell.",
3657+ "The text is explicitly aligned to the center of the cell.",
3658+ "The text is explicitly aligned to the right of the cell."
3659+ ]
3660+ },
3661+ "backgroundColorStyle": {
3662+ "description": "The background color of the slicer. If background_color is also set, this field takes precedence.",
3663+ "$ref": "ColorStyle"
3664+ }
3665+ }
3666+ },
3667+ "DuplicateSheetRequest": {
3668+ "id": "DuplicateSheetRequest",
3669+ "description": "Duplicates the contents of a sheet.",
3670+ "type": "object",
3671+ "properties": {
3672+ "sourceSheetId": {
3673+ "format": "int32",
3674+ "description": "The sheet to duplicate. If the source sheet is of DATA_SOURCE type, its backing DataSource is also duplicated and associated with the new copy of the sheet. No data execution is triggered, the grid data of this sheet is also copied over but only available after the batch request completes.",
3675+ "type": "integer"
3676+ },
3677+ "insertSheetIndex": {
3678+ "description": "The zero-based index where the new sheet should be inserted. The index of all sheets after this are incremented.",
3679+ "type": "integer",
3680+ "format": "int32"
3681+ },
3682+ "newSheetId": {
3683+ "format": "int32",
3684+ "description": "If set, the ID of the new sheet. If not set, an ID is chosen. If set, the ID must not conflict with any existing sheet ID. If set, it must be non-negative.",
3685+ "type": "integer"
3686+ },
3687+ "newSheetName": {
3688+ "description": "The name of the new sheet. If empty, a new name is chosen for you.",
3689+ "type": "string"
3690+ }
3691+ }
3692+ },
3693+ "DuplicateFilterViewResponse": {
3694+ "description": "The result of a filter view being duplicated.",
3695+ "type": "object",
3696+ "properties": {
3697+ "filter": {
3698+ "description": "The newly created filter.",
3699+ "$ref": "FilterView"
3700+ }
3701+ },
3702+ "id": "DuplicateFilterViewResponse"
3703+ },
3704+ "PointStyle": {
3705+ "description": "The style of a point on the chart.",
3706+ "type": "object",
3707+ "properties": {
3708+ "size": {
3709+ "format": "double",
3710+ "description": "The point size. If empty, a default size is used.",
3711+ "type": "number"
3712+ },
3713+ "shape": {
3714+ "enum": [
3715+ "POINT_SHAPE_UNSPECIFIED",
3716+ "CIRCLE",
3717+ "DIAMOND",
3718+ "HEXAGON",
3719+ "PENTAGON",
3720+ "SQUARE",
3721+ "STAR",
3722+ "TRIANGLE",
3723+ "X_MARK"
3724+ ],
3725+ "description": "The point shape. If empty or unspecified, a default shape is used.",
3726+ "type": "string",
3727+ "enumDescriptions": [
3728+ "Default value.",
3729+ "A circle shape.",
3730+ "A diamond shape.",
3731+ "A hexagon shape.",
3732+ "A pentagon shape.",
3733+ "A square shape.",
3734+ "A star shape.",
3735+ "A triangle shape.",
3736+ "An x-mark shape."
3737+ ]
3738+ }
3739+ },
3740+ "id": "PointStyle"
3741+ },
3742+ "AddConditionalFormatRuleRequest": {
3743+ "id": "AddConditionalFormatRuleRequest",
3744+ "description": "Adds a new conditional format rule at the given index. All subsequent rules' indexes are incremented.",
3745+ "type": "object",
3746+ "properties": {
3747+ "index": {
3748+ "description": "The zero-based index where the rule should be inserted.",
3749+ "type": "integer",
3750+ "format": "int32"
3751+ },
3752+ "rule": {
3753+ "description": "The rule to add.",
3754+ "$ref": "ConditionalFormatRule"
3755+ }
3756+ }
3757+ },
3758+ "PasteDataRequest": {
3759+ "id": "PasteDataRequest",
3760+ "description": "Inserts data into the spreadsheet starting at the specified coordinate.",
3761+ "type": "object",
3762+ "properties": {
3763+ "delimiter": {
3764+ "description": "The delimiter in the data.",
3765+ "type": "string"
3766+ },
3767+ "data": {
3768+ "description": "The data to insert.",
3769+ "type": "string"
3770+ },
3771+ "type": {
3772+ "description": "How the data should be pasted.",
3773+ "type": "string",
3774+ "enumDescriptions": [
3775+ "Paste values, formulas, formats, and merges.",
3776+ "Paste the values ONLY without formats, formulas, or merges.",
3777+ "Paste the format and data validation only.",
3778+ "Like `PASTE_NORMAL` but without borders.",
3779+ "Paste the formulas only.",
3780+ "Paste the data validation only.",
3781+ "Paste the conditional formatting rules only."
3782+ ],
3783+ "enum": [
3784+ "PASTE_NORMAL",
3785+ "PASTE_VALUES",
3786+ "PASTE_FORMAT",
3787+ "PASTE_NO_BORDERS",
3788+ "PASTE_FORMULA",
3789+ "PASTE_DATA_VALIDATION",
3790+ "PASTE_CONDITIONAL_FORMATTING"
3791+ ]
3792+ },
3793+ "html": {
3794+ "description": "True if the data is HTML.",
3795+ "type": "boolean"
3796+ },
3797+ "coordinate": {
3798+ "description": "The coordinate at which the data should start being inserted.",
3799+ "$ref": "GridCoordinate"
3800+ }
3801+ }
3802+ },
3803+ "DeleteNamedRangeRequest": {
3804+ "description": "Removes the named range with the given ID from the spreadsheet.",
3805+ "type": "object",
3806+ "properties": {
3807+ "namedRangeId": {
3808+ "description": "The ID of the named range to delete.",
3809+ "type": "string"
3810+ }
3811+ },
3812+ "id": "DeleteNamedRangeRequest"
3813+ },
3814+ "RepeatCellRequest": {
3815+ "description": "Updates all cells in the range to the values in the given Cell object. Only the fields listed in the fields field are updated; others are unchanged. If writing a cell with a formula, the formula's ranges will automatically increment for each field in the range. For example, if writing a cell with formula `=A1` into range B2:C4, B2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`, C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`. To keep the formula's ranges static, use the `$` indicator. For example, use the formula `=$A$1` to prevent both the row and the column from incrementing.",
3816+ "type": "object",
3817+ "properties": {
3818+ "fields": {
3819+ "description": "The fields that should be updated. At least one field must be specified. The root `cell` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.",
3820+ "type": "string",
3821+ "format": "google-fieldmask"
3822+ },
3823+ "range": {
3824+ "description": "The range to repeat the cell in.",
3825+ "$ref": "GridRange"
3826+ },
3827+ "cell": {
3828+ "description": "The data to write.",
3829+ "$ref": "CellData"
3830+ }
3831+ },
3832+ "id": "RepeatCellRequest"
3833+ },
3834+ "NamedRange": {
3835+ "description": "A named range.",
3836+ "type": "object",
3837+ "properties": {
3838+ "name": {
3839+ "description": "The name of the named range.",
3840+ "type": "string"
3841+ },
3842+ "namedRangeId": {
3843+ "description": "The ID of the named range.",
3844+ "type": "string"
3845+ },
3846+ "range": {
3847+ "description": "The range this represents.",
3848+ "$ref": "GridRange"
3849+ }
3850+ },
3851+ "id": "NamedRange"
3852+ },
3853+ "UpdateSheetPropertiesRequest": {
3854+ "description": "Updates properties of the sheet with the specified sheetId.",
3855+ "type": "object",
3856+ "properties": {
3857+ "properties": {
3858+ "description": "The properties to update.",
3859+ "$ref": "SheetProperties"
3860+ },
3861+ "fields": {
3862+ "description": "The fields that should be updated. At least one field must be specified. The root `properties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.",
3863+ "type": "string",
3864+ "format": "google-fieldmask"
3865+ }
3866+ },
3867+ "id": "UpdateSheetPropertiesRequest"
3868+ },
3869+ "ColorStyle": {
3870+ "id": "ColorStyle",
3871+ "description": "A color value.",
3872+ "type": "object",
3873+ "properties": {
3874+ "rgbColor": {
3875+ "description": "RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object isn't generally supported.",
3876+ "$ref": "Color"
3877+ },
3878+ "themeColor": {
3879+ "enum": [
3880+ "THEME_COLOR_TYPE_UNSPECIFIED",
3881+ "TEXT",
3882+ "BACKGROUND",
3883+ "ACCENT1",
3884+ "ACCENT2",
3885+ "ACCENT3",
3886+ "ACCENT4",
3887+ "ACCENT5",
3888+ "ACCENT6",
3889+ "LINK"
3890+ ],
3891+ "description": "Theme color.",
3892+ "type": "string",
3893+ "enumDescriptions": [
3894+ "Unspecified theme color",
3895+ "Represents the primary text color",
3896+ "Represents the primary background color",
3897+ "Represents the first accent color",
3898+ "Represents the second accent color",
3899+ "Represents the third accent color",
3900+ "Represents the fourth accent color",
3901+ "Represents the fifth accent color",
3902+ "Represents the sixth accent color",
3903+ "Represents the color to use for hyperlinks"
3904+ ]
3905+ }
3906+ }
3907+ },
3908+ "InsertRangeRequest": {
3909+ "description": "Inserts cells into a range, shifting the existing cells over or down.",
3910+ "type": "object",
3911+ "properties": {
3912+ "shiftDimension": {
3913+ "description": "The dimension which will be shifted when inserting cells. If ROWS, existing cells will be shifted down. If COLUMNS, existing cells will be shifted right.",
3914+ "type": "string",
3915+ "enumDescriptions": [
3916+ "The default value, do not use.",
3917+ "Operates on the rows of a sheet.",
3918+ "Operates on the columns of a sheet."
3919+ ],
3920+ "enum": [
3921+ "DIMENSION_UNSPECIFIED",
3922+ "ROWS",
3923+ "COLUMNS"
3924+ ]
3925+ },
3926+ "range": {
3927+ "description": "The range to insert new cells into. The range is constrained to the current sheet boundaries.",
3928+ "$ref": "GridRange"
3929+ }
3930+ },
3931+ "id": "InsertRangeRequest"
3932+ },
3933+ "AppendCellsRequest": {
3934+ "id": "AppendCellsRequest",
3935+ "description": "Adds new cells after the last row with data in a sheet, inserting new rows into the sheet if necessary.",
3936+ "type": "object",
3937+ "properties": {
3938+ "sheetId": {
3939+ "description": "The sheet ID to append the data to.",
3940+ "type": "integer",
3941+ "format": "int32"
3942+ },
3943+ "fields": {
3944+ "description": "The fields of CellData that should be updated. At least one field must be specified. The root is the CellData; 'row.values.' should not be specified. A single `\"*\"` can be used as short-hand for listing every field.",
3945+ "type": "string",
3946+ "format": "google-fieldmask"
3947+ },
3948+ "tableId": {
3949+ "description": "The ID of the table to append data to. The data will be only appended to the table body. This field also takes precedence over the `sheet_id` field.",
3950+ "type": "string"
3951+ },
3952+ "rows": {
3953+ "items": {
3954+ "$ref": "RowData"
3955+ },
3956+ "description": "The data to append.",
3957+ "type": "array"
3958+ }
3959+ }
3960+ },
3961+ "ClearBasicFilterRequest": {
3962+ "id": "ClearBasicFilterRequest",
3963+ "description": "Clears the basic filter, if any exists on the sheet.",
3964+ "type": "object",
3965+ "properties": {
3966+ "sheetId": {
3967+ "format": "int32",
3968+ "description": "The sheet ID on which the basic filter should be cleared.",
3969+ "type": "integer"
3970+ }
3971+ }
3972+ },
3973+ "BooleanCondition": {
3974+ "id": "BooleanCondition",
3975+ "description": "A condition that can evaluate to true or false. BooleanConditions are used by conditional formatting, data validation, and the criteria in filters.",
3976+ "type": "object",
3977+ "properties": {
3978+ "values": {
3979+ "description": "The values of the condition. The number of supported values depends on the condition type. Some support zero values, others one or two values, and ConditionType.ONE_OF_LIST supports an arbitrary number of values.",
3980+ "type": "array",
3981+ "items": {
3982+ "$ref": "ConditionValue"
3983+ }
3984+ },
3985+ "type": {
3986+ "enum": [
3987+ "CONDITION_TYPE_UNSPECIFIED",
3988+ "NUMBER_GREATER",
3989+ "NUMBER_GREATER_THAN_EQ",
3990+ "NUMBER_LESS",
3991+ "NUMBER_LESS_THAN_EQ",
3992+ "NUMBER_EQ",
3993+ "NUMBER_NOT_EQ",
3994+ "NUMBER_BETWEEN",
3995+ "NUMBER_NOT_BETWEEN",
3996+ "TEXT_CONTAINS",
3997+ "TEXT_NOT_CONTAINS",
3998+ "TEXT_STARTS_WITH",
3999+ "TEXT_ENDS_WITH",
4000+ "TEXT_EQ",
4001+ "TEXT_IS_EMAIL",
4002+ "TEXT_IS_URL",
4003+ "DATE_EQ",
4004+ "DATE_BEFORE",
4005+ "DATE_AFTER",
4006+ "DATE_ON_OR_BEFORE",
4007+ "DATE_ON_OR_AFTER",
4008+ "DATE_BETWEEN",
4009+ "DATE_NOT_BETWEEN",
4010+ "DATE_IS_VALID",
4011+ "ONE_OF_RANGE",
4012+ "ONE_OF_LIST",
4013+ "BLANK",
4014+ "NOT_BLANK",
4015+ "CUSTOM_FORMULA",
4016+ "BOOLEAN",
4017+ "TEXT_NOT_EQ",
4018+ "DATE_NOT_EQ",
4019+ "FILTER_EXPRESSION"
4020+ ],
4021+ "description": "The type of condition.",
4022+ "type": "string",
4023+ "enumDescriptions": [
4024+ "The default value, do not use.",
4025+ "The cell's value must be greater than the condition's value. Supported by data validation, conditional formatting and filters. Requires a single ConditionValue.",
4026+ "The cell's value must be greater than or equal to the condition's value. Supported by data validation, conditional formatting and filters. Requires a single ConditionValue.",
4027+ "The cell's value must be less than the condition's value. Supported by data validation, conditional formatting and filters. Requires a single ConditionValue.",
4028+ "The cell's value must be less than or equal to the condition's value. Supported by data validation, conditional formatting and filters. Requires a single ConditionValue.",
4029+ "The cell's value must be equal to the condition's value. Supported by data validation, conditional formatting and filters. Requires a single ConditionValue for data validation, conditional formatting, and filters on non-data source objects and at least one ConditionValue for filters on data source objects.",
4030+ "The cell's value must be not equal to the condition's value. Supported by data validation, conditional formatting and filters. Requires a single ConditionValue for data validation, conditional formatting, and filters on non-data source objects and at least one ConditionValue for filters on data source objects.",
4031+ "The cell's value must be between the two condition values. Supported by data validation, conditional formatting and filters. Requires exactly two ConditionValues.",
4032+ "The cell's value must not be between the two condition values. Supported by data validation, conditional formatting and filters. Requires exactly two ConditionValues.",
4033+ "The cell's value must contain the condition's value. Supported by data validation, conditional formatting and filters. Requires a single ConditionValue.",
4034+ "The cell's value must not contain the condition's value. Supported by data validation, conditional formatting and filters. Requires a single ConditionValue.",
4035+ "The cell's value must start with the condition's value. Supported by conditional formatting and filters. Requires a single ConditionValue.",
4036+ "The cell's value must end with the condition's value. Supported by conditional formatting and filters. Requires a single ConditionValue.",
4037+ "The cell's value must be exactly the condition's value. Supported by data validation, conditional formatting and filters. Requires a single ConditionValue for data validation, conditional formatting, and filters on non-data source objects and at least one ConditionValue for filters on data source objects.",
4038+ "The cell's value must be a valid email address. Supported by data validation. Requires no ConditionValues.",
4039+ "The cell's value must be a valid URL. Supported by data validation. Requires no ConditionValues.",
4040+ "The cell's value must be the same date as the condition's value. Supported by data validation, conditional formatting and filters. Requires a single ConditionValue for data validation, conditional formatting, and filters on non-data source objects and at least one ConditionValue for filters on data source objects.",
4041+ "The cell's value must be before the date of the condition's value. Supported by data validation, conditional formatting and filters. Requires a single ConditionValue that may be a relative date.",
4042+ "The cell's value must be after the date of the condition's value. Supported by data validation, conditional formatting and filters. Requires a single ConditionValue that may be a relative date.",
4043+ "The cell's value must be on or before the date of the condition's value. Supported by data validation. Requires a single ConditionValue that may be a relative date.",
4044+ "The cell's value must be on or after the date of the condition's value. Supported by data validation. Requires a single ConditionValue that may be a relative date.",
4045+ "The cell's value must be between the dates of the two condition values. Supported by data validation. Requires exactly two ConditionValues.",
4046+ "The cell's value must be outside the dates of the two condition values. Supported by data validation. Requires exactly two ConditionValues.",
4047+ "The cell's value must be a date. Supported by data validation. Requires no ConditionValues.",
4048+ "The cell's value must be listed in the grid in condition value's range. Supported by data validation. Requires a single ConditionValue, and the value must be a valid range in A1 notation.",
4049+ "The cell's value must be in the list of condition values. Supported by data validation. Supports any number of condition values, one per item in the list. Formulas are not supported in the values.",
4050+ "The cell's value must be empty. Supported by conditional formatting and filters. Requires no ConditionValues.",
4051+ "The cell's value must not be empty. Supported by conditional formatting and filters. Requires no ConditionValues.",
4052+ "The condition's formula must evaluate to true. Supported by data validation, conditional formatting and filters. Not supported by data source sheet filters. Requires a single ConditionValue.",
4053+ "The cell's value must be TRUE/FALSE or in the list of condition values. Supported by data validation. Renders as a cell checkbox. Supports zero, one or two ConditionValues. No values indicates the cell must be TRUE or FALSE, where TRUE renders as checked and FALSE renders as unchecked. One value indicates the cell will render as checked when it contains that value and unchecked when it is blank. Two values indicate that the cell will render as checked when it contains the first value and unchecked when it contains the second value. For example, [\"Yes\",\"No\"] indicates that the cell will render a checked box when it has the value \"Yes\" and an unchecked box when it has the value \"No\".",
4054+ "The cell's value must be exactly not the condition's value. Supported by filters on data source objects. Requires at least one ConditionValue.",
4055+ "The cell's value must be exactly not the condition's value. Supported by filters on data source objects. Requires at least one ConditionValue.",
4056+ "The cell's value must follow the pattern specified. Requires a single ConditionValue."
4057+ ]
4058+ }
4059+ }
4060+ },
4061+ "DataSourceChartProperties": {
4062+ "id": "DataSourceChartProperties",
4063+ "description": "Properties of a data source chart.",
4064+ "type": "object",
4065+ "properties": {
4066+ "dataSourceId": {
4067+ "description": "ID of the data source that the chart is associated with.",
4068+ "type": "string"
4069+ },
4070+ "dataExecutionStatus": {
4071+ "description": "Output only. The data execution status.",
4072+ "readOnly": true,
4073+ "$ref": "DataExecutionStatus"
4074+ }
4075+ }
4076+ },
4077+ "ThemeColorPair": {
4078+ "description": "A pair mapping a spreadsheet theme color type to the concrete color it represents.",
4079+ "type": "object",
4080+ "properties": {
4081+ "colorType": {
4082+ "enum": [
4083+ "THEME_COLOR_TYPE_UNSPECIFIED",
4084+ "TEXT",
4085+ "BACKGROUND",
4086+ "ACCENT1",
4087+ "ACCENT2",
4088+ "ACCENT3",
4089+ "ACCENT4",
4090+ "ACCENT5",
4091+ "ACCENT6",
4092+ "LINK"
4093+ ],
4094+ "description": "The type of the spreadsheet theme color.",
4095+ "type": "string",
4096+ "enumDescriptions": [
4097+ "Unspecified theme color",
4098+ "Represents the primary text color",
4099+ "Represents the primary background color",
4100+ "Represents the first accent color",
4101+ "Represents the second accent color",
4102+ "Represents the third accent color",
4103+ "Represents the fourth accent color",
4104+ "Represents the fifth accent color",
4105+ "Represents the sixth accent color",
4106+ "Represents the color to use for hyperlinks"
4107+ ]
4108+ },
4109+ "color": {
4110+ "description": "The concrete color corresponding to the theme color type.",
4111+ "$ref": "ColorStyle"
4112+ }
4113+ },
4114+ "id": "ThemeColorPair"
4115+ },
4116+ "DeleteDuplicatesRequest": {
4117+ "description": "Removes rows within this range that contain values in the specified columns that are duplicates of values in any previous row. Rows with identical values but different letter cases, formatting, or formulas are considered to be duplicates. This request also removes duplicate rows hidden from view (for example, due to a filter). When removing duplicates, the first instance of each duplicate row scanning from the top downwards is kept in the resulting range. Content outside of the specified range isn't removed, and rows considered duplicates do not have to be adjacent to each other in the range.",
4118+ "type": "object",
4119+ "properties": {
4120+ "comparisonColumns": {
4121+ "items": {
4122+ "$ref": "DimensionRange"
4123+ },
4124+ "description": "The columns in the range to analyze for duplicate values. If no columns are selected then all columns are analyzed for duplicates.",
4125+ "type": "array"
4126+ },
4127+ "range": {
4128+ "description": "The range to remove duplicates rows from.",
4129+ "$ref": "GridRange"
4130+ }
4131+ },
4132+ "id": "DeleteDuplicatesRequest"
4133+ },
4134+ "FilterView": {
4135+ "description": "A filter view. For more information, see [Manage data visibility with filters](https://developers.google.com/workspace/sheets/api/guides/filters).",
4136+ "type": "object",
4137+ "properties": {
4138+ "sortSpecs": {
4139+ "description": "The sort order per column. Later specifications are used when values are equal in the earlier specifications.",
4140+ "type": "array",
4141+ "items": {
4142+ "$ref": "SortSpec"
4143+ }
4144+ },
4145+ "criteria": {
4146+ "description": "The criteria for showing/hiding values per column. The map's key is the column index, and the value is the criteria for that column. This field is deprecated in favor of filter_specs.",
4147+ "deprecated": true,
4148+ "type": "object",
4149+ "additionalProperties": {
4150+ "$ref": "FilterCriteria"
4151+ }
4152+ },
4153+ "title": {
4154+ "description": "The name of the filter view.",
4155+ "type": "string"
4156+ },
4157+ "range": {
4158+ "description": "The range this filter view covers. When writing, only one of range, named_range_id, or table_id may be set.",
4159+ "$ref": "GridRange"
4160+ },
4161+ "tableId": {
4162+ "description": "The table this filter view is backed by, if any. When writing, only one of range, named_range_id, or table_id may be set.",
4163+ "type": "string"
4164+ },
4165+ "filterViewId": {
4166+ "description": "The ID of the filter view.",
4167+ "type": "integer",
4168+ "format": "int32"
4169+ },
4170+ "namedRangeId": {
4171+ "description": "The named range this filter view is backed by, if any. When writing, only one of range, named_range_id, or table_id may be set.",
4172+ "type": "string"
4173+ },
4174+ "filterSpecs": {
4175+ "items": {
4176+ "$ref": "FilterSpec"
4177+ },
4178+ "description": "The filter criteria for showing or hiding values per column. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence.",
4179+ "type": "array"
4180+ }
4181+ },
4182+ "id": "FilterView"
4183+ },
4184+ "DeleteConditionalFormatRuleRequest": {
4185+ "description": "Deletes a conditional format rule at the given index. All subsequent rules' indexes are decremented.",
4186+ "type": "object",
4187+ "properties": {
4188+ "index": {
4189+ "format": "int32",
4190+ "description": "The zero-based index of the rule to be deleted.",
4191+ "type": "integer"
4192+ },
4193+ "sheetId": {
4194+ "description": "The sheet the rule is being deleted from.",
4195+ "type": "integer",
4196+ "format": "int32"
4197+ }
4198+ },
4199+ "id": "DeleteConditionalFormatRuleRequest"
4200+ },
4201+ "GridData": {
4202+ "id": "GridData",
4203+ "description": "Data in the grid, as well as metadata about the dimensions.",
4204+ "type": "object",
4205+ "properties": {
4206+ "rowMetadata": {
4207+ "description": "Metadata about the requested rows in the grid, starting with the row in start_row.",
4208+ "type": "array",
4209+ "items": {
4210+ "$ref": "DimensionProperties"
4211+ }
4212+ },
4213+ "startRow": {
4214+ "description": "The first row this GridData refers to, zero-based.",
4215+ "type": "integer",
4216+ "format": "int32"
4217+ },
4218+ "startColumn": {
4219+ "description": "The first column this GridData refers to, zero-based.",
4220+ "type": "integer",
4221+ "format": "int32"
4222+ },
4223+ "rowData": {
4224+ "description": "The data in the grid, one entry per row, starting with the row in startRow. The values in RowData will correspond to columns starting at start_column.",
4225+ "type": "array",
4226+ "items": {
4227+ "$ref": "RowData"
4228+ }
4229+ },
4230+ "columnMetadata": {
4231+ "description": "Metadata about the requested columns in the grid, starting with the column in start_column.",
4232+ "type": "array",
4233+ "items": {
4234+ "$ref": "DimensionProperties"
4235+ }
4236+ }
4237+ }
4238+ },
4239+ "BatchUpdateValuesByDataFilterResponse": {
4240+ "id": "BatchUpdateValuesByDataFilterResponse",
4241+ "description": "The response when updating a range of values in a spreadsheet.",
4242+ "type": "object",
4243+ "properties": {
4244+ "spreadsheetId": {
4245+ "description": "The spreadsheet the updates were applied to.",
4246+ "type": "string"
4247+ },
4248+ "responses": {
4249+ "description": "The response for each range updated.",
4250+ "type": "array",
4251+ "items": {
4252+ "$ref": "UpdateValuesByDataFilterResponse"
4253+ }
4254+ },
4255+ "totalUpdatedSheets": {
4256+ "description": "The total number of sheets where at least one cell in the sheet was updated.",
4257+ "type": "integer",
4258+ "format": "int32"
4259+ },
4260+ "totalUpdatedCells": {
4261+ "format": "int32",
4262+ "description": "The total number of cells updated.",
4263+ "type": "integer"
4264+ },
4265+ "totalUpdatedColumns": {
4266+ "format": "int32",
4267+ "description": "The total number of columns where at least one cell in the column was updated.",
4268+ "type": "integer"
4269+ },
4270+ "totalUpdatedRows": {
4271+ "description": "The total number of rows where at least one cell in the row was updated.",
4272+ "type": "integer",
4273+ "format": "int32"
4274+ }
4275+ }
4276+ },
4277+ "RichLinkProperties": {
4278+ "id": "RichLinkProperties",
4279+ "description": "Properties of a link to a Google resource (such as a file in Drive, a YouTube video, a Maps address, or a Calendar event). Only Drive files can be written as chips. All other rich link types are read only. URIs cannot exceed 2000 bytes when writing. NOTE: Writing Drive file chips requires at least one of the `drive.file`, `drive.readonly`, or `drive` OAuth scopes.",
4280+ "type": "object",
4281+ "properties": {
4282+ "uri": {
4283+ "description": "Required. The URI to the link. This is always present.",
4284+ "type": "string"
4285+ },
4286+ "mimeType": {
4287+ "description": "Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the link, if there's one (for example, when it's a file in Drive).",
4288+ "readOnly": true,
4289+ "type": "string"
4290+ }
4291+ }
4292+ },
4293+ "UpdateCellsRequest": {
4294+ "description": "Updates all cells in a range with new data.",
4295+ "type": "object",
4296+ "properties": {
4297+ "fields": {
4298+ "description": "The fields of CellData that should be updated. At least one field must be specified. The root is the CellData; 'row.values.' should not be specified. A single `\"*\"` can be used as short-hand for listing every field.",
4299+ "type": "string",
4300+ "format": "google-fieldmask"
4301+ },
4302+ "range": {
4303+ "description": "The range to write data to. If the data in rows does not cover the entire requested range, the fields matching those set in fields will be cleared.",
4304+ "$ref": "GridRange"
4305+ },
4306+ "rows": {
4307+ "items": {
4308+ "$ref": "RowData"
4309+ },
4310+ "description": "The data to write.",
4311+ "type": "array"
4312+ },
4313+ "start": {
4314+ "description": "The coordinate to start writing data at. Any number of rows and columns (including a different number of columns per row) may be written.",
4315+ "$ref": "GridCoordinate"
4316+ }
4317+ },
4318+ "id": "UpdateCellsRequest"
4319+ },
4320+ "DataSourceColumn": {
4321+ "id": "DataSourceColumn",
4322+ "description": "A column in a data source.",
4323+ "type": "object",
4324+ "properties": {
4325+ "reference": {
4326+ "description": "The column reference.",
4327+ "$ref": "DataSourceColumnReference"
4328+ },
4329+ "formula": {
4330+ "description": "The formula of the calculated column.",
4331+ "type": "string"
4332+ }
4333+ }
4334+ },
4335+ "GridProperties": {
4336+ "description": "Properties of a grid.",
4337+ "type": "object",
4338+ "properties": {
4339+ "frozenColumnCount": {
4340+ "format": "int32",
4341+ "description": "The number of columns that are frozen in the grid.",
4342+ "type": "integer"
4343+ },
4344+ "hideGridlines": {
4345+ "description": "True if the grid isn't showing gridlines in the UI.",
4346+ "type": "boolean"
4347+ },
4348+ "columnCount": {
4349+ "description": "The number of columns in the grid.",
4350+ "type": "integer",
4351+ "format": "int32"
4352+ },
4353+ "columnGroupControlAfter": {
4354+ "description": "True if the column grouping control toggle is shown after the group.",
4355+ "type": "boolean"
4356+ },
4357+ "rowCount": {
4358+ "description": "The number of rows in the grid.",
4359+ "type": "integer",
4360+ "format": "int32"
4361+ },
4362+ "frozenRowCount": {
4363+ "description": "The number of rows that are frozen in the grid.",
4364+ "type": "integer",
4365+ "format": "int32"
4366+ },
4367+ "rowGroupControlAfter": {
4368+ "description": "True if the row grouping control toggle is shown after the group.",
4369+ "type": "boolean"
4370+ }
4371+ },
4372+ "id": "GridProperties"
4373+ },
4374+ "TextPosition": {
4375+ "id": "TextPosition",
4376+ "description": "Position settings for text.",
4377+ "type": "object",
4378+ "properties": {
4379+ "horizontalAlignment": {
4380+ "enum": [
4381+ "HORIZONTAL_ALIGN_UNSPECIFIED",
4382+ "LEFT",
4383+ "CENTER",
4384+ "RIGHT"
4385+ ],
4386+ "description": "Horizontal alignment setting for the piece of text.",
4387+ "type": "string",
4388+ "enumDescriptions": [
4389+ "The horizontal alignment is not specified. Do not use this.",
4390+ "The text is explicitly aligned to the left of the cell.",
4391+ "The text is explicitly aligned to the center of the cell.",
4392+ "The text is explicitly aligned to the right of the cell."
4393+ ]
4394+ }
4395+ }
4396+ },
4397+ "AddSheetResponse": {
4398+ "description": "The result of adding a sheet.",
4399+ "type": "object",
4400+ "properties": {
4401+ "properties": {
4402+ "description": "The properties of the newly added sheet.",
4403+ "$ref": "SheetProperties"
4404+ }
4405+ },
4406+ "id": "AddSheetResponse"
4407+ },
4408+ "RefreshDataSourceRequest": {
4409+ "id": "RefreshDataSourceRequest",
4410+ "description": "Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are refreshing a BigQuery data source. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly.",
4411+ "type": "object",
4412+ "properties": {
4413+ "dataSourceId": {
4414+ "description": "Reference to a DataSource. If specified, refreshes all associated data source objects for the data source.",
4415+ "type": "string"
4416+ },
4417+ "references": {
4418+ "description": "References to data source objects to refresh.",
4419+ "$ref": "DataSourceObjectReferences"
4420+ },
4421+ "force": {
4422+ "description": "Refreshes the data source objects regardless of the current state. If not set and a referenced data source object was in error state, the refresh will fail immediately.",
4423+ "type": "boolean"
4424+ },
4425+ "isAll": {
4426+ "description": "Refreshes all existing data source objects in the spreadsheet.",
4427+ "type": "boolean"
4428+ }
4429+ }
4430+ },
4431+ "CopySheetToAnotherSpreadsheetRequest": {
4432+ "description": "The request to copy a sheet across spreadsheets.",
4433+ "type": "object",
4434+ "properties": {
4435+ "destinationSpreadsheetId": {
4436+ "description": "The ID of the spreadsheet to copy the sheet to.",
4437+ "type": "string"
4438+ }
4439+ },
4440+ "id": "CopySheetToAnotherSpreadsheetRequest"
4441+ },
4442+ "PivotGroupSortValueBucket": {
4443+ "id": "PivotGroupSortValueBucket",
4444+ "description": "Information about which values in a pivot group should be used for sorting.",
4445+ "type": "object",
4446+ "properties": {
4447+ "valuesIndex": {
4448+ "description": "The offset in the PivotTable.values list which the values in this grouping should be sorted by.",
4449+ "type": "integer",
4450+ "format": "int32"
4451+ },
4452+ "buckets": {
4453+ "description": "Determines the bucket from which values are chosen to sort. For example, in a pivot table with one row group & two column groups, the row group can list up to two values. The first value corresponds to a value within the first column group, and the second value corresponds to a value in the second column group. If no values are listed, this would indicate that the row should be sorted according to the \"Grand Total\" over the column groups. If a single value is listed, this would correspond to using the \"Total\" of that bucket.",
4454+ "type": "array",
4455+ "items": {
4456+ "$ref": "ExtendedValue"
4457+ }
4458+ }
4459+ }
4460+ },
4461+ "DataSourceRefreshWeeklySchedule": {
4462+ "id": "DataSourceRefreshWeeklySchedule",
4463+ "description": "A weekly schedule for data to refresh on specific days in a given time interval.",
4464+ "type": "object",
4465+ "properties": {
4466+ "startTime": {
4467+ "description": "The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor.",
4468+ "$ref": "TimeOfDay"
4469+ },
4470+ "daysOfWeek": {
4471+ "description": "Days of the week to refresh. At least one day must be specified.",
4472+ "type": "array",
4473+ "items": {
4474+ "enum": [
4475+ "DAY_OF_WEEK_UNSPECIFIED",
4476+ "MONDAY",
4477+ "TUESDAY",
4478+ "WEDNESDAY",
4479+ "THURSDAY",
4480+ "FRIDAY",
4481+ "SATURDAY",
4482+ "SUNDAY"
4483+ ],
4484+ "type": "string",
4485+ "enumDescriptions": [
4486+ "The day of the week is unspecified.",
4487+ "Monday",
4488+ "Tuesday",
4489+ "Wednesday",
4490+ "Thursday",
4491+ "Friday",
4492+ "Saturday",
4493+ "Sunday"
4494+ ]
4495+ }
4496+ }
4497+ }
4498+ },
4499+ "ClearValuesResponse": {
4500+ "id": "ClearValuesResponse",
4501+ "description": "The response when clearing a range of values in a spreadsheet.",
4502+ "type": "object",
4503+ "properties": {
4504+ "clearedRange": {
4505+ "description": "The range (in A1 notation) that was cleared. (If the request was for an unbounded range or a range larger than the bounds of the sheet, this will be the actual range that was cleared, bounded to the sheet's limits.)",
4506+ "type": "string"
4507+ },
4508+ "spreadsheetId": {
4509+ "description": "The spreadsheet the updates were applied to.",
4510+ "type": "string"
4511+ }
4512+ }
4513+ },
4514+ "WaterfallChartSpec": {
4515+ "description": "A waterfall chart.",
4516+ "type": "object",
4517+ "properties": {
4518+ "domain": {
4519+ "description": "The domain data (horizontal axis) for the waterfall chart.",
4520+ "$ref": "WaterfallChartDomain"
4521+ },
4522+ "firstValueIsTotal": {
4523+ "description": "True to interpret the first value as a total.",
4524+ "type": "boolean"
4525+ },
4526+ "totalDataLabel": {
4527+ "description": "Controls whether to display additional data labels on stacked charts which sum the total value of all stacked values at each value along the domain axis. stacked_type must be STACKED and neither CUSTOM nor placement can be set on the total_data_label.",
4528+ "$ref": "DataLabel"
4529+ },
4530+ "hideConnectorLines": {
4531+ "description": "True to hide connector lines between columns.",
4532+ "type": "boolean"
4533+ },
4534+ "stackedType": {
4535+ "enum": [
4536+ "WATERFALL_STACKED_TYPE_UNSPECIFIED",
4537+ "STACKED",
4538+ "SEQUENTIAL"
4539+ ],
4540+ "description": "The stacked type.",
4541+ "type": "string",
4542+ "enumDescriptions": [
4543+ "Default value, do not use.",
4544+ "Values corresponding to the same domain (horizontal axis) value will be stacked vertically.",
4545+ "Series will spread out along the horizontal axis."
4546+ ]
4547+ },
4548+ "series": {
4549+ "items": {
4550+ "$ref": "WaterfallChartSeries"
4551+ },
4552+ "description": "The data this waterfall chart is visualizing.",
4553+ "type": "array"
4554+ },
4555+ "connectorLineStyle": {
4556+ "description": "The line style for the connector lines.",
4557+ "$ref": "LineStyle"
4558+ }
4559+ },
4560+ "id": "WaterfallChartSpec"
4561+ },
4562+ "ChartData": {
4563+ "description": "The data included in a domain or series.",
4564+ "type": "object",
4565+ "properties": {
4566+ "groupRule": {
4567+ "description": "The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.",
4568+ "$ref": "ChartGroupRule"
4569+ },
4570+ "columnReference": {
4571+ "description": "The reference to the data source column that the data reads from.",
4572+ "$ref": "DataSourceColumnReference"
4573+ },
4574+ "aggregateType": {
4575+ "enum": [
4576+ "CHART_AGGREGATE_TYPE_UNSPECIFIED",
4577+ "AVERAGE",
4578+ "COUNT",
4579+ "MAX",
4580+ "MEDIAN",
4581+ "MIN",
4582+ "SUM"
4583+ ],
4584+ "description": "The aggregation type for the series of a data source chart. Only supported for data source charts.",
4585+ "type": "string",
4586+ "enumDescriptions": [
4587+ "Default value, do not use.",
4588+ "Average aggregate function.",
4589+ "Count aggregate function.",
4590+ "Maximum aggregate function.",
4591+ "Median aggregate function.",
4592+ "Minimum aggregate function.",
4593+ "Sum aggregate function."
4594+ ]
4595+ },
4596+ "sourceRange": {
4597+ "description": "The source ranges of the data.",
4598+ "$ref": "ChartSourceRange"
4599+ }
4600+ },
4601+ "id": "ChartData"
4602+ },
4603+ "CancelDataSourceRefreshRequest": {
4604+ "id": "CancelDataSourceRefreshRequest",
4605+ "description": "Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are cancelling a refresh on a BigQuery data source.",
4606+ "type": "object",
4607+ "properties": {
4608+ "dataSourceId": {
4609+ "description": "Reference to a DataSource. If specified, cancels all associated data source object refreshes for this data source.",
4610+ "type": "string"
4611+ },
4612+ "references": {
4613+ "description": "References to data source objects whose refreshes are to be cancelled.",
4614+ "$ref": "DataSourceObjectReferences"
4615+ },
4616+ "isAll": {
4617+ "description": "Cancels all existing data source object refreshes for all data sources in the spreadsheet.",
4618+ "type": "boolean"
4619+ }
4620+ }
4621+ },
4622+ "AddSheetRequest": {
4623+ "description": "Adds a new sheet. When a sheet is added at a given index, all subsequent sheets' indexes are incremented. To add an object sheet, use AddChartRequest instead and specify EmbeddedObjectPosition.sheetId or EmbeddedObjectPosition.newSheet.",
4624+ "type": "object",
4625+ "properties": {
4626+ "properties": {
4627+ "description": "The properties the new sheet should have. All properties are optional. The sheetId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of a sheet that already exists.)",
4628+ "$ref": "SheetProperties"
4629+ }
4630+ },
4631+ "id": "AddSheetRequest"
4632+ },
4633+ "BatchClearValuesRequest": {
4634+ "description": "The request for clearing more than one range of values in a spreadsheet.",
4635+ "type": "object",
4636+ "properties": {
4637+ "ranges": {
4638+ "items": {
4639+ "type": "string"
4640+ },
4641+ "description": "The ranges to clear, in [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell).",
4642+ "type": "array"
4643+ }
4644+ },
4645+ "id": "BatchClearValuesRequest"
4646+ },
4647+ "AddChartRequest": {
4648+ "description": "Adds a chart to a sheet in the spreadsheet.",
4649+ "type": "object",
4650+ "properties": {
4651+ "chart": {
4652+ "description": "The chart that should be added to the spreadsheet, including the position where it should be placed. The chartId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of an embedded object that already exists.)",
4653+ "$ref": "EmbeddedChart"
4654+ }
4655+ },
4656+ "id": "AddChartRequest"
4657+ },
4658+ "DataSourceRefreshMonthlySchedule": {
4659+ "description": "A monthly schedule for data to refresh on specific days in the month in a given time interval.",
4660+ "type": "object",
4661+ "properties": {
4662+ "startTime": {
4663+ "description": "The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor.",
4664+ "$ref": "TimeOfDay"
4665+ },
4666+ "daysOfMonth": {
4667+ "description": "Days of the month to refresh. Only 1-28 are supported, mapping to the 1st to the 28th day. At least one day must be specified.",
4668+ "type": "array",
4669+ "items": {
4670+ "type": "integer",
4671+ "format": "int32"
4672+ }
4673+ }
4674+ },
4675+ "id": "DataSourceRefreshMonthlySchedule"
4676+ },
4677+ "FilterCriteria": {
4678+ "description": "Criteria for showing or hiding rows in a filter or filter view.",
4679+ "type": "object",
4680+ "properties": {
4681+ "visibleBackgroundColorStyle": {
4682+ "description": "The background fill color to filter by; only cells with this fill color are shown. This field is mutually exclusive with visible_foreground_color, and must be set to an RGB-type color. If visible_background_color is also set, this field takes precedence.",
4683+ "$ref": "ColorStyle"
4684+ },
4685+ "visibleForegroundColor": {
4686+ "description": "The foreground color to filter by; only cells with this foreground color are shown. Mutually exclusive with visible_background_color. Deprecated: Use visible_foreground_color_style.",
4687+ "deprecated": true,
4688+ "$ref": "Color"
4689+ },
4690+ "hiddenValues": {
4691+ "items": {
4692+ "type": "string"
4693+ },
4694+ "description": "Values that should be hidden.",
4695+ "type": "array"
4696+ },
4697+ "condition": {
4698+ "description": "A condition that must be `true` for values to be shown. (This does not override hidden_values -- if a value is listed there, it will still be hidden.)",
4699+ "$ref": "BooleanCondition"
4700+ },
4701+ "visibleBackgroundColor": {
4702+ "description": "The background fill color to filter by; only cells with this fill color are shown. Mutually exclusive with visible_foreground_color. Deprecated: Use visible_background_color_style.",
4703+ "deprecated": true,
4704+ "$ref": "Color"
4705+ },
4706+ "visibleForegroundColorStyle": {
4707+ "description": "The foreground color to filter by; only cells with this foreground color are shown. This field is mutually exclusive with visible_background_color, and must be set to an RGB-type color. If visible_foreground_color is also set, this field takes precedence.",
4708+ "$ref": "ColorStyle"
4709+ }
4710+ },
4711+ "id": "FilterCriteria"
4712+ },
4713+ "BatchUpdateSpreadsheetRequest": {
4714+ "description": "The request for updating any aspect of a spreadsheet.",
4715+ "type": "object",
4716+ "properties": {
4717+ "requests": {
4718+ "description": "A list of updates to apply to the spreadsheet. Requests will be applied in the order they are specified. If any request is not valid, no requests will be applied.",
4719+ "type": "array",
4720+ "items": {
4721+ "$ref": "Request"
4722+ }
4723+ },
4724+ "includeSpreadsheetInResponse": {
4725+ "description": "Determines if the update response should include the spreadsheet resource.",
4726+ "type": "boolean"
4727+ },
4728+ "responseIncludeGridData": {
4729+ "description": "True if grid data should be returned. Meaningful only if include_spreadsheet_in_response is 'true'. This parameter is ignored if a field mask was set in the request.",
4730+ "type": "boolean"
4731+ },
4732+ "responseRanges": {
4733+ "items": {
4734+ "type": "string"
4735+ },
4736+ "description": "Limits the ranges included in the response spreadsheet. Meaningful only if include_spreadsheet_in_response is 'true'.",
4737+ "type": "array"
4738+ }
4739+ },
4740+ "id": "BatchUpdateSpreadsheetRequest"
4741+ },
4742+ "PivotGroupValueMetadata": {
4743+ "description": "Metadata about a value in a pivot grouping.",
4744+ "type": "object",
4745+ "properties": {
4746+ "collapsed": {
4747+ "description": "True if the data corresponding to the value is collapsed.",
4748+ "type": "boolean"
4749+ },
4750+ "value": {
4751+ "description": "The calculated value the metadata corresponds to. (Note that formulaValue is not valid, because the values will be calculated.)",
4752+ "$ref": "ExtendedValue"
4753+ }
4754+ },
4755+ "id": "PivotGroupValueMetadata"
4756+ },
4757+ "BaselineValueFormat": {
4758+ "description": "Formatting options for baseline value.",
4759+ "type": "object",
4760+ "properties": {
4761+ "comparisonType": {
4762+ "description": "The comparison type of key value with baseline value.",
4763+ "type": "string",
4764+ "enumDescriptions": [
4765+ "Default value, do not use.",
4766+ "Use absolute difference between key and baseline value.",
4767+ "Use percentage difference between key and baseline value."
4768+ ],
4769+ "enum": [
4770+ "COMPARISON_TYPE_UNDEFINED",
4771+ "ABSOLUTE_DIFFERENCE",
4772+ "PERCENTAGE_DIFFERENCE"
4773+ ]
4774+ },
4775+ "negativeColor": {
4776+ "description": "Color to be used, in case baseline value represents a negative change for key value. This field is optional. Deprecated: Use negative_color_style.",
4777+ "deprecated": true,
4778+ "$ref": "Color"
4779+ },
4780+ "negativeColorStyle": {
4781+ "description": "Color to be used, in case baseline value represents a negative change for key value. This field is optional. If negative_color is also set, this field takes precedence.",
4782+ "$ref": "ColorStyle"
4783+ },
4784+ "description": {
4785+ "description": "Description which is appended after the baseline value. This field is optional.",
4786+ "type": "string"
4787+ },
4788+ "positiveColor": {
4789+ "description": "Color to be used, in case baseline value represents a positive change for key value. This field is optional. Deprecated: Use positive_color_style.",
4790+ "deprecated": true,
4791+ "$ref": "Color"
4792+ },
4793+ "positiveColorStyle": {
4794+ "description": "Color to be used, in case baseline value represents a positive change for key value. This field is optional. If positive_color is also set, this field takes precedence.",
4795+ "$ref": "ColorStyle"
4796+ },
4797+ "textFormat": {
4798+ "description": "Text formatting options for baseline value. The link field is not supported.",
4799+ "$ref": "TextFormat"
4800+ },
4801+ "position": {
4802+ "description": "Specifies the horizontal text positioning of baseline value. This field is optional. If not specified, default positioning is used.",
4803+ "$ref": "TextPosition"
4804+ }
4805+ },
4806+ "id": "BaselineValueFormat"
4807+ },
4808+ "UpdateDataSourceResponse": {
4809+ "description": "The response from updating data source.",
4810+ "type": "object",
4811+ "properties": {
4812+ "dataSource": {
4813+ "description": "The updated data source.",
4814+ "$ref": "DataSource"
4815+ },
4816+ "dataExecutionStatus": {
4817+ "description": "The data execution status.",
4818+ "$ref": "DataExecutionStatus"
4819+ }
4820+ },
4821+ "id": "UpdateDataSourceResponse"
4822+ },
4823+ "DimensionProperties": {
4824+ "description": "Properties about a dimension.",
4825+ "type": "object",
4826+ "properties": {
4827+ "hiddenByUser": {
4828+ "description": "True if this dimension is explicitly hidden.",
4829+ "type": "boolean"
4830+ },
4831+ "developerMetadata": {
4832+ "description": "The developer metadata associated with a single row or column.",
4833+ "type": "array",
4834+ "items": {
4835+ "$ref": "DeveloperMetadata"
4836+ }
4837+ },
4838+ "dataSourceColumnReference": {
4839+ "description": "Output only. If set, this is a column in a data source sheet.",
4840+ "readOnly": true,
4841+ "$ref": "DataSourceColumnReference"
4842+ },
4843+ "hiddenByFilter": {
4844+ "description": "True if this dimension is being filtered. This field is read-only.",
4845+ "type": "boolean"
4846+ },
4847+ "pixelSize": {
4848+ "format": "int32",
4849+ "description": "The height (if a row) or width (if a column) of the dimension in pixels.",
4850+ "type": "integer"
4851+ }
4852+ },
4853+ "id": "DimensionProperties"
4854+ },
4855+ "ChipRun": {
4856+ "id": "ChipRun",
4857+ "description": "The run of a chip. The chip continues until the start index of the next run.",
4858+ "type": "object",
4859+ "properties": {
4860+ "startIndex": {
4861+ "format": "int32",
4862+ "description": "Required. The zero-based character index where this run starts, in UTF-16 code units.",
4863+ "type": "integer"
4864+ },
4865+ "chip": {
4866+ "description": "Optional. The chip of this run.",
4867+ "$ref": "Chip"
4868+ }
4869+ }
4870+ },
4871+ "UpdateDeveloperMetadataRequest": {
4872+ "id": "UpdateDeveloperMetadataRequest",
4873+ "description": "A request to update properties of developer metadata. Updates the properties of the developer metadata selected by the filters to the values provided in the DeveloperMetadata resource. Callers must specify the properties they wish to update in the fields parameter, as well as specify at least one DataFilter matching the metadata they wish to update.",
4874+ "type": "object",
4875+ "properties": {
4876+ "dataFilters": {
4877+ "description": "The filters matching the developer metadata entries to update.",
4878+ "type": "array",
4879+ "items": {
4880+ "$ref": "DataFilter"
4881+ }
4882+ },
4883+ "fields": {
4884+ "description": "The fields that should be updated. At least one field must be specified. The root `developerMetadata` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.",
4885+ "type": "string",
4886+ "format": "google-fieldmask"
4887+ },
4888+ "developerMetadata": {
4889+ "description": "The value that all metadata matched by the data filters will be updated to.",
4890+ "$ref": "DeveloperMetadata"
4891+ }
4892+ }
4893+ },
4894+ "UpdateTableRequest": {
4895+ "id": "UpdateTableRequest",
4896+ "description": "Updates a table in the spreadsheet.",
4897+ "type": "object",
4898+ "properties": {
4899+ "table": {
4900+ "description": "Required. The table to update.",
4901+ "$ref": "Table"
4902+ },
4903+ "fields": {
4904+ "format": "google-fieldmask",
4905+ "description": "Required. The fields that should be updated. At least one field must be specified. The root `table` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.",
4906+ "type": "string"
4907+ }
4908+ }
4909+ },
4910+ "CancelDataSourceRefreshStatus": {
4911+ "description": "The status of cancelling a single data source object refresh.",
4912+ "type": "object",
4913+ "properties": {
4914+ "refreshCancellationStatus": {
4915+ "description": "The cancellation status.",
4916+ "$ref": "RefreshCancellationStatus"
4917+ },
4918+ "reference": {
4919+ "description": "Reference to the data source object whose refresh is being cancelled.",
4920+ "$ref": "DataSourceObjectReference"
4921+ }
4922+ },
4923+ "id": "CancelDataSourceRefreshStatus"
4924+ },
4925+ "SortSpec": {
4926+ "description": "A sort order associated with a specific column or row.",
4927+ "type": "object",
4928+ "properties": {
4929+ "dimensionIndex": {
4930+ "description": "The dimension the sort should be applied to.",
4931+ "type": "integer",
4932+ "format": "int32"
4933+ },
4934+ "sortOrder": {
4935+ "enum": [
4936+ "SORT_ORDER_UNSPECIFIED",
4937+ "ASCENDING",
4938+ "DESCENDING"
4939+ ],
4940+ "description": "The order data should be sorted.",
4941+ "type": "string",
4942+ "enumDescriptions": [
4943+ "Default value, do not use this.",
4944+ "Sort ascending.",
4945+ "Sort descending."
4946+ ]
4947+ },
4948+ "backgroundColor": {
4949+ "description": "The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color. Deprecated: Use background_color_style.",
4950+ "deprecated": true,
4951+ "$ref": "Color"
4952+ },
4953+ "foregroundColorStyle": {
4954+ "description": "The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color, and must be an RGB-type color. If foreground_color is also set, this field takes precedence.",
4955+ "$ref": "ColorStyle"
4956+ },
4957+ "backgroundColorStyle": {
4958+ "description": "The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color, and must be an RGB-type color. If background_color is also set, this field takes precedence.",
4959+ "$ref": "ColorStyle"
4960+ },
4961+ "dataSourceColumnReference": {
4962+ "description": "Reference to a data source column.",
4963+ "$ref": "DataSourceColumnReference"
4964+ },
4965+ "foregroundColor": {
4966+ "description": "The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color. Deprecated: Use foreground_color_style.",
4967+ "deprecated": true,
4968+ "$ref": "Color"
4969+ }
4970+ },
4971+ "id": "SortSpec"
4972+ },
4973+ "DeleteEmbeddedObjectRequest": {
4974+ "id": "DeleteEmbeddedObjectRequest",
4975+ "description": "Deletes the embedded object with the given ID.",
4976+ "type": "object",
4977+ "properties": {
4978+ "objectId": {
4979+ "description": "The ID of the embedded object to delete.",
4980+ "type": "integer",
4981+ "format": "int32"
4982+ }
4983+ }
4984+ },
4985+ "WaterfallChartCustomSubtotal": {
4986+ "description": "A custom subtotal column for a waterfall chart series.",
4987+ "type": "object",
4988+ "properties": {
4989+ "subtotalIndex": {
4990+ "format": "int32",
4991+ "description": "The zero-based index of a data point within the series. If data_is_subtotal is true, the data point at this index is the subtotal. Otherwise, the subtotal appears after the data point with this index. A series can have multiple subtotals at arbitrary indices, but subtotals do not affect the indices of the data points. For example, if a series has three data points, their indices will always be 0, 1, and 2, regardless of how many subtotals exist on the series or what data points they are associated with.",
4992+ "type": "integer"
4993+ },
4994+ "dataIsSubtotal": {
4995+ "description": "True if the data point at subtotal_index is the subtotal. If false, the subtotal will be computed and appear after the data point.",
4996+ "type": "boolean"
4997+ },
4998+ "label": {
4999+ "description": "A label for the subtotal column.",

3315 more lines aren’t shown here.

packages/control-plane/src/runtime/fixtures/linear-introspection.json+129477−0
@@ -0,0 +1,129477 @@
1+{
2+ "data": {
3+ "__schema": {
4+ "queryType": {
5+ "name": "Query",
6+ "kind": "OBJECT"
7+ },
8+ "mutationType": {
9+ "name": "Mutation",
10+ "kind": "OBJECT"
11+ },
12+ "subscriptionType": null,
13+ "types": [
14+ {
15+ "kind": "OBJECT",
16+ "name": "CustomerNotificationSubscription",
17+ "description": "A customer notification subscription.",
18+ "fields": [
19+ {
20+ "name": "id",
21+ "description": "The unique identifier of the entity.",
22+ "args": [],
23+ "type": {
24+ "kind": "NON_NULL",
25+ "name": null,
26+ "ofType": {
27+ "kind": "SCALAR",
28+ "name": "ID",
29+ "ofType": null
30+ }
31+ },
32+ "isDeprecated": false,
33+ "deprecationReason": null
34+ },
35+ {
36+ "name": "createdAt",
37+ "description": "The time at which the entity was created.",
38+ "args": [],
39+ "type": {
40+ "kind": "NON_NULL",
41+ "name": null,
42+ "ofType": {
43+ "kind": "SCALAR",
44+ "name": "DateTime",
45+ "ofType": null
46+ }
47+ },
48+ "isDeprecated": false,
49+ "deprecationReason": null
50+ },
51+ {
52+ "name": "updatedAt",
53+ "description": "The last time at which the entity was meaningfully updated. This is the same as the creation time if the entity hasn't\n been updated after creation.",
54+ "args": [],
55+ "type": {
56+ "kind": "NON_NULL",
57+ "name": null,
58+ "ofType": {
59+ "kind": "SCALAR",
60+ "name": "DateTime",
61+ "ofType": null
62+ }
63+ },
64+ "isDeprecated": false,
65+ "deprecationReason": null
66+ },
67+ {
68+ "name": "archivedAt",
69+ "description": "The time at which the entity was archived. Null if the entity has not been archived.",
70+ "args": [],
71+ "type": {
72+ "kind": "SCALAR",
73+ "name": "DateTime",
74+ "ofType": null
75+ },
76+ "isDeprecated": false,
77+ "deprecationReason": null
78+ },
79+ {
80+ "name": "subscriber",
81+ "description": "The user that subscribed to receive notifications.",
82+ "args": [],
83+ "type": {
84+ "kind": "NON_NULL",
85+ "name": null,
86+ "ofType": {
87+ "kind": "OBJECT",
88+ "name": "User",
89+ "ofType": null
90+ }
91+ },
92+ "isDeprecated": false,
93+ "deprecationReason": null
94+ },
95+ {
96+ "name": "customer",
97+ "description": "The customer subscribed to.",
98+ "args": [],
99+ "type": {
100+ "kind": "NON_NULL",
101+ "name": null,
102+ "ofType": {
103+ "kind": "OBJECT",
104+ "name": "Customer",
105+ "ofType": null
106+ }
107+ },
108+ "isDeprecated": false,
109+ "deprecationReason": null
110+ },
111+ {
112+ "name": "customView",
113+ "description": "The contextual custom view associated with the notification subscription.",
114+ "args": [],
115+ "type": {
116+ "kind": "OBJECT",
117+ "name": "CustomView",
118+ "ofType": null
119+ },
120+ "isDeprecated": false,
121+ "deprecationReason": null
122+ },
123+ {
124+ "name": "cycle",
125+ "description": "The contextual cycle view associated with the notification subscription.",
126+ "args": [],
127+ "type": {
128+ "kind": "OBJECT",
129+ "name": "Cycle",
130+ "ofType": null
131+ },
132+ "isDeprecated": false,
133+ "deprecationReason": null
134+ },
135+ {
136+ "name": "label",
137+ "description": "The contextual label view associated with the notification subscription.",
138+ "args": [],
139+ "type": {
140+ "kind": "OBJECT",
141+ "name": "IssueLabel",
142+ "ofType": null
143+ },
144+ "isDeprecated": false,
145+ "deprecationReason": null
146+ },
147+ {
148+ "name": "project",
149+ "description": "The contextual project view associated with the notification subscription.",
150+ "args": [],
151+ "type": {
152+ "kind": "OBJECT",
153+ "name": "Project",
154+ "ofType": null
155+ },
156+ "isDeprecated": false,
157+ "deprecationReason": null
158+ },
159+ {
160+ "name": "initiative",
161+ "description": "The contextual initiative view associated with the notification subscription.",
162+ "args": [],
163+ "type": {
164+ "kind": "OBJECT",
165+ "name": "Initiative",
166+ "ofType": null
167+ },
168+ "isDeprecated": false,
169+ "deprecationReason": null
170+ },
171+ {
172+ "name": "team",
173+ "description": "The team associated with the notification subscription.",
174+ "args": [],
175+ "type": {
176+ "kind": "OBJECT",
177+ "name": "Team",
178+ "ofType": null
179+ },
180+ "isDeprecated": false,
181+ "deprecationReason": null
182+ },
183+ {
184+ "name": "user",
185+ "description": "The user view associated with the notification subscription.",
186+ "args": [],
187+ "type": {
188+ "kind": "OBJECT",
189+ "name": "User",
190+ "ofType": null
191+ },
192+ "isDeprecated": false,
193+ "deprecationReason": null
194+ },
195+ {
196+ "name": "contextViewType",
197+ "description": "The type of view to which the notification subscription context is associated with.",
198+ "args": [],
199+ "type": {
200+ "kind": "ENUM",
201+ "name": "ContextViewType",
202+ "ofType": null
203+ },
204+ "isDeprecated": false,
205+ "deprecationReason": null
206+ },
207+ {
208+ "name": "userContextViewType",
209+ "description": "The type of user view to which the notification subscription context is associated with.",
210+ "args": [],
211+ "type": {
212+ "kind": "ENUM",
213+ "name": "UserContextViewType",
214+ "ofType": null
215+ },
216+ "isDeprecated": false,
217+ "deprecationReason": null
218+ },
219+ {
220+ "name": "active",
221+ "description": "Whether the subscription is active or not.",
222+ "args": [],
223+ "type": {
224+ "kind": "NON_NULL",
225+ "name": null,
226+ "ofType": {
227+ "kind": "SCALAR",
228+ "name": "Boolean",
229+ "ofType": null
230+ }
231+ },
232+ "isDeprecated": false,
233+ "deprecationReason": null
234+ },
235+ {
236+ "name": "notificationSubscriptionTypes",
237+ "description": "The type of subscription.",
238+ "args": [],
239+ "type": {
240+ "kind": "NON_NULL",
241+ "name": null,
242+ "ofType": {
243+ "kind": "LIST",
244+ "name": null,
245+ "ofType": {
246+ "kind": "NON_NULL",
247+ "name": null,
248+ "ofType": {
249+ "kind": "SCALAR",
250+ "name": "String",
251+ "ofType": null
252+ }
253+ }
254+ }
255+ },
256+ "isDeprecated": false,
257+ "deprecationReason": null
258+ }
259+ ],
260+ "inputFields": null,
261+ "interfaces": [
262+ {
263+ "kind": "INTERFACE",
264+ "name": "NotificationSubscription",
265+ "ofType": null
266+ },
267+ {
268+ "kind": "INTERFACE",
269+ "name": "Entity",
270+ "ofType": null
271+ },
272+ {
273+ "kind": "INTERFACE",
274+ "name": "Node",
275+ "ofType": null
276+ }
277+ ],
278+ "enumValues": null,
279+ "possibleTypes": null
280+ },
281+ {
282+ "kind": "INTERFACE",
283+ "name": "NotificationSubscription",
284+ "description": "Notification subscriptions for models.",
285+ "fields": [
286+ {
287+ "name": "id",
288+ "description": "The unique identifier of the entity.",
289+ "args": [],
290+ "type": {
291+ "kind": "NON_NULL",
292+ "name": null,
293+ "ofType": {
294+ "kind": "SCALAR",
295+ "name": "ID",
296+ "ofType": null
297+ }
298+ },
299+ "isDeprecated": false,
300+ "deprecationReason": null
301+ },
302+ {
303+ "name": "createdAt",
304+ "description": "The time at which the entity was created.",
305+ "args": [],
306+ "type": {
307+ "kind": "NON_NULL",
308+ "name": null,
309+ "ofType": {
310+ "kind": "SCALAR",
311+ "name": "DateTime",
312+ "ofType": null
313+ }
314+ },
315+ "isDeprecated": false,
316+ "deprecationReason": null
317+ },
318+ {
319+ "name": "updatedAt",
320+ "description": "The last time at which the entity was meaningfully updated. This is the same as the creation time if the entity hasn't\n been updated after creation.",
321+ "args": [],
322+ "type": {
323+ "kind": "NON_NULL",
324+ "name": null,
325+ "ofType": {
326+ "kind": "SCALAR",
327+ "name": "DateTime",
328+ "ofType": null
329+ }
330+ },
331+ "isDeprecated": false,
332+ "deprecationReason": null
333+ },
334+ {
335+ "name": "archivedAt",
336+ "description": "The time at which the entity was archived. Null if the entity has not been archived.",
337+ "args": [],
338+ "type": {
339+ "kind": "SCALAR",
340+ "name": "DateTime",
341+ "ofType": null
342+ },
343+ "isDeprecated": false,
344+ "deprecationReason": null
345+ },
346+ {
347+ "name": "subscriber",
348+ "description": "The user that subscribed to receive notifications.",
349+ "args": [],
350+ "type": {
351+ "kind": "NON_NULL",
352+ "name": null,
353+ "ofType": {
354+ "kind": "OBJECT",
355+ "name": "User",
356+ "ofType": null
357+ }
358+ },
359+ "isDeprecated": false,
360+ "deprecationReason": null
361+ },
362+ {
363+ "name": "customer",
364+ "description": "The customer associated with the notification subscription.",
365+ "args": [],
366+ "type": {
367+ "kind": "OBJECT",
368+ "name": "Customer",
369+ "ofType": null
370+ },
371+ "isDeprecated": false,
372+ "deprecationReason": null
373+ },
374+ {
375+ "name": "customView",
376+ "description": "The contextual custom view associated with the notification subscription.",
377+ "args": [],
378+ "type": {
379+ "kind": "OBJECT",
380+ "name": "CustomView",
381+ "ofType": null
382+ },
383+ "isDeprecated": false,
384+ "deprecationReason": null
385+ },
386+ {
387+ "name": "cycle",
388+ "description": "The contextual cycle view associated with the notification subscription.",
389+ "args": [],
390+ "type": {
391+ "kind": "OBJECT",
392+ "name": "Cycle",
393+ "ofType": null
394+ },
395+ "isDeprecated": false,
396+ "deprecationReason": null
397+ },
398+ {
399+ "name": "label",
400+ "description": "The contextual label view associated with the notification subscription.",
401+ "args": [],
402+ "type": {
403+ "kind": "OBJECT",
404+ "name": "IssueLabel",
405+ "ofType": null
406+ },
407+ "isDeprecated": false,
408+ "deprecationReason": null
409+ },
410+ {
411+ "name": "project",
412+ "description": "The contextual project view associated with the notification subscription.",
413+ "args": [],
414+ "type": {
415+ "kind": "OBJECT",
416+ "name": "Project",
417+ "ofType": null
418+ },
419+ "isDeprecated": false,
420+ "deprecationReason": null
421+ },
422+ {
423+ "name": "initiative",
424+ "description": "The contextual initiative view associated with the notification subscription.",
425+ "args": [],
426+ "type": {
427+ "kind": "OBJECT",
428+ "name": "Initiative",
429+ "ofType": null
430+ },
431+ "isDeprecated": false,
432+ "deprecationReason": null
433+ },
434+ {
435+ "name": "team",
436+ "description": "The team associated with the notification subscription.",
437+ "args": [],
438+ "type": {
439+ "kind": "OBJECT",
440+ "name": "Team",
441+ "ofType": null
442+ },
443+ "isDeprecated": false,
444+ "deprecationReason": null
445+ },
446+ {
447+ "name": "user",
448+ "description": "The user view associated with the notification subscription.",
449+ "args": [],
450+ "type": {
451+ "kind": "OBJECT",
452+ "name": "User",
453+ "ofType": null
454+ },
455+ "isDeprecated": false,
456+ "deprecationReason": null
457+ },
458+ {
459+ "name": "contextViewType",
460+ "description": "The type of view to which the notification subscription context is associated with.",
461+ "args": [],
462+ "type": {
463+ "kind": "ENUM",
464+ "name": "ContextViewType",
465+ "ofType": null
466+ },
467+ "isDeprecated": false,
468+ "deprecationReason": null
469+ },
470+ {
471+ "name": "userContextViewType",
472+ "description": "The type of user view to which the notification subscription context is associated with.",
473+ "args": [],
474+ "type": {
475+ "kind": "ENUM",
476+ "name": "UserContextViewType",
477+ "ofType": null
478+ },
479+ "isDeprecated": false,
480+ "deprecationReason": null
481+ },
482+ {
483+ "name": "active",
484+ "description": "Whether the subscription is active or not.",
485+ "args": [],
486+ "type": {
487+ "kind": "NON_NULL",
488+ "name": null,
489+ "ofType": {
490+ "kind": "SCALAR",
491+ "name": "Boolean",
492+ "ofType": null
493+ }
494+ },
495+ "isDeprecated": false,
496+ "deprecationReason": null
497+ }
498+ ],
499+ "inputFields": null,
500+ "interfaces": [
501+ {
502+ "kind": "INTERFACE",
503+ "name": "Entity",
504+ "ofType": null
505+ },
506+ {
507+ "kind": "INTERFACE",
508+ "name": "Node",
509+ "ofType": null
510+ }
511+ ],
512+ "enumValues": null,
513+ "possibleTypes": [
514+ {
515+ "kind": "OBJECT",
516+ "name": "CustomerNotificationSubscription",
517+ "ofType": null
518+ },
519+ {
520+ "kind": "OBJECT",
521+ "name": "CustomViewNotificationSubscription",
522+ "ofType": null
523+ },
524+ {
525+ "kind": "OBJECT",
526+ "name": "CycleNotificationSubscription",
527+ "ofType": null
528+ },
529+ {
530+ "kind": "OBJECT",
531+ "name": "LabelNotificationSubscription",
532+ "ofType": null
533+ },
534+ {
535+ "kind": "OBJECT",
536+ "name": "ProjectNotificationSubscription",
537+ "ofType": null
538+ },
539+ {
540+ "kind": "OBJECT",
541+ "name": "InitiativeNotificationSubscription",
542+ "ofType": null
543+ },
544+ {
545+ "kind": "OBJECT",
546+ "name": "TeamNotificationSubscription",
547+ "ofType": null
548+ },
549+ {
550+ "kind": "OBJECT",
551+ "name": "UserNotificationSubscription",
552+ "ofType": null
553+ }
554+ ]
555+ },
556+ {
557+ "kind": "INTERFACE",
558+ "name": "Entity",
559+ "description": "A basic entity.",
560+ "fields": [
561+ {
562+ "name": "id",
563+ "description": "The unique identifier of the entity.",
564+ "args": [],
565+ "type": {
566+ "kind": "NON_NULL",
567+ "name": null,
568+ "ofType": {
569+ "kind": "SCALAR",
570+ "name": "ID",
571+ "ofType": null
572+ }
573+ },
574+ "isDeprecated": false,
575+ "deprecationReason": null
576+ },
577+ {
578+ "name": "createdAt",
579+ "description": "The time at which the entity was created.",
580+ "args": [],
581+ "type": {
582+ "kind": "NON_NULL",
583+ "name": null,
584+ "ofType": {
585+ "kind": "SCALAR",
586+ "name": "DateTime",
587+ "ofType": null
588+ }
589+ },
590+ "isDeprecated": false,
591+ "deprecationReason": null
592+ },
593+ {
594+ "name": "updatedAt",
595+ "description": "The last time at which the entity was meaningfully updated. This is the same as the creation time if the entity hasn't\n been updated after creation.",
596+ "args": [],
597+ "type": {
598+ "kind": "NON_NULL",
599+ "name": null,
600+ "ofType": {
601+ "kind": "SCALAR",
602+ "name": "DateTime",
603+ "ofType": null
604+ }
605+ },
606+ "isDeprecated": false,
607+ "deprecationReason": null
608+ },
609+ {
610+ "name": "archivedAt",
611+ "description": "The time at which the entity was archived. Null if the entity has not been archived.",
612+ "args": [],
613+ "type": {
614+ "kind": "SCALAR",
615+ "name": "DateTime",
616+ "ofType": null
617+ },
618+ "isDeprecated": false,
619+ "deprecationReason": null
620+ }
621+ ],
622+ "inputFields": null,
623+ "interfaces": [
624+ {
625+ "kind": "INTERFACE",
626+ "name": "Node",
627+ "ofType": null
628+ }
629+ ],
630+ "enumValues": null,
631+ "possibleTypes": [
632+ {
633+ "kind": "OBJECT",
634+ "name": "CustomerNotificationSubscription",
635+ "ofType": null
636+ },
637+ {
638+ "kind": "OBJECT",
639+ "name": "CustomViewNotificationSubscription",
640+ "ofType": null
641+ },
642+ {
643+ "kind": "OBJECT",
644+ "name": "CycleNotificationSubscription",
645+ "ofType": null
646+ },
647+ {
648+ "kind": "OBJECT",
649+ "name": "LabelNotificationSubscription",
650+ "ofType": null
651+ },
652+ {
653+ "kind": "OBJECT",
654+ "name": "ProjectNotificationSubscription",
655+ "ofType": null
656+ },
657+ {
658+ "kind": "OBJECT",
659+ "name": "InitiativeNotificationSubscription",
660+ "ofType": null
661+ },
662+ {
663+ "kind": "OBJECT",
664+ "name": "TeamNotificationSubscription",
665+ "ofType": null
666+ },
667+ {
668+ "kind": "OBJECT",
669+ "name": "UserNotificationSubscription",
670+ "ofType": null
671+ },
672+ {
673+ "kind": "OBJECT",
674+ "name": "IssueNotification",
675+ "ofType": null
676+ },
677+ {
678+ "kind": "OBJECT",
679+ "name": "ProjectNotification",
680+ "ofType": null
681+ },
682+ {
683+ "kind": "OBJECT",
684+ "name": "InitiativeNotification",
685+ "ofType": null
686+ },
687+ {
688+ "kind": "OBJECT",
689+ "name": "OauthClientApprovalNotification",
690+ "ofType": null
691+ },
692+ {
693+ "kind": "OBJECT",
694+ "name": "DocumentNotification",
695+ "ofType": null
696+ },
697+ {
698+ "kind": "OBJECT",
699+ "name": "PostNotification",
700+ "ofType": null
701+ },
702+ {
703+ "kind": "OBJECT",
704+ "name": "CustomerNeedNotification",
705+ "ofType": null
706+ },
707+ {
708+ "kind": "OBJECT",
709+ "name": "CustomerNotification",
710+ "ofType": null
711+ },
712+ {
713+ "kind": "OBJECT",
714+ "name": "PullRequestNotification",
715+ "ofType": null
716+ },
717+ {
718+ "kind": "OBJECT",
719+ "name": "WelcomeMessageNotification",
720+ "ofType": null
721+ }
722+ ]
723+ },
724+ {
725+ "kind": "INTERFACE",
726+ "name": "Node",
727+ "description": null,
728+ "fields": [
729+ {
730+ "name": "id",
731+ "description": "The unique identifier of the entity.",
732+ "args": [],
733+ "type": {
734+ "kind": "NON_NULL",
735+ "name": null,
736+ "ofType": {
737+ "kind": "SCALAR",
738+ "name": "ID",
739+ "ofType": null
740+ }
741+ },
742+ "isDeprecated": false,
743+ "deprecationReason": null
744+ }
745+ ],
746+ "inputFields": null,
747+ "interfaces": [],
748+ "enumValues": null,
749+ "possibleTypes": [
750+ {
751+ "kind": "OBJECT",
752+ "name": "CustomerNotificationSubscription",
753+ "ofType": null
754+ },
755+ {
756+ "kind": "OBJECT",
757+ "name": "User",
758+ "ofType": null
759+ },
760+ {
761+ "kind": "OBJECT",
762+ "name": "Organization",
763+ "ofType": null
764+ },
765+ {
766+ "kind": "OBJECT",
767+ "name": "Facet",
768+ "ofType": null
769+ },
770+ {
771+ "kind": "OBJECT",
772+ "name": "Team",
773+ "ofType": null
774+ },
775+ {
776+ "kind": "OBJECT",
777+ "name": "WorkflowState",
778+ "ofType": null
779+ },
780+ {
781+ "kind": "OBJECT",
782+ "name": "Issue",
783+ "ofType": null
784+ },
785+ {
786+ "kind": "OBJECT",
787+ "name": "Summary",
788+ "ofType": null
789+ },
790+ {
791+ "kind": "OBJECT",
792+ "name": "Cycle",
793+ "ofType": null
794+ },
795+ {
796+ "kind": "OBJECT",
797+ "name": "Document",
798+ "ofType": null
799+ },
800+ {
801+ "kind": "OBJECT",
802+ "name": "Project",
803+ "ofType": null
804+ },
805+ {
806+ "kind": "OBJECT",
807+ "name": "ProjectStatus",
808+ "ofType": null
809+ },
810+ {
811+ "kind": "OBJECT",
812+ "name": "Template",
813+ "ofType": null
814+ },
815+ {
816+ "kind": "OBJECT",
817+ "name": "ProjectUpdate",
818+ "ofType": null
819+ },
820+ {
821+ "kind": "OBJECT",
822+ "name": "Reaction",
823+ "ofType": null
824+ },
825+ {
826+ "kind": "OBJECT",
827+ "name": "Comment",
828+ "ofType": null
829+ },
830+ {
831+ "kind": "OBJECT",
832+ "name": "DocumentContent",
833+ "ofType": null
834+ },
835+ {
836+ "kind": "OBJECT",
837+ "name": "PullRequest",
838+ "ofType": null
839+ },
840+ {
841+ "kind": "OBJECT",
842+ "name": "Initiative",
843+ "ofType": null
844+ },
845+ {
846+ "kind": "OBJECT",
847+ "name": "InitiativeUpdate",
848+ "ofType": null
849+ },
850+ {
851+ "kind": "OBJECT",
852+ "name": "EntityExternalLink",
853+ "ofType": null
854+ },
855+ {
856+ "kind": "OBJECT",
857+ "name": "IntegrationsSettings",
858+ "ofType": null
859+ },
860+ {
861+ "kind": "OBJECT",
862+ "name": "InitiativeHistory",
863+ "ofType": null
864+ },
865+ {
866+ "kind": "OBJECT",
867+ "name": "ProjectMilestone",
868+ "ofType": null
869+ },
870+ {
871+ "kind": "OBJECT",
872+ "name": "AiPromptRules",
873+ "ofType": null
874+ },
875+ {
876+ "kind": "OBJECT",
877+ "name": "WelcomeMessage",
878+ "ofType": null
879+ },
880+ {
881+ "kind": "OBJECT",
882+ "name": "Post",
883+ "ofType": null
884+ },
885+ {
886+ "kind": "OBJECT",
887+ "name": "ExternalUser",
888+ "ofType": null
889+ },
890+ {
891+ "kind": "OBJECT",
892+ "name": "AgentSession",
893+ "ofType": null
894+ },
895+ {
896+ "kind": "OBJECT",
897+ "name": "AgentActivity",
898+ "ofType": null
899+ },
900+ {
901+ "kind": "OBJECT",
902+ "name": "AgentSessionToPullRequest",
903+ "ofType": null
904+ },
905+ {
906+ "kind": "OBJECT",
907+ "name": "Favorite",
908+ "ofType": null
909+ },
910+ {
911+ "kind": "OBJECT",
912+ "name": "CustomView",
913+ "ofType": null
914+ },
915+ {
916+ "kind": "OBJECT",
917+ "name": "FeedItem",
918+ "ofType": null
919+ },
920+ {
921+ "kind": "OBJECT",
922+ "name": "ViewPreferences",
923+ "ofType": null
924+ },
925+ {
926+ "kind": "OBJECT",
927+ "name": "IssueLabel",
928+ "ofType": null
929+ },
930+ {
931+ "kind": "OBJECT",
932+ "name": "ProjectLabel",
933+ "ofType": null
934+ },
935+ {
936+ "kind": "OBJECT",
937+ "name": "Customer",
938+ "ofType": null
939+ },
940+ {
941+ "kind": "OBJECT",
942+ "name": "CustomerStatus",
943+ "ofType": null
944+ },
945+ {
946+ "kind": "OBJECT",
947+ "name": "CustomerTier",
948+ "ofType": null
949+ },
950+ {
951+ "kind": "OBJECT",
952+ "name": "CustomerNeed",
953+ "ofType": null
954+ },
955+ {
956+ "kind": "OBJECT",
957+ "name": "Attachment",
958+ "ofType": null
959+ },
960+ {
961+ "kind": "OBJECT",
962+ "name": "ProjectAttachment",
963+ "ofType": null
964+ },
965+ {
966+ "kind": "OBJECT",
967+ "name": "Integration",
968+ "ofType": null
969+ },
970+ {
971+ "kind": "OBJECT",
972+ "name": "Dashboard",
973+ "ofType": null
974+ },
975+ {
976+ "kind": "OBJECT",
977+ "name": "Release",
978+ "ofType": null
979+ },
980+ {
981+ "kind": "OBJECT",
982+ "name": "ReleasePipeline",
983+ "ofType": null
984+ },
985+ {
986+ "kind": "OBJECT",
987+ "name": "ReleaseStage",
988+ "ofType": null
989+ },
990+ {
991+ "kind": "OBJECT",
992+ "name": "InitiativeToProject",
993+ "ofType": null
994+ },
995+ {
996+ "kind": "OBJECT",
997+ "name": "ProjectHistory",
998+ "ofType": null
999+ },
1000+ {
1001+ "kind": "OBJECT",
1002+ "name": "ProjectRelation",
1003+ "ofType": null
1004+ },
1005+ {
1006+ "kind": "OBJECT",
1007+ "name": "IssueHistory",
1008+ "ofType": null
1009+ },
1010+ {
1011+ "kind": "OBJECT",
1012+ "name": "IssueImport",
1013+ "ofType": null
1014+ },
1015+ {
1016+ "kind": "OBJECT",
1017+ "name": "WorkflowDefinition",
1018+ "ofType": null
1019+ },
1020+ {
1021+ "kind": "OBJECT",
1022+ "name": "AiConversation",
1023+ "ofType": null
1024+ },
1025+ {
1026+ "kind": "OBJECT",
1027+ "name": "IssueRelation",
1028+ "ofType": null
1029+ },
1030+ {
1031+ "kind": "OBJECT",
1032+ "name": "IssueSuggestion",
1033+ "ofType": null
1034+ },
1035+ {
1036+ "kind": "OBJECT",
1037+ "name": "TriageResponsibility",
1038+ "ofType": null
1039+ },
1040+ {
1041+ "kind": "OBJECT",
1042+ "name": "TimeSchedule",
1043+ "ofType": null
1044+ },
1045+ {
1046+ "kind": "OBJECT",
1047+ "name": "TeamMembership",
1048+ "ofType": null
1049+ },
1050+ {
1051+ "kind": "OBJECT",
1052+ "name": "GitAutomationState",
1053+ "ofType": null
1054+ },
1055+ {
1056+ "kind": "OBJECT",
1057+ "name": "GitAutomationTargetBranch",
1058+ "ofType": null
1059+ },
1060+ {
1061+ "kind": "OBJECT",
1062+ "name": "Webhook",
1063+ "ofType": null
1064+ },
1065+ {
1066+ "kind": "OBJECT",
1067+ "name": "PaidSubscription",
1068+ "ofType": null
1069+ },
1070+ {
1071+ "kind": "OBJECT",
1072+ "name": "IdentityProvider",
1073+ "ofType": null
1074+ },
1075+ {
1076+ "kind": "OBJECT",
1077+ "name": "IssueDraft",
1078+ "ofType": null
1079+ },
1080+ {
1081+ "kind": "OBJECT",
1082+ "name": "Draft",
1083+ "ofType": null
1084+ },
1085+ {
1086+ "kind": "OBJECT",
1087+ "name": "CustomViewNotificationSubscription",
1088+ "ofType": null
1089+ },
1090+ {
1091+ "kind": "OBJECT",
1092+ "name": "CycleNotificationSubscription",
1093+ "ofType": null
1094+ },
1095+ {
1096+ "kind": "OBJECT",
1097+ "name": "LabelNotificationSubscription",
1098+ "ofType": null
1099+ },
1100+ {
1101+ "kind": "OBJECT",
1102+ "name": "ProjectNotificationSubscription",
1103+ "ofType": null
1104+ },
1105+ {
1106+ "kind": "OBJECT",
1107+ "name": "InitiativeNotificationSubscription",
1108+ "ofType": null
1109+ },
1110+ {
1111+ "kind": "OBJECT",
1112+ "name": "TeamNotificationSubscription",
1113+ "ofType": null
1114+ },
1115+ {
1116+ "kind": "OBJECT",
1117+ "name": "UserNotificationSubscription",
1118+ "ofType": null
1119+ },
1120+ {
1121+ "kind": "OBJECT",
1122+ "name": "IssueNotification",
1123+ "ofType": null
1124+ },
1125+ {
1126+ "kind": "OBJECT",
1127+ "name": "ProjectNotification",
1128+ "ofType": null
1129+ },
1130+ {
1131+ "kind": "OBJECT",
1132+ "name": "InitiativeNotification",
1133+ "ofType": null
1134+ },
1135+ {
1136+ "kind": "OBJECT",
1137+ "name": "OauthClientApprovalNotification",
1138+ "ofType": null
1139+ },
1140+ {
1141+ "kind": "OBJECT",
1142+ "name": "OauthClientApproval",
1143+ "ofType": null
1144+ },
1145+ {
1146+ "kind": "OBJECT",
1147+ "name": "DocumentNotification",
1148+ "ofType": null
1149+ },
1150+ {
1151+ "kind": "OBJECT",
1152+ "name": "PostNotification",
1153+ "ofType": null
1154+ },
1155+ {
1156+ "kind": "OBJECT",
1157+ "name": "CustomerNeedNotification",
1158+ "ofType": null
1159+ },
1160+ {
1161+ "kind": "OBJECT",
1162+ "name": "CustomerNotification",
1163+ "ofType": null
1164+ },
1165+ {
1166+ "kind": "OBJECT",
1167+ "name": "PullRequestNotification",
1168+ "ofType": null
1169+ },
1170+ {
1171+ "kind": "OBJECT",
1172+ "name": "WelcomeMessageNotification",
1173+ "ofType": null
1174+ },
1175+ {
1176+ "kind": "OBJECT",
1177+ "name": "UserSettings",
1178+ "ofType": null
1179+ },
1180+ {
1181+ "kind": "OBJECT",
1182+ "name": "SemanticSearchResult",
1183+ "ofType": null
1184+ },
1185+ {
1186+ "kind": "OBJECT",
1187+ "name": "DocumentSearchResult",
1188+ "ofType": null
1189+ },
1190+ {
1191+ "kind": "OBJECT",
1192+ "name": "ProjectSearchResult",
1193+ "ofType": null
1194+ },
1195+ {
1196+ "kind": "OBJECT",
1197+ "name": "IssueSearchResult",
1198+ "ofType": null
1199+ },
1200+ {
1201+ "kind": "OBJECT",
1202+ "name": "RoadmapToProject",
1203+ "ofType": null
1204+ },
1205+ {
1206+ "kind": "OBJECT",
1207+ "name": "Roadmap",
1208+ "ofType": null
1209+ },
1210+ {
1211+ "kind": "OBJECT",
1212+ "name": "OrganizationInvite",
1213+ "ofType": null
1214+ },
1215+ {
1216+ "kind": "OBJECT",
1217+ "name": "IssueToRelease",
1218+ "ofType": null
1219+ },
1220+ {
1221+ "kind": "OBJECT",
1222+ "name": "IntegrationTemplate",
1223+ "ofType": null
1224+ },
1225+ {
1226+ "kind": "OBJECT",
1227+ "name": "InitiativeRelation",
1228+ "ofType": null
1229+ },
1230+ {
1231+ "kind": "OBJECT",
1232+ "name": "Emoji",
1233+ "ofType": null
1234+ },
1235+ {
1236+ "kind": "OBJECT",
1237+ "name": "EmailIntakeAddress",
1238+ "ofType": null
1239+ },
1240+ {
1241+ "kind": "OBJECT",
1242+ "name": "SesDomainIdentity",
1243+ "ofType": null
1244+ },
1245+ {
1246+ "kind": "OBJECT",
1247+ "name": "AuditEntry",
1248+ "ofType": null
1249+ },
1250+ {
1251+ "kind": "OBJECT",
1252+ "name": "PushSubscription",
1253+ "ofType": null
1254+ },
1255+ {
1256+ "kind": "OBJECT",
1257+ "name": "OrganizationDomain",
1258+ "ofType": null
1259+ }
1260+ ]
1261+ },
1262+ {
1263+ "kind": "SCALAR",
1264+ "name": "ID",
1265+ "description": "The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `\"4\"`) or integer (such as `4`) input value will be accepted as an ID.",
1266+ "fields": null,
1267+ "inputFields": null,
1268+ "interfaces": null,
1269+ "enumValues": null,
1270+ "possibleTypes": null
1271+ },
1272+ {
1273+ "kind": "SCALAR",
1274+ "name": "DateTime",
1275+ "description": "Represents a date and time in ISO 8601 format. Accepts shortcuts like `2021` to represent midnight Fri Jan 01 2021. Also accepts ISO 8601 durations strings which are added to the current date to create the represented date (e.g '-P2W1D' represents the date that was two weeks and 1 day ago) ",
1276+ "fields": null,
1277+ "inputFields": null,
1278+ "interfaces": null,
1279+ "enumValues": null,
1280+ "possibleTypes": null
1281+ },
1282+ {
1283+ "kind": "OBJECT",
1284+ "name": "User",
1285+ "description": "A user that has access to the the resources of an organization.",
1286+ "fields": [
1287+ {
1288+ "name": "id",
1289+ "description": "The unique identifier of the entity.",
1290+ "args": [],
1291+ "type": {
1292+ "kind": "NON_NULL",
1293+ "name": null,
1294+ "ofType": {
1295+ "kind": "SCALAR",
1296+ "name": "ID",
1297+ "ofType": null
1298+ }
1299+ },
1300+ "isDeprecated": false,
1301+ "deprecationReason": null
1302+ },
1303+ {
1304+ "name": "createdAt",
1305+ "description": "The time at which the entity was created.",
1306+ "args": [],
1307+ "type": {
1308+ "kind": "NON_NULL",
1309+ "name": null,
1310+ "ofType": {
1311+ "kind": "SCALAR",
1312+ "name": "DateTime",
1313+ "ofType": null
1314+ }
1315+ },
1316+ "isDeprecated": false,
1317+ "deprecationReason": null
1318+ },
1319+ {
1320+ "name": "updatedAt",
1321+ "description": "The last time at which the entity was meaningfully updated. This is the same as the creation time if the entity hasn't\n been updated after creation.",
1322+ "args": [],
1323+ "type": {
1324+ "kind": "NON_NULL",
1325+ "name": null,
1326+ "ofType": {
1327+ "kind": "SCALAR",
1328+ "name": "DateTime",
1329+ "ofType": null
1330+ }
1331+ },
1332+ "isDeprecated": false,
1333+ "deprecationReason": null
1334+ },
1335+ {
1336+ "name": "archivedAt",
1337+ "description": "The time at which the entity was archived. Null if the entity has not been archived.",
1338+ "args": [],
1339+ "type": {
1340+ "kind": "SCALAR",
1341+ "name": "DateTime",
1342+ "ofType": null
1343+ },
1344+ "isDeprecated": false,
1345+ "deprecationReason": null
1346+ },
1347+ {
1348+ "name": "name",
1349+ "description": "The user's full name.",
1350+ "args": [],
1351+ "type": {
1352+ "kind": "NON_NULL",
1353+ "name": null,
1354+ "ofType": {
1355+ "kind": "SCALAR",
1356+ "name": "String",
1357+ "ofType": null
1358+ }
1359+ },
1360+ "isDeprecated": false,
1361+ "deprecationReason": null
1362+ },
1363+ {
1364+ "name": "displayName",
1365+ "description": "The user's display (nick) name. Unique within each organization.",
1366+ "args": [],
1367+ "type": {
1368+ "kind": "NON_NULL",
1369+ "name": null,
1370+ "ofType": {
1371+ "kind": "SCALAR",
1372+ "name": "String",
1373+ "ofType": null
1374+ }
1375+ },
1376+ "isDeprecated": false,
1377+ "deprecationReason": null
1378+ },
1379+ {
1380+ "name": "email",
1381+ "description": "The user's email address.",
1382+ "args": [],
1383+ "type": {
1384+ "kind": "NON_NULL",
1385+ "name": null,
1386+ "ofType": {
1387+ "kind": "SCALAR",
1388+ "name": "String",
1389+ "ofType": null
1390+ }
1391+ },
1392+ "isDeprecated": false,
1393+ "deprecationReason": null
1394+ },
1395+ {
1396+ "name": "avatarUrl",
1397+ "description": "An URL to the user's avatar image.",
1398+ "args": [],
1399+ "type": {
1400+ "kind": "SCALAR",
1401+ "name": "String",
1402+ "ofType": null
1403+ },
1404+ "isDeprecated": false,
1405+ "deprecationReason": null
1406+ },
1407+ {
1408+ "name": "disableReason",
1409+ "description": "Reason why is the account disabled.",
1410+ "args": [],
1411+ "type": {
1412+ "kind": "SCALAR",
1413+ "name": "String",
1414+ "ofType": null
1415+ },
1416+ "isDeprecated": false,
1417+ "deprecationReason": null
1418+ },
1419+ {
1420+ "name": "calendarHash",
1421+ "description": "[DEPRECATED] Hash for the user to be used in calendar URLs.",
1422+ "args": [],
1423+ "type": {
1424+ "kind": "SCALAR",
1425+ "name": "String",
1426+ "ofType": null
1427+ },
1428+ "isDeprecated": false,
1429+ "deprecationReason": null
1430+ },
1431+ {
1432+ "name": "description",
1433+ "description": "A short description of the user, either its title or bio.",
1434+ "args": [],
1435+ "type": {
1436+ "kind": "SCALAR",
1437+ "name": "String",
1438+ "ofType": null
1439+ },
1440+ "isDeprecated": false,
1441+ "deprecationReason": null
1442+ },
1443+ {
1444+ "name": "statusEmoji",
1445+ "description": "The emoji to represent the user current status.",
1446+ "args": [],
1447+ "type": {
1448+ "kind": "SCALAR",
1449+ "name": "String",
1450+ "ofType": null
1451+ },
1452+ "isDeprecated": false,
1453+ "deprecationReason": null
1454+ },
1455+ {
1456+ "name": "statusLabel",
1457+ "description": "The label of the user current status.",
1458+ "args": [],
1459+ "type": {
1460+ "kind": "SCALAR",
1461+ "name": "String",
1462+ "ofType": null
1463+ },
1464+ "isDeprecated": false,
1465+ "deprecationReason": null
1466+ },
1467+ {
1468+ "name": "statusUntilAt",
1469+ "description": "A date at which the user current status should be cleared.",
1470+ "args": [],
1471+ "type": {
1472+ "kind": "SCALAR",
1473+ "name": "DateTime",
1474+ "ofType": null
1475+ },
1476+ "isDeprecated": false,
1477+ "deprecationReason": null
1478+ },
1479+ {
1480+ "name": "timezone",
1481+ "description": "The local timezone of the user.",
1482+ "args": [],
1483+ "type": {
1484+ "kind": "SCALAR",
1485+ "name": "String",
1486+ "ofType": null
1487+ },
1488+ "isDeprecated": false,
1489+ "deprecationReason": null
1490+ },
1491+ {
1492+ "name": "organization",
1493+ "description": "Organization the user belongs to.",
1494+ "args": [],
1495+ "type": {
1496+ "kind": "NON_NULL",
1497+ "name": null,
1498+ "ofType": {
1499+ "kind": "OBJECT",
1500+ "name": "Organization",
1501+ "ofType": null
1502+ }
1503+ },
1504+ "isDeprecated": false,
1505+ "deprecationReason": null
1506+ },
1507+ {
1508+ "name": "lastSeen",
1509+ "description": "The last time the user was seen online.",
1510+ "args": [],
1511+ "type": {
1512+ "kind": "SCALAR",
1513+ "name": "DateTime",
1514+ "ofType": null
1515+ },
1516+ "isDeprecated": false,
1517+ "deprecationReason": null
1518+ },
1519+ {
1520+ "name": "identityProvider",
1521+ "description": "[INTERNAL] Identity provider the user is managed by.",
1522+ "args": [],
1523+ "type": {
1524+ "kind": "OBJECT",
1525+ "name": "IdentityProvider",
1526+ "ofType": null
1527+ },
1528+ "isDeprecated": false,
1529+ "deprecationReason": null
1530+ },
1531+ {
1532+ "name": "initials",
1533+ "description": "The initials of the user.",
1534+ "args": [],
1535+ "type": {
1536+ "kind": "NON_NULL",
1537+ "name": null,
1538+ "ofType": {
1539+ "kind": "SCALAR",
1540+ "name": "String",
1541+ "ofType": null
1542+ }
1543+ },
1544+ "isDeprecated": false,
1545+ "deprecationReason": null
1546+ },
1547+ {
1548+ "name": "avatarBackgroundColor",
1549+ "description": "The background color of the avatar for users without set avatar.",
1550+ "args": [],
1551+ "type": {
1552+ "kind": "NON_NULL",
1553+ "name": null,
1554+ "ofType": {
1555+ "kind": "SCALAR",
1556+ "name": "String",
1557+ "ofType": null
1558+ }
1559+ },
1560+ "isDeprecated": false,
1561+ "deprecationReason": null
1562+ },
1563+ {
1564+ "name": "guest",
1565+ "description": "Whether the user is a guest in the workspace and limited to accessing a subset of teams.",
1566+ "args": [],
1567+ "type": {
1568+ "kind": "NON_NULL",
1569+ "name": null,
1570+ "ofType": {
1571+ "kind": "SCALAR",
1572+ "name": "Boolean",
1573+ "ofType": null
1574+ }
1575+ },
1576+ "isDeprecated": false,
1577+ "deprecationReason": null
1578+ },
1579+ {
1580+ "name": "app",
1581+ "description": "Whether the user is an app.",
1582+ "args": [],
1583+ "type": {
1584+ "kind": "NON_NULL",
1585+ "name": null,
1586+ "ofType": {
1587+ "kind": "SCALAR",
1588+ "name": "Boolean",
1589+ "ofType": null
1590+ }
1591+ },
1592+ "isDeprecated": false,
1593+ "deprecationReason": null
1594+ },
1595+ {
1596+ "name": "isMentionable",
1597+ "description": "Whether the user is mentionable.",
1598+ "args": [],
1599+ "type": {
1600+ "kind": "NON_NULL",
1601+ "name": null,
1602+ "ofType": {
1603+ "kind": "SCALAR",
1604+ "name": "Boolean",
1605+ "ofType": null
1606+ }
1607+ },
1608+ "isDeprecated": false,
1609+ "deprecationReason": null
1610+ },
1611+ {
1612+ "name": "isAssignable",
1613+ "description": "Whether the user is assignable.",
1614+ "args": [],
1615+ "type": {
1616+ "kind": "NON_NULL",
1617+ "name": null,
1618+ "ofType": {
1619+ "kind": "SCALAR",
1620+ "name": "Boolean",
1621+ "ofType": null
1622+ }
1623+ },
1624+ "isDeprecated": false,
1625+ "deprecationReason": null
1626+ },
1627+ {
1628+ "name": "active",
1629+ "description": "Whether the user account is active or disabled (suspended).",
1630+ "args": [],
1631+ "type": {
1632+ "kind": "NON_NULL",
1633+ "name": null,
1634+ "ofType": {
1635+ "kind": "SCALAR",
1636+ "name": "Boolean",
1637+ "ofType": null
1638+ }
1639+ },
1640+ "isDeprecated": false,
1641+ "deprecationReason": null
1642+ },
1643+ {
1644+ "name": "issueDrafts",
1645+ "description": "The user's issue drafts",
1646+ "args": [
1647+ {
1648+ "name": "before",
1649+ "description": "A cursor to be used with last for backward pagination.",
1650+ "type": {
1651+ "kind": "SCALAR",
1652+ "name": "String",
1653+ "ofType": null
1654+ },
1655+ "defaultValue": null
1656+ },
1657+ {
1658+ "name": "after",
1659+ "description": "A cursor to be used with first for forward pagination",
1660+ "type": {
1661+ "kind": "SCALAR",
1662+ "name": "String",
1663+ "ofType": null
1664+ },
1665+ "defaultValue": null
1666+ },
1667+ {
1668+ "name": "first",
1669+ "description": "The number of items to forward paginate (used with after). Defaults to 50.",
1670+ "type": {
1671+ "kind": "SCALAR",
1672+ "name": "Int",
1673+ "ofType": null
1674+ },
1675+ "defaultValue": null
1676+ },
1677+ {
1678+ "name": "last",
1679+ "description": "The number of items to backward paginate (used with before). Defaults to 50.",
1680+ "type": {
1681+ "kind": "SCALAR",
1682+ "name": "Int",
1683+ "ofType": null
1684+ },
1685+ "defaultValue": null
1686+ },
1687+ {
1688+ "name": "includeArchived",
1689+ "description": "Should archived resources be included (default: false)",
1690+ "type": {
1691+ "kind": "SCALAR",
1692+ "name": "Boolean",
1693+ "ofType": null
1694+ },
1695+ "defaultValue": null
1696+ },
1697+ {
1698+ "name": "orderBy",
1699+ "description": "By which field should the pagination order by. Available options are createdAt (default) and updatedAt.",
1700+ "type": {
1701+ "kind": "ENUM",
1702+ "name": "PaginationOrderBy",
1703+ "ofType": null
1704+ },
1705+ "defaultValue": null
1706+ }
1707+ ],
1708+ "type": {
1709+ "kind": "NON_NULL",
1710+ "name": null,
1711+ "ofType": {
1712+ "kind": "OBJECT",
1713+ "name": "IssueDraftConnection",
1714+ "ofType": null
1715+ }
1716+ },
1717+ "isDeprecated": false,
1718+ "deprecationReason": null
1719+ },
1720+ {
1721+ "name": "drafts",
1722+ "description": "The user's drafts",
1723+ "args": [
1724+ {
1725+ "name": "before",
1726+ "description": "A cursor to be used with last for backward pagination.",
1727+ "type": {
1728+ "kind": "SCALAR",
1729+ "name": "String",
1730+ "ofType": null
1731+ },
1732+ "defaultValue": null
1733+ },
1734+ {
1735+ "name": "after",
1736+ "description": "A cursor to be used with first for forward pagination",
1737+ "type": {
1738+ "kind": "SCALAR",
1739+ "name": "String",
1740+ "ofType": null
1741+ },
1742+ "defaultValue": null
1743+ },
1744+ {
1745+ "name": "first",
1746+ "description": "The number of items to forward paginate (used with after). Defaults to 50.",
1747+ "type": {
1748+ "kind": "SCALAR",
1749+ "name": "Int",
1750+ "ofType": null
1751+ },
1752+ "defaultValue": null
1753+ },
1754+ {
1755+ "name": "last",
1756+ "description": "The number of items to backward paginate (used with before). Defaults to 50.",
1757+ "type": {
1758+ "kind": "SCALAR",
1759+ "name": "Int",
1760+ "ofType": null
1761+ },
1762+ "defaultValue": null
1763+ },
1764+ {
1765+ "name": "includeArchived",
1766+ "description": "Should archived resources be included (default: false)",
1767+ "type": {
1768+ "kind": "SCALAR",
1769+ "name": "Boolean",
1770+ "ofType": null
1771+ },
1772+ "defaultValue": null
1773+ },
1774+ {
1775+ "name": "orderBy",
1776+ "description": "By which field should the pagination order by. Available options are createdAt (default) and updatedAt.",
1777+ "type": {
1778+ "kind": "ENUM",
1779+ "name": "PaginationOrderBy",
1780+ "ofType": null
1781+ },
1782+ "defaultValue": null
1783+ }
1784+ ],
1785+ "type": {
1786+ "kind": "NON_NULL",
1787+ "name": null,
1788+ "ofType": {
1789+ "kind": "OBJECT",
1790+ "name": "DraftConnection",
1791+ "ofType": null
1792+ }
1793+ },
1794+ "isDeprecated": false,
1795+ "deprecationReason": null
1796+ },
1797+ {
1798+ "name": "url",
1799+ "description": "User's profile URL.",
1800+ "args": [],
1801+ "type": {
1802+ "kind": "NON_NULL",
1803+ "name": null,
1804+ "ofType": {
1805+ "kind": "SCALAR",
1806+ "name": "String",
1807+ "ofType": null
1808+ }
1809+ },
1810+ "isDeprecated": false,
1811+ "deprecationReason": null
1812+ },
1813+ {
1814+ "name": "assignedIssues",
1815+ "description": "Issues assigned to the user.",
1816+ "args": [
1817+ {
1818+ "name": "filter",
1819+ "description": "Filter returned issues.",
1820+ "type": {
1821+ "kind": "INPUT_OBJECT",
1822+ "name": "IssueFilter",
1823+ "ofType": null
1824+ },
1825+ "defaultValue": null
1826+ },
1827+ {
1828+ "name": "before",
1829+ "description": "A cursor to be used with last for backward pagination.",
1830+ "type": {
1831+ "kind": "SCALAR",
1832+ "name": "String",
1833+ "ofType": null
1834+ },
1835+ "defaultValue": null
1836+ },
1837+ {
1838+ "name": "after",
1839+ "description": "A cursor to be used with first for forward pagination",
1840+ "type": {
1841+ "kind": "SCALAR",
1842+ "name": "String",
1843+ "ofType": null
1844+ },
1845+ "defaultValue": null
1846+ },
1847+ {
1848+ "name": "first",
1849+ "description": "The number of items to forward paginate (used with after). Defaults to 50.",
1850+ "type": {
1851+ "kind": "SCALAR",
1852+ "name": "Int",
1853+ "ofType": null
1854+ },
1855+ "defaultValue": null
1856+ },
1857+ {
1858+ "name": "last",
1859+ "description": "The number of items to backward paginate (used with before). Defaults to 50.",
1860+ "type": {
1861+ "kind": "SCALAR",
1862+ "name": "Int",
1863+ "ofType": null
1864+ },
1865+ "defaultValue": null
1866+ },
1867+ {
1868+ "name": "includeArchived",
1869+ "description": "Should archived resources be included (default: false)",
1870+ "type": {
1871+ "kind": "SCALAR",
1872+ "name": "Boolean",
1873+ "ofType": null
1874+ },
1875+ "defaultValue": null
1876+ },
1877+ {
1878+ "name": "orderBy",
1879+ "description": "By which field should the pagination order by. Available options are createdAt (default) and updatedAt.",
1880+ "type": {
1881+ "kind": "ENUM",
1882+ "name": "PaginationOrderBy",
1883+ "ofType": null
1884+ },
1885+ "defaultValue": null
1886+ }
1887+ ],
1888+ "type": {
1889+ "kind": "NON_NULL",
1890+ "name": null,
1891+ "ofType": {
1892+ "kind": "OBJECT",
1893+ "name": "IssueConnection",
1894+ "ofType": null
1895+ }
1896+ },
1897+ "isDeprecated": false,
1898+ "deprecationReason": null
1899+ },
1900+ {
1901+ "name": "delegatedIssues",
1902+ "description": "Issues delegated to this user.",
1903+ "args": [
1904+ {
1905+ "name": "filter",
1906+ "description": "Filter returned issues.",
1907+ "type": {
1908+ "kind": "INPUT_OBJECT",
1909+ "name": "IssueFilter",
1910+ "ofType": null
1911+ },
1912+ "defaultValue": null
1913+ },
1914+ {
1915+ "name": "before",
1916+ "description": "A cursor to be used with last for backward pagination.",
1917+ "type": {
1918+ "kind": "SCALAR",
1919+ "name": "String",
1920+ "ofType": null
1921+ },
1922+ "defaultValue": null
1923+ },
1924+ {
1925+ "name": "after",
1926+ "description": "A cursor to be used with first for forward pagination",
1927+ "type": {
1928+ "kind": "SCALAR",
1929+ "name": "String",
1930+ "ofType": null
1931+ },
1932+ "defaultValue": null
1933+ },
1934+ {
1935+ "name": "first",
1936+ "description": "The number of items to forward paginate (used with after). Defaults to 50.",
1937+ "type": {
1938+ "kind": "SCALAR",
1939+ "name": "Int",
1940+ "ofType": null
1941+ },
1942+ "defaultValue": null
1943+ },
1944+ {
1945+ "name": "last",
1946+ "description": "The number of items to backward paginate (used with before). Defaults to 50.",
1947+ "type": {
1948+ "kind": "SCALAR",
1949+ "name": "Int",
1950+ "ofType": null
1951+ },
1952+ "defaultValue": null
1953+ },
1954+ {
1955+ "name": "includeArchived",
1956+ "description": "Should archived resources be included (default: false)",
1957+ "type": {
1958+ "kind": "SCALAR",
1959+ "name": "Boolean",
1960+ "ofType": null
1961+ },
1962+ "defaultValue": null
1963+ },
1964+ {
1965+ "name": "orderBy",
1966+ "description": "By which field should the pagination order by. Available options are createdAt (default) and updatedAt.",
1967+ "type": {
1968+ "kind": "ENUM",
1969+ "name": "PaginationOrderBy",
1970+ "ofType": null
1971+ },
1972+ "defaultValue": null
1973+ }
1974+ ],
1975+ "type": {
1976+ "kind": "NON_NULL",
1977+ "name": null,
1978+ "ofType": {
1979+ "kind": "OBJECT",
1980+ "name": "IssueConnection",
1981+ "ofType": null
1982+ }
1983+ },
1984+ "isDeprecated": false,
1985+ "deprecationReason": null
1986+ },
1987+ {
1988+ "name": "createdIssues",
1989+ "description": "Issues created by the user.",
1990+ "args": [
1991+ {
1992+ "name": "filter",
1993+ "description": "Filter returned issues.",
1994+ "type": {
1995+ "kind": "INPUT_OBJECT",
1996+ "name": "IssueFilter",
1997+ "ofType": null
1998+ },
1999+ "defaultValue": null
2000+ },
2001+ {
2002+ "name": "before",
2003+ "description": "A cursor to be used with last for backward pagination.",
2004+ "type": {
2005+ "kind": "SCALAR",
2006+ "name": "String",
2007+ "ofType": null
2008+ },
2009+ "defaultValue": null
2010+ },
2011+ {
2012+ "name": "after",
2013+ "description": "A cursor to be used with first for forward pagination",
2014+ "type": {
2015+ "kind": "SCALAR",
2016+ "name": "String",
2017+ "ofType": null
2018+ },
2019+ "defaultValue": null
2020+ },
2021+ {
2022+ "name": "first",
2023+ "description": "The number of items to forward paginate (used with after). Defaults to 50.",
2024+ "type": {
2025+ "kind": "SCALAR",
2026+ "name": "Int",
2027+ "ofType": null
2028+ },
2029+ "defaultValue": null
2030+ },
2031+ {
2032+ "name": "last",
2033+ "description": "The number of items to backward paginate (used with before). Defaults to 50.",
2034+ "type": {
2035+ "kind": "SCALAR",
2036+ "name": "Int",
2037+ "ofType": null
2038+ },
2039+ "defaultValue": null
2040+ },
2041+ {
2042+ "name": "includeArchived",
2043+ "description": "Should archived resources be included (default: false)",
2044+ "type": {
2045+ "kind": "SCALAR",
2046+ "name": "Boolean",
2047+ "ofType": null
2048+ },
2049+ "defaultValue": null
2050+ },
2051+ {
2052+ "name": "orderBy",
2053+ "description": "By which field should the pagination order by. Available options are createdAt (default) and updatedAt.",
2054+ "type": {
2055+ "kind": "ENUM",
2056+ "name": "PaginationOrderBy",
2057+ "ofType": null
2058+ },
2059+ "defaultValue": null
2060+ }
2061+ ],
2062+ "type": {
2063+ "kind": "NON_NULL",
2064+ "name": null,
2065+ "ofType": {
2066+ "kind": "OBJECT",
2067+ "name": "IssueConnection",
2068+ "ofType": null
2069+ }
2070+ },
2071+ "isDeprecated": false,
2072+ "deprecationReason": null
2073+ },
2074+ {
2075+ "name": "createdIssueCount",
2076+ "description": "Number of issues created.",
2077+ "args": [],
2078+ "type": {
2079+ "kind": "NON_NULL",
2080+ "name": null,
2081+ "ofType": {
2082+ "kind": "SCALAR",
2083+ "name": "Int",
2084+ "ofType": null
2085+ }
2086+ },
2087+ "isDeprecated": false,
2088+ "deprecationReason": null
2089+ },
2090+ {
2091+ "name": "teams",
2092+ "description": "Teams the user is part of.",
2093+ "args": [
2094+ {
2095+ "name": "filter",
2096+ "description": "Filter returned teams.",
2097+ "type": {
2098+ "kind": "INPUT_OBJECT",
2099+ "name": "TeamFilter",
2100+ "ofType": null
2101+ },
2102+ "defaultValue": null
2103+ },
2104+ {
2105+ "name": "before",
2106+ "description": "A cursor to be used with last for backward pagination.",
2107+ "type": {
2108+ "kind": "SCALAR",
2109+ "name": "String",
2110+ "ofType": null
2111+ },
2112+ "defaultValue": null
2113+ },
2114+ {
2115+ "name": "after",
2116+ "description": "A cursor to be used with first for forward pagination",
2117+ "type": {
2118+ "kind": "SCALAR",
2119+ "name": "String",
2120+ "ofType": null
2121+ },
2122+ "defaultValue": null
2123+ },
2124+ {
2125+ "name": "first",
2126+ "description": "The number of items to forward paginate (used with after). Defaults to 50.",
2127+ "type": {
2128+ "kind": "SCALAR",
2129+ "name": "Int",
2130+ "ofType": null
2131+ },
2132+ "defaultValue": null
2133+ },
2134+ {
2135+ "name": "last",
2136+ "description": "The number of items to backward paginate (used with before). Defaults to 50.",
2137+ "type": {
2138+ "kind": "SCALAR",
2139+ "name": "Int",
2140+ "ofType": null
2141+ },
2142+ "defaultValue": null
2143+ },
2144+ {
2145+ "name": "includeArchived",
2146+ "description": "Should archived resources be included (default: false)",
2147+ "type": {
2148+ "kind": "SCALAR",
2149+ "name": "Boolean",
2150+ "ofType": null
2151+ },
2152+ "defaultValue": null
2153+ },
2154+ {
2155+ "name": "orderBy",
2156+ "description": "By which field should the pagination order by. Available options are createdAt (default) and updatedAt.",
2157+ "type": {
2158+ "kind": "ENUM",
2159+ "name": "PaginationOrderBy",
2160+ "ofType": null
2161+ },
2162+ "defaultValue": null
2163+ }
2164+ ],
2165+ "type": {
2166+ "kind": "NON_NULL",
2167+ "name": null,
2168+ "ofType": {
2169+ "kind": "OBJECT",
2170+ "name": "TeamConnection",
2171+ "ofType": null
2172+ }
2173+ },
2174+ "isDeprecated": false,
2175+ "deprecationReason": null
2176+ },
2177+ {
2178+ "name": "teamMemberships",
2179+ "description": "Memberships associated with the user. For easier access of the same data, use `teams` query.",
2180+ "args": [
2181+ {
2182+ "name": "before",
2183+ "description": "A cursor to be used with last for backward pagination.",
2184+ "type": {
2185+ "kind": "SCALAR",
2186+ "name": "String",
2187+ "ofType": null
2188+ },
2189+ "defaultValue": null
2190+ },
2191+ {
2192+ "name": "after",
2193+ "description": "A cursor to be used with first for forward pagination",
2194+ "type": {
2195+ "kind": "SCALAR",
2196+ "name": "String",
2197+ "ofType": null
2198+ },
2199+ "defaultValue": null
2200+ },
2201+ {
2202+ "name": "first",
2203+ "description": "The number of items to forward paginate (used with after). Defaults to 50.",
2204+ "type": {
2205+ "kind": "SCALAR",
2206+ "name": "Int",
2207+ "ofType": null
2208+ },
2209+ "defaultValue": null
2210+ },
2211+ {
2212+ "name": "last",
2213+ "description": "The number of items to backward paginate (used with before). Defaults to 50.",
2214+ "type": {
2215+ "kind": "SCALAR",
2216+ "name": "Int",
2217+ "ofType": null
2218+ },
2219+ "defaultValue": null
2220+ },
2221+ {
2222+ "name": "includeArchived",
2223+ "description": "Should archived resources be included (default: false)",
2224+ "type": {
2225+ "kind": "SCALAR",
2226+ "name": "Boolean",
2227+ "ofType": null
2228+ },
2229+ "defaultValue": null
2230+ },
2231+ {
2232+ "name": "orderBy",
2233+ "description": "By which field should the pagination order by. Available options are createdAt (default) and updatedAt.",
2234+ "type": {
2235+ "kind": "ENUM",
2236+ "name": "PaginationOrderBy",
2237+ "ofType": null
2238+ },
2239+ "defaultValue": null
2240+ }
2241+ ],
2242+ "type": {
2243+ "kind": "NON_NULL",
2244+ "name": null,
2245+ "ofType": {
2246+ "kind": "OBJECT",
2247+ "name": "TeamMembershipConnection",
2248+ "ofType": null
2249+ }
2250+ },
2251+ "isDeprecated": false,
2252+ "deprecationReason": null
2253+ },
2254+ {
2255+ "name": "feedFacets",
2256+ "description": "[INTERNAL] The user's pinned feeds.",
2257+ "args": [
2258+ {
2259+ "name": "before",
2260+ "description": "A cursor to be used with last for backward pagination.",
2261+ "type": {
2262+ "kind": "SCALAR",
2263+ "name": "String",
2264+ "ofType": null
2265+ },
2266+ "defaultValue": null
2267+ },
2268+ {
2269+ "name": "after",
2270+ "description": "A cursor to be used with first for forward pagination",
2271+ "type": {
2272+ "kind": "SCALAR",
2273+ "name": "String",
2274+ "ofType": null
2275+ },
2276+ "defaultValue": null
2277+ },
2278+ {
2279+ "name": "first",
2280+ "description": "The number of items to forward paginate (used with after). Defaults to 50.",
2281+ "type": {
2282+ "kind": "SCALAR",
2283+ "name": "Int",
2284+ "ofType": null
2285+ },
2286+ "defaultValue": null
2287+ },
2288+ {
2289+ "name": "last",
2290+ "description": "The number of items to backward paginate (used with before). Defaults to 50.",
2291+ "type": {
2292+ "kind": "SCALAR",
2293+ "name": "Int",
2294+ "ofType": null
2295+ },
2296+ "defaultValue": null
2297+ },
2298+ {
2299+ "name": "includeArchived",
2300+ "description": "Should archived resources be included (default: false)",
2301+ "type": {
2302+ "kind": "SCALAR",
2303+ "name": "Boolean",
2304+ "ofType": null
2305+ },
2306+ "defaultValue": null
2307+ },
2308+ {
2309+ "name": "orderBy",
2310+ "description": "By which field should the pagination order by. Available options are createdAt (default) and updatedAt.",
2311+ "type": {
2312+ "kind": "ENUM",
2313+ "name": "PaginationOrderBy",
2314+ "ofType": null
2315+ },
2316+ "defaultValue": null
2317+ }
2318+ ],
2319+ "type": {
2320+ "kind": "NON_NULL",
2321+ "name": null,
2322+ "ofType": {
2323+ "kind": "OBJECT",
2324+ "name": "FacetConnection",
2325+ "ofType": null
2326+ }
2327+ },
2328+ "isDeprecated": false,
2329+ "deprecationReason": null
2330+ },
2331+ {
2332+ "name": "canAccessAnyPublicTeam",
2333+ "description": "Whether this user can access any public team in the organization.",
2334+ "args": [],
2335+ "type": {
2336+ "kind": "NON_NULL",
2337+ "name": null,
2338+ "ofType": {
2339+ "kind": "SCALAR",
2340+ "name": "Boolean",
2341+ "ofType": null
2342+ }
2343+ },
2344+ "isDeprecated": false,
2345+ "deprecationReason": null
2346+ },
2347+ {
2348+ "name": "isMe",
2349+ "description": "Whether the user is the currently authenticated user.",
2350+ "args": [],
2351+ "type": {
2352+ "kind": "NON_NULL",
2353+ "name": null,
2354+ "ofType": {
2355+ "kind": "SCALAR",
2356+ "name": "Boolean",
2357+ "ofType": null
2358+ }
2359+ },
2360+ "isDeprecated": false,
2361+ "deprecationReason": null
2362+ },
2363+ {
2364+ "name": "admin",
2365+ "description": "Whether the user is an organization administrator.",
2366+ "args": [],
2367+ "type": {
2368+ "kind": "NON_NULL",
2369+ "name": null,
2370+ "ofType": {
2371+ "kind": "SCALAR",
2372+ "name": "Boolean",
2373+ "ofType": null
2374+ }
2375+ },
2376+ "isDeprecated": false,
2377+ "deprecationReason": null
2378+ },
2379+ {
2380+ "name": "owner",
2381+ "description": "Whether the user is an organization owner.",
2382+ "args": [],
2383+ "type": {
2384+ "kind": "NON_NULL",
2385+ "name": null,
2386+ "ofType": {
2387+ "kind": "SCALAR",
2388+ "name": "Boolean",
2389+ "ofType": null
2390+ }
2391+ },
2392+ "isDeprecated": false,
2393+ "deprecationReason": null
2394+ },
2395+ {
2396+ "name": "supportsAgentSessions",
2397+ "description": "Whether this agent user supports agent sessions.",
2398+ "args": [],
2399+ "type": {
2400+ "kind": "NON_NULL",
2401+ "name": null,
2402+ "ofType": {
2403+ "kind": "SCALAR",
2404+ "name": "Boolean",
2405+ "ofType": null
2406+ }
2407+ },
2408+ "isDeprecated": false,
2409+ "deprecationReason": null
2410+ },
2411+ {
2412+ "name": "inviteHash",
2413+ "description": "[DEPRECATED] Unique hash for the user to be used in invite URLs.",
2414+ "args": [],
2415+ "type": {
2416+ "kind": "NON_NULL",
2417+ "name": null,
2418+ "ofType": {
2419+ "kind": "SCALAR",
2420+ "name": "String",
2421+ "ofType": null
2422+ }
2423+ },
2424+ "isDeprecated": true,
2425+ "deprecationReason": "This hash is not in use anymore, this value will always be empty."
2426+ },
2427+ {
2428+ "name": "gitHubUserId",
2429+ "description": "The user's GitHub user ID.",
2430+ "args": [],
2431+ "type": {
2432+ "kind": "SCALAR",
2433+ "name": "String",
2434+ "ofType": null
2435+ },
2436+ "isDeprecated": false,
2437+ "deprecationReason": null
2438+ }
2439+ ],
2440+ "inputFields": null,
2441+ "interfaces": [
2442+ {
2443+ "kind": "INTERFACE",
2444+ "name": "Node",
2445+ "ofType": null
2446+ }
2447+ ],
2448+ "enumValues": null,
2449+ "possibleTypes": null
2450+ },
2451+ {
2452+ "kind": "SCALAR",
2453+ "name": "String",
2454+ "description": "The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.",
2455+ "fields": null,
2456+ "inputFields": null,
2457+ "interfaces": null,
2458+ "enumValues": null,
2459+ "possibleTypes": null
2460+ },
2461+ {
2462+ "kind": "OBJECT",
2463+ "name": "Organization",
2464+ "description": "An organization. Organizations are root-level objects that contain user accounts and teams.",
2465+ "fields": [
2466+ {
2467+ "name": "id",
2468+ "description": "The unique identifier of the entity.",
2469+ "args": [],
2470+ "type": {
2471+ "kind": "NON_NULL",
2472+ "name": null,
2473+ "ofType": {
2474+ "kind": "SCALAR",
2475+ "name": "ID",
2476+ "ofType": null
2477+ }
2478+ },
2479+ "isDeprecated": false,
2480+ "deprecationReason": null
2481+ },
2482+ {
2483+ "name": "createdAt",
2484+ "description": "The time at which the entity was created.",
2485+ "args": [],
2486+ "type": {
2487+ "kind": "NON_NULL",
2488+ "name": null,
2489+ "ofType": {
2490+ "kind": "SCALAR",
2491+ "name": "DateTime",
2492+ "ofType": null
2493+ }
2494+ },
2495+ "isDeprecated": false,
2496+ "deprecationReason": null
2497+ },
2498+ {
2499+ "name": "updatedAt",
2500+ "description": "The last time at which the entity was meaningfully updated. This is the same as the creation time if the entity hasn't\n been updated after creation.",
2501+ "args": [],
2502+ "type": {
2503+ "kind": "NON_NULL",
2504+ "name": null,
2505+ "ofType": {
2506+ "kind": "SCALAR",
2507+ "name": "DateTime",
2508+ "ofType": null
2509+ }
2510+ },
2511+ "isDeprecated": false,
2512+ "deprecationReason": null
2513+ },
2514+ {
2515+ "name": "archivedAt",
2516+ "description": "The time at which the entity was archived. Null if the entity has not been archived.",
2517+ "args": [],
2518+ "type": {
2519+ "kind": "SCALAR",
2520+ "name": "DateTime",
2521+ "ofType": null
2522+ },
2523+ "isDeprecated": false,
2524+ "deprecationReason": null
2525+ },
2526+ {
2527+ "name": "name",
2528+ "description": "The organization's name.",
2529+ "args": [],
2530+ "type": {
2531+ "kind": "NON_NULL",
2532+ "name": null,
2533+ "ofType": {
2534+ "kind": "SCALAR",
2535+ "name": "String",
2536+ "ofType": null
2537+ }
2538+ },
2539+ "isDeprecated": false,
2540+ "deprecationReason": null
2541+ },
2542+ {
2543+ "name": "urlKey",
2544+ "description": "The organization's unique URL key.",
2545+ "args": [],
2546+ "type": {
2547+ "kind": "NON_NULL",
2548+ "name": null,
2549+ "ofType": {
2550+ "kind": "SCALAR",
2551+ "name": "String",
2552+ "ofType": null
2553+ }
2554+ },
2555+ "isDeprecated": false,
2556+ "deprecationReason": null
2557+ },
2558+ {
2559+ "name": "logoUrl",
2560+ "description": "The organization's logo URL.",
2561+ "args": [],
2562+ "type": {
2563+ "kind": "SCALAR",
2564+ "name": "String",
2565+ "ofType": null
2566+ },
2567+ "isDeprecated": false,
2568+ "deprecationReason": null
2569+ },
2570+ {
2571+ "name": "periodUploadVolume",
2572+ "description": "Rolling 30-day total upload volume for the organization, in megabytes.",
2573+ "args": [],
2574+ "type": {
2575+ "kind": "NON_NULL",
2576+ "name": null,
2577+ "ofType": {
2578+ "kind": "SCALAR",
2579+ "name": "Float",
2580+ "ofType": null
2581+ }
2582+ },
2583+ "isDeprecated": false,
2584+ "deprecationReason": null
2585+ },
2586+ {
2587+ "name": "facets",
2588+ "description": "[Internal] Facets associated with the organization.",
2589+ "args": [],
2590+ "type": {
2591+ "kind": "NON_NULL",
2592+ "name": null,
2593+ "ofType": {
2594+ "kind": "LIST",
2595+ "name": null,
2596+ "ofType": {
2597+ "kind": "NON_NULL",
2598+ "name": null,
2599+ "ofType": {
2600+ "kind": "OBJECT",
2601+ "name": "Facet",
2602+ "ofType": null
2603+ }
2604+ }
2605+ }
2606+ },
2607+ "isDeprecated": false,
2608+ "deprecationReason": null
2609+ },
2610+ {
2611+ "name": "gitBranchFormat",
2612+ "description": "How git branches are formatted. If null, default formatting will be used.",
2613+ "args": [],
2614+ "type": {
2615+ "kind": "SCALAR",
2616+ "name": "String",
2617+ "ofType": null
2618+ },
2619+ "isDeprecated": false,
2620+ "deprecationReason": null
2621+ },
2622+ {
2623+ "name": "gitLinkbackMessagesEnabled",
2624+ "description": "Whether the Git integration linkback messages should be sent to private repositories.",
2625+ "args": [],
2626+ "type": {
2627+ "kind": "NON_NULL",
2628+ "name": null,
2629+ "ofType": {
2630+ "kind": "SCALAR",
2631+ "name": "Boolean",
2632+ "ofType": null
2633+ }
2634+ },
2635+ "isDeprecated": false,
2636+ "deprecationReason": null
2637+ },
2638+ {
2639+ "name": "gitPublicLinkbackMessagesEnabled",
2640+ "description": "Whether the Git integration linkback messages should be sent to public repositories.",
2641+ "args": [],
2642+ "type": {
2643+ "kind": "NON_NULL",
2644+ "name": null,
2645+ "ofType": {
2646+ "kind": "SCALAR",
2647+ "name": "Boolean",
2648+ "ofType": null
2649+ }
2650+ },
2651+ "isDeprecated": false,
2652+ "deprecationReason": null
2653+ },
2654+ {
2655+ "name": "gitLinkbackDescriptionsEnabled",
2656+ "description": "Whether issue descriptions should be included in Git integration linkback messages.",
2657+ "args": [],
2658+ "type": {
2659+ "kind": "NON_NULL",
2660+ "name": null,
2661+ "ofType": {
2662+ "kind": "SCALAR",
2663+ "name": "Boolean",
2664+ "ofType": null
2665+ }
2666+ },
2667+ "isDeprecated": false,
2668+ "deprecationReason": null
2669+ },
2670+ {
2671+ "name": "roadmapEnabled",
2672+ "description": "Whether the organization is using a roadmap.",
2673+ "args": [],
2674+ "type": {
2675+ "kind": "NON_NULL",
2676+ "name": null,
2677+ "ofType": {
2678+ "kind": "SCALAR",
2679+ "name": "Boolean",
2680+ "ofType": null
2681+ }
2682+ },
2683+ "isDeprecated": false,
2684+ "deprecationReason": null
2685+ },
2686+ {
2687+ "name": "projectUpdateReminderFrequencyInWeeks",
2688+ "description": "The n-weekly frequency at which to prompt for project updates. When not set, reminders are off.",
2689+ "args": [],
2690+ "type": {
2691+ "kind": "SCALAR",
2692+ "name": "Float",
2693+ "ofType": null
2694+ },
2695+ "isDeprecated": false,
2696+ "deprecationReason": null
2697+ },
2698+ {
2699+ "name": "projectUpdateRemindersDay",
2700+ "description": "The day at which to prompt for project updates.",
2701+ "args": [],
2702+ "type": {
2703+ "kind": "NON_NULL",
2704+ "name": null,
2705+ "ofType": {
2706+ "kind": "ENUM",
2707+ "name": "Day",
2708+ "ofType": null
2709+ }
2710+ },
2711+ "isDeprecated": false,
2712+ "deprecationReason": null
2713+ },
2714+ {
2715+ "name": "projectUpdateRemindersHour",
2716+ "description": "The hour at which to prompt for project updates.",
2717+ "args": [],
2718+ "type": {
2719+ "kind": "NON_NULL",
2720+ "name": null,
2721+ "ofType": {
2722+ "kind": "SCALAR",
2723+ "name": "Float",
2724+ "ofType": null
2725+ }
2726+ },
2727+ "isDeprecated": false,
2728+ "deprecationReason": null
2729+ },
2730+ {
2731+ "name": "initiativeUpdateReminderFrequencyInWeeks",
2732+ "description": "The n-weekly frequency at which to prompt for initiative updates. When not set, reminders are off.",
2733+ "args": [],
2734+ "type": {
2735+ "kind": "SCALAR",
2736+ "name": "Float",
2737+ "ofType": null
2738+ },
2739+ "isDeprecated": false,
2740+ "deprecationReason": null
2741+ },
2742+ {
2743+ "name": "initiativeUpdateRemindersDay",
2744+ "description": "The day at which to prompt for initiative updates.",
2745+ "args": [],
2746+ "type": {
2747+ "kind": "NON_NULL",
2748+ "name": null,
2749+ "ofType": {
2750+ "kind": "ENUM",
2751+ "name": "Day",
2752+ "ofType": null
2753+ }
2754+ },
2755+ "isDeprecated": false,
2756+ "deprecationReason": null
2757+ },
2758+ {
2759+ "name": "initiativeUpdateRemindersHour",
2760+ "description": "The hour at which to prompt for initiative updates.",
2761+ "args": [],
2762+ "type": {
2763+ "kind": "NON_NULL",
2764+ "name": null,
2765+ "ofType": {
2766+ "kind": "SCALAR",
2767+ "name": "Float",
2768+ "ofType": null
2769+ }
2770+ },
2771+ "isDeprecated": false,
2772+ "deprecationReason": null
2773+ },
2774+ {
2775+ "name": "fiscalYearStartMonth",
2776+ "description": "The month at which the fiscal year starts. Defaults to January (0).",
2777+ "args": [],
2778+ "type": {
2779+ "kind": "NON_NULL",
2780+ "name": null,
2781+ "ofType": {
2782+ "kind": "SCALAR",
2783+ "name": "Float",
2784+ "ofType": null
2785+ }
2786+ },
2787+ "isDeprecated": false,
2788+ "deprecationReason": null
2789+ },
2790+ {
2791+ "name": "workingDays",
2792+ "description": "[Internal] The list of working days. Sunday is 0, Monday is 1, etc.",
2793+ "args": [],
2794+ "type": {
2795+ "kind": "NON_NULL",
2796+ "name": null,
2797+ "ofType": {
2798+ "kind": "LIST",
2799+ "name": null,
2800+ "ofType": {
2801+ "kind": "NON_NULL",
2802+ "name": null,
2803+ "ofType": {
2804+ "kind": "SCALAR",
2805+ "name": "Float",
2806+ "ofType": null
2807+ }
2808+ }
2809+ }
2810+ },
2811+ "isDeprecated": false,
2812+ "deprecationReason": null
2813+ },
2814+ {
2815+ "name": "samlEnabled",
2816+ "description": "Whether SAML authentication is enabled for organization.",
2817+ "args": [],
2818+ "type": {
2819+ "kind": "NON_NULL",
2820+ "name": null,
2821+ "ofType": {
2822+ "kind": "SCALAR",
2823+ "name": "Boolean",
2824+ "ofType": null
2825+ }
2826+ },
2827+ "isDeprecated": false,
2828+ "deprecationReason": null
2829+ },
2830+ {
2831+ "name": "samlSettings",
2832+ "description": "[INTERNAL] SAML settings.",
2833+ "args": [],
2834+ "type": {
2835+ "kind": "SCALAR",
2836+ "name": "JSONObject",
2837+ "ofType": null
2838+ },
2839+ "isDeprecated": false,
2840+ "deprecationReason": null
2841+ },
2842+ {
2843+ "name": "scimEnabled",
2844+ "description": "Whether SCIM provisioning is enabled for organization.",
2845+ "args": [],
2846+ "type": {
2847+ "kind": "NON_NULL",
2848+ "name": null,
2849+ "ofType": {
2850+ "kind": "SCALAR",
2851+ "name": "Boolean",
2852+ "ofType": null
2853+ }
2854+ },
2855+ "isDeprecated": false,
2856+ "deprecationReason": null
2857+ },
2858+ {
2859+ "name": "scimSettings",
2860+ "description": "[INTERNAL] SCIM settings.",
2861+ "args": [],
2862+ "type": {
2863+ "kind": "SCALAR",
2864+ "name": "JSONObject",
2865+ "ofType": null
2866+ },
2867+ "isDeprecated": false,
2868+ "deprecationReason": null
2869+ },
2870+ {
2871+ "name": "securitySettings",
2872+ "description": "Security settings for the organization.",
2873+ "args": [],
2874+ "type": {
2875+ "kind": "NON_NULL",
2876+ "name": null,
2877+ "ofType": {
2878+ "kind": "SCALAR",
2879+ "name": "JSONObject",
2880+ "ofType": null
2881+ }
2882+ },
2883+ "isDeprecated": false,
2884+ "deprecationReason": null
2885+ },
2886+ {
2887+ "name": "authSettings",
2888+ "description": "Authentication settings for the organization.",
2889+ "args": [],
2890+ "type": {
2891+ "kind": "NON_NULL",
2892+ "name": null,
2893+ "ofType": {
2894+ "kind": "SCALAR",
2895+ "name": "JSONObject",
2896+ "ofType": null
2897+ }
2898+ },
2899+ "isDeprecated": false,
2900+ "deprecationReason": null
2901+ },
2902+ {
2903+ "name": "allowedAuthServices",
2904+ "description": "Allowed authentication providers, empty array means all are allowed.",
2905+ "args": [],
2906+ "type": {
2907+ "kind": "NON_NULL",
2908+ "name": null,
2909+ "ofType": {
2910+ "kind": "LIST",
2911+ "name": null,
2912+ "ofType": {
2913+ "kind": "NON_NULL",
2914+ "name": null,
2915+ "ofType": {
2916+ "kind": "SCALAR",
2917+ "name": "String",
2918+ "ofType": null
2919+ }
2920+ }
2921+ }
2922+ },
2923+ "isDeprecated": true,
2924+ "deprecationReason": "Use authSettings.allowedAuthServices instead."
2925+ },
2926+ {
2927+ "name": "allowedFileUploadContentTypes",
2928+ "description": "Allowed file upload content types",
2929+ "args": [],
2930+ "type": {
2931+ "kind": "LIST",
2932+ "name": null,
2933+ "ofType": {
2934+ "kind": "NON_NULL",
2935+ "name": null,
2936+ "ofType": {
2937+ "kind": "SCALAR",
2938+ "name": "String",
2939+ "ofType": null
2940+ }
2941+ }
2942+ },
2943+ "isDeprecated": false,
2944+ "deprecationReason": null
2945+ },
2946+ {
2947+ "name": "ipRestrictions",
2948+ "description": "IP restriction configurations.",
2949+ "args": [],
2950+ "type": {
2951+ "kind": "LIST",
2952+ "name": null,
2953+ "ofType": {
2954+ "kind": "NON_NULL",
2955+ "name": null,
2956+ "ofType": {
2957+ "kind": "OBJECT",
2958+ "name": "OrganizationIpRestriction",
2959+ "ofType": null
2960+ }
2961+ }
2962+ },
2963+ "isDeprecated": false,
2964+ "deprecationReason": null
2965+ },
2966+ {
2967+ "name": "deletionRequestedAt",
2968+ "description": "The time at which deletion of the organization was requested.",
2969+ "args": [],
2970+ "type": {
2971+ "kind": "SCALAR",
2972+ "name": "DateTime",
2973+ "ofType": null
2974+ },
2975+ "isDeprecated": false,
2976+ "deprecationReason": null
2977+ },
2978+ {
2979+ "name": "trialEndsAt",
2980+ "description": "The time at which the trial will end.",
2981+ "args": [],
2982+ "type": {
2983+ "kind": "SCALAR",
2984+ "name": "DateTime",
2985+ "ofType": null
2986+ },
2987+ "isDeprecated": false,
2988+ "deprecationReason": null
2989+ },
2990+ {
2991+ "name": "trialStartsAt",
2992+ "description": "The time at which the trial started.",
2993+ "args": [],
2994+ "type": {
2995+ "kind": "SCALAR",
2996+ "name": "DateTime",
2997+ "ofType": null
2998+ },
2999+ "isDeprecated": false,
3000+ "deprecationReason": null
3001+ },
3002+ {
3003+ "name": "previousUrlKeys",
3004+ "description": "Previously used URL keys for the organization (last 3 are kept and redirected).",
3005+ "args": [],
3006+ "type": {
3007+ "kind": "NON_NULL",
3008+ "name": null,
3009+ "ofType": {
3010+ "kind": "LIST",
3011+ "name": null,
3012+ "ofType": {
3013+ "kind": "NON_NULL",
3014+ "name": null,
3015+ "ofType": {
3016+ "kind": "SCALAR",
3017+ "name": "String",
3018+ "ofType": null
3019+ }
3020+ }
3021+ }
3022+ },
3023+ "isDeprecated": false,
3024+ "deprecationReason": null
3025+ },
3026+ {
3027+ "name": "restrictAgentInvocationToMembers",
3028+ "description": "[Internal] Whether agent invocation is restricted to full workspace members.",
3029+ "args": [],
3030+ "type": {
3031+ "kind": "SCALAR",
3032+ "name": "Boolean",
3033+ "ofType": null
3034+ },
3035+ "isDeprecated": false,
3036+ "deprecationReason": null
3037+ },
3038+ {
3039+ "name": "hipaaComplianceEnabled",
3040+ "description": "Whether HIPAA compliance is enabled for organization.",
3041+ "args": [],
3042+ "type": {
3043+ "kind": "NON_NULL",
3044+ "name": null,
3045+ "ofType": {
3046+ "kind": "SCALAR",
3047+ "name": "Boolean",
3048+ "ofType": null
3049+ }
3050+ },
3051+ "isDeprecated": false,
3052+ "deprecationReason": null
3053+ },
3054+ {
3055+ "name": "themeSettings",
3056+ "description": "[ALPHA] Theme settings for the organization.",
3057+ "args": [],
3058+ "type": {
3059+ "kind": "SCALAR",
3060+ "name": "JSONObject",
3061+ "ofType": null
3062+ },
3063+ "isDeprecated": false,
3064+ "deprecationReason": null
3065+ },
3066+ {
3067+ "name": "releaseChannel",
3068+ "description": "The feature release channel the organization belongs to.",
3069+ "args": [],
3070+ "type": {
3071+ "kind": "NON_NULL",
3072+ "name": null,
3073+ "ofType": {
3074+ "kind": "ENUM",
3075+ "name": "ReleaseChannel",
3076+ "ofType": null
3077+ }
3078+ },
3079+ "isDeprecated": false,
3080+ "deprecationReason": null
3081+ },
3082+ {
3083+ "name": "customersConfiguration",
3084+ "description": "Configuration settings for the Customers feature.",
3085+ "args": [],
3086+ "type": {
3087+ "kind": "NON_NULL",
3088+ "name": null,
3089+ "ofType": {
3090+ "kind": "SCALAR",
3091+ "name": "JSONObject",
3092+ "ofType": null
3093+ }
3094+ },
3095+ "isDeprecated": false,
3096+ "deprecationReason": null
3097+ },
3098+ {
3099+ "name": "codeIntelligenceEnabled",
3100+ "description": "[INTERNAL] Whether code intelligence is enabled for the organization.",
3101+ "args": [],
3102+ "type": {
3103+ "kind": "NON_NULL",
3104+ "name": null,
3105+ "ofType": {
3106+ "kind": "SCALAR",
3107+ "name": "Boolean",
3108+ "ofType": null
3109+ }
3110+ },
3111+ "isDeprecated": false,
3112+ "deprecationReason": null
3113+ },
3114+ {
3115+ "name": "codeIntelligenceRepository",
3116+ "description": "[INTERNAL] GitHub repository in owner/repo format for code intelligence.",
3117+ "args": [],
3118+ "type": {
3119+ "kind": "SCALAR",
3120+ "name": "String",
3121+ "ofType": null
3122+ },
3123+ "isDeprecated": false,
3124+ "deprecationReason": null
3125+ },
3126+ {
3127+ "name": "defaultFeedSummarySchedule",
3128+ "description": "Default schedule for how often feed summaries are generated.",
3129+ "args": [],
3130+ "type": {
3131+ "kind": "ENUM",
3132+ "name": "FeedSummarySchedule",
3133+ "ofType": null
3134+ },
3135+ "isDeprecated": false,
3136+ "deprecationReason": null
3137+ },
3138+ {
3139+ "name": "feedEnabled",
3140+ "description": "Whether the organization has enabled the feed feature.",
3141+ "args": [],
3142+ "type": {
3143+ "kind": "NON_NULL",
3144+ "name": null,
3145+ "ofType": {
3146+ "kind": "SCALAR",
3147+ "name": "Boolean",
3148+ "ofType": null
3149+ }
3150+ },
3151+ "isDeprecated": false,
3152+ "deprecationReason": null
3153+ },
3154+ {
3155+ "name": "hideNonPrimaryOrganizations",
3156+ "description": "Whether to hide other organizations for new users signing up with email domains claimed by this organization.",
3157+ "args": [],
3158+ "type": {
3159+ "kind": "NON_NULL",
3160+ "name": null,
3161+ "ofType": {
3162+ "kind": "SCALAR",
3163+ "name": "Boolean",
3164+ "ofType": null
3165+ }
3166+ },
3167+ "isDeprecated": true,
3168+ "deprecationReason": "Use authSettings.hideNonPrimaryOrganizations instead."
3169+ },
3170+ {
3171+ "name": "aiAddonEnabled",
3172+ "description": "[INTERNAL] Whether the organization has enabled the AI add-on (which at this point only includes triage suggestions).",
3173+ "args": [],
3174+ "type": {
3175+ "kind": "NON_NULL",
3176+ "name": null,
3177+ "ofType": {
3178+ "kind": "SCALAR",
3179+ "name": "Boolean",
3180+ "ofType": null
3181+ }
3182+ },
3183+ "isDeprecated": false,
3184+ "deprecationReason": null
3185+ },
3186+ {
3187+ "name": "generatedUpdatesEnabled",
3188+ "description": "[INTERNAL] Whether the organization has enabled generated updates.",
3189+ "args": [],
3190+ "type": {
3191+ "kind": "NON_NULL",
3192+ "name": null,
3193+ "ofType": {
3194+ "kind": "SCALAR",
3195+ "name": "Boolean",
3196+ "ofType": null
3197+ }
3198+ },
3199+ "isDeprecated": false,
3200+ "deprecationReason": null
3201+ },
3202+ {
3203+ "name": "aiThreadSummariesEnabled",
3204+ "description": "Whether the organization has enabled resolved thread AI summaries.",
3205+ "args": [],
3206+ "type": {
3207+ "kind": "NON_NULL",
3208+ "name": null,
3209+ "ofType": {
3210+ "kind": "SCALAR",
3211+ "name": "Boolean",
3212+ "ofType": null
3213+ }
3214+ },
3215+ "isDeprecated": false,
3216+ "deprecationReason": null
3217+ },
3218+ {
3219+ "name": "aiDiscussionSummariesEnabled",
3220+ "description": "Whether the organization has enabled AI discussion summaries for issues.",
3221+ "args": [],
3222+ "type": {
3223+ "kind": "NON_NULL",
3224+ "name": null,
3225+ "ofType": {
3226+ "kind": "SCALAR",
3227+ "name": "Boolean",
3228+ "ofType": null
3229+ }
3230+ },
3231+ "isDeprecated": false,
3232+ "deprecationReason": null
3233+ },
3234+ {
3235+ "name": "aiProviderConfiguration",
3236+ "description": "[INTERNAL] Configure per-modality AI host providers and model families.",
3237+ "args": [],
3238+ "type": {
3239+ "kind": "SCALAR",
3240+ "name": "JSONObject",
3241+ "ofType": null
3242+ },
3243+ "isDeprecated": false,
3244+ "deprecationReason": null
3245+ },
3246+ {
3247+ "name": "linearAgentEnabled",
3248+ "description": "[Internal] Whether the organization has enabled Linear Agent.",
3249+ "args": [],
3250+ "type": {
3251+ "kind": "NON_NULL",
3252+ "name": null,
3253+ "ofType": {
3254+ "kind": "SCALAR",
3255+ "name": "Boolean",
3256+ "ofType": null
3257+ }
3258+ },
3259+ "isDeprecated": false,
3260+ "deprecationReason": null
3261+ },
3262+ {
3263+ "name": "slaDayCount",
3264+ "description": "[DEPRECATED] Which day count to use for SLA calculations.",
3265+ "args": [],
3266+ "type": {
3267+ "kind": "NON_NULL",
3268+ "name": null,
3269+ "ofType": {
3270+ "kind": "ENUM",
3271+ "name": "SLADayCountType",
3272+ "ofType": null
3273+ }
3274+ },
3275+ "isDeprecated": true,
3276+ "deprecationReason": "No longer in use"
3277+ },
3278+ {
3279+ "name": "projectUpdatesReminderFrequency",
3280+ "description": "[DEPRECATED] The frequency at which to prompt for project updates.",
3281+ "args": [],
3282+ "type": {
3283+ "kind": "NON_NULL",
3284+ "name": null,
3285+ "ofType": {
3286+ "kind": "ENUM",
3287+ "name": "ProjectUpdateReminderFrequency",
3288+ "ofType": null
3289+ }
3290+ },
3291+ "isDeprecated": true,
3292+ "deprecationReason": "Use organization.projectUpdatesReminderFrequencyInWeeks instead"
3293+ },
3294+ {
3295+ "name": "allowedAiProviders",
3296+ "description": "[INTERNAL] Permitted AI providers.",
3297+ "args": [],
3298+ "type": {
3299+ "kind": "NON_NULL",
3300+ "name": null,
3301+ "ofType": {
3302+ "kind": "LIST",
3303+ "name": null,
3304+ "ofType": {
3305+ "kind": "NON_NULL",
3306+ "name": null,
3307+ "ofType": {
3308+ "kind": "SCALAR",
3309+ "name": "String",
3310+ "ofType": null
3311+ }
3312+ }
3313+ }
3314+ },
3315+ "isDeprecated": true,
3316+ "deprecationReason": "Use aiProviderConfiguration instead."
3317+ },
3318+ {
3319+ "name": "users",
3320+ "description": "Users associated with the organization.",
3321+ "args": [
3322+ {
3323+ "name": "includeDisabled",
3324+ "description": "Should query return disabled/suspended users (default: false).",
3325+ "type": {
3326+ "kind": "SCALAR",
3327+ "name": "Boolean",
3328+ "ofType": null
3329+ },
3330+ "defaultValue": null
3331+ },
3332+ {
3333+ "name": "before",
3334+ "description": "A cursor to be used with last for backward pagination.",
3335+ "type": {
3336+ "kind": "SCALAR",
3337+ "name": "String",
3338+ "ofType": null
3339+ },
3340+ "defaultValue": null
3341+ },
3342+ {
3343+ "name": "after",
3344+ "description": "A cursor to be used with first for forward pagination",
3345+ "type": {
3346+ "kind": "SCALAR",
3347+ "name": "String",
3348+ "ofType": null
3349+ },
3350+ "defaultValue": null
3351+ },
3352+ {
3353+ "name": "first",
3354+ "description": "The number of items to forward paginate (used with after). Defaults to 50.",
3355+ "type": {
3356+ "kind": "SCALAR",
3357+ "name": "Int",
3358+ "ofType": null
3359+ },
3360+ "defaultValue": null
3361+ },
3362+ {
3363+ "name": "last",
3364+ "description": "The number of items to backward paginate (used with before). Defaults to 50.",
3365+ "type": {
3366+ "kind": "SCALAR",
3367+ "name": "Int",
3368+ "ofType": null
3369+ },
3370+ "defaultValue": null
3371+ },
3372+ {
3373+ "name": "includeArchived",
3374+ "description": "Should archived resources be included (default: false)",
3375+ "type": {
3376+ "kind": "SCALAR",
3377+ "name": "Boolean",
3378+ "ofType": null
3379+ },
3380+ "defaultValue": null
3381+ },
3382+ {
3383+ "name": "orderBy",
3384+ "description": "By which field should the pagination order by. Available options are createdAt (default) and updatedAt.",
3385+ "type": {
3386+ "kind": "ENUM",
3387+ "name": "PaginationOrderBy",
3388+ "ofType": null
3389+ },
3390+ "defaultValue": null
3391+ }
3392+ ],
3393+ "type": {
3394+ "kind": "NON_NULL",
3395+ "name": null,
3396+ "ofType": {
3397+ "kind": "OBJECT",
3398+ "name": "UserConnection",
3399+ "ofType": null
3400+ }
3401+ },
3402+ "isDeprecated": false,
3403+ "deprecationReason": null
3404+ },
3405+ {
3406+ "name": "teams",
3407+ "description": "Teams associated with the organization.",
3408+ "args": [
3409+ {
3410+ "name": "filter",
3411+ "description": "Filter returned teams.",
3412+ "type": {
3413+ "kind": "INPUT_OBJECT",
3414+ "name": "TeamFilter",
3415+ "ofType": null
3416+ },
3417+ "defaultValue": null
3418+ },
3419+ {
3420+ "name": "before",
3421+ "description": "A cursor to be used with last for backward pagination.",
3422+ "type": {
3423+ "kind": "SCALAR",
3424+ "name": "String",
3425+ "ofType": null
3426+ },
3427+ "defaultValue": null
3428+ },
3429+ {
3430+ "name": "after",
3431+ "description": "A cursor to be used with first for forward pagination",
3432+ "type": {
3433+ "kind": "SCALAR",
3434+ "name": "String",
3435+ "ofType": null
3436+ },
3437+ "defaultValue": null
3438+ },
3439+ {
3440+ "name": "first",
3441+ "description": "The number of items to forward paginate (used with after). Defaults to 50.",
3442+ "type": {
3443+ "kind": "SCALAR",
3444+ "name": "Int",
3445+ "ofType": null
3446+ },
3447+ "defaultValue": null
3448+ },
3449+ {
3450+ "name": "last",
3451+ "description": "The number of items to backward paginate (used with before). Defaults to 50.",
3452+ "type": {
3453+ "kind": "SCALAR",
3454+ "name": "Int",
3455+ "ofType": null
3456+ },
3457+ "defaultValue": null
3458+ },
3459+ {
3460+ "name": "includeArchived",
3461+ "description": "Should archived resources be included (default: false)",
3462+ "type": {
3463+ "kind": "SCALAR",
3464+ "name": "Boolean",
3465+ "ofType": null
3466+ },
3467+ "defaultValue": null
3468+ },
3469+ {
3470+ "name": "orderBy",
3471+ "description": "By which field should the pagination order by. Available options are createdAt (default) and updatedAt.",
3472+ "type": {
3473+ "kind": "ENUM",
3474+ "name": "PaginationOrderBy",
3475+ "ofType": null
3476+ },
3477+ "defaultValue": null
3478+ }
3479+ ],
3480+ "type": {
3481+ "kind": "NON_NULL",
3482+ "name": null,
3483+ "ofType": {
3484+ "kind": "OBJECT",
3485+ "name": "TeamConnection",
3486+ "ofType": null
3487+ }
3488+ },
3489+ "isDeprecated": false,
3490+ "deprecationReason": null
3491+ },
3492+ {
3493+ "name": "projectStatuses",
3494+ "description": "The organization's project statuses.",
3495+ "args": [],
3496+ "type": {
3497+ "kind": "NON_NULL",
3498+ "name": null,
3499+ "ofType": {
3500+ "kind": "LIST",
3501+ "name": null,
3502+ "ofType": {
3503+ "kind": "NON_NULL",
3504+ "name": null,
3505+ "ofType": {
3506+ "kind": "OBJECT",
3507+ "name": "ProjectStatus",
3508+ "ofType": null
3509+ }
3510+ }
3511+ }
3512+ },
3513+ "isDeprecated": false,
3514+ "deprecationReason": null
3515+ },
3516+ {
3517+ "name": "integrations",
3518+ "description": "Integrations associated with the organization.",
3519+ "args": [
3520+ {
3521+ "name": "before",
3522+ "description": "A cursor to be used with last for backward pagination.",
3523+ "type": {
3524+ "kind": "SCALAR",
3525+ "name": "String",
3526+ "ofType": null
3527+ },
3528+ "defaultValue": null
3529+ },
3530+ {
3531+ "name": "after",
3532+ "description": "A cursor to be used with first for forward pagination",
3533+ "type": {
3534+ "kind": "SCALAR",
3535+ "name": "String",
3536+ "ofType": null
3537+ },
3538+ "defaultValue": null
3539+ },
3540+ {
3541+ "name": "first",
3542+ "description": "The number of items to forward paginate (used with after). Defaults to 50.",
3543+ "type": {
3544+ "kind": "SCALAR",
3545+ "name": "Int",
3546+ "ofType": null
3547+ },
3548+ "defaultValue": null
3549+ },
3550+ {
3551+ "name": "last",
3552+ "description": "The number of items to backward paginate (used with before). Defaults to 50.",
3553+ "type": {
3554+ "kind": "SCALAR",
3555+ "name": "Int",
3556+ "ofType": null
3557+ },
3558+ "defaultValue": null
3559+ },
3560+ {
3561+ "name": "includeArchived",
3562+ "description": "Should archived resources be included (default: false)",
3563+ "type": {
3564+ "kind": "SCALAR",
3565+ "name": "Boolean",
3566+ "ofType": null
3567+ },
3568+ "defaultValue": null
3569+ },
3570+ {
3571+ "name": "orderBy",
3572+ "description": "By which field should the pagination order by. Available options are createdAt (default) and updatedAt.",
3573+ "type": {
3574+ "kind": "ENUM",
3575+ "name": "PaginationOrderBy",
3576+ "ofType": null
3577+ },
3578+ "defaultValue": null
3579+ }
3580+ ],
3581+ "type": {
3582+ "kind": "NON_NULL",
3583+ "name": null,
3584+ "ofType": {
3585+ "kind": "OBJECT",
3586+ "name": "IntegrationConnection",
3587+ "ofType": null
3588+ }
3589+ },
3590+ "isDeprecated": false,
3591+ "deprecationReason": null
3592+ },
3593+ {
3594+ "name": "slackProjectChannelIntegration",
3595+ "description": "The Slack integration used for auto-creating project channels.",
3596+ "args": [],
3597+ "type": {
3598+ "kind": "OBJECT",
3599+ "name": "Integration",
3600+ "ofType": null
3601+ },
3602+ "isDeprecated": false,
3603+ "deprecationReason": null
3604+ },
3605+ {
3606+ "name": "slackProjectChannelPrefix",
3607+ "description": "The prefix used for auto-created Slack project channels.",
3608+ "args": [],
3609+ "type": {
3610+ "kind": "NON_NULL",
3611+ "name": null,
3612+ "ofType": {
3613+ "kind": "SCALAR",
3614+ "name": "String",
3615+ "ofType": null
3616+ }
3617+ },
3618+ "isDeprecated": false,
3619+ "deprecationReason": null
3620+ },
3621+ {
3622+ "name": "subscription",
3623+ "description": "The organization's subscription to a paid plan.",
3624+ "args": [],
3625+ "type": {
3626+ "kind": "OBJECT",
3627+ "name": "PaidSubscription",
3628+ "ofType": null
3629+ },
3630+ "isDeprecated": false,
3631+ "deprecationReason": null
3632+ },
3633+ {
3634+ "name": "userCount",
3635+ "description": "Number of active users in the organization.",
3636+ "args": [],
3637+ "type": {
3638+ "kind": "NON_NULL",
3639+ "name": null,
3640+ "ofType": {
3641+ "kind": "SCALAR",
3642+ "name": "Int",
3643+ "ofType": null
3644+ }
3645+ },
3646+ "isDeprecated": false,
3647+ "deprecationReason": null
3648+ },
3649+ {
3650+ "name": "createdIssueCount",
3651+ "description": "Aproximate number of issues in the organization, including archived ones.",
3652+ "args": [],
3653+ "type": {
3654+ "kind": "NON_NULL",
3655+ "name": null,
3656+ "ofType": {
3657+ "kind": "SCALAR",
3658+ "name": "Int",
3659+ "ofType": null
3660+ }
3661+ },
3662+ "isDeprecated": false,
3663+ "deprecationReason": null
3664+ },
3665+ {
3666+ "name": "templates",
3667+ "description": "Templates associated with the organization.",
3668+ "args": [
3669+ {
3670+ "name": "filter",
3671+ "description": "Filter returned templates.",
3672+ "type": {
3673+ "kind": "INPUT_OBJECT",
3674+ "name": "NullableTemplateFilter",
3675+ "ofType": null
3676+ },
3677+ "defaultValue": null
3678+ },
3679+ {
3680+ "name": "before",
3681+ "description": "A cursor to be used with last for backward pagination.",
3682+ "type": {
3683+ "kind": "SCALAR",
3684+ "name": "String",
3685+ "ofType": null
3686+ },
3687+ "defaultValue": null
3688+ },
3689+ {
3690+ "name": "after",
3691+ "description": "A cursor to be used with first for forward pagination",
3692+ "type": {
3693+ "kind": "SCALAR",
3694+ "name": "String",
3695+ "ofType": null
3696+ },
3697+ "defaultValue": null
3698+ },
3699+ {
3700+ "name": "first",
3701+ "description": "The number of items to forward paginate (used with after). Defaults to 50.",
3702+ "type": {
3703+ "kind": "SCALAR",
3704+ "name": "Int",
3705+ "ofType": null
3706+ },
3707+ "defaultValue": null
3708+ },
3709+ {
3710+ "name": "last",
3711+ "description": "The number of items to backward paginate (used with before). Defaults to 50.",
3712+ "type": {
3713+ "kind": "SCALAR",
3714+ "name": "Int",
3715+ "ofType": null
3716+ },
3717+ "defaultValue": null
3718+ },
3719+ {
3720+ "name": "includeArchived",
3721+ "description": "Should archived resources be included (default: false)",
3722+ "type": {
3723+ "kind": "SCALAR",
3724+ "name": "Boolean",
3725+ "ofType": null
3726+ },
3727+ "defaultValue": null
3728+ },
3729+ {
3730+ "name": "orderBy",
3731+ "description": "By which field should the pagination order by. Available options are createdAt (default) and updatedAt.",
3732+ "type": {
3733+ "kind": "ENUM",
3734+ "name": "PaginationOrderBy",
3735+ "ofType": null
3736+ },
3737+ "defaultValue": null
3738+ }
3739+ ],
3740+ "type": {
3741+ "kind": "NON_NULL",
3742+ "name": null,
3743+ "ofType": {
3744+ "kind": "OBJECT",
3745+ "name": "TemplateConnection",
3746+ "ofType": null
3747+ }
3748+ },
3749+ "isDeprecated": false,
3750+ "deprecationReason": null
3751+ },
3752+ {
3753+ "name": "labels",
3754+ "description": "Labels associated with the organization.",
3755+ "args": [
3756+ {
3757+ "name": "filter",
3758+ "description": "Filter returned issue labels.",
3759+ "type": {
3760+ "kind": "INPUT_OBJECT",
3761+ "name": "IssueLabelFilter",
3762+ "ofType": null
3763+ },
3764+ "defaultValue": null
3765+ },
3766+ {
3767+ "name": "before",
3768+ "description": "A cursor to be used with last for backward pagination.",
3769+ "type": {
3770+ "kind": "SCALAR",
3771+ "name": "String",
3772+ "ofType": null
3773+ },
3774+ "defaultValue": null
3775+ },
3776+ {
3777+ "name": "after",
3778+ "description": "A cursor to be used with first for forward pagination",
3779+ "type": {
3780+ "kind": "SCALAR",
3781+ "name": "String",
3782+ "ofType": null
3783+ },
3784+ "defaultValue": null
3785+ },
3786+ {
3787+ "name": "first",
3788+ "description": "The number of items to forward paginate (used with after). Defaults to 50.",
3789+ "type": {
3790+ "kind": "SCALAR",
3791+ "name": "Int",
3792+ "ofType": null
3793+ },
3794+ "defaultValue": null
3795+ },
3796+ {
3797+ "name": "last",
3798+ "description": "The number of items to backward paginate (used with before). Defaults to 50.",
3799+ "type": {
3800+ "kind": "SCALAR",
3801+ "name": "Int",
3802+ "ofType": null
3803+ },
3804+ "defaultValue": null
3805+ },
3806+ {
3807+ "name": "includeArchived",
3808+ "description": "Should archived resources be included (default: false)",
3809+ "type": {
3810+ "kind": "SCALAR",
3811+ "name": "Boolean",
3812+ "ofType": null
3813+ },
3814+ "defaultValue": null
3815+ },
3816+ {
3817+ "name": "orderBy",
3818+ "description": "By which field should the pagination order by. Available options are createdAt (default) and updatedAt.",
3819+ "type": {
3820+ "kind": "ENUM",
3821+ "name": "PaginationOrderBy",
3822+ "ofType": null
3823+ },
3824+ "defaultValue": null
3825+ }
3826+ ],
3827+ "type": {
3828+ "kind": "NON_NULL",
3829+ "name": null,
3830+ "ofType": {
3831+ "kind": "OBJECT",
3832+ "name": "IssueLabelConnection",
3833+ "ofType": null
3834+ }
3835+ },
3836+ "isDeprecated": false,
3837+ "deprecationReason": null
3838+ },
3839+ {
3840+ "name": "projectLabels",
3841+ "description": "Project labels associated with the organization.",
3842+ "args": [
3843+ {
3844+ "name": "filter",
3845+ "description": "Filter returned project labels.",
3846+ "type": {
3847+ "kind": "INPUT_OBJECT",
3848+ "name": "ProjectLabelFilter",
3849+ "ofType": null
3850+ },
3851+ "defaultValue": null
3852+ },
3853+ {
3854+ "name": "before",
3855+ "description": "A cursor to be used with last for backward pagination.",
3856+ "type": {
3857+ "kind": "SCALAR",
3858+ "name": "String",
3859+ "ofType": null
3860+ },
3861+ "defaultValue": null
3862+ },
3863+ {
3864+ "name": "after",
3865+ "description": "A cursor to be used with first for forward pagination",
3866+ "type": {
3867+ "kind": "SCALAR",
3868+ "name": "String",
3869+ "ofType": null
3870+ },
3871+ "defaultValue": null
3872+ },
3873+ {
3874+ "name": "first",
3875+ "description": "The number of items to forward paginate (used with after). Defaults to 50.",
3876+ "type": {
3877+ "kind": "SCALAR",
3878+ "name": "Int",
3879+ "ofType": null
3880+ },
3881+ "defaultValue": null
3882+ },
3883+ {
3884+ "name": "last",
3885+ "description": "The number of items to backward paginate (used with before). Defaults to 50.",
3886+ "type": {
3887+ "kind": "SCALAR",
3888+ "name": "Int",
3889+ "ofType": null
3890+ },
3891+ "defaultValue": null
3892+ },
3893+ {
3894+ "name": "includeArchived",
3895+ "description": "Should archived resources be included (default: false)",
3896+ "type": {
3897+ "kind": "SCALAR",
3898+ "name": "Boolean",
3899+ "ofType": null
3900+ },
3901+ "defaultValue": null
3902+ },
3903+ {
3904+ "name": "orderBy",
3905+ "description": "By which field should the pagination order by. Available options are createdAt (default) and updatedAt.",
3906+ "type": {
3907+ "kind": "ENUM",
3908+ "name": "PaginationOrderBy",
3909+ "ofType": null
3910+ },
3911+ "defaultValue": null
3912+ }
3913+ ],
3914+ "type": {
3915+ "kind": "NON_NULL",
3916+ "name": null,
3917+ "ofType": {
3918+ "kind": "OBJECT",
3919+ "name": "ProjectLabelConnection",
3920+ "ofType": null
3921+ }
3922+ },
3923+ "isDeprecated": false,
3924+ "deprecationReason": null
3925+ },
3926+ {
3927+ "name": "customerCount",
3928+ "description": "Number of customers in the organization.",
3929+ "args": [],
3930+ "type": {
3931+ "kind": "NON_NULL",
3932+ "name": null,
3933+ "ofType": {
3934+ "kind": "SCALAR",
3935+ "name": "Int",
3936+ "ofType": null
3937+ }
3938+ },
3939+ "isDeprecated": false,
3940+ "deprecationReason": null
3941+ },
3942+ {
3943+ "name": "customersEnabled",
3944+ "description": "Whether the organization is using Customers.",
3945+ "args": [],
3946+ "type": {
3947+ "kind": "NON_NULL",
3948+ "name": null,
3949+ "ofType": {
3950+ "kind": "SCALAR",
3951+ "name": "Boolean",
3952+ "ofType": null
3953+ }
3954+ },
3955+ "isDeprecated": false,
3956+ "deprecationReason": null
3957+ },
3958+ {
3959+ "name": "allowMembersToInvite",
3960+ "description": "[DEPRECATED] Whether member users are allowed to send invites.",
3961+ "args": [],
3962+ "type": {
3963+ "kind": "SCALAR",
3964+ "name": "Boolean",
3965+ "ofType": null
3966+ },
3967+ "isDeprecated": true,
3968+ "deprecationReason": "Use `securitySettings.invitationsRole` instead."
3969+ },
3970+ {
3971+ "name": "restrictTeamCreationToAdmins",
3972+ "description": "[DEPRECATED] Whether team creation is restricted to admins.",
3973+ "args": [],
3974+ "type": {
3975+ "kind": "SCALAR",
3976+ "name": "Boolean",
3977+ "ofType": null
3978+ },
3979+ "isDeprecated": true,
3980+ "deprecationReason": "Use `securitySettings.teamCreationRole` instead."
3981+ },
3982+ {
3983+ "name": "restrictLabelManagementToAdmins",
3984+ "description": "[DEPRECATED] Whether workspace label creation, update, and deletion is restricted to admins.",
3985+ "args": [],
3986+ "type": {
3987+ "kind": "SCALAR",
3988+ "name": "Boolean",
3989+ "ofType": null
3990+ },
3991+ "isDeprecated": true,
3992+ "deprecationReason": "Use `securitySettings.labelManagementRole` instead."
3993+ }
3994+ ],
3995+ "inputFields": null,
3996+ "interfaces": [
3997+ {
3998+ "kind": "INTERFACE",
3999+ "name": "Node",
4000+ "ofType": null
4001+ }
4002+ ],
4003+ "enumValues": null,
4004+ "possibleTypes": null
4005+ },
4006+ {
4007+ "kind": "SCALAR",
4008+ "name": "Float",
4009+ "description": "The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).",
4010+ "fields": null,
4011+ "inputFields": null,
4012+ "interfaces": null,
4013+ "enumValues": null,
4014+ "possibleTypes": null
4015+ },
4016+ {
4017+ "kind": "OBJECT",
4018+ "name": "Facet",
4019+ "description": "A facet. Facets are joins between entities. A facet can tie a custom view to a project, or a a project to a roadmap for example.",
4020+ "fields": [
4021+ {
4022+ "name": "id",
4023+ "description": "The unique identifier of the entity.",
4024+ "args": [],
4025+ "type": {
4026+ "kind": "NON_NULL",
4027+ "name": null,
4028+ "ofType": {
4029+ "kind": "SCALAR",
4030+ "name": "ID",
4031+ "ofType": null
4032+ }
4033+ },
4034+ "isDeprecated": false,
4035+ "deprecationReason": null
4036+ },
4037+ {
4038+ "name": "createdAt",
4039+ "description": "The time at which the entity was created.",
4040+ "args": [],
4041+ "type": {
4042+ "kind": "NON_NULL",
4043+ "name": null,
4044+ "ofType": {
4045+ "kind": "SCALAR",
4046+ "name": "DateTime",
4047+ "ofType": null
4048+ }
4049+ },
4050+ "isDeprecated": false,
4051+ "deprecationReason": null
4052+ },
4053+ {
4054+ "name": "updatedAt",
4055+ "description": "The last time at which the entity was meaningfully updated. This is the same as the creation time if the entity hasn't\n been updated after creation.",
4056+ "args": [],
4057+ "type": {
4058+ "kind": "NON_NULL",
4059+ "name": null,
4060+ "ofType": {
4061+ "kind": "SCALAR",
4062+ "name": "DateTime",
4063+ "ofType": null
4064+ }
4065+ },
4066+ "isDeprecated": false,
4067+ "deprecationReason": null
4068+ },
4069+ {
4070+ "name": "archivedAt",
4071+ "description": "The time at which the entity was archived. Null if the entity has not been archived.",
4072+ "args": [],
4073+ "type": {
4074+ "kind": "SCALAR",
4075+ "name": "DateTime",
4076+ "ofType": null
4077+ },
4078+ "isDeprecated": false,
4079+ "deprecationReason": null
4080+ },
4081+ {
4082+ "name": "sortOrder",
4083+ "description": "The sort order of the facet.",
4084+ "args": [],
4085+ "type": {
4086+ "kind": "NON_NULL",
4087+ "name": null,
4088+ "ofType": {
4089+ "kind": "SCALAR",
4090+ "name": "Float",
4091+ "ofType": null
4092+ }
4093+ },
4094+ "isDeprecated": false,
4095+ "deprecationReason": null
4096+ },
4097+ {
4098+ "name": "sourceOrganization",
4099+ "description": "The owning organization.",
4100+ "args": [],
4101+ "type": {
4102+ "kind": "OBJECT",
4103+ "name": "Organization",
4104+ "ofType": null
4105+ },
4106+ "isDeprecated": false,
4107+ "deprecationReason": null
4108+ },
4109+ {
4110+ "name": "sourceTeam",
4111+ "description": "The owning team.",
4112+ "args": [],
4113+ "type": {
4114+ "kind": "OBJECT",
4115+ "name": "Team",
4116+ "ofType": null
4117+ },
4118+ "isDeprecated": false,
4119+ "deprecationReason": null
4120+ },
4121+ {
4122+ "name": "sourceProject",
4123+ "description": "The owning project.",
4124+ "args": [],
4125+ "type": {
4126+ "kind": "OBJECT",
4127+ "name": "Project",
4128+ "ofType": null
4129+ },
4130+ "isDeprecated": false,
4131+ "deprecationReason": null
4132+ },
4133+ {
4134+ "name": "sourceInitiative",
4135+ "description": "The owning initiative.",
4136+ "args": [],
4137+ "type": {
4138+ "kind": "OBJECT",
4139+ "name": "Initiative",
4140+ "ofType": null
4141+ },
4142+ "isDeprecated": false,
4143+ "deprecationReason": null
4144+ },
4145+ {
4146+ "name": "sourceFeedUser",
4147+ "description": "The owning feed user.",
4148+ "args": [],
4149+ "type": {
4150+ "kind": "OBJECT",
4151+ "name": "User",
4152+ "ofType": null
4153+ },
4154+ "isDeprecated": false,
4155+ "deprecationReason": null
4156+ },
4157+ {
4158+ "name": "sourcePage",
4159+ "description": "The owning page.",
4160+ "args": [],
4161+ "type": {
4162+ "kind": "ENUM",
4163+ "name": "FacetPageSource",
4164+ "ofType": null
4165+ },
4166+ "isDeprecated": false,
4167+ "deprecationReason": null
4168+ },
4169+ {
4170+ "name": "targetCustomView",
4171+ "description": "The targeted custom view.",
4172+ "args": [],
4173+ "type": {
4174+ "kind": "OBJECT",
4175+ "name": "CustomView",
4176+ "ofType": null
4177+ },
4178+ "isDeprecated": false,
4179+ "deprecationReason": null
4180+ }
4181+ ],
4182+ "inputFields": null,
4183+ "interfaces": [
4184+ {
4185+ "kind": "INTERFACE",
4186+ "name": "Node",
4187+ "ofType": null
4188+ }
4189+ ],
4190+ "enumValues": null,
4191+ "possibleTypes": null
4192+ },
4193+ {
4194+ "kind": "OBJECT",
4195+ "name": "Team",
4196+ "description": "An organizational unit that contains issues.",
4197+ "fields": [
4198+ {
4199+ "name": "id",
4200+ "description": "The unique identifier of the entity.",
4201+ "args": [],
4202+ "type": {
4203+ "kind": "NON_NULL",
4204+ "name": null,
4205+ "ofType": {
4206+ "kind": "SCALAR",
4207+ "name": "ID",
4208+ "ofType": null
4209+ }
4210+ },
4211+ "isDeprecated": false,
4212+ "deprecationReason": null
4213+ },
4214+ {
4215+ "name": "createdAt",
4216+ "description": "The time at which the entity was created.",
4217+ "args": [],
4218+ "type": {
4219+ "kind": "NON_NULL",
4220+ "name": null,
4221+ "ofType": {
4222+ "kind": "SCALAR",
4223+ "name": "DateTime",
4224+ "ofType": null
4225+ }
4226+ },
4227+ "isDeprecated": false,
4228+ "deprecationReason": null
4229+ },
4230+ {
4231+ "name": "updatedAt",
4232+ "description": "The last time at which the entity was meaningfully updated. This is the same as the creation time if the entity hasn't\n been updated after creation.",
4233+ "args": [],
4234+ "type": {
4235+ "kind": "NON_NULL",
4236+ "name": null,
4237+ "ofType": {
4238+ "kind": "SCALAR",
4239+ "name": "DateTime",
4240+ "ofType": null
4241+ }
4242+ },
4243+ "isDeprecated": false,
4244+ "deprecationReason": null
4245+ },
4246+ {
4247+ "name": "archivedAt",
4248+ "description": "The time at which the entity was archived. Null if the entity has not been archived.",
4249+ "args": [],
4250+ "type": {
4251+ "kind": "SCALAR",
4252+ "name": "DateTime",
4253+ "ofType": null
4254+ },
4255+ "isDeprecated": false,
4256+ "deprecationReason": null
4257+ },
4258+ {
4259+ "name": "name",
4260+ "description": "The team's name.",
4261+ "args": [],
4262+ "type": {
4263+ "kind": "NON_NULL",
4264+ "name": null,
4265+ "ofType": {
4266+ "kind": "SCALAR",
4267+ "name": "String",
4268+ "ofType": null
4269+ }
4270+ },
4271+ "isDeprecated": false,
4272+ "deprecationReason": null
4273+ },
4274+ {
4275+ "name": "key",
4276+ "description": "The team's unique key. The key is used in URLs.",
4277+ "args": [],
4278+ "type": {
4279+ "kind": "NON_NULL",
4280+ "name": null,
4281+ "ofType": {
4282+ "kind": "SCALAR",
4283+ "name": "String",
4284+ "ofType": null
4285+ }
4286+ },
4287+ "isDeprecated": false,
4288+ "deprecationReason": null
4289+ },
4290+ {
4291+ "name": "description",
4292+ "description": "The team's description.",
4293+ "args": [],
4294+ "type": {
4295+ "kind": "SCALAR",
4296+ "name": "String",
4297+ "ofType": null
4298+ },
4299+ "isDeprecated": false,
4300+ "deprecationReason": null
4301+ },
4302+ {
4303+ "name": "icon",
4304+ "description": "The icon of the team.",
4305+ "args": [],
4306+ "type": {
4307+ "kind": "SCALAR",
4308+ "name": "String",
4309+ "ofType": null
4310+ },
4311+ "isDeprecated": false,
4312+ "deprecationReason": null
4313+ },
4314+ {
4315+ "name": "color",
4316+ "description": "The team's color.",
4317+ "args": [],
4318+ "type": {
4319+ "kind": "SCALAR",
4320+ "name": "String",
4321+ "ofType": null
4322+ },
4323+ "isDeprecated": false,
4324+ "deprecationReason": null
4325+ },
4326+ {
4327+ "name": "retiredAt",
4328+ "description": "The time at which the team was retired. Null if the team has not been retired.",
4329+ "args": [],
4330+ "type": {
4331+ "kind": "SCALAR",
4332+ "name": "DateTime",
4333+ "ofType": null
4334+ },
4335+ "isDeprecated": false,
4336+ "deprecationReason": null
4337+ },
4338+ {
4339+ "name": "organization",
4340+ "description": "The organization that the team is associated with.",
4341+ "args": [],
4342+ "type": {
4343+ "kind": "NON_NULL",
4344+ "name": null,
4345+ "ofType": {
4346+ "kind": "OBJECT",
4347+ "name": "Organization",
4348+ "ofType": null
4349+ }
4350+ },
4351+ "isDeprecated": false,
4352+ "deprecationReason": null
4353+ },
4354+ {
4355+ "name": "parent",
4356+ "description": "[Internal] The team's parent team.",
4357+ "args": [],
4358+ "type": {
4359+ "kind": "OBJECT",
4360+ "name": "Team",
4361+ "ofType": null
4362+ },
4363+ "isDeprecated": false,
4364+ "deprecationReason": null
4365+ },
4366+ {
4367+ "name": "children",
4368+ "description": "[Internal] The team's sub-teams.",
4369+ "args": [],
4370+ "type": {
4371+ "kind": "NON_NULL",
4372+ "name": null,
4373+ "ofType": {
4374+ "kind": "LIST",
4375+ "name": null,
4376+ "ofType": {
4377+ "kind": "NON_NULL",
4378+ "name": null,
4379+ "ofType": {
4380+ "kind": "OBJECT",
4381+ "name": "Team",
4382+ "ofType": null
4383+ }
4384+ }
4385+ }
4386+ },
4387+ "isDeprecated": false,
4388+ "deprecationReason": null
4389+ },
4390+ {
4391+ "name": "cyclesEnabled",
4392+ "description": "Whether the team uses cycles.",
4393+ "args": [],
4394+ "type": {
4395+ "kind": "NON_NULL",
4396+ "name": null,
4397+ "ofType": {
4398+ "kind": "SCALAR",
4399+ "name": "Boolean",
4400+ "ofType": null
4401+ }
4402+ },
4403+ "isDeprecated": false,
4404+ "deprecationReason": null
4405+ },
4406+ {
4407+ "name": "cycleStartDay",
4408+ "description": "The day of the week that a new cycle starts.",
4409+ "args": [],
4410+ "type": {
4411+ "kind": "NON_NULL",
4412+ "name": null,
4413+ "ofType": {
4414+ "kind": "SCALAR",
4415+ "name": "Float",
4416+ "ofType": null
4417+ }
4418+ },
4419+ "isDeprecated": false,
4420+ "deprecationReason": null
4421+ },
4422+ {
4423+ "name": "cycleDuration",
4424+ "description": "The duration of a cycle in weeks.",
4425+ "args": [],
4426+ "type": {
4427+ "kind": "NON_NULL",
4428+ "name": null,
4429+ "ofType": {
4430+ "kind": "SCALAR",
4431+ "name": "Float",
4432+ "ofType": null
4433+ }
4434+ },
4435+ "isDeprecated": false,
4436+ "deprecationReason": null
4437+ },
4438+ {
4439+ "name": "cycleCooldownTime",
4440+ "description": "The cooldown time after each cycle in weeks.",
4441+ "args": [],
4442+ "type": {
4443+ "kind": "NON_NULL",
4444+ "name": null,
4445+ "ofType": {
4446+ "kind": "SCALAR",
4447+ "name": "Float",
4448+ "ofType": null
4449+ }
4450+ },
4451+ "isDeprecated": false,
4452+ "deprecationReason": null
4453+ },
4454+ {
4455+ "name": "cycleIssueAutoAssignStarted",
4456+ "description": "Auto assign started issues to current cycle.",
4457+ "args": [],
4458+ "type": {
4459+ "kind": "NON_NULL",
4460+ "name": null,
4461+ "ofType": {
4462+ "kind": "SCALAR",
4463+ "name": "Boolean",
4464+ "ofType": null
4465+ }
4466+ },
4467+ "isDeprecated": false,
4468+ "deprecationReason": null
4469+ },
4470+ {
4471+ "name": "cycleIssueAutoAssignCompleted",
4472+ "description": "Auto assign completed issues to current cycle.",
4473+ "args": [],
4474+ "type": {
4475+ "kind": "NON_NULL",
4476+ "name": null,
4477+ "ofType": {
4478+ "kind": "SCALAR",
4479+ "name": "Boolean",
4480+ "ofType": null
4481+ }
4482+ },
4483+ "isDeprecated": false,
4484+ "deprecationReason": null
4485+ },
4486+ {
4487+ "name": "cycleLockToActive",
4488+ "description": "Auto assign issues to current cycle if in active status.",
4489+ "args": [],
4490+ "type": {
4491+ "kind": "NON_NULL",
4492+ "name": null,
4493+ "ofType": {
4494+ "kind": "SCALAR",
4495+ "name": "Boolean",
4496+ "ofType": null
4497+ }
4498+ },
4499+ "isDeprecated": false,
4500+ "deprecationReason": null
4501+ },
4502+ {
4503+ "name": "upcomingCycleCount",
4504+ "description": "How many upcoming cycles to create.",
4505+ "args": [],
4506+ "type": {
4507+ "kind": "NON_NULL",
4508+ "name": null,
4509+ "ofType": {
4510+ "kind": "SCALAR",
4511+ "name": "Float",
4512+ "ofType": null
4513+ }
4514+ },
4515+ "isDeprecated": false,
4516+ "deprecationReason": null
4517+ },
4518+ {
4519+ "name": "timezone",
4520+ "description": "The timezone of the team. Defaults to \"America/Los_Angeles\"",
4521+ "args": [],
4522+ "type": {
4523+ "kind": "NON_NULL",
4524+ "name": null,
4525+ "ofType": {
4526+ "kind": "SCALAR",
4527+ "name": "String",
4528+ "ofType": null
4529+ }
4530+ },
4531+ "isDeprecated": false,
4532+ "deprecationReason": null
4533+ },
4534+ {
4535+ "name": "inheritWorkflowStatuses",
4536+ "description": "Whether the team should inherit its workflow statuses from its parent. Only applies to sub-teams.",
4537+ "args": [],
4538+ "type": {
4539+ "kind": "NON_NULL",
4540+ "name": null,
4541+ "ofType": {
4542+ "kind": "SCALAR",
4543+ "name": "Boolean",
4544+ "ofType": null
4545+ }
4546+ },
4547+ "isDeprecated": false,
4548+ "deprecationReason": null
4549+ },
4550+ {
4551+ "name": "inheritIssueEstimation",
4552+ "description": "Whether the team should inherit its estimation settings from its parent. Only applies to sub-teams.",
4553+ "args": [],
4554+ "type": {
4555+ "kind": "NON_NULL",
4556+ "name": null,
4557+ "ofType": {
4558+ "kind": "SCALAR",
4559+ "name": "Boolean",
4560+ "ofType": null
4561+ }
4562+ },
4563+ "isDeprecated": false,
4564+ "deprecationReason": null
4565+ },
4566+ {
4567+ "name": "issueEstimationType",
4568+ "description": "The issue estimation type to use. Must be one of \"notUsed\", \"exponential\", \"fibonacci\", \"linear\", \"tShirt\".",
4569+ "args": [],
4570+ "type": {
4571+ "kind": "NON_NULL",
4572+ "name": null,
4573+ "ofType": {
4574+ "kind": "SCALAR",
4575+ "name": "String",
4576+ "ofType": null
4577+ }
4578+ },
4579+ "isDeprecated": false,
4580+ "deprecationReason": null
4581+ },
4582+ {
4583+ "name": "issueOrderingNoPriorityFirst",
4584+ "description": "[DEPRECATED] Whether issues without priority should be sorted first.",
4585+ "args": [],
4586+ "type": {
4587+ "kind": "NON_NULL",
4588+ "name": null,
4589+ "ofType": {
4590+ "kind": "SCALAR",
4591+ "name": "Boolean",
4592+ "ofType": null
4593+ }
4594+ },
4595+ "isDeprecated": true,
4596+ "deprecationReason": "This setting is no longer in use."
4597+ },
4598+ {
4599+ "name": "issueEstimationAllowZero",
4600+ "description": "Whether to allow zeros in issues estimates.",
4601+ "args": [],
4602+ "type": {
4603+ "kind": "NON_NULL",
4604+ "name": null,
4605+ "ofType": {
4606+ "kind": "SCALAR",
4607+ "name": "Boolean",
4608+ "ofType": null
4609+ }
4610+ },
4611+ "isDeprecated": false,
4612+ "deprecationReason": null
4613+ },
4614+ {
4615+ "name": "setIssueSortOrderOnStateChange",
4616+ "description": "Where to move issues when changing state.",
4617+ "args": [],
4618+ "type": {
4619+ "kind": "NON_NULL",
4620+ "name": null,
4621+ "ofType": {
4622+ "kind": "SCALAR",
4623+ "name": "String",
4624+ "ofType": null
4625+ }
4626+ },
4627+ "isDeprecated": false,
4628+ "deprecationReason": null
4629+ },
4630+ {
4631+ "name": "issueEstimationExtended",
4632+ "description": "Whether to add additional points to the estimate scale.",
4633+ "args": [],
4634+ "type": {
4635+ "kind": "NON_NULL",
4636+ "name": null,
4637+ "ofType": {
4638+ "kind": "SCALAR",
4639+ "name": "Boolean",
4640+ "ofType": null
4641+ }
4642+ },
4643+ "isDeprecated": false,
4644+ "deprecationReason": null
4645+ },
4646+ {
4647+ "name": "defaultIssueEstimate",
4648+ "description": "What to use as a default estimate for unestimated issues.",
4649+ "args": [],
4650+ "type": {
4651+ "kind": "NON_NULL",
4652+ "name": null,
4653+ "ofType": {
4654+ "kind": "SCALAR",
4655+ "name": "Float",
4656+ "ofType": null
4657+ }
4658+ },
4659+ "isDeprecated": false,
4660+ "deprecationReason": null
4661+ },
4662+ {
4663+ "name": "triageEnabled",
4664+ "description": "Whether triage mode is enabled for the team or not.",
4665+ "args": [],
4666+ "type": {
4667+ "kind": "NON_NULL",
4668+ "name": null,
4669+ "ofType": {
4670+ "kind": "SCALAR",
4671+ "name": "Boolean",
4672+ "ofType": null
4673+ }
4674+ },
4675+ "isDeprecated": false,
4676+ "deprecationReason": null
4677+ },
4678+ {
4679+ "name": "requirePriorityToLeaveTriage",
4680+ "description": "Whether an issue needs to have a priority set before leaving triage.",
4681+ "args": [],
4682+ "type": {
4683+ "kind": "NON_NULL",
4684+ "name": null,
4685+ "ofType": {
4686+ "kind": "SCALAR",
4687+ "name": "Boolean",
4688+ "ofType": null
4689+ }
4690+ },
4691+ "isDeprecated": false,
4692+ "deprecationReason": null
4693+ },
4694+ {
4695+ "name": "defaultIssueState",
4696+ "description": "The default workflow state into which issues are set when they are opened by team members.",
4697+ "args": [],
4698+ "type": {
4699+ "kind": "OBJECT",
4700+ "name": "WorkflowState",
4701+ "ofType": null
4702+ },
4703+ "isDeprecated": false,
4704+ "deprecationReason": null
4705+ },
4706+ {
4707+ "name": "defaultTemplateForMembers",
4708+ "description": "The default template to use for new issues created by members of the team.",
4709+ "args": [],
4710+ "type": {
4711+ "kind": "OBJECT",
4712+ "name": "Template",
4713+ "ofType": null
4714+ },
4715+ "isDeprecated": false,
4716+ "deprecationReason": null
4717+ },
4718+ {
4719+ "name": "defaultTemplateForMembersId",
4720+ "description": "The id of the default template to use for new issues created by members of the team.",
4721+ "args": [],
4722+ "type": {
4723+ "kind": "SCALAR",
4724+ "name": "String",
4725+ "ofType": null
4726+ },
4727+ "isDeprecated": true,
4728+ "deprecationReason": "Use defaultTemplateForMembers instead"
4729+ },
4730+ {
4731+ "name": "defaultTemplateForNonMembers",
4732+ "description": "The default template to use for new issues created by non-members of the team.",
4733+ "args": [],
4734+ "type": {
4735+ "kind": "OBJECT",
4736+ "name": "Template",
4737+ "ofType": null
4738+ },
4739+ "isDeprecated": false,
4740+ "deprecationReason": null
4741+ },
4742+ {
4743+ "name": "defaultTemplateForNonMembersId",
4744+ "description": "The id of the default template to use for new issues created by non-members of the team.",
4745+ "args": [],
4746+ "type": {
4747+ "kind": "SCALAR",
4748+ "name": "String",
4749+ "ofType": null
4750+ },
4751+ "isDeprecated": true,
4752+ "deprecationReason": "Use defaultTemplateForNonMembers instead"
4753+ },
4754+ {
4755+ "name": "defaultProjectTemplate",
4756+ "description": "The default template to use for new projects created for the team.",
4757+ "args": [],
4758+ "type": {
4759+ "kind": "OBJECT",
4760+ "name": "Template",
4761+ "ofType": null
4762+ },
4763+ "isDeprecated": false,
4764+ "deprecationReason": null
4765+ },
4766+ {
4767+ "name": "triageIssueState",
4768+ "description": "The workflow state into which issues are set when they are opened by non-team members or integrations if triage is enabled.",
4769+ "args": [],
4770+ "type": {
4771+ "kind": "OBJECT",
4772+ "name": "WorkflowState",
4773+ "ofType": null
4774+ },
4775+ "isDeprecated": false,
4776+ "deprecationReason": null
4777+ },
4778+ {
4779+ "name": "private",
4780+ "description": "Whether the team is private or not.",
4781+ "args": [],
4782+ "type": {
4783+ "kind": "NON_NULL",
4784+ "name": null,
4785+ "ofType": {
4786+ "kind": "SCALAR",
4787+ "name": "Boolean",
4788+ "ofType": null
4789+ }
4790+ },
4791+ "isDeprecated": false,
4792+ "deprecationReason": null
4793+ },
4794+ {
4795+ "name": "allMembersCanJoin",
4796+ "description": "Whether all members in the workspace can join the team. Only used for public teams.",
4797+ "args": [],
4798+ "type": {
4799+ "kind": "SCALAR",
4800+ "name": "Boolean",
4801+ "ofType": null
4802+ },
4803+ "isDeprecated": false,
4804+ "deprecationReason": null
4805+ },
4806+ {
4807+ "name": "securitySettings",
4808+ "description": "Security settings for the team.",
4809+ "args": [],
4810+ "type": {
4811+ "kind": "NON_NULL",
4812+ "name": null,
4813+ "ofType": {
4814+ "kind": "SCALAR",
4815+ "name": "JSONObject",
4816+ "ofType": null
4817+ }
4818+ },
4819+ "isDeprecated": false,
4820+ "deprecationReason": null
4821+ },
4822+ {
4823+ "name": "facets",
4824+ "description": "[Internal] Facets associated with the team.",
4825+ "args": [],
4826+ "type": {
4827+ "kind": "NON_NULL",
4828+ "name": null,
4829+ "ofType": {
4830+ "kind": "LIST",
4831+ "name": null,
4832+ "ofType": {
4833+ "kind": "NON_NULL",
4834+ "name": null,
4835+ "ofType": {
4836+ "kind": "OBJECT",
4837+ "name": "Facet",
4838+ "ofType": null
4839+ }
4840+ }
4841+ }
4842+ },
4843+ "isDeprecated": false,
4844+ "deprecationReason": null
4845+ },
4846+ {
4847+ "name": "posts",
4848+ "description": "[Internal] Posts associated with the team.",
4849+ "args": [],
4850+ "type": {
4851+ "kind": "NON_NULL",
4852+ "name": null,
4853+ "ofType": {
4854+ "kind": "LIST",
4855+ "name": null,
4856+ "ofType": {
4857+ "kind": "NON_NULL",
4858+ "name": null,
4859+ "ofType": {
4860+ "kind": "OBJECT",
4861+ "name": "Post",
4862+ "ofType": null
4863+ }
4864+ }
4865+ }
4866+ },
4867+ "isDeprecated": false,
4868+ "deprecationReason": null
4869+ },
4870+ {
4871+ "name": "scimManaged",
4872+ "description": "Whether the team is managed by SCIM integration.",
4873+ "args": [],
4874+ "type": {
4875+ "kind": "NON_NULL",
4876+ "name": null,
4877+ "ofType": {
4878+ "kind": "SCALAR",
4879+ "name": "Boolean",
4880+ "ofType": null
4881+ }
4882+ },
4883+ "isDeprecated": false,
4884+ "deprecationReason": null
4885+ },
4886+ {
4887+ "name": "scimGroupName",
4888+ "description": "The SCIM group name for the team.",
4889+ "args": [],
4890+ "type": {
4891+ "kind": "SCALAR",
4892+ "name": "String",
4893+ "ofType": null
4894+ },
4895+ "isDeprecated": false,
4896+ "deprecationReason": null
4897+ },
4898+ {
4899+ "name": "progressHistory",
4900+ "description": "[Internal] The progress history of the team.",
4901+ "args": [],
4902+ "type": {
4903+ "kind": "NON_NULL",
4904+ "name": null,
4905+ "ofType": {
4906+ "kind": "SCALAR",
4907+ "name": "JSONObject",
4908+ "ofType": null
4909+ }
4910+ },
4911+ "isDeprecated": false,
4912+ "deprecationReason": null
4913+ },
4914+ {
4915+ "name": "currentProgress",
4916+ "description": "[Internal] The current progress of the team.",
4917+ "args": [],
4918+ "type": {
4919+ "kind": "NON_NULL",
4920+ "name": null,
4921+ "ofType": {
4922+ "kind": "SCALAR",
4923+ "name": "JSONObject",
4924+ "ofType": null
4925+ }
4926+ },
4927+ "isDeprecated": false,
4928+ "deprecationReason": null
4929+ },
4930+ {
4931+ "name": "draftWorkflowState",
4932+ "description": "The workflow state into which issues are moved when a PR has been opened as draft.",
4933+ "args": [],
4934+ "type": {
4935+ "kind": "OBJECT",
4936+ "name": "WorkflowState",
4937+ "ofType": null
4938+ },
4939+ "isDeprecated": true,
4940+ "deprecationReason": "Use team.gitAutomationStates instead."
4941+ },
4942+ {
4943+ "name": "startWorkflowState",
4944+ "description": "The workflow state into which issues are moved when a PR has been opened.",
4945+ "args": [],
4946+ "type": {
4947+ "kind": "OBJECT",
4948+ "name": "WorkflowState",
4949+ "ofType": null
4950+ },
4951+ "isDeprecated": true,
4952+ "deprecationReason": "Use team.gitAutomationStates instead."
4953+ },
4954+ {
4955+ "name": "reviewWorkflowState",
4956+ "description": "The workflow state into which issues are moved when a review has been requested for the PR.",
4957+ "args": [],
4958+ "type": {
4959+ "kind": "OBJECT",
4960+ "name": "WorkflowState",
4961+ "ofType": null
4962+ },
4963+ "isDeprecated": true,
4964+ "deprecationReason": "Use team.gitAutomationStates instead."
4965+ },
4966+ {
4967+ "name": "mergeableWorkflowState",
4968+ "description": "The workflow state into which issues are moved when a PR is ready to be merged.",
4969+ "args": [],
4970+ "type": {
4971+ "kind": "OBJECT",
4972+ "name": "WorkflowState",
4973+ "ofType": null
4974+ },
4975+ "isDeprecated": true,
4976+ "deprecationReason": "Use team.gitAutomationStates instead."
4977+ },
4978+ {
4979+ "name": "mergeWorkflowState",
4980+ "description": "The workflow state into which issues are moved when a PR has been merged.",
4981+ "args": [],
4982+ "type": {
4983+ "kind": "OBJECT",
4984+ "name": "WorkflowState",
4985+ "ofType": null
4986+ },
4987+ "isDeprecated": true,
4988+ "deprecationReason": "Use team.gitAutomationStates instead."
4989+ },
4990+ {
4991+ "name": "groupIssueHistory",
4992+ "description": "Whether to group recent issue history entries.",
4993+ "args": [],
4994+ "type": {
4995+ "kind": "NON_NULL",
4996+ "name": null,
4997+ "ofType": {
4998+ "kind": "SCALAR",
4999+ "name": "Boolean",

124478 more lines aren’t shown here.

packages/control-plane/src/runtime/fixtures/neon-openapi.json+14358−0
@@ -0,0 +1,14358 @@
1+{
2+ "openapi": "3.0.3",
3+ "servers": [
4+ {
5+ "url": "https://console.neon.tech/api/v2"
6+ }
7+ ],
8+ "info": {
9+ "title": "Neon API",
10+ "description": "The Neon API allows you to access and manage Neon programmatically. You can use the Neon API to manage API keys, projects, branches, compute endpoints, databases, roles, and operations. For information about these features, refer to the [Neon documentation](https://neon.tech/docs/manage/overview/).\n\nYou can run Neon API requests from this API reference using the **Try It** feature. Enter your API key as a **Bearer** token in the **Authorization** section of the page.\n\nYou can create and manage API keys in the Neon Console. See [Manage API keys](https://neon.tech/docs/manage/api-keys/) for instructions.",
11+ "version": "v2",
12+ "contact": {
13+ "email": "help@databricks.com"
14+ },
15+ "license": {
16+ "name": "Proprietary"
17+ }
18+ },
19+ "x-readme": {
20+ "samples-languages": [
21+ "shell"
22+ ]
23+ },
24+ "security": [
25+ {
26+ "BearerAuth": []
27+ },
28+ {
29+ "CookieAuth": []
30+ },
31+ {
32+ "TokenCookieAuth": []
33+ }
34+ ],
35+ "tags": [
36+ {
37+ "name": "API Key",
38+ "description": "These methods allow you to create and manage API keys for your Neon account. For related information, see [Manage API keys](https://neon.tech/docs/manage/api-keys)."
39+ },
40+ {
41+ "name": "Operation",
42+ "description": "These methods allow you to view operation details for your Neon project. For related information, see [Operations](https://neon.tech/docs/manage/operations)."
43+ },
44+ {
45+ "name": "Project",
46+ "description": "These methods allow you to create and manage Neon projects. For related information, see [Manage projects](https://neon.tech/docs/manage/projects)."
47+ },
48+ {
49+ "name": "Branch",
50+ "description": "These methods allow you to create and manage branches in your Neon project. For related information, see [Manage branches](https://neon.tech/docs/manage/branches)."
51+ },
52+ {
53+ "name": "Endpoint",
54+ "description": "These methods allow you to create and manage compute endpoints in your Neon project. For related information, see [Manage compute endpoints](https://neon.tech/docs/manage/endpoints)."
55+ },
56+ {
57+ "name": "Snapshot",
58+ "description": "These methods allow you to create and manage snapshots."
59+ },
60+ {
61+ "name": "Preview",
62+ "description": "New API methods that are in a Preview state and may be subject to changes."
63+ },
64+ {
65+ "name": "Region",
66+ "description": "These methods allow you to inspect Neon regions."
67+ },
68+ {
69+ "name": "Users",
70+ "description": "These methods allow you to manage your Neon user account."
71+ },
72+ {
73+ "name": "Consumption",
74+ "description": "These methods allow you to view consumption details for your Neon account."
75+ },
76+ {
77+ "name": "Organizations",
78+ "description": "These methods allow you to manage your Neon organizations."
79+ },
80+ {
81+ "name": "Auth",
82+ "description": "These methods allow you to create and manage Neon Auth projects."
83+ },
84+ {
85+ "name": "Auth (legacy)",
86+ "description": "These methods allow you to create and manage Neon Auth projects. Deprecated. See routes with the `Auth` tag instead."
87+ }
88+ ],
89+ "paths": {
90+ "/projects/{project_id}/advisors": {
91+ "parameters": [
92+ {
93+ "name": "project_id",
94+ "description": "Neon project ID",
95+ "in": "path",
96+ "required": true,
97+ "schema": {
98+ "type": "string",
99+ "pattern": "^[a-z0-9-]{1,60}$"
100+ }
101+ }
102+ ],
103+ "get": {
104+ "summary": "Get advisor issues",
105+ "description": "Analyzes the database for security and performance issues.\nReturns a list of issues categorized by severity (ERROR, WARN, INFO).\n\nRequires read access to the project.\n",
106+ "operationId": "getProjectAdvisorSecurityIssues",
107+ "tags": [
108+ "Project"
109+ ],
110+ "x-stability-level": "alpha",
111+ "parameters": [
112+ {
113+ "name": "branch_id",
114+ "in": "query",
115+ "required": false,
116+ "description": "Branch ID to analyze. If not specified, the project's default branch is used.",
117+ "schema": {
118+ "type": "string",
119+ "pattern": "^[a-z0-9-]{1,60}$"
120+ }
121+ },
122+ {
123+ "name": "database_name",
124+ "in": "query",
125+ "required": false,
126+ "description": "Database name to analyze. Required if branch has multiple databases.",
127+ "schema": {
128+ "type": "string"
129+ }
130+ },
131+ {
132+ "name": "category",
133+ "in": "query",
134+ "required": false,
135+ "description": "Filter issues by category",
136+ "schema": {
137+ "$ref": "#/components/schemas/AdvisorCategory"
138+ }
139+ },
140+ {
141+ "name": "min_severity",
142+ "in": "query",
143+ "required": false,
144+ "description": "Minimum severity level to include. For example, WARN returns WARN and ERROR issues, excluding INFO.",
145+ "schema": {
146+ "type": "string",
147+ "enum": [
148+ "INFO",
149+ "WARN",
150+ "ERROR"
151+ ]
152+ }
153+ }
154+ ],
155+ "responses": {
156+ "200": {
157+ "description": "Successfully retrieved security advisor issues",
158+ "content": {
159+ "application/json": {
160+ "schema": {
161+ "type": "object",
162+ "required": [
163+ "issues"
164+ ],
165+ "properties": {
166+ "issues": {
167+ "type": "array",
168+ "items": {
169+ "$ref": "#/components/schemas/AdvisorIssue"
170+ }
171+ }
172+ }
173+ }
174+ }
175+ }
176+ },
177+ "default": {
178+ "$ref": "#/components/responses/GeneralError"
179+ }
180+ }
181+ }
182+ },
183+ "/api_keys": {
184+ "get": {
185+ "summary": "List API keys",
186+ "description": "Retrieves the API keys for your Neon account.\nThe response does not include API key tokens. A token is only provided when creating an API key.\nAPI keys can also be managed in the Neon Console.\nFor more information, see [Manage API keys](https://neon.tech/docs/manage/api-keys/).\n",
187+ "tags": [
188+ "API Key"
189+ ],
190+ "operationId": "listApiKeys",
191+ "responses": {
192+ "200": {
193+ "description": "Returned the API keys for the Neon account",
194+ "content": {
195+ "application/json": {
196+ "schema": {
197+ "type": "array",
198+ "items": {
199+ "$ref": "#/components/schemas/ApiKeysListResponseItem"
200+ },
201+ "example": [
202+ {
203+ "id": 165432,
204+ "name": "mykey_1",
205+ "created_at": "2022-11-15T20:13:35Z",
206+ "created_by": {
207+ "id": "629982cc-de05-43db-ae16-28f2399c4910",
208+ "name": "John Smith",
209+ "image": "http://link.to.image"
210+ },
211+ "last_used_at": "2022-11-15T20:22:51Z",
212+ "last_used_from_addr": "192.0.2.255"
213+ },
214+ {
215+ "id": 165433,
216+ "name": "mykey_2",
217+ "created_at": "2022-11-15T20:12:36Z",
218+ "created_by": {
219+ "id": "629982cc-de05-43db-ae16-28f2399c4910",
220+ "name": "John Smith",
221+ "image": "http://link.to.image"
222+ },
223+ "last_used_at": "2022-11-15T20:15:04Z",
224+ "last_used_from_addr": "192.0.2.255"
225+ }
226+ ]
227+ }
228+ }
229+ }
230+ },
231+ "default": {
232+ "$ref": "#/components/responses/GeneralError"
233+ }
234+ }
235+ },
236+ "post": {
237+ "summary": "Create API key",
238+ "description": "Creates an API key.\nThe `key_name` is a user-specified name for the key.\nThis method returns an `id` and `key`. The `key` is a randomly generated, 64-bit token required to access the Neon API.\nAPI keys can also be managed in the Neon Console.\nSee [Manage API keys](https://neon.tech/docs/manage/api-keys/).\n",
239+ "tags": [
240+ "API Key"
241+ ],
242+ "operationId": "createApiKey",
243+ "requestBody": {
244+ "content": {
245+ "application/json": {
246+ "schema": {
247+ "$ref": "#/components/schemas/ApiKeyCreateRequest"
248+ },
249+ "example": {
250+ "key_name": "mykey"
251+ }
252+ }
253+ },
254+ "required": true
255+ },
256+ "responses": {
257+ "200": {
258+ "description": "Created an API key",
259+ "content": {
260+ "application/json": {
261+ "schema": {
262+ "$ref": "#/components/schemas/ApiKeyCreateResponse"
263+ },
264+ "example": {
265+ "id": 165434,
266+ "key": "9v1faketcjbl4sn1013keyd43n2a8qlfakeog8yvp40hx16keyjo1bpds4y2dfms3",
267+ "name": "mykey",
268+ "created_at": "2022-11-15T20:13:35Z",
269+ "created_by": "629982cc-de05-43db-ae16-28f2399c4910"
270+ }
271+ }
272+ }
273+ },
274+ "default": {
275+ "$ref": "#/components/responses/GeneralError"
276+ }
277+ }
278+ }
279+ },
280+ "/api_keys/{key_id}": {
281+ "delete": {
282+ "summary": "Revoke API key",
283+ "description": "Revokes the specified API key.\nAn API key that is no longer needed can be revoked.\nThis action cannot be reversed.\nYou can obtain `key_id` values by listing the API keys for your Neon account.\nAPI keys can also be managed in the Neon Console.\nSee [Manage API keys](https://neon.tech/docs/manage/api-keys/).\n",
284+ "tags": [
285+ "API Key"
286+ ],
287+ "operationId": "revokeApiKey",
288+ "parameters": [
289+ {
290+ "name": "key_id",
291+ "in": "path",
292+ "description": "The API key ID",
293+ "required": true,
294+ "schema": {
295+ "type": "integer",
296+ "format": "int64"
297+ }
298+ }
299+ ],
300+ "responses": {
301+ "200": {
302+ "description": "Revoked the specified API key",
303+ "content": {
304+ "application/json": {
305+ "schema": {
306+ "$ref": "#/components/schemas/ApiKeyRevokeResponse"
307+ },
308+ "example": {
309+ "id": 165435,
310+ "name": "mykey",
311+ "created_at": "2022-11-15T20:13:35Z",
312+ "created_by": "629982cc-de05-43db-ae16-28f2399c4910",
313+ "last_used_at": "2022-11-15T20:15:04Z",
314+ "last_used_from_addr": "192.0.2.255",
315+ "revoked": true
316+ }
317+ }
318+ }
319+ },
320+ "default": {
321+ "$ref": "#/components/responses/GeneralError"
322+ }
323+ }
324+ }
325+ },
326+ "/projects/{project_id}/operations/{operation_id}": {
327+ "parameters": [
328+ {
329+ "name": "project_id",
330+ "in": "path",
331+ "description": "The Neon project ID",
332+ "required": true,
333+ "schema": {
334+ "type": "string",
335+ "pattern": "^[a-z0-9-]{1,60}$"
336+ }
337+ },
338+ {
339+ "name": "operation_id",
340+ "in": "path",
341+ "description": "The operation ID",
342+ "required": true,
343+ "schema": {
344+ "type": "string",
345+ "format": "uuid"
346+ }
347+ }
348+ ],
349+ "get": {
350+ "summary": "Retrieve operation details",
351+ "description": "Retrieves details for the specified operation.\nAn operation is an action performed on a Neon project resource.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nYou can obtain a `operation_id` by listing operations for the project.\n",
352+ "tags": [
353+ "Operation"
354+ ],
355+ "operationId": "getProjectOperation",
356+ "responses": {
357+ "200": {
358+ "description": "Returned details for the specified operation",
359+ "content": {
360+ "application/json": {
361+ "schema": {
362+ "$ref": "#/components/schemas/OperationResponse"
363+ },
364+ "example": {
365+ "operation": {
366+ "id": "a07f8772-1877-4da9-a939-3a3ae62d1d8d",
367+ "project_id": "floral-king-961888",
368+ "branch_id": "br-bitter-sound-247814",
369+ "endpoint_id": "ep-dark-snowflake-942567",
370+ "action": "create_timeline",
371+ "status": "finished",
372+ "failures_count": 0,
373+ "created_at": "2022-10-04T18:20:17Z",
374+ "updated_at": "2022-10-04T18:20:18Z",
375+ "total_duration_ms": 100
376+ }
377+ }
378+ }
379+ }
380+ },
381+ "default": {
382+ "$ref": "#/components/responses/GeneralError"
383+ }
384+ }
385+ }
386+ },
387+ "/projects": {
388+ "get": {
389+ "summary": "List projects",
390+ "description": "Retrieves a list of projects for an organization.\nYou may need to specify an org_id parameter depending on your API key type.\nFor more information, see [Manage projects](https://neon.tech/docs/manage/projects/).\n",
391+ "tags": [
392+ "Project"
393+ ],
394+ "operationId": "listProjects",
395+ "parameters": [
396+ {
397+ "name": "cursor",
398+ "description": "Specify the cursor value from the previous response to retrieve the next batch of projects.",
399+ "in": "query",
400+ "schema": {
401+ "type": "string"
402+ }
403+ },
404+ {
405+ "name": "limit",
406+ "description": "Specify a value from 1 to 400 to limit number of projects in the response.",
407+ "in": "query",
408+ "schema": {
409+ "type": "integer",
410+ "minimum": 1,
411+ "default": 10,
412+ "maximum": 400
413+ }
414+ },
415+ {
416+ "name": "search",
417+ "description": "Search by project `name` or `id`. You can specify partial `name` or `id` values to filter results.",
418+ "in": "query",
419+ "schema": {
420+ "type": "string"
421+ }
422+ },
423+ {
424+ "name": "org_id",
425+ "description": "Search for projects by `org_id`.",
426+ "in": "query",
427+ "schema": {
428+ "type": "string",
429+ "pattern": "^[a-z0-9-]{1,60}$"
430+ }
431+ },
432+ {
433+ "$ref": "#/components/parameters/TimeoutParam"
434+ },
435+ {
436+ "name": "recoverable",
437+ "description": "Show only deleted projects within the recovery window.\n",
438+ "in": "query",
439+ "x-stability-level": "beta",
440+ "schema": {
441+ "type": "boolean",
442+ "default": false
443+ }
444+ }
445+ ],
446+ "responses": {
447+ "200": {
448+ "description": "Returned a list of projects for the Neon account",
449+ "content": {
450+ "application/json": {
451+ "schema": {
452+ "allOf": [
453+ {
454+ "$ref": "#/components/schemas/ProjectsResponse"
455+ },
456+ {
457+ "$ref": "#/components/schemas/PaginationResponse"
458+ },
459+ {
460+ "$ref": "#/components/schemas/ProjectsApplicationsMapResponse"
461+ },
462+ {
463+ "$ref": "#/components/schemas/ProjectsIntegrationsMapResponse"
464+ }
465+ ]
466+ },
467+ "example": {
468+ "projects": [
469+ {
470+ "id": "shiny-wind-028834",
471+ "platform_id": "aws",
472+ "region_id": "aws-us-east-2",
473+ "name": "shiny-wind-028834",
474+ "provisioner": "k8s-pod",
475+ "pg_version": 15,
476+ "created_at": "2022-11-23T17:42:25Z",
477+ "updated_at": "2022-11-23T17:42:25Z",
478+ "proxy_host": "us-east-2.aws.neon.tech",
479+ "cpu_used_sec": 0,
480+ "branch_logical_size_limit": 0,
481+ "owner_id": "1232111",
482+ "creation_source": "console",
483+ "store_passwords": true,
484+ "branch_logical_size_limit_bytes": 10800,
485+ "active_time": 100
486+ },
487+ {
488+ "id": "winter-boat-259881",
489+ "platform_id": "aws",
490+ "region_id": "aws-us-east-2",
491+ "name": "winter-boat-259881",
492+ "provisioner": "k8s-pod",
493+ "pg_version": 15,
494+ "created_at": "2022-11-23T17:52:25Z",
495+ "updated_at": "2022-11-23T17:52:25Z",
496+ "proxy_host": "us-east-2.aws.neon.tech",
497+ "cpu_used_sec": 0,
498+ "branch_logical_size_limit": 0,
499+ "owner_id": "1232111",
500+ "creation_source": "console",
501+ "store_passwords": true,
502+ "branch_logical_size_limit_bytes": 10800,
503+ "active_time": 100,
504+ "org_id": "org-morning-bread-81040908"
505+ }
506+ ],
507+ "applications": {
508+ "winter-boat-259881": [
509+ "vercel",
510+ "github"
511+ ]
512+ },
513+ "integrations": {
514+ "winter-boat-259881": [
515+ "vercel",
516+ "github"
517+ ]
518+ }
519+ }
520+ }
521+ }
522+ },
523+ "default": {
524+ "$ref": "#/components/responses/GeneralError"
525+ }
526+ }
527+ },
528+ "post": {
529+ "summary": "Create project",
530+ "description": "Creates a Neon project within an organization.\nYou may need to specify an org_id parameter depending on your API key type.\nPlan limits define how many projects you can create.\nFor more information, see [Manage projects](https://neon.tech/docs/manage/projects/).\n\nYou can specify a region and Postgres version in the request body.\nNeon currently supports PostgreSQL 14, 15, 16, and 17.\nFor supported regions and `region_id` values, see [Regions](https://neon.tech/docs/introduction/regions/).\n",
531+ "tags": [
532+ "Project"
533+ ],
534+ "operationId": "createProject",
535+ "requestBody": {
536+ "required": true,
537+ "content": {
538+ "application/json": {
539+ "schema": {
540+ "$ref": "#/components/schemas/ProjectCreateRequest"
541+ },
542+ "examples": {
543+ "required_attributes_only": {
544+ "summary": "Required attributes only",
545+ "value": {
546+ "project": {
547+ "name": "myproject"
548+ }
549+ }
550+ },
551+ "commonly_specified_attributes": {
552+ "summary": "Commonly-specified attributes",
553+ "value": {
554+ "project": {
555+ "name": "myproject",
556+ "region_id": "aws-us-east-2",
557+ "pg_version": 15
558+ }
559+ }
560+ },
561+ "with_autoscaling": {
562+ "summary": "With autoscaling attributes",
563+ "value": {
564+ "project": {
565+ "name": "myproject",
566+ "region_id": "aws-us-east-2",
567+ "pg_version": 15,
568+ "autoscaling_limit_min_cu": 0.25,
569+ "autoscaling_limit_max_cu": 1,
570+ "provisioner": "k8s-neonvm"
571+ }
572+ }
573+ },
574+ "with_branch_attributes": {
575+ "summary": "With branch attributes",
576+ "value": {
577+ "project": {
578+ "name": "myproject",
579+ "region_id": "aws-us-east-2",
580+ "pg_version": 15,
581+ "branch": {
582+ "name": "mybranch",
583+ "role_name": "sally",
584+ "database_name": "mydb"
585+ }
586+ }
587+ }
588+ }
589+ }
590+ }
591+ }
592+ },
593+ "responses": {
594+ "201": {
595+ "$ref": "#/components/responses/CreatedProject"
596+ },
597+ "default": {
598+ "$ref": "#/components/responses/GeneralError"
599+ }
600+ }
601+ }
602+ },
603+ "/projects/shared": {
604+ "get": {
605+ "summary": "List shared projects",
606+ "description": "Retrieves a list of projects shared with your Neon account.\nFor more information, see [Manage projects](https://neon.tech/docs/manage/projects/).\n",
607+ "tags": [
608+ "Project"
609+ ],
610+ "operationId": "listSharedProjects",
611+ "parameters": [
612+ {
613+ "name": "cursor",
614+ "description": "Specify the cursor value from the previous response to get the next batch of projects.",
615+ "in": "query",
616+ "schema": {
617+ "type": "string"
618+ }
619+ },
620+ {
621+ "name": "limit",
622+ "description": "Specify a value from 1 to 400 to limit number of projects in the response.",
623+ "in": "query",
624+ "schema": {
625+ "type": "integer",
626+ "minimum": 1,
627+ "default": 10,
628+ "maximum": 400
629+ }
630+ },
631+ {
632+ "name": "search",
633+ "description": "Search query by name or id.",
634+ "in": "query",
635+ "schema": {
636+ "type": "string"
637+ }
638+ },
639+ {
640+ "$ref": "#/components/parameters/TimeoutParam"
641+ }
642+ ],
643+ "responses": {
644+ "200": {
645+ "description": "Returned a list of shared projects for the Neon account",
646+ "content": {
647+ "application/json": {
648+ "schema": {
649+ "allOf": [
650+ {
651+ "$ref": "#/components/schemas/ProjectsResponse"
652+ },
653+ {
654+ "$ref": "#/components/schemas/PaginationResponse"
655+ }
656+ ]
657+ },
658+ "example": {
659+ "projects": [
660+ {
661+ "id": "shiny-wind-028834",
662+ "platform_id": "aws",
663+ "region_id": "aws-us-east-2",
664+ "name": "shiny-wind-028834",
665+ "provisioner": "k8s-pod",
666+ "pg_version": 15,
667+ "created_at": "2022-11-23T17:42:25Z",
668+ "updated_at": "2022-11-23T17:42:25Z",
669+ "proxy_host": "us-east-2.aws.neon.tech",
670+ "cpu_used_sec": 0,
671+ "branch_logical_size_limit": 0,
672+ "owner_id": "1232111",
673+ "creation_source": "console",
674+ "store_passwords": true,
675+ "branch_logical_size_limit_bytes": 10800,
676+ "active_time": 100
677+ },
678+ {
679+ "id": "winter-boat-259881",
680+ "platform_id": "aws",
681+ "region_id": "aws-us-east-2",
682+ "name": "winter-boat-259881",
683+ "provisioner": "k8s-pod",
684+ "pg_version": 15,
685+ "created_at": "2022-11-23T17:52:25Z",
686+ "updated_at": "2022-11-23T17:52:25Z",
687+ "proxy_host": "us-east-2.aws.neon.tech",
688+ "cpu_used_sec": 0,
689+ "branch_logical_size_limit": 0,
690+ "owner_id": "1232111",
691+ "creation_source": "console",
692+ "store_passwords": true,
693+ "branch_logical_size_limit_bytes": 10800,
694+ "active_time": 100
695+ }
696+ ]
697+ }
698+ }
699+ }
700+ },
701+ "default": {
702+ "$ref": "#/components/responses/GeneralError"
703+ }
704+ }
705+ }
706+ },
707+ "/projects/{project_id}": {
708+ "parameters": [
709+ {
710+ "name": "project_id",
711+ "in": "path",
712+ "description": "The Neon project ID",
713+ "required": true,
714+ "schema": {
715+ "type": "string",
716+ "pattern": "^[a-z0-9-]{1,60}$"
717+ }
718+ }
719+ ],
720+ "get": {
721+ "summary": "Retrieve project details",
722+ "description": "Retrieves information about the specified project.\nYou can obtain a `project_id` by listing the projects for an organization.\n",
723+ "tags": [
724+ "Project"
725+ ],
726+ "operationId": "getProject",
727+ "responses": {
728+ "200": {
729+ "description": "Returned information about the specified project",
730+ "content": {
731+ "application/json": {
732+ "schema": {
733+ "$ref": "#/components/schemas/ProjectResponse"
734+ },
735+ "example": {
736+ "project": {
737+ "id": "shiny-wind-028834",
738+ "platform_id": "aws",
739+ "region_id": "aws-us-east-2",
740+ "name": "shiny-wind-028834",
741+ "provisioner": "k8s-pod",
742+ "pg_version": 15,
743+ "history_retention_seconds": 604800,
744+ "created_at": "2022-11-23T17:42:25Z",
745+ "updated_at": "2022-11-23T17:42:25Z",
746+ "proxy_host": "us-east-2.aws.neon.tech",
747+ "branch_logical_size_limit": 0,
748+ "cpu_used_sec": 10,
749+ "owner_id": "1232111",
750+ "owner": {
751+ "name": "John Smith",
752+ "email": "some@email.com",
753+ "branches_limit": 10,
754+ "subscription_type": "scale"
755+ },
756+ "creation_source": "console",
757+ "store_passwords": true,
758+ "branch_logical_size_limit_bytes": 10500,
759+ "data_storage_bytes_hour": 1040,
760+ "data_transfer_bytes": 1000000,
761+ "written_data_bytes": 100800,
762+ "compute_time_seconds": 100,
763+ "active_time_seconds": 100,
764+ "consumption_period_start": "2023-02-01T00:00:00Z",
765+ "consumption_period_end": "2023-03-01T00:00:00Z"
766+ }
767+ }
768+ }
769+ }
770+ },
771+ "default": {
772+ "$ref": "#/components/responses/GeneralError"
773+ }
774+ }
775+ },
776+ "patch": {
777+ "summary": "Update project",
778+ "description": "Updates the specified project.\nYou can obtain a `project_id` by listing the projects for your Neon account.\n",
779+ "tags": [
780+ "Project"
781+ ],
782+ "operationId": "updateProject",
783+ "requestBody": {
784+ "required": true,
785+ "content": {
786+ "application/json": {
787+ "schema": {
788+ "$ref": "#/components/schemas/ProjectUpdateRequest"
789+ },
790+ "example": {
791+ "project": {
792+ "name": "myproject"
793+ }
794+ }
795+ }
796+ }
797+ },
798+ "responses": {
799+ "200": {
800+ "description": "Updated the specified project",
801+ "content": {
802+ "application/json": {
803+ "schema": {
804+ "allOf": [
805+ {
806+ "$ref": "#/components/schemas/ProjectResponse"
807+ },
808+ {
809+ "$ref": "#/components/schemas/OperationsResponse"
810+ }
811+ ]
812+ },
813+ "example": {
814+ "operations": [],
815+ "project": {
816+ "id": "shiny-wind-028834",
817+ "platform_id": "aws",
818+ "region_id": "aws-us-east-2",
819+ "name": "myproject",
820+ "provisioner": "k8s-pod",
821+ "pg_version": 15,
822+ "created_at": "2022-11-23T17:42:25Z",
823+ "updated_at": "2022-12-04T02:39:25Z",
824+ "proxy_host": "us-east-2.aws.neon.tech",
825+ "branch_logical_size_limit": 0,
826+ "cpu_used_sec": 213230,
827+ "owner_id": "1232111",
828+ "creation_source": "console",
829+ "store_passwords": true,
830+ "branch_logical_size_limit_bytes": 10500,
831+ "data_storage_bytes_hour": 1040,
832+ "data_transfer_bytes": 1000000,
833+ "written_data_bytes": 100800,
834+ "compute_time_seconds": 100,
835+ "active_time_seconds": 100,
836+ "history_retention_seconds": 604800,
837+ "consumption_period_start": "2023-02-01T00:00:00Z",
838+ "consumption_period_end": "2023-03-01T00:00:00Z"
839+ }
840+ }
841+ }
842+ }
843+ },
844+ "default": {
845+ "$ref": "#/components/responses/GeneralError"
846+ }
847+ }
848+ },
849+ "delete": {
850+ "summary": "Delete project",
851+ "description": "Deletes the specified project.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nDeleting a project is a permanent action.\nDeleting a project also deletes endpoints, branches, databases, and users that belong to the project.\n",
852+ "tags": [
853+ "Project"
854+ ],
855+ "operationId": "deleteProject",
856+ "responses": {
857+ "200": {
858+ "description": "Deleted the specified project",
859+ "content": {
860+ "application/json": {
861+ "schema": {
862+ "$ref": "#/components/schemas/ProjectResponse"
863+ },
864+ "example": {
865+ "project": {
866+ "id": "bold-cloud-468218",
867+ "platform_id": "aws",
868+ "region_id": "aws-us-east-2",
869+ "name": "bold-cloud-468218",
870+ "provisioner": "k8s-pod",
871+ "pg_version": 15,
872+ "created_at": "2022-11-30T18:41:29Z",
873+ "updated_at": "2022-11-30T18:41:29Z",
874+ "proxy_host": "us-east-2.aws.neon.tech",
875+ "cpu_used_sec": 23004200,
876+ "branch_logical_size_limit": 0,
877+ "owner_id": "1232111",
878+ "creation_source": "console",
879+ "store_passwords": true,
880+ "branch_logical_size_limit_bytes": 10500,
881+ "data_storage_bytes_hour": 1040,
882+ "data_transfer_bytes": 1000000,
883+ "written_data_bytes": 100800,
884+ "compute_time_seconds": 100,
885+ "active_time_seconds": 100,
886+ "history_retention_seconds": 604800,
887+ "consumption_period_start": "2023-02-01T00:00:00Z",
888+ "consumption_period_end": "2023-03-01T00:00:00Z"
889+ }
890+ }
891+ }
892+ }
893+ },
894+ "default": {
895+ "$ref": "#/components/responses/GeneralError"
896+ }
897+ }
898+ }
899+ },
900+ "/projects/{project_id}/restore": {
901+ "parameters": [
902+ {
903+ "name": "project_id",
904+ "in": "path",
905+ "description": "The Neon project ID",
906+ "required": true,
907+ "schema": {
908+ "type": "string",
909+ "pattern": "^[a-z0-9-]{1,60}$"
910+ }
911+ }
912+ ],
913+ "post": {
914+ "summary": "Restore a deleted project",
915+ "description": "DEPRECATED, use `/projects/{project_id}/recover` instead. Restores a deleted project during the deletion grace period.\nYou can obtain a `project_id` by listing the projects for your Neon account.\n",
916+ "tags": [
917+ "Project"
918+ ],
919+ "operationId": "restoreProject",
920+ "deprecated": true,
921+ "x-stability-level": "beta",
922+ "x-sunset": "2026-02-06",
923+ "responses": {
924+ "200": {
925+ "description": "Returned the restored project",
926+ "content": {
927+ "application/json": {
928+ "schema": {
929+ "$ref": "#/components/schemas/ProjectRecoverResponse"
930+ }
931+ }
932+ }
933+ },
934+ "default": {
935+ "$ref": "#/components/responses/GeneralError"
936+ }
937+ }
938+ }
939+ },
940+ "/projects/{project_id}/recover": {
941+ "parameters": [
942+ {
943+ "name": "project_id",
944+ "in": "path",
945+ "description": "The Neon project ID",
946+ "required": true,
947+ "schema": {
948+ "type": "string",
949+ "pattern": "^[a-z0-9-]{1,60}$"
950+ }
951+ }
952+ ],
953+ "post": {
954+ "summary": "Recover a deleted project",
955+ "description": "Recovers a deleted project during the deletion grace period.\nYou can obtain a `project_id` by listing the projects for your Neon account.\n",
956+ "tags": [
957+ "Project"
958+ ],
959+ "operationId": "recoverProject",
960+ "x-stability-level": "beta",
961+ "responses": {
962+ "200": {
963+ "description": "Returned the recovered project",
964+ "content": {
965+ "application/json": {
966+ "schema": {
967+ "$ref": "#/components/schemas/ProjectRecoverResponse"
968+ }
969+ }
970+ }
971+ },
972+ "default": {
973+ "$ref": "#/components/responses/GeneralError"
974+ }
975+ }
976+ }
977+ },
978+ "/projects/{project_id}/operations": {
979+ "get": {
980+ "summary": "List operations",
981+ "description": "Retrieves a list of operations for the specified Neon project.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nThe number of operations returned can be large.\nTo paginate the response, issue an initial request with a `limit` value.\nThen, add the `cursor` value that was returned in the response to the next request.\nOperations older than 6 months may be deleted from our systems.\nIf you need more history than that, you should store your own history.\n",
982+ "tags": [
983+ "Operation"
984+ ],
985+ "operationId": "listProjectOperations",
986+ "parameters": [
987+ {
988+ "name": "cursor",
989+ "description": "Specify the cursor value from the previous response to get the next batch of operations",
990+ "in": "query",
991+ "schema": {
992+ "type": "string"
993+ }
994+ },
995+ {
996+ "name": "limit",
997+ "description": "Specify a value from 1 to 1000 to limit number of operations in the response",
998+ "in": "query",
999+ "schema": {
1000+ "type": "integer",
1001+ "minimum": 1,
1002+ "maximum": 1000
1003+ }
1004+ },
1005+ {
1006+ "name": "project_id",
1007+ "in": "path",
1008+ "description": "The Neon project ID",
1009+ "required": true,
1010+ "schema": {
1011+ "type": "string",
1012+ "pattern": "^[a-z0-9-]{1,60}$"
1013+ }
1014+ }
1015+ ],
1016+ "responses": {
1017+ "200": {
1018+ "$ref": "#/components/responses/ListOperations"
1019+ },
1020+ "default": {
1021+ "$ref": "#/components/responses/GeneralError"
1022+ }
1023+ }
1024+ }
1025+ },
1026+ "/projects/{project_id}/permissions": {
1027+ "parameters": [
1028+ {
1029+ "name": "project_id",
1030+ "in": "path",
1031+ "required": true,
1032+ "schema": {
1033+ "type": "string",
1034+ "pattern": "^[a-z0-9-]{1,60}$"
1035+ }
1036+ }
1037+ ],
1038+ "get": {
1039+ "summary": "List project access",
1040+ "description": "Retrieves details about users who have access to the project, including the permission `id`, the granted-to email address, and the date project access was granted.",
1041+ "tags": [
1042+ "Project"
1043+ ],
1044+ "operationId": "listProjectPermissions",
1045+ "responses": {
1046+ "200": {
1047+ "description": "Returned project access details",
1048+ "content": {
1049+ "application/json": {
1050+ "schema": {
1051+ "$ref": "#/components/schemas/ProjectPermissions"
1052+ }
1053+ }
1054+ }
1055+ },
1056+ "default": {
1057+ "$ref": "#/components/responses/GeneralError"
1058+ }
1059+ }
1060+ },
1061+ "post": {
1062+ "summary": "Grant project access",
1063+ "description": "Grants project access to the account associated with the specified email address",
1064+ "tags": [
1065+ "Project"
1066+ ],
1067+ "operationId": "grantPermissionToProject",
1068+ "requestBody": {
1069+ "content": {
1070+ "application/json": {
1071+ "schema": {
1072+ "$ref": "#/components/schemas/GrantPermissionToProjectRequest"
1073+ }
1074+ }
1075+ },
1076+ "required": true
1077+ },
1078+ "responses": {
1079+ "200": {
1080+ "description": "Granted project access",
1081+ "content": {
1082+ "application/json": {
1083+ "schema": {
1084+ "$ref": "#/components/schemas/ProjectPermission"
1085+ }
1086+ }
1087+ }
1088+ },
1089+ "default": {
1090+ "$ref": "#/components/responses/GeneralError"
1091+ }
1092+ }
1093+ }
1094+ },
1095+ "/projects/{project_id}/permissions/{permission_id}": {
1096+ "parameters": [
1097+ {
1098+ "name": "project_id",
1099+ "in": "path",
1100+ "required": true,
1101+ "schema": {
1102+ "type": "string",
1103+ "pattern": "^[a-z0-9-]{1,60}$"
1104+ }
1105+ },
1106+ {
1107+ "name": "permission_id",
1108+ "in": "path",
1109+ "required": true,
1110+ "schema": {
1111+ "type": "string"
1112+ }
1113+ }
1114+ ],
1115+ "delete": {
1116+ "summary": "Revoke project access",
1117+ "description": "Revokes project access from the user associated with the specified permission `id`. You can retrieve a user's permission `id` by listing project access.",
1118+ "tags": [
1119+ "Project"
1120+ ],
1121+ "operationId": "revokePermissionFromProject",
1122+ "responses": {
1123+ "200": {
1124+ "description": "Revoked project access",
1125+ "content": {
1126+ "application/json": {
1127+ "schema": {
1128+ "$ref": "#/components/schemas/ProjectPermission"
1129+ }
1130+ }
1131+ }
1132+ },
1133+ "default": {
1134+ "$ref": "#/components/responses/GeneralError"
1135+ }
1136+ }
1137+ }
1138+ },
1139+ "/projects/{project_id}/available_preload_libraries": {
1140+ "get": {
1141+ "summary": "Return available shared preload libraries",
1142+ "description": "Return available shared preload libraries",
1143+ "tags": [
1144+ "Project"
1145+ ],
1146+ "operationId": "getAvailablePreloadLibraries",
1147+ "parameters": [
1148+ {
1149+ "name": "project_id",
1150+ "in": "path",
1151+ "required": true,
1152+ "schema": {
1153+ "type": "string",
1154+ "pattern": "^[a-z0-9-]{1,60}$"
1155+ }
1156+ }
1157+ ],
1158+ "responses": {
1159+ "200": {
1160+ "description": "Successfully returned available shared preload libraries",
1161+ "content": {
1162+ "application/json": {
1163+ "schema": {
1164+ "$ref": "#/components/schemas/AvailablePreloadLibraries"
1165+ }
1166+ }
1167+ }
1168+ },
1169+ "default": {
1170+ "$ref": "#/components/responses/GeneralError"
1171+ }
1172+ }
1173+ }
1174+ },
1175+ "/projects/{project_id}/transfer_requests": {
1176+ "parameters": [
1177+ {
1178+ "name": "project_id",
1179+ "in": "path",
1180+ "description": "The Neon project ID",
1181+ "required": true,
1182+ "schema": {
1183+ "type": "string",
1184+ "pattern": "^[a-z0-9-]{1,60}$"
1185+ }
1186+ }
1187+ ],
1188+ "post": {
1189+ "summary": "Create a project transfer request",
1190+ "description": "Creates a transfer request for the specified project. A transfer request allows\nthe project to be transferred to another account or organization. The request\nhas an expiration time after which it can no longer be used. To accept/claim\nthe transfer request, the recipient user/organization must call the\n`/projects/{project_id}/transfer_requests/{request_id}` API endpoint, or visit\n`https://console.neon.tech/app/claim?p={project_id}&tr={request_id}&ru={redirect_url}`\nin the Neon Console. The `ru` parameter is optional and can be used to redirect\nthe user after accepting the transfer request.\n",
1191+ "tags": [
1192+ "Project"
1193+ ],
1194+ "operationId": "createProjectTransferRequest",
1195+ "requestBody": {
1196+ "content": {
1197+ "application/json": {
1198+ "schema": {
1199+ "type": "object",
1200+ "properties": {
1201+ "ttl_seconds": {
1202+ "type": "integer",
1203+ "format": "int64",
1204+ "description": "Specifies the validity duration of the transfer request in seconds. If not provided,\nthe request will expire after 24 hours (86,400 seconds).\n"
1205+ }
1206+ }
1207+ }
1208+ }
1209+ }
1210+ },
1211+ "responses": {
1212+ "201": {
1213+ "description": "Project transfer request created successfully",
1214+ "content": {
1215+ "application/json": {
1216+ "schema": {
1217+ "$ref": "#/components/schemas/ProjectTransferRequestResponse"
1218+ }
1219+ }
1220+ }
1221+ },
1222+ "default": {
1223+ "$ref": "#/components/responses/GeneralError"
1224+ }
1225+ }
1226+ }
1227+ },
1228+ "/projects/{project_id}/transfer_requests/{request_id}": {
1229+ "parameters": [
1230+ {
1231+ "name": "project_id",
1232+ "in": "path",
1233+ "description": "The Neon project ID",
1234+ "required": true,
1235+ "schema": {
1236+ "type": "string",
1237+ "pattern": "^[a-z0-9-]{1,60}$"
1238+ }
1239+ },
1240+ {
1241+ "name": "request_id",
1242+ "in": "path",
1243+ "description": "The Neon project transfer request ID",
1244+ "required": true,
1245+ "schema": {
1246+ "type": "string",
1247+ "pattern": "^[a-z0-9-]{1,60}$"
1248+ }
1249+ }
1250+ ],
1251+ "put": {
1252+ "summary": "Accept a project transfer request",
1253+ "description": "Accepts a transfer request for the specified project, transferring it to the specified organization\nor user. If org_id is not passed, the project will be transferred to the current user or organization account.\n",
1254+ "tags": [
1255+ "Project"
1256+ ],
1257+ "operationId": "acceptProjectTransferRequest",
1258+ "requestBody": {
1259+ "content": {
1260+ "application/json": {
1261+ "schema": {
1262+ "type": "object",
1263+ "properties": {
1264+ "org_id": {
1265+ "description": "The Neon organization ID to transfer the project to. If not provided, the project will be\ntransferred to the current user or organization account.\n",
1266+ "type": "string",
1267+ "pattern": "^[a-z0-9-]{1,60}$"
1268+ }
1269+ }
1270+ }
1271+ }
1272+ }
1273+ },
1274+ "responses": {
1275+ "204": {
1276+ "description": "Project transfer request accepted successfully"
1277+ },
1278+ "406": {
1279+ "description": "Account doesn't satisfy the plan requirements to own the project",
1280+ "content": {
1281+ "application/json": {
1282+ "schema": {
1283+ "$ref": "#/components/schemas/AcceptProjectTransferRequestSatisfiesPlanError"
1284+ }
1285+ }
1286+ }
1287+ },
1288+ "default": {
1289+ "$ref": "#/components/responses/GeneralError"
1290+ }
1291+ }
1292+ }
1293+ },
1294+ "/projects/{project_id}/jwks": {
1295+ "parameters": [
1296+ {
1297+ "name": "project_id",
1298+ "in": "path",
1299+ "description": "The Neon project ID",
1300+ "required": true,
1301+ "schema": {
1302+ "type": "string",
1303+ "pattern": "^[a-z0-9-]{1,60}$"
1304+ }
1305+ }
1306+ ],
1307+ "get": {
1308+ "summary": "List JWKS URLs",
1309+ "description": "Returns the JWKS URLs available for verifying JWTs used as the authentication mechanism for the specified project.\n",
1310+ "tags": [
1311+ "Project"
1312+ ],
1313+ "operationId": "getProjectJWKS",
1314+ "responses": {
1315+ "200": {
1316+ "description": "The JWKS URLs available for the project",
1317+ "content": {
1318+ "application/json": {
1319+ "schema": {
1320+ "$ref": "#/components/schemas/ProjectJWKSResponse"
1321+ }
1322+ }
1323+ }
1324+ },
1325+ "default": {
1326+ "$ref": "#/components/responses/GeneralError"
1327+ }
1328+ }
1329+ },
1330+ "post": {
1331+ "summary": "Add JWKS URL",
1332+ "description": "Add a new JWKS URL to a project, such that it can be used for verifying JWTs used as the authentication mechanism for the specified project.\n\nThe URL must be a valid HTTPS URL that returns a JSON Web Key Set.\n\nThe `provider_name` field allows you to specify which authentication provider you're using (e.g., Clerk, Auth0, AWS Cognito, etc.).\n\nThe `branch_id` can be used to specify on which branches the JWKS URL will be accepted. If not specified, then it will work on any branch.\n\nThe `role_names` can be used to specify for which roles the JWKS URL will be accepted. If not specified, then default roles will be used (authenticator, authenticated and anonymous).\n\nThe `jwt_audience` can be used to specify which \"aud\" values should be accepted by Neon in the JWTs that are used for authentication.\n",
1333+ "tags": [
1334+ "Project"
1335+ ],
1336+ "operationId": "addProjectJWKS",
1337+ "requestBody": {
1338+ "required": true,
1339+ "content": {
1340+ "application/json": {
1341+ "schema": {
1342+ "$ref": "#/components/schemas/AddProjectJWKSRequest"
1343+ }
1344+ }
1345+ }
1346+ },
1347+ "responses": {
1348+ "201": {
1349+ "description": "The JWKS URL was added to the project's authentication connections",
1350+ "content": {
1351+ "application/json": {
1352+ "schema": {
1353+ "$ref": "#/components/schemas/JWKSCreationOperation"
1354+ }
1355+ }
1356+ }
1357+ },
1358+ "default": {
1359+ "$ref": "#/components/responses/GeneralError"
1360+ }
1361+ }
1362+ }
1363+ },
1364+ "/projects/{project_id}/jwks/{jwks_id}": {
1365+ "parameters": [
1366+ {
1367+ "name": "project_id",
1368+ "in": "path",
1369+ "description": "The Neon project ID",
1370+ "required": true,
1371+ "schema": {
1372+ "type": "string",
1373+ "pattern": "^[a-z0-9-]{1,60}$"
1374+ }
1375+ },
1376+ {
1377+ "name": "jwks_id",
1378+ "in": "path",
1379+ "description": "The JWKS ID",
1380+ "required": true,
1381+ "schema": {
1382+ "type": "string"
1383+ }
1384+ }
1385+ ],
1386+ "delete": {
1387+ "summary": "Delete JWKS URL",
1388+ "description": "Deletes a JWKS URL from the specified project",
1389+ "tags": [
1390+ "Project"
1391+ ],
1392+ "operationId": "deleteProjectJWKS",
1393+ "responses": {
1394+ "200": {
1395+ "description": "Deleted a JWKS URL from the project",
1396+ "content": {
1397+ "application/json": {
1398+ "schema": {
1399+ "$ref": "#/components/schemas/JWKS"
1400+ }
1401+ }
1402+ }
1403+ },
1404+ "default": {
1405+ "$ref": "#/components/responses/GeneralError"
1406+ }
1407+ }
1408+ }
1409+ },
1410+ "/projects/{project_id}/branches/{branch_id}/data-api/{database_name}": {
1411+ "parameters": [
1412+ {
1413+ "name": "project_id",
1414+ "in": "path",
1415+ "description": "The Neon project ID",
1416+ "required": true,
1417+ "schema": {
1418+ "type": "string",
1419+ "pattern": "^[a-z0-9-]{1,60}$"
1420+ }
1421+ },
1422+ {
1423+ "name": "branch_id",
1424+ "in": "path",
1425+ "description": "The Neon branch ID",
1426+ "required": true,
1427+ "schema": {
1428+ "type": "string",
1429+ "pattern": "^[a-z0-9-]{1,60}$"
1430+ }
1431+ },
1432+ {
1433+ "name": "database_name",
1434+ "in": "path",
1435+ "description": "The database name",
1436+ "required": true,
1437+ "schema": {
1438+ "type": "string"
1439+ }
1440+ }
1441+ ],
1442+ "post": {
1443+ "summary": "Create Neon Data API",
1444+ "description": "Creates a new instance of Neon Data API in the specified branch.\nYou can obtain the `project_id` and `branch_id` by listing the projects and branches for your Neon account.\n",
1445+ "tags": [
1446+ "DataAPI"
1447+ ],
1448+ "operationId": "createProjectBranchDataAPI",
1449+ "requestBody": {
1450+ "content": {
1451+ "application/json": {
1452+ "schema": {
1453+ "$ref": "#/components/schemas/DataAPICreateRequest"
1454+ }
1455+ }
1456+ }
1457+ },
1458+ "responses": {
1459+ "201": {
1460+ "description": "Creates a new app",
1461+ "content": {
1462+ "application/json": {
1463+ "schema": {
1464+ "$ref": "#/components/schemas/DataAPICreateResponse"
1465+ }
1466+ }
1467+ }
1468+ },
1469+ "default": {
1470+ "$ref": "#/components/responses/GeneralError"
1471+ }
1472+ }
1473+ },
1474+ "patch": {
1475+ "summary": "Update Neon Data API",
1476+ "description": "Updates the Neon Data API configuration for the specified branch.\nYou can optionally provide settings to update the Data API configuration.\nThe schema cache is always refreshed as part of this operation.\nYou can obtain the `project_id` and `branch_id` by listing the projects and branches for your Neon account.\n",
1477+ "tags": [
1478+ "DataAPI"
1479+ ],
1480+ "operationId": "updateProjectBranchDataAPI",
1481+ "requestBody": {
1482+ "content": {
1483+ "application/json": {
1484+ "schema": {
1485+ "$ref": "#/components/schemas/DataAPIUpdateRequest"
1486+ }
1487+ }
1488+ }
1489+ },
1490+ "responses": {
1491+ "201": {
1492+ "description": "Updated the Neon Data API configuration and refreshed the schema cache",
1493+ "content": {
1494+ "application/json": {
1495+ "schema": {
1496+ "$ref": "#/components/schemas/EmptyResponse"
1497+ }
1498+ }
1499+ }
1500+ },
1501+ "default": {
1502+ "$ref": "#/components/responses/GeneralError"
1503+ }
1504+ }
1505+ },
1506+ "delete": {
1507+ "summary": "Delete Neon Data API",
1508+ "description": "Deletes the Neon Data API for the specified branch.\nYou can obtain the `project_id` and `branch_id` by listing the projects and branches for your Neon account.\n",
1509+ "tags": [
1510+ "DataAPI"
1511+ ],
1512+ "operationId": "deleteProjectBranchDataAPI",
1513+ "responses": {
1514+ "200": {
1515+ "description": "Deleted the Neon Data API for the specified branch",
1516+ "content": {
1517+ "application/json": {
1518+ "schema": {
1519+ "$ref": "#/components/schemas/EmptyResponse"
1520+ }
1521+ }
1522+ }
1523+ },
1524+ "default": {
1525+ "$ref": "#/components/responses/GeneralError"
1526+ }
1527+ }
1528+ },
1529+ "get": {
1530+ "summary": "Get Neon Data API",
1531+ "description": "Retrieves the Neon Data API for the specified branch.\n",
1532+ "tags": [
1533+ "DataAPI"
1534+ ],
1535+ "operationId": "getProjectBranchDataAPI",
1536+ "responses": {
1537+ "200": {
1538+ "description": "Returns the Neon Data API for the specified branch",
1539+ "content": {
1540+ "application/json": {
1541+ "schema": {
1542+ "$ref": "#/components/schemas/DataAPIReponse"
1543+ }
1544+ }
1545+ }
1546+ },
1547+ "default": {
1548+ "$ref": "#/components/responses/GeneralError"
1549+ }
1550+ }
1551+ }
1552+ },
1553+ "/projects/auth/create": {
1554+ "post": {
1555+ "summary": "Create Neon Auth integration",
1556+ "description": "DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth` instead. Creates a project on a third-party authentication provider's platform for use with Neon Auth.\nUse this endpoint if the frontend integration flow can't be used.\n",
1557+ "tags": [
1558+ "Auth (legacy)"
1559+ ],
1560+ "operationId": "createNeonAuthIntegration",
1561+ "deprecated": true,
1562+ "x-sunset": "2026-03-01",
1563+ "requestBody": {
1564+ "content": {
1565+ "application/json": {
1566+ "schema": {
1567+ "$ref": "#/components/schemas/NeonAuthCreateIntegrationRequest"
1568+ }
1569+ }
1570+ },
1571+ "required": true
1572+ },
1573+ "responses": {
1574+ "201": {
1575+ "description": "Creates Neon Auth integration",
1576+ "content": {
1577+ "application/json": {
1578+ "schema": {
1579+ "$ref": "#/components/schemas/NeonAuthCreateIntegrationResponse"
1580+ }
1581+ }
1582+ }
1583+ },
1584+ "default": {
1585+ "$ref": "#/components/responses/GeneralError"
1586+ }
1587+ }
1588+ }
1589+ },
1590+ "/projects/{project_id}/branches/{branch_id}/auth": {
1591+ "parameters": [
1592+ {
1593+ "name": "project_id",
1594+ "in": "path",
1595+ "description": "The Neon project ID",
1596+ "required": true,
1597+ "schema": {
1598+ "type": "string",
1599+ "pattern": "^[a-z0-9-]{1,60}$"
1600+ }
1601+ },
1602+ {
1603+ "name": "branch_id",
1604+ "in": "path",
1605+ "description": "The Neon branch ID",
1606+ "required": true,
1607+ "schema": {
1608+ "type": "string",
1609+ "pattern": "^[a-z0-9-]{1,60}$"
1610+ }
1611+ }
1612+ ],
1613+ "get": {
1614+ "summary": "Get details of Neon Auth for the branch",
1615+ "description": "/ Fetches the details of the Neon Auth for the specified branch. You can obtain the `project_id` and `branch_id` by listing the projects and branches for your Neon account.",
1616+ "tags": [
1617+ "Auth"
1618+ ],
1619+ "x-stability-level": "beta",
1620+ "operationId": "getNeonAuth",
1621+ "responses": {
1622+ "200": {
1623+ "description": "Fetched the details of the Neon Auth integration for the specified branch",
1624+ "content": {
1625+ "application/json": {
1626+ "schema": {
1627+ "$ref": "#/components/schemas/NeonAuthIntegration"
1628+ }
1629+ }
1630+ }
1631+ },
1632+ "default": {
1633+ "$ref": "#/components/responses/GeneralError"
1634+ }
1635+ }
1636+ },
1637+ "post": {
1638+ "summary": "Enable Neon Auth for the branch",
1639+ "description": "Enables Neon Auth integrationfor the branch.\nYou can obtain the `project_id` and `branch_id` by listing the projects and branches for your Neon account.\n",
1640+ "tags": [
1641+ "Auth"
1642+ ],
1643+ "x-stability-level": "beta",
1644+ "operationId": "createNeonAuth",
1645+ "requestBody": {
1646+ "content": {
1647+ "application/json": {
1648+ "schema": {
1649+ "$ref": "#/components/schemas/EnableNeonAuthIntegrationRequest"
1650+ }
1651+ }
1652+ },
1653+ "required": true
1654+ },
1655+ "responses": {
1656+ "201": {
1657+ "description": "Enables Neon Auth integration for the branch",
1658+ "content": {
1659+ "application/json": {
1660+ "schema": {
1661+ "$ref": "#/components/schemas/NeonAuthCreateIntegrationResponse"
1662+ }
1663+ }
1664+ }
1665+ },
1666+ "default": {
1667+ "$ref": "#/components/responses/GeneralError"
1668+ }
1669+ }
1670+ },
1671+ "delete": {
1672+ "summary": "Disables Neon Auth for the branch",
1673+ "tags": [
1674+ "Auth"
1675+ ],
1676+ "x-stability-level": "beta",
1677+ "operationId": "disableNeonAuth",
1678+ "requestBody": {
1679+ "content": {
1680+ "application/json": {
1681+ "schema": {
1682+ "type": "object",
1683+ "properties": {
1684+ "delete_data": {
1685+ "type": "boolean",
1686+ "description": "If true, deletes the `neon_auth` schema from the database",
1687+ "default": false
1688+ }
1689+ }
1690+ }
1691+ }
1692+ }
1693+ },
1694+ "responses": {
1695+ "200": {
1696+ "description": "Delete the integration with the authentication provider"
1697+ },
1698+ "default": {
1699+ "$ref": "#/components/responses/GeneralError"
1700+ }
1701+ }
1702+ }
1703+ },
1704+ "/projects/{project_id}/auth/domains": {
1705+ "parameters": [
1706+ {
1707+ "name": "project_id",
1708+ "in": "path",
1709+ "description": "The Neon project ID",
1710+ "required": true,
1711+ "schema": {
1712+ "type": "string",
1713+ "pattern": "^[a-z0-9-]{1,60}$"
1714+ }
1715+ }
1716+ ],
1717+ "get": {
1718+ "summary": "List domains in redirect_uri whitelist",
1719+ "description": "DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/domains` instead. Lists the domains in the redirect_uri whitelist for the specified project.\n",
1720+ "tags": [
1721+ "Auth (legacy)"
1722+ ],
1723+ "deprecated": true,
1724+ "x-sunset": "2026-03-01",
1725+ "operationId": "listNeonAuthRedirectURIWhitelistDomains",
1726+ "responses": {
1727+ "200": {
1728+ "description": "Returned the domains in the redirect_uri whitelist",
1729+ "content": {
1730+ "application/json": {
1731+ "schema": {
1732+ "$ref": "#/components/schemas/NeonAuthRedirectURIWhitelistResponse"
1733+ }
1734+ }
1735+ }
1736+ },
1737+ "default": {
1738+ "$ref": "#/components/responses/GeneralError"
1739+ }
1740+ }
1741+ },
1742+ "post": {
1743+ "summary": "Add domain to redirect_uri whitelist",
1744+ "description": "DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/domains` instead. Adds a domain to the redirect_uri whitelist for the specified project.\n",
1745+ "tags": [
1746+ "Auth (legacy)"
1747+ ],
1748+ "deprecated": true,
1749+ "x-sunset": "2026-03-01",
1750+ "operationId": "addNeonAuthDomainToRedirectURIWhitelist",
1751+ "requestBody": {
1752+ "content": {
1753+ "application/json": {
1754+ "schema": {
1755+ "$ref": "#/components/schemas/NeonAuthAddDomainToRedirectURIWhitelistRequest"
1756+ }
1757+ }
1758+ },
1759+ "required": true
1760+ },
1761+ "responses": {
1762+ "201": {
1763+ "description": "Added the domain to the redirect_uri whitelist"
1764+ },
1765+ "default": {
1766+ "$ref": "#/components/responses/GeneralError"
1767+ }
1768+ }
1769+ },
1770+ "delete": {
1771+ "summary": "Delete domain from redirect_uri whitelist",
1772+ "description": "DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/domains` instead. Deletes a domain from the redirect_uri whitelist for the specified project.\n",
1773+ "tags": [
1774+ "Auth (legacy)"
1775+ ],
1776+ "deprecated": true,
1777+ "x-sunset": "2026-03-01",
1778+ "operationId": "deleteNeonAuthDomainFromRedirectURIWhitelist",
1779+ "requestBody": {
1780+ "content": {
1781+ "application/json": {
1782+ "schema": {
1783+ "$ref": "#/components/schemas/NeonAuthDeleteDomainFromRedirectURIWhitelistRequest"
1784+ }
1785+ }
1786+ },
1787+ "required": true
1788+ },
1789+ "responses": {
1790+ "200": {
1791+ "description": "Deleted the domain from the redirect_uri whitelist"
1792+ },
1793+ "default": {
1794+ "$ref": "#/components/responses/GeneralError"
1795+ }
1796+ }
1797+ }
1798+ },
1799+ "/projects/{project_id}/branches/{branch_id}/auth/domains": {
1800+ "parameters": [
1801+ {
1802+ "name": "project_id",
1803+ "in": "path",
1804+ "description": "The Neon project ID",
1805+ "required": true,
1806+ "schema": {
1807+ "type": "string",
1808+ "pattern": "^[a-z0-9-]{1,60}$"
1809+ }
1810+ },
1811+ {
1812+ "name": "branch_id",
1813+ "in": "path",
1814+ "description": "The Neon branch ID",
1815+ "required": true,
1816+ "schema": {
1817+ "type": "string",
1818+ "pattern": "^[a-z0-9-]{1,60}$"
1819+ }
1820+ }
1821+ ],
1822+ "get": {
1823+ "summary": "List domains in redirect_uri whitelist",
1824+ "description": "Lists the domains in the redirect_uri whitelist for the specified project.\n",
1825+ "tags": [
1826+ "Auth"
1827+ ],
1828+ "x-stability-level": "beta",
1829+ "operationId": "listBranchNeonAuthTrustedDomains",
1830+ "responses": {
1831+ "200": {
1832+ "description": "Returned the domains in the redirect_uri whitelist",
1833+ "content": {
1834+ "application/json": {
1835+ "schema": {
1836+ "$ref": "#/components/schemas/NeonAuthRedirectURIWhitelistResponse"
1837+ }
1838+ }
1839+ }
1840+ },
1841+ "default": {
1842+ "$ref": "#/components/responses/GeneralError"
1843+ }
1844+ }
1845+ },
1846+ "post": {
1847+ "summary": "Add domain to redirect_uri whitelist",
1848+ "description": "Adds a domain to the redirect_uri whitelist for the specified project.\n",
1849+ "tags": [
1850+ "Auth"
1851+ ],
1852+ "x-stability-level": "beta",
1853+ "operationId": "addBranchNeonAuthTrustedDomain",
1854+ "requestBody": {
1855+ "content": {
1856+ "application/json": {
1857+ "schema": {
1858+ "$ref": "#/components/schemas/NeonAuthAddDomainToRedirectURIWhitelistRequest"
1859+ }
1860+ }
1861+ },
1862+ "required": true
1863+ },
1864+ "responses": {
1865+ "201": {
1866+ "description": "Added the domain to the redirect_uri whitelist"
1867+ },
1868+ "default": {
1869+ "$ref": "#/components/responses/GeneralError"
1870+ }
1871+ }
1872+ },
1873+ "delete": {
1874+ "summary": "Delete domain from redirect_uri whitelist",
1875+ "description": "Deletes a domain from the redirect_uri whitelist for the specified project.\n",
1876+ "tags": [
1877+ "Auth"
1878+ ],
1879+ "x-stability-level": "beta",
1880+ "operationId": "deleteBranchNeonAuthTrustedDomain",
1881+ "requestBody": {
1882+ "content": {
1883+ "application/json": {
1884+ "schema": {
1885+ "$ref": "#/components/schemas/NeonAuthDeleteDomainFromRedirectURIWhitelistRequest"
1886+ }
1887+ }
1888+ },
1889+ "required": true
1890+ },
1891+ "responses": {
1892+ "200": {
1893+ "description": "Deleted the domain from the redirect_uri whitelist"
1894+ },
1895+ "default": {
1896+ "$ref": "#/components/responses/GeneralError"
1897+ }
1898+ }
1899+ }
1900+ },
1901+ "/projects/auth/keys": {
1902+ "post": {
1903+ "summary": "Create Auth Provider SDK keys",
1904+ "description": "Generates SDK or API Keys for the auth provider. These might be called different things depending\non the auth provider you're using, but are generally used for setting up the frontend and backend SDKs.\n",
1905+ "tags": [
1906+ "Auth (legacy)"
1907+ ],
1908+ "operationId": "createNeonAuthProviderSDKKeys",
1909+ "requestBody": {
1910+ "content": {
1911+ "application/json": {
1912+ "schema": {
1913+ "$ref": "#/components/schemas/NeonAuthCreateAuthProviderSDKKeysRequest"
1914+ }
1915+ }
1916+ },
1917+ "required": true
1918+ },
1919+ "responses": {
1920+ "201": {
1921+ "description": "Creates Auth Provider SDK keys",
1922+ "content": {
1923+ "application/json": {
1924+ "schema": {
1925+ "$ref": "#/components/schemas/NeonAuthCreateIntegrationResponse"
1926+ }
1927+ }
1928+ }
1929+ },
1930+ "default": {
1931+ "$ref": "#/components/responses/GeneralError"
1932+ }
1933+ }
1934+ }
1935+ },
1936+ "/projects/auth/user": {
1937+ "post": {
1938+ "summary": "Create new auth user",
1939+ "description": "DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/users` instead. Creates a new user in Neon Auth.\nThe user will be created in your neon_auth.users_sync table and automatically propagated to your auth project, whether Neon-managed or provider-owned.\n",
1940+ "tags": [
1941+ "Auth (legacy)"
1942+ ],
1943+ "deprecated": true,
1944+ "x-sunset": "2026-03-01",
1945+ "operationId": "createNeonAuthNewUser",
1946+ "requestBody": {
1947+ "content": {
1948+ "application/json": {
1949+ "schema": {
1950+ "$ref": "#/components/schemas/NeonAuthCreateNewUserRequest"
1951+ }
1952+ }
1953+ },
1954+ "required": true
1955+ },
1956+ "responses": {
1957+ "201": {
1958+ "description": "Creates new user",
1959+ "content": {
1960+ "application/json": {
1961+ "schema": {
1962+ "$ref": "#/components/schemas/NeonAuthCreateNewUserResponse"
1963+ }
1964+ }
1965+ }
1966+ },
1967+ "default": {
1968+ "$ref": "#/components/responses/GeneralError"
1969+ }
1970+ }
1971+ }
1972+ },
1973+ "/projects/{project_id}/branches/{branch_id}/auth/users": {
1974+ "parameters": [
1975+ {
1976+ "name": "project_id",
1977+ "in": "path",
1978+ "description": "The Neon project ID",
1979+ "required": true,
1980+ "schema": {
1981+ "type": "string",
1982+ "pattern": "^[a-z0-9-]{1,60}$"
1983+ }
1984+ },
1985+ {
1986+ "name": "branch_id",
1987+ "in": "path",
1988+ "description": "The Neon branch ID",
1989+ "required": true,
1990+ "schema": {
1991+ "type": "string",
1992+ "pattern": "^[a-z0-9-]{1,60}$"
1993+ }
1994+ }
1995+ ],
1996+ "post": {
1997+ "summary": "Create new auth user",
1998+ "description": "Creates a new user in Neon Auth.\n",
1999+ "tags": [
2000+ "Auth"
2001+ ],
2002+ "x-stability-level": "beta",
2003+ "operationId": "createBranchNeonAuthNewUser",
2004+ "requestBody": {
2005+ "content": {
2006+ "application/json": {
2007+ "schema": {
2008+ "$ref": "#/components/schemas/CreateBranchNeonAuthNewUserRequest"
2009+ }
2010+ }
2011+ },
2012+ "required": true
2013+ },
2014+ "responses": {
2015+ "201": {
2016+ "description": "Creates new user",
2017+ "content": {
2018+ "application/json": {
2019+ "schema": {
2020+ "$ref": "#/components/schemas/NeonAuthCreateNewUserResponse"
2021+ }
2022+ }
2023+ }
2024+ },
2025+ "default": {
2026+ "$ref": "#/components/responses/GeneralError"
2027+ }
2028+ }
2029+ }
2030+ },
2031+ "/projects/{project_id}/branches/{branch_id}/auth/users/{auth_user_id}": {
2032+ "parameters": [
2033+ {
2034+ "name": "project_id",
2035+ "in": "path",
2036+ "description": "The Neon project ID",
2037+ "required": true,
2038+ "schema": {
2039+ "type": "string",
2040+ "pattern": "^[a-z0-9-]{1,60}$"
2041+ }
2042+ },
2043+ {
2044+ "name": "branch_id",
2045+ "in": "path",
2046+ "description": "The Neon branch ID",
2047+ "required": true,
2048+ "schema": {
2049+ "type": "string",
2050+ "pattern": "^[a-z0-9-]{1,60}$"
2051+ }
2052+ },
2053+ {
2054+ "name": "auth_user_id",
2055+ "in": "path",
2056+ "description": "The Neon user ID",
2057+ "required": true,
2058+ "schema": {
2059+ "type": "string"
2060+ }
2061+ }
2062+ ],
2063+ "delete": {
2064+ "summary": "Delete auth user",
2065+ "description": "Deletes the auth user for the specified project.\n",
2066+ "tags": [
2067+ "Auth"
2068+ ],
2069+ "x-stability-level": "beta",
2070+ "operationId": "deleteBranchNeonAuthUser",
2071+ "responses": {
2072+ "204": {
2073+ "description": "Deleted the auth user"
2074+ },
2075+ "default": {
2076+ "$ref": "#/components/responses/GeneralError"
2077+ }
2078+ }
2079+ }
2080+ },
2081+ "/projects/{project_id}/branches/{branch_id}/auth/users/{auth_user_id}/role": {
2082+ "parameters": [
2083+ {
2084+ "name": "project_id",
2085+ "in": "path",
2086+ "description": "The Neon project ID",
2087+ "required": true,
2088+ "schema": {
2089+ "type": "string",
2090+ "pattern": "^[a-z0-9-]{1,60}$"
2091+ }
2092+ },
2093+ {
2094+ "name": "branch_id",
2095+ "in": "path",
2096+ "description": "The Neon branch ID",
2097+ "required": true,
2098+ "schema": {
2099+ "type": "string",
2100+ "pattern": "^[a-z0-9-]{1,60}$"
2101+ }
2102+ },
2103+ {
2104+ "name": "auth_user_id",
2105+ "in": "path",
2106+ "description": "The Neon user ID",
2107+ "required": true,
2108+ "schema": {
2109+ "type": "string"
2110+ }
2111+ }
2112+ ],
2113+ "put": {
2114+ "summary": "Update auth user role",
2115+ "description": "Updates the role of an auth user for the specified project.\n",
2116+ "tags": [
2117+ "Auth"
2118+ ],
2119+ "operationId": "updateNeonAuthUserRole",
2120+ "requestBody": {
2121+ "content": {
2122+ "application/json": {
2123+ "schema": {
2124+ "$ref": "#/components/schemas/UpdateNeonAuthUserRoleRequest"
2125+ }
2126+ }
2127+ },
2128+ "required": true
2129+ },
2130+ "responses": {
2131+ "200": {
2132+ "description": "Updated the auth user role",
2133+ "content": {
2134+ "application/json": {
2135+ "schema": {
2136+ "$ref": "#/components/schemas/UpdateNeonAuthUserRoleResponse"
2137+ }
2138+ }
2139+ }
2140+ },
2141+ "default": {
2142+ "$ref": "#/components/responses/GeneralError"
2143+ }
2144+ }
2145+ }
2146+ },
2147+ "/projects/{project_id}/auth/users/{auth_user_id}": {
2148+ "delete": {
2149+ "summary": "Delete auth user",
2150+ "description": "DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/users/{auth_user_id}` instead. Deletes the auth user for the specified project.\n",
2151+ "tags": [
2152+ "Auth (legacy)"
2153+ ],
2154+ "deprecated": true,
2155+ "x-sunset": "2026-03-01",
2156+ "operationId": "deleteNeonAuthUser",
2157+ "parameters": [
2158+ {
2159+ "name": "project_id",
2160+ "in": "path",
2161+ "description": "The Neon project ID",
2162+ "required": true,
2163+ "schema": {
2164+ "type": "string",
2165+ "pattern": "^[a-z0-9-]{1,60}$"
2166+ }
2167+ },
2168+ {
2169+ "name": "auth_user_id",
2170+ "in": "path",
2171+ "description": "The Neon user ID",
2172+ "required": true,
2173+ "schema": {
2174+ "type": "string"
2175+ }
2176+ }
2177+ ],
2178+ "responses": {
2179+ "204": {
2180+ "description": "Deleted the auth user"
2181+ },
2182+ "default": {
2183+ "$ref": "#/components/responses/GeneralError"
2184+ }
2185+ }
2186+ }
2187+ },
2188+ "/projects/auth/transfer_ownership": {
2189+ "post": {
2190+ "summary": "Transfer Neon-managed auth project to your own account",
2191+ "description": "Transfer ownership of your Neon-managed auth project to your own auth provider account.\n",
2192+ "tags": [
2193+ "Auth (legacy)"
2194+ ],
2195+ "operationId": "transferNeonAuthProviderProject",
2196+ "requestBody": {
2197+ "content": {
2198+ "application/json": {
2199+ "schema": {
2200+ "$ref": "#/components/schemas/NeonAuthTransferAuthProviderProjectRequest"
2201+ }
2202+ }
2203+ },
2204+ "required": true
2205+ },
2206+ "responses": {
2207+ "200": {
2208+ "description": "Transfer initiated. Follow the URL to complete the process in your auth provider's UI.",
2209+ "content": {
2210+ "application/json": {
2211+ "schema": {
2212+ "$ref": "#/components/schemas/NeonAuthTransferAuthProviderProjectResponse"
2213+ }
2214+ }
2215+ }
2216+ },
2217+ "default": {
2218+ "$ref": "#/components/responses/GeneralError"
2219+ }
2220+ }
2221+ }
2222+ },
2223+ "/projects/{project_id}/auth/integrations": {
2224+ "get": {
2225+ "summary": "Lists active integrations with auth providers",
2226+ "description": "DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth` instead.",
2227+ "tags": [
2228+ "Auth (legacy)"
2229+ ],
2230+ "operationId": "listNeonAuthIntegrations",
2231+ "deprecated": true,
2232+ "x-sunset": "2026-03-01",
2233+ "parameters": [
2234+ {
2235+ "name": "project_id",
2236+ "in": "path",
2237+ "description": "The Neon project ID",
2238+ "required": true,
2239+ "schema": {
2240+ "type": "string",
2241+ "pattern": "^[a-z0-9-]{1,60}$"
2242+ }
2243+ }
2244+ ],
2245+ "responses": {
2246+ "200": {
2247+ "description": "Return management API keys metadata",
2248+ "content": {
2249+ "application/json": {
2250+ "schema": {
2251+ "$ref": "#/components/schemas/ListNeonAuthIntegrationsResponse"
2252+ }
2253+ }
2254+ }
2255+ },
2256+ "default": {
2257+ "$ref": "#/components/responses/GeneralError"
2258+ }
2259+ }
2260+ }
2261+ },
2262+ "/projects/{project_id}/auth/oauth_providers": {
2263+ "parameters": [
2264+ {
2265+ "name": "project_id",
2266+ "in": "path",
2267+ "description": "The Neon project ID",
2268+ "required": true,
2269+ "schema": {
2270+ "type": "string",
2271+ "pattern": "^[a-z0-9-]{1,60}$"
2272+ }
2273+ }
2274+ ],
2275+ "get": {
2276+ "summary": "List OAuth providers",
2277+ "description": "DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/oauth_providers` instead. Lists the OAuth providers for the specified project.\n",
2278+ "tags": [
2279+ "Auth (legacy)"
2280+ ],
2281+ "deprecated": true,
2282+ "x-sunset": "2026-03-01",
2283+ "operationId": "listNeonAuthOauthProviders",
2284+ "responses": {
2285+ "200": {
2286+ "description": "Returns the OAuth providers for the Neon Auth",
2287+ "content": {
2288+ "application/json": {
2289+ "schema": {
2290+ "$ref": "#/components/schemas/ListNeonAuthOauthProvidersResponse"
2291+ }
2292+ }
2293+ }
2294+ },
2295+ "default": {
2296+ "$ref": "#/components/responses/GeneralError"
2297+ }
2298+ }
2299+ },
2300+ "post": {
2301+ "summary": "Add a OAuth provider",
2302+ "description": "DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/oauth_providers` instead. Adds a OAuth provider to the specified project.\n",
2303+ "tags": [
2304+ "Auth (legacy)"
2305+ ],
2306+ "deprecated": true,
2307+ "x-sunset": "2026-03-01",
2308+ "operationId": "addNeonAuthOauthProvider",
2309+ "requestBody": {
2310+ "content": {
2311+ "application/json": {
2312+ "schema": {
2313+ "$ref": "#/components/schemas/NeonAuthAddOAuthProviderRequest"
2314+ }
2315+ }
2316+ },
2317+ "required": true
2318+ },
2319+ "responses": {
2320+ "200": {
2321+ "description": "The OAuth provider has been added to the project",
2322+ "content": {
2323+ "application/json": {
2324+ "schema": {
2325+ "$ref": "#/components/schemas/NeonAuthOauthProvider"
2326+ }
2327+ }
2328+ }
2329+ },
2330+ "default": {
2331+ "$ref": "#/components/responses/GeneralError"
2332+ }
2333+ }
2334+ }
2335+ },
2336+ "/projects/{project_id}/branches/{branch_id}/auth/oauth_providers": {
2337+ "parameters": [
2338+ {
2339+ "name": "project_id",
2340+ "in": "path",
2341+ "description": "The Neon project ID",
2342+ "required": true,
2343+ "schema": {
2344+ "type": "string",
2345+ "pattern": "^[a-z0-9-]{1,60}$"
2346+ }
2347+ },
2348+ {
2349+ "name": "branch_id",
2350+ "in": "path",
2351+ "description": "The Neon branch ID",
2352+ "required": true,
2353+ "schema": {
2354+ "type": "string",
2355+ "pattern": "^[a-z0-9-]{1,60}$"
2356+ }
2357+ }
2358+ ],
2359+ "get": {
2360+ "summary": "List OAuth providers for neon auth for a branch",
2361+ "description": "Lists the OAuth providers for the specified project and branch.\n",
2362+ "tags": [
2363+ "Auth"
2364+ ],
2365+ "x-stability-level": "beta",
2366+ "operationId": "listBranchNeonAuthOauthProviders",
2367+ "responses": {
2368+ "200": {
2369+ "description": "Returns the OAuth providers for the Neon Auth",
2370+ "content": {
2371+ "application/json": {
2372+ "schema": {
2373+ "$ref": "#/components/schemas/ListNeonAuthOauthProvidersResponse"
2374+ }
2375+ }
2376+ }
2377+ },
2378+ "default": {
2379+ "$ref": "#/components/responses/GeneralError"
2380+ }
2381+ }
2382+ },
2383+ "post": {
2384+ "summary": "Add a OAuth provider",
2385+ "description": "Adds a OAuth provider to the specified project.\n",
2386+ "tags": [
2387+ "Auth"
2388+ ],
2389+ "x-stability-level": "beta",
2390+ "operationId": "addBranchNeonAuthOauthProvider",
2391+ "requestBody": {
2392+ "content": {
2393+ "application/json": {
2394+ "schema": {
2395+ "$ref": "#/components/schemas/NeonAuthAddOAuthProviderRequest"
2396+ }
2397+ }
2398+ },
2399+ "required": true
2400+ },
2401+ "responses": {
2402+ "200": {
2403+ "description": "The OAuth provider has been added to the project",
2404+ "content": {
2405+ "application/json": {
2406+ "schema": {
2407+ "$ref": "#/components/schemas/NeonAuthOauthProvider"
2408+ }
2409+ }
2410+ }
2411+ },
2412+ "default": {
2413+ "$ref": "#/components/responses/GeneralError"
2414+ }
2415+ }
2416+ }
2417+ },
2418+ "/projects/{project_id}/auth/oauth_providers/{oauth_provider_id}": {
2419+ "parameters": [
2420+ {
2421+ "name": "project_id",
2422+ "in": "path",
2423+ "description": "The Neon project ID",
2424+ "required": true,
2425+ "schema": {
2426+ "type": "string",
2427+ "pattern": "^[a-z0-9-]{1,60}$"
2428+ }
2429+ },
2430+ {
2431+ "name": "oauth_provider_id",
2432+ "in": "path",
2433+ "description": "The OAuth provider ID",
2434+ "required": true,
2435+ "schema": {
2436+ "$ref": "#/components/schemas/NeonAuthOauthProviderId"
2437+ }
2438+ }
2439+ ],
2440+ "patch": {
2441+ "summary": "Update OAuth provider",
2442+ "description": "DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/oauth_providers/{oauth_provider_id}` instead. Updates a OAuth provider for the specified project.\n",
2443+ "tags": [
2444+ "Auth (legacy)"
2445+ ],
2446+ "deprecated": true,
2447+ "x-sunset": "2026-03-01",
2448+ "operationId": "updateNeonAuthOauthProvider",
2449+ "requestBody": {
2450+ "content": {
2451+ "application/json": {
2452+ "schema": {
2453+ "$ref": "#/components/schemas/NeonAuthUpdateOAuthProviderRequest"
2454+ }
2455+ }
2456+ },
2457+ "required": true
2458+ },
2459+ "responses": {
2460+ "200": {
2461+ "description": "The OAuth provider has been added to the project",
2462+ "content": {
2463+ "application/json": {
2464+ "schema": {
2465+ "$ref": "#/components/schemas/NeonAuthOauthProvider"
2466+ }
2467+ }
2468+ }
2469+ },
2470+ "default": {
2471+ "$ref": "#/components/responses/GeneralError"
2472+ }
2473+ }
2474+ },
2475+ "delete": {
2476+ "summary": "Delete OAuth provider",
2477+ "description": "DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/oauth_providers/{oauth_provider_id}` instead. Deletes a OAuth provider from the specified project.\n",
2478+ "tags": [
2479+ "Auth (legacy)"
2480+ ],
2481+ "deprecated": true,
2482+ "x-sunset": "2026-03-01",
2483+ "operationId": "deleteNeonAuthOauthProvider",
2484+ "responses": {
2485+ "200": {
2486+ "description": "Deleted the OAuth provider from the project"
2487+ },
2488+ "default": {
2489+ "$ref": "#/components/responses/GeneralError"
2490+ }
2491+ }
2492+ }
2493+ },
2494+ "/projects/{project_id}/branches/{branch_id}/auth/oauth_providers/{oauth_provider_id}": {
2495+ "parameters": [
2496+ {
2497+ "name": "project_id",
2498+ "in": "path",
2499+ "description": "The Neon project ID",
2500+ "required": true,
2501+ "schema": {
2502+ "type": "string",
2503+ "pattern": "^[a-z0-9-]{1,60}$"
2504+ }
2505+ },
2506+ {
2507+ "name": "branch_id",
2508+ "in": "path",
2509+ "description": "The Neon branch ID",
2510+ "required": true,
2511+ "schema": {
2512+ "type": "string",
2513+ "pattern": "^[a-z0-9-]{1,60}$"
2514+ }
2515+ },
2516+ {
2517+ "name": "oauth_provider_id",
2518+ "in": "path",
2519+ "description": "The OAuth provider ID",
2520+ "required": true,
2521+ "schema": {
2522+ "$ref": "#/components/schemas/NeonAuthOauthProviderId"
2523+ }
2524+ }
2525+ ],
2526+ "patch": {
2527+ "summary": "Update OAuth provider",
2528+ "description": "Updates a OAuth provider for the specified project.\n",
2529+ "tags": [
2530+ "Auth"
2531+ ],
2532+ "x-stability-level": "beta",
2533+ "operationId": "updateBranchNeonAuthOauthProvider",
2534+ "requestBody": {
2535+ "content": {
2536+ "application/json": {
2537+ "schema": {
2538+ "$ref": "#/components/schemas/NeonAuthUpdateOAuthProviderRequest"
2539+ }
2540+ }
2541+ },
2542+ "required": true
2543+ },
2544+ "responses": {
2545+ "200": {
2546+ "description": "The OAuth provider has been added to the project",
2547+ "content": {
2548+ "application/json": {
2549+ "schema": {
2550+ "$ref": "#/components/schemas/NeonAuthOauthProvider"
2551+ }
2552+ }
2553+ }
2554+ },
2555+ "default": {
2556+ "$ref": "#/components/responses/GeneralError"
2557+ }
2558+ }
2559+ },
2560+ "delete": {
2561+ "summary": "Delete OAuth provider",
2562+ "description": "Deletes a OAuth provider from the specified project.\n",
2563+ "tags": [
2564+ "Auth"
2565+ ],
2566+ "x-stability-level": "beta",
2567+ "operationId": "deleteBranchNeonAuthOauthProvider",
2568+ "responses": {
2569+ "200": {
2570+ "description": "Deleted the OAuth provider from the project"
2571+ },
2572+ "default": {
2573+ "$ref": "#/components/responses/GeneralError"
2574+ }
2575+ }
2576+ }
2577+ },
2578+ "/projects/{project_id}/auth/email_server": {
2579+ "parameters": [
2580+ {
2581+ "name": "project_id",
2582+ "in": "path",
2583+ "description": "The Neon project ID",
2584+ "required": true,
2585+ "schema": {
2586+ "type": "string",
2587+ "pattern": "^[a-z0-9-]{1,60}$"
2588+ }
2589+ }
2590+ ],
2591+ "get": {
2592+ "summary": "Get email server configuration",
2593+ "description": "DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/email_provider` instead. Gets the email server configuration for the specified project.\n",
2594+ "tags": [
2595+ "Auth (legacy)"
2596+ ],
2597+ "deprecated": true,
2598+ "x-sunset": "2026-03-01",
2599+ "operationId": "getNeonAuthEmailServer",
2600+ "responses": {
2601+ "200": {
2602+ "description": "Returns the email server configuration for the Neon Auth",
2603+ "content": {
2604+ "application/json": {
2605+ "schema": {
2606+ "$ref": "#/components/schemas/NeonAuthEmailServerConfig"
2607+ }
2608+ }
2609+ }
2610+ },
2611+ "default": {
2612+ "$ref": "#/components/responses/GeneralError"
2613+ }
2614+ }
2615+ },
2616+ "patch": {
2617+ "summary": "Update email server configuration",
2618+ "description": "DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/email_provider` instead. Updates the email server configuration for the specified project.\n",
2619+ "tags": [
2620+ "Auth (legacy)"
2621+ ],
2622+ "deprecated": true,
2623+ "x-sunset": "2026-03-01",
2624+ "operationId": "updateNeonAuthEmailServer",
2625+ "requestBody": {
2626+ "content": {
2627+ "application/json": {
2628+ "schema": {
2629+ "$ref": "#/components/schemas/NeonAuthEmailServerConfig"
2630+ }
2631+ }
2632+ },
2633+ "required": true
2634+ },
2635+ "responses": {
2636+ "200": {
2637+ "description": "The OAuth provider has been added to the project",
2638+ "content": {
2639+ "application/json": {
2640+ "schema": {
2641+ "$ref": "#/components/schemas/NeonAuthEmailServerConfig"
2642+ }
2643+ }
2644+ }
2645+ },
2646+ "default": {
2647+ "$ref": "#/components/responses/GeneralError"
2648+ }
2649+ }
2650+ }
2651+ },
2652+ "/projects/{project_id}/branches/{branch_id}/auth/send_test_email": {
2653+ "parameters": [
2654+ {
2655+ "name": "project_id",
2656+ "in": "path",
2657+ "description": "The Neon project ID",
2658+ "required": true,
2659+ "schema": {
2660+ "type": "string",
2661+ "pattern": "^[a-z0-9-]{1,60}$"
2662+ }
2663+ },
2664+ {
2665+ "name": "branch_id",
2666+ "in": "path",
2667+ "description": "The Neon branch ID",
2668+ "required": true,
2669+ "schema": {
2670+ "type": "string",
2671+ "pattern": "^[a-z0-9-]{1,60}$"
2672+ }
2673+ }
2674+ ],
2675+ "post": {
2676+ "summary": "Send test email",
2677+ "description": "Sends a test email to the specified email address.\n",
2678+ "tags": [
2679+ "Auth"
2680+ ],
2681+ "x-stability-level": "beta",
2682+ "operationId": "sendNeonAuthTestEmail",
2683+ "requestBody": {
2684+ "content": {
2685+ "application/json": {
2686+ "schema": {
2687+ "$ref": "#/components/schemas/SendNeonAuthTestEmailRequest"
2688+ }
2689+ }
2690+ },
2691+ "required": true
2692+ },
2693+ "responses": {
2694+ "200": {
2695+ "description": "Response with the result of the test email send",
2696+ "content": {
2697+ "application/json": {
2698+ "schema": {
2699+ "$ref": "#/components/schemas/SendNeonAuthTestEmailResponse"
2700+ }
2701+ }
2702+ }
2703+ },
2704+ "default": {
2705+ "$ref": "#/components/responses/GeneralError"
2706+ }
2707+ }
2708+ }
2709+ },
2710+ "/projects/{project_id}/branches/{branch_id}/auth/email_and_password": {
2711+ "parameters": [
2712+ {
2713+ "name": "project_id",
2714+ "in": "path",
2715+ "description": "The Neon project ID",
2716+ "required": true,
2717+ "schema": {
2718+ "type": "string",
2719+ "pattern": "^[a-z0-9-]{1,60}$"
2720+ }
2721+ },
2722+ {
2723+ "name": "branch_id",
2724+ "in": "path",
2725+ "description": "The Neon branch ID",
2726+ "required": true,
2727+ "schema": {
2728+ "type": "string",
2729+ "pattern": "^[a-z0-9-]{1,60}$"
2730+ }
2731+ }
2732+ ],
2733+ "get": {
2734+ "summary": "Get email and password configuration",
2735+ "description": "Gets the email and password authentication configuration for Neon Auth\n",
2736+ "tags": [
2737+ "Auth"
2738+ ],
2739+ "operationId": "getNeonAuthEmailAndPasswordConfig",
2740+ "responses": {
2741+ "200": {
2742+ "description": "Returns the email and password configuration for Neon Auth",
2743+ "content": {
2744+ "application/json": {
2745+ "schema": {
2746+ "$ref": "#/components/schemas/NeonAuthEmailAndPasswordConfig"
2747+ }
2748+ }
2749+ }
2750+ },
2751+ "default": {
2752+ "$ref": "#/components/responses/GeneralError"
2753+ }
2754+ }
2755+ },
2756+ "patch": {
2757+ "summary": "Update email and password configuration",
2758+ "description": "Updates the email and password authentication configuration for Neon Auth\n",
2759+ "tags": [
2760+ "Auth"
2761+ ],
2762+ "operationId": "updateNeonAuthEmailAndPasswordConfig",
2763+ "requestBody": {
2764+ "content": {
2765+ "application/json": {
2766+ "schema": {
2767+ "$ref": "#/components/schemas/NeonAuthEmailAndPasswordConfigUpdate"
2768+ }
2769+ }
2770+ },
2771+ "required": true
2772+ },
2773+ "responses": {
2774+ "200": {
2775+ "description": "The email and password configuration has been updated",
2776+ "content": {
2777+ "application/json": {
2778+ "schema": {
2779+ "$ref": "#/components/schemas/NeonAuthEmailAndPasswordConfig"
2780+ }
2781+ }
2782+ }
2783+ },
2784+ "default": {
2785+ "$ref": "#/components/responses/GeneralError"
2786+ }
2787+ }
2788+ }
2789+ },
2790+ "/projects/{project_id}/branches/{branch_id}/auth/email_provider": {
2791+ "parameters": [
2792+ {
2793+ "name": "project_id",
2794+ "in": "path",
2795+ "description": "The Neon project ID",
2796+ "required": true,
2797+ "schema": {
2798+ "type": "string",
2799+ "pattern": "^[a-z0-9-]{1,60}$"
2800+ }
2801+ },
2802+ {
2803+ "name": "branch_id",
2804+ "in": "path",
2805+ "description": "The Neon branch ID",
2806+ "required": true,
2807+ "schema": {
2808+ "type": "string",
2809+ "pattern": "^[a-z0-9-]{1,60}$"
2810+ }
2811+ }
2812+ ],
2813+ "get": {
2814+ "summary": "Get email provider configuration",
2815+ "description": "Gets the email provider configuration for the specified branch.\n",
2816+ "tags": [
2817+ "Auth"
2818+ ],
2819+ "operationId": "getNeonAuthEmailProvider",
2820+ "responses": {
2821+ "200": {
2822+ "description": "Returns the email provider configuration for the Neon Auth",
2823+ "content": {
2824+ "application/json": {
2825+ "schema": {
2826+ "$ref": "#/components/schemas/NeonAuthEmailServerConfig"
2827+ }
2828+ }
2829+ }
2830+ },
2831+ "default": {
2832+ "$ref": "#/components/responses/GeneralError"
2833+ }
2834+ }
2835+ },
2836+ "patch": {
2837+ "summary": "Update email provider configuration",
2838+ "description": "Updates the email provider configuration for the specified branch.\n",
2839+ "tags": [
2840+ "Auth"
2841+ ],
2842+ "operationId": "updateNeonAuthEmailProvider",
2843+ "requestBody": {
2844+ "content": {
2845+ "application/json": {
2846+ "schema": {
2847+ "$ref": "#/components/schemas/NeonAuthEmailServerConfig"
2848+ }
2849+ }
2850+ },
2851+ "required": true
2852+ },
2853+ "responses": {
2854+ "200": {
2855+ "description": "The email provider configuration has been updated",
2856+ "content": {
2857+ "application/json": {
2858+ "schema": {
2859+ "$ref": "#/components/schemas/NeonAuthEmailServerConfig"
2860+ }
2861+ }
2862+ }
2863+ },
2864+ "default": {
2865+ "$ref": "#/components/responses/GeneralError"
2866+ }
2867+ }
2868+ }
2869+ },
2870+ "/projects/{project_id}/auth/integration/{auth_provider}": {
2871+ "delete": {
2872+ "summary": "Delete integration with auth provider",
2873+ "description": "DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth` instead.",
2874+ "tags": [
2875+ "Auth (legacy)"
2876+ ],
2877+ "deprecated": true,
2878+ "x-sunset": "2026-03-01",
2879+ "operationId": "deleteNeonAuthIntegration",
2880+ "parameters": [
2881+ {
2882+ "name": "project_id",
2883+ "in": "path",
2884+ "description": "The Neon project ID",
2885+ "required": true,
2886+ "schema": {
2887+ "type": "string",
2888+ "pattern": "^[a-z0-9-]{1,60}$"
2889+ }
2890+ },
2891+ {
2892+ "name": "auth_provider",
2893+ "in": "path",
2894+ "description": "The authentication provider name",
2895+ "required": true,
2896+ "schema": {
2897+ "$ref": "#/components/schemas/NeonAuthSupportedAuthProvider"
2898+ }
2899+ }
2900+ ],
2901+ "requestBody": {
2902+ "content": {
2903+ "application/json": {
2904+ "schema": {
2905+ "type": "object",
2906+ "properties": {
2907+ "delete_data": {
2908+ "type": "boolean",
2909+ "description": "If true, deletes the `neon_auth` schema from the database",
2910+ "default": false
2911+ }
2912+ }
2913+ }
2914+ }
2915+ }
2916+ },
2917+ "responses": {
2918+ "200": {
2919+ "description": "Delete the integration with the authentication provider"
2920+ },
2921+ "default": {
2922+ "$ref": "#/components/responses/GeneralError"
2923+ }
2924+ }
2925+ }
2926+ },
2927+ "/projects/{project_id}/connection_uri": {
2928+ "get": {
2929+ "summary": "Retrieve connection URI",
2930+ "description": "Retrieves a connection URI for the specified database.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nYou can obtain the `database_name` by listing the databases for a branch.\nYou can obtain a `role_name` by listing the roles for a branch.\n",
2931+ "tags": [
2932+ "Project"
2933+ ],
2934+ "operationId": "getConnectionURI",
2935+ "parameters": [
2936+ {
2937+ "name": "project_id",
2938+ "in": "path",
2939+ "description": "The Neon project ID",
2940+ "required": true,
2941+ "schema": {
2942+ "type": "string",
2943+ "pattern": "^[a-z0-9-]{1,60}$"
2944+ }
2945+ },
2946+ {
2947+ "name": "branch_id",
2948+ "in": "query",
2949+ "description": "The branch ID. Defaults to your project's default `branch_id` if not specified.",
2950+ "required": false,
2951+ "schema": {
2952+ "type": "string",
2953+ "pattern": "^[a-z0-9-]{1,60}$"
2954+ }
2955+ },
2956+ {
2957+ "name": "endpoint_id",
2958+ "in": "query",
2959+ "description": "The endpoint ID. Defaults to the read-write `endpoint_id` associated with the `branch_id` if not specified.",
2960+ "required": false,
2961+ "schema": {
2962+ "type": "string",
2963+ "pattern": "^[a-z0-9-]{1,60}$"
2964+ }
2965+ },
2966+ {
2967+ "name": "database_name",
2968+ "in": "query",
2969+ "description": "The database name",
2970+ "required": true,
2971+ "schema": {
2972+ "type": "string"
2973+ }
2974+ },
2975+ {
2976+ "name": "role_name",
2977+ "in": "query",
2978+ "description": "The role name",
2979+ "required": true,
2980+ "schema": {
2981+ "type": "string"
2982+ }
2983+ },
2984+ {
2985+ "name": "pooled",
2986+ "in": "query",
2987+ "description": "Adds the `-pooler` option to the connection URI when set to `true`, creating a pooled connection URI.",
2988+ "required": false,
2989+ "schema": {
2990+ "type": "boolean"
2991+ }
2992+ }
2993+ ],
2994+ "responses": {
2995+ "200": {
2996+ "description": "Returned the connection URI",
2997+ "content": {
2998+ "application/json": {
2999+ "schema": {
3000+ "$ref": "#/components/schemas/ConnectionURIResponse"
3001+ }
3002+ }
3003+ }
3004+ },
3005+ "default": {
3006+ "$ref": "#/components/responses/GeneralError"
3007+ }
3008+ }
3009+ }
3010+ },
3011+ "/projects/{project_id}/branches/{branch_id}/auth/allow_localhost": {
3012+ "parameters": [
3013+ {
3014+ "name": "project_id",
3015+ "in": "path",
3016+ "description": "The Neon project ID",
3017+ "required": true,
3018+ "schema": {
3019+ "type": "string",
3020+ "pattern": "^[a-z0-9-]{1,60}$"
3021+ }
3022+ },
3023+ {
3024+ "name": "branch_id",
3025+ "in": "path",
3026+ "description": "The Neon branch ID",
3027+ "required": true,
3028+ "schema": {
3029+ "type": "string",
3030+ "pattern": "^[a-z0-9-]{1,60}$"
3031+ }
3032+ }
3033+ ],
3034+ "get": {
3035+ "summary": "Get allow localhost",
3036+ "description": "Get the allow localhost configuration for the specified branch.\n",
3037+ "tags": [
3038+ "Auth"
3039+ ],
3040+ "operationId": "getNeonAuthAllowLocalhost",
3041+ "responses": {
3042+ "200": {
3043+ "description": "The allow localhost configuration",
3044+ "content": {
3045+ "application/json": {
3046+ "schema": {
3047+ "$ref": "#/components/schemas/NeonAuthAllowLocalhostResponse"
3048+ }
3049+ }
3050+ }
3051+ },
3052+ "default": {
3053+ "$ref": "#/components/responses/GeneralError"
3054+ }
3055+ }
3056+ },
3057+ "patch": {
3058+ "summary": "Update allow localhost",
3059+ "description": "Updates the allow localhost configuration for the specified branch.\n",
3060+ "tags": [
3061+ "Auth"
3062+ ],
3063+ "operationId": "updateNeonAuthAllowLocalhost",
3064+ "requestBody": {
3065+ "content": {
3066+ "application/json": {
3067+ "schema": {
3068+ "$ref": "#/components/schemas/UpdateNeonAuthAllowLocalhostRequest"
3069+ }
3070+ }
3071+ },
3072+ "required": true
3073+ },
3074+ "responses": {
3075+ "200": {
3076+ "description": "Updated the allow localhost configuration",
3077+ "content": {
3078+ "application/json": {
3079+ "schema": {
3080+ "$ref": "#/components/schemas/NeonAuthAllowLocalhostResponse"
3081+ }
3082+ }
3083+ }
3084+ },
3085+ "default": {
3086+ "$ref": "#/components/responses/GeneralError"
3087+ }
3088+ }
3089+ }
3090+ },
3091+ "/projects/{project_id}/branches/{branch_id}/auth/plugins": {
3092+ "parameters": [
3093+ {
3094+ "name": "project_id",
3095+ "in": "path",
3096+ "description": "The Neon project ID",
3097+ "required": true,
3098+ "schema": {
3099+ "type": "string",
3100+ "pattern": "^[a-z0-9-]{1,60}$"
3101+ }
3102+ },
3103+ {
3104+ "name": "branch_id",
3105+ "in": "path",
3106+ "description": "The Neon branch ID",
3107+ "required": true,
3108+ "schema": {
3109+ "type": "string",
3110+ "pattern": "^[a-z0-9-]{1,60}$"
3111+ }
3112+ }
3113+ ],
3114+ "get": {
3115+ "summary": "Get all plugin configurations",
3116+ "description": "Returns all plugin configurations for Neon Auth in a single response.\nThis endpoint aggregates organization, email provider, email and password,\nOAuth providers, and localhost settings.\n",
3117+ "tags": [
3118+ "Auth"
3119+ ],
3120+ "operationId": "getNeonAuthPluginConfigs",
3121+ "responses": {
3122+ "200": {
3123+ "description": "Returns all plugin configurations",
3124+ "content": {
3125+ "application/json": {
3126+ "schema": {
3127+ "$ref": "#/components/schemas/NeonAuthPluginConfigs"
3128+ }
3129+ }
3130+ }
3131+ },
3132+ "default": {
3133+ "$ref": "#/components/responses/GeneralError"
3134+ }
3135+ }
3136+ }
3137+ },
3138+ "/projects/{project_id}/branches/{branch_id}/auth/plugins/organization": {
3139+ "parameters": [
3140+ {
3141+ "name": "project_id",
3142+ "in": "path",
3143+ "description": "The Neon project ID",
3144+ "required": true,
3145+ "schema": {
3146+ "type": "string",
3147+ "pattern": "^[a-z0-9-]{1,60}$"
3148+ }
3149+ },
3150+ {
3151+ "name": "branch_id",
3152+ "in": "path",
3153+ "description": "The Neon branch ID",
3154+ "required": true,
3155+ "schema": {
3156+ "type": "string",
3157+ "pattern": "^[a-z0-9-]{1,60}$"
3158+ }
3159+ }
3160+ ],
3161+ "patch": {
3162+ "summary": "Update organization plugin configuration",
3163+ "description": "Updates the organization plugin configuration for Neon Auth.\nThe organization plugin enables multi-tenant organization support.\n",
3164+ "tags": [
3165+ "Auth"
3166+ ],
3167+ "operationId": "updateNeonAuthOrganizationPlugin",
3168+ "requestBody": {
3169+ "content": {
3170+ "application/json": {
3171+ "schema": {
3172+ "$ref": "#/components/schemas/NeonAuthOrganizationConfigUpdate"
3173+ }
3174+ }
3175+ },
3176+ "required": true
3177+ },
3178+ "responses": {
3179+ "200": {
3180+ "description": "The organization plugin configuration has been updated",
3181+ "content": {
3182+ "application/json": {
3183+ "schema": {
3184+ "$ref": "#/components/schemas/NeonAuthOrganizationConfig"
3185+ }
3186+ }
3187+ }
3188+ },
3189+ "default": {
3190+ "$ref": "#/components/responses/GeneralError"
3191+ }
3192+ }
3193+ }
3194+ },
3195+ "/projects/{project_id}/branches/{branch_id}/auth/webhooks": {
3196+ "parameters": [
3197+ {
3198+ "name": "project_id",
3199+ "in": "path",
3200+ "description": "The Neon project ID",
3201+ "required": true,
3202+ "schema": {
3203+ "type": "string",
3204+ "pattern": "^[a-z0-9-]{1,60}$"
3205+ }
3206+ },
3207+ {
3208+ "name": "branch_id",
3209+ "in": "path",
3210+ "description": "The Neon branch ID",
3211+ "required": true,
3212+ "schema": {
3213+ "type": "string",
3214+ "pattern": "^[a-z0-9-]{1,60}$"
3215+ }
3216+ }
3217+ ],
3218+ "get": {
3219+ "summary": "Get webhook configuration for Neon Auth",
3220+ "description": "Returns the webhook configuration for Neon Auth.\n",
3221+ "tags": [
3222+ "Auth"
3223+ ],
3224+ "operationId": "getNeonAuthWebhookConfig",
3225+ "responses": {
3226+ "200": {
3227+ "description": "Returns webhook configuration for Neon Auth",
3228+ "content": {
3229+ "application/json": {
3230+ "schema": {
3231+ "$ref": "#/components/schemas/NeonAuthWebhookConfig"
3232+ }
3233+ }
3234+ }
3235+ },
3236+ "default": {
3237+ "$ref": "#/components/responses/GeneralError"
3238+ }
3239+ }
3240+ },
3241+ "put": {
3242+ "summary": "Update webhook configuration for Neon Auth",
3243+ "description": "Updates the webhook configuration for Neon Auth on a specific branch.\n",
3244+ "tags": [
3245+ "Auth"
3246+ ],
3247+ "operationId": "updateNeonAuthWebhookConfig",
3248+ "requestBody": {
3249+ "required": true,
3250+ "content": {
3251+ "application/json": {
3252+ "schema": {
3253+ "$ref": "#/components/schemas/NeonAuthWebhookConfig"
3254+ }
3255+ }
3256+ }
3257+ },
3258+ "responses": {
3259+ "200": {
3260+ "description": "Returns the updated webhook configuration",
3261+ "content": {
3262+ "application/json": {
3263+ "schema": {
3264+ "$ref": "#/components/schemas/NeonAuthWebhookConfig"
3265+ }
3266+ }
3267+ }
3268+ },
3269+ "default": {
3270+ "$ref": "#/components/responses/GeneralError"
3271+ }
3272+ }
3273+ }
3274+ },
3275+ "/projects/{project_id}/branches": {
3276+ "parameters": [
3277+ {
3278+ "name": "project_id",
3279+ "in": "path",
3280+ "description": "The Neon project ID",
3281+ "required": true,
3282+ "schema": {
3283+ "type": "string",
3284+ "pattern": "^[a-z0-9-]{1,60}$"
3285+ }
3286+ }
3287+ ],
3288+ "post": {
3289+ "summary": "Create branch",
3290+ "description": "Creates a branch in the specified project.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nThis method does not require a request body, but you can specify one to create a compute endpoint for the branch or to select a non-default parent branch.\nBy default, the branch is created from the project's default branch with no compute endpoint, and the branch name is auto-generated.\nTo access the branch, you must add an endpoint object. A `read_write` endpoint allows you to perform read and write operations on the branch.\nEach branch supports one read-write endpoint and multiple read-only endpoints.\nFor related information, see [Manage branches](https://neon.tech/docs/manage/branches/).\n",
3291+ "tags": [
3292+ "Branch"
3293+ ],
3294+ "operationId": "createProjectBranch",
3295+ "requestBody": {
3296+ "content": {
3297+ "application/json": {
3298+ "schema": {
3299+ "allOf": [
3300+ {
3301+ "$ref": "#/components/schemas/BranchCreateRequest"
3302+ },
3303+ {
3304+ "$ref": "#/components/schemas/AnnotationCreateValueRequest"
3305+ }
3306+ ]
3307+ },
3308+ "examples": {
3309+ "branch_only": {
3310+ "summary": "Branch only",
3311+ "value": {
3312+ "branch": {
3313+ "parent_id": "br-aged-salad-637688",
3314+ "name": "mybranch"
3315+ }
3316+ }
3317+ },
3318+ "branch_with_endpoint": {
3319+ "summary": "Branch with endpoint",
3320+ "value": {
3321+ "endpoints": [
3322+ {
3323+ "type": "read_write"
3324+ }
3325+ ],
3326+ "branch": {
3327+ "parent_id": "br-aged-salad-637688",
3328+ "name": "mybranch"
3329+ }
3330+ }
3331+ }
3332+ }
3333+ }
3334+ },
3335+ "required": false
3336+ },
3337+ "responses": {
3338+ "201": {
3339+ "$ref": "#/components/responses/CreatedBranch"
3340+ },
3341+ "default": {
3342+ "$ref": "#/components/responses/GeneralError"
3343+ }
3344+ }
3345+ },
3346+ "get": {
3347+ "summary": "List branches",
3348+ "description": "Retrieves a list of branches for the specified project.\nYou can obtain a `project_id` by listing the projects for your Neon account.\n\nEach Neon project has a root branch named `main`.\nA `branch_id` value has a `br-` prefix.\nA project may contain child branches that were branched from `main` or from another branch.\nA parent branch is identified by the `parent_id` value, which is the `id` of the parent branch.\nFor related information, see [Manage branches](https://neon.tech/docs/manage/branches/).\n",
3349+ "tags": [
3350+ "Branch"
3351+ ],
3352+ "operationId": "listProjectBranches",
3353+ "parameters": [
3354+ {
3355+ "name": "search",
3356+ "description": "Search by branch `name` or `id`. You can specify partial `name` or `id` values to filter results.",
3357+ "in": "query",
3358+ "schema": {
3359+ "type": "string"
3360+ }
3361+ },
3362+ {
3363+ "name": "sort_by",
3364+ "description": "Sort the branches by sort_field. If not provided, branches will be sorted by updated_at descending order",
3365+ "in": "query",
3366+ "schema": {
3367+ "type": "string",
3368+ "default": "updated_at",
3369+ "enum": [
3370+ "name",
3371+ "created_at",
3372+ "updated_at"
3373+ ]
3374+ }
3375+ },
3376+ {
3377+ "$ref": "#/components/parameters/CursorParam"
3378+ },
3379+ {
3380+ "$ref": "#/components/parameters/SortOrderParam"
3381+ },
3382+ {
3383+ "$ref": "#/components/parameters/LimitParam"
3384+ }
3385+ ],
3386+ "responses": {
3387+ "200": {
3388+ "description": "Returned a list of branches for the specified project",
3389+ "content": {
3390+ "application/json": {
3391+ "schema": {
3392+ "allOf": [
3393+ {
3394+ "$ref": "#/components/schemas/BranchesResponse"
3395+ },
3396+ {
3397+ "$ref": "#/components/schemas/AnnotationsMapResponse"
3398+ },
3399+ {
3400+ "$ref": "#/components/schemas/CursorPaginationResponse"
3401+ }
3402+ ]
3403+ },
3404+ "example": {
3405+ "branches": [
3406+ {
3407+ "id": "br-aged-salad-637688",
3408+ "project_id": "shiny-wind-028834",
3409+ "name": "main",
3410+ "current_state": "ready",
3411+ "state_changed_at": "2022-11-30T20:09:48Z",
3412+ "logical_size": 28,
3413+ "created_at": "2022-11-23T17:42:25Z",
3414+ "updated_at": "2022-11-23T17:42:26Z",
3415+ "data_transfer_bytes": 1000000,
3416+ "written_data_bytes": 100800,
3417+ "compute_time_seconds": 100,
3418+ "active_time_seconds": 100,
3419+ "cpu_used_sec": 100,
3420+ "default": true,
3421+ "protected": false,
3422+ "creation_source": "console",
3423+ "init_source": "parent-data"
3424+ },
3425+ {
3426+ "id": "br-sweet-breeze-497520",
3427+ "project_id": "shiny-wind-028834",
3428+ "parent_id": "br-aged-salad-637688",
3429+ "parent_lsn": "0/1DE2850",
3430+ "name": "dev2",
3431+ "current_state": "ready",
3432+ "state_changed_at": "2022-11-30T20:09:48Z",
3433+ "logical_size": 28,
3434+ "created_at": "2022-11-30T19:09:48Z",
3435+ "updated_at": "2022-11-30T19:09:49Z",
3436+ "data_transfer_bytes": 1000000,
3437+ "written_data_bytes": 100800,
3438+ "compute_time_seconds": 100,
3439+ "active_time_seconds": 100,
3440+ "cpu_used_sec": 100,
3441+ "default": true,
3442+ "protected": false,
3443+ "creation_source": "console",
3444+ "init_source": "parent-data"
3445+ },
3446+ {
3447+ "id": "br-raspy-hill-832856",
3448+ "project_id": "shiny-wind-028834",
3449+ "parent_id": "br-aged-salad-637688",
3450+ "parent_lsn": "0/19623D8",
3451+ "name": "dev1",
3452+ "current_state": "ready",
3453+ "state_changed_at": "2022-11-30T20:09:48Z",
3454+ "logical_size": 21,
3455+ "created_at": "2022-11-30T17:36:57Z",
3456+ "updated_at": "2022-11-30T17:36:57Z",
3457+ "data_transfer_bytes": 1000000,
3458+ "written_data_bytes": 100800,
3459+ "compute_time_seconds": 100,
3460+ "active_time_seconds": 100,
3461+ "cpu_used_sec": 100,
3462+ "default": true,
3463+ "protected": false,
3464+ "creation_source": "console",
3465+ "init_source": "parent-data"
3466+ }
3467+ ],
3468+ "annotations": {
3469+ "br-aged-salad-637688": {
3470+ "object": {
3471+ "type": "console/branch",
3472+ "id": "br-aged-salad-637688"
3473+ },
3474+ "value": {
3475+ "vercel-commit-ref": "test"
3476+ },
3477+ "created_at": "2022-11-23T17:42:25Z",
3478+ "updated_at": "2022-11-23T17:42:26Z"
3479+ }
3480+ },
3481+ "pagination": {
3482+ "next": "eyJjcmVhdGV",
3483+ "sort_by": "updated_at",
3484+ "sort_order": "desc"
3485+ }
3486+ }
3487+ }
3488+ }
3489+ },
3490+ "default": {
3491+ "$ref": "#/components/responses/GeneralError"
3492+ }
3493+ }
3494+ }
3495+ },
3496+ "/projects/{project_id}/branch_anonymized": {
3497+ "parameters": [
3498+ {
3499+ "name": "project_id",
3500+ "in": "path",
3501+ "description": "The Neon project ID",
3502+ "required": true,
3503+ "schema": {
3504+ "type": "string",
3505+ "pattern": "^[a-z0-9-]{1,60}$"
3506+ }
3507+ }
3508+ ],
3509+ "post": {
3510+ "summary": "Create anonymized branch",
3511+ "description": "Creates a new branch with anonymized data using PostgreSQL Anonymizer for static masking.\nThis allows developers to work with masked production data.\nOptionally, provide `masking_rules` to set initial masking rules for the branch\nand `start_anonymization` to automatically start anonymization after creation. This\ncombines functionality of updating masking rules and starting anonymization into the\nbranch creation request.\n\n**Note**: This endpoint is currently in Beta.\n",
3512+ "tags": [
3513+ "Branch"
3514+ ],
3515+ "operationId": "createProjectBranchAnonymized",
3516+ "requestBody": {
3517+ "content": {
3518+ "application/json": {
3519+ "schema": {
3520+ "$ref": "#/components/schemas/BranchAnonymizedCreateRequest"
3521+ }
3522+ }
3523+ },
3524+ "required": true
3525+ },
3526+ "responses": {
3527+ "201": {
3528+ "$ref": "#/components/responses/CreatedBranch"
3529+ },
3530+ "default": {
3531+ "$ref": "#/components/responses/GeneralError"
3532+ }
3533+ }
3534+ }
3535+ },
3536+ "/projects/{project_id}/branches/count": {
3537+ "parameters": [
3538+ {
3539+ "name": "project_id",
3540+ "in": "path",
3541+ "description": "The Neon project ID",
3542+ "required": true,
3543+ "schema": {
3544+ "type": "string",
3545+ "pattern": "^[a-z0-9-]{1,60}$"
3546+ }
3547+ }
3548+ ],
3549+ "get": {
3550+ "summary": "Retrieve number of branches",
3551+ "description": "Retrieves the total number of branches in the specified project.\nYou can obtain a `project_id` by listing the projects for your Neon account.\n",
3552+ "tags": [
3553+ "Branch"
3554+ ],
3555+ "operationId": "countProjectBranches",
3556+ "parameters": [
3557+ {
3558+ "name": "search",
3559+ "description": "Count branches matching the `name` in search query",
3560+ "in": "query",
3561+ "schema": {
3562+ "type": "string"
3563+ }
3564+ }
3565+ ],
3566+ "responses": {
3567+ "default": {
3568+ "$ref": "#/components/responses/GeneralError"
3569+ },
3570+ "200": {
3571+ "description": "Returned a count of branches for the specified project",
3572+ "content": {
3573+ "application/json": {
3574+ "schema": {
3575+ "allOf": [
3576+ {
3577+ "$ref": "#/components/schemas/BranchesCountResponse"
3578+ }
3579+ ]
3580+ }
3581+ }
3582+ }
3583+ }
3584+ }
3585+ }
3586+ },
3587+ "/projects/{project_id}/branches/{branch_id}": {
3588+ "parameters": [
3589+ {
3590+ "name": "project_id",
3591+ "in": "path",
3592+ "description": "The Neon project ID",
3593+ "required": true,
3594+ "schema": {
3595+ "type": "string",
3596+ "pattern": "^[a-z0-9-]{1,60}$"
3597+ }
3598+ },
3599+ {
3600+ "name": "branch_id",
3601+ "in": "path",
3602+ "description": "The branch ID",
3603+ "required": true,
3604+ "schema": {
3605+ "type": "string",
3606+ "pattern": "^[a-z0-9-]{1,60}$"
3607+ }
3608+ }
3609+ ],
3610+ "get": {
3611+ "summary": "Retrieve branch details",
3612+ "description": "Retrieves information about the specified branch.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nYou can obtain a `branch_id` by listing the project's branches.\nA `branch_id` value has a `br-` prefix.\n\nEach Neon project is initially created with a root and default branch named `main`.\nA project can contain one or more branches.\nA parent branch is identified by a `parent_id` value, which is the `id` of the parent branch.\nFor related information, see [Manage branches](https://neon.tech/docs/manage/branches/).\n",
3613+ "tags": [
3614+ "Branch"
3615+ ],
3616+ "operationId": "getProjectBranch",
3617+ "responses": {
3618+ "200": {
3619+ "description": "Returned information about the specified branch",
3620+ "content": {
3621+ "application/json": {
3622+ "schema": {
3623+ "allOf": [
3624+ {
3625+ "$ref": "#/components/schemas/BranchResponse"
3626+ },
3627+ {
3628+ "$ref": "#/components/schemas/AnnotationResponse"
3629+ }
3630+ ]
3631+ },
3632+ "example": {
3633+ "branch": {
3634+ "id": "br-aged-salad-637688",
3635+ "project_id": "shiny-wind-028834",
3636+ "name": "main",
3637+ "current_state": "ready",
3638+ "state_changed_at": "2022-11-30T20:09:48Z",
3639+ "logical_size": 28,
3640+ "created_at": "2022-11-23T17:42:25Z",
3641+ "updated_at": "2022-11-23T17:42:26Z",
3642+ "data_transfer_bytes": 1000000,
3643+ "written_data_bytes": 100800,
3644+ "compute_time_seconds": 100,
3645+ "active_time_seconds": 100,
3646+ "cpu_used_sec": 100,
3647+ "default": true,
3648+ "protected": false,
3649+ "creation_source": "console",
3650+ "init_source": "parent-data"
3651+ },
3652+ "annotation": {
3653+ "object": {
3654+ "type": "console/branch",
3655+ "id": "br-aged-salad-637688"
3656+ },
3657+ "value": {
3658+ "vercel-commit-ref": "test"
3659+ },
3660+ "created_at": "2022-11-23T17:42:25Z",
3661+ "updated_at": "2022-11-23T17:42:26Z"
3662+ }
3663+ }
3664+ }
3665+ }
3666+ },
3667+ "default": {
3668+ "$ref": "#/components/responses/GeneralError"
3669+ }
3670+ }
3671+ },
3672+ "delete": {
3673+ "summary": "Delete branch",
3674+ "description": "Deletes the specified branch from a project, and places\nall compute endpoints into an idle state, breaking existing client connections.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nYou can obtain a `branch_id` by listing the project's branches.\nFor related information, see [Manage branches](https://neon.tech/docs/manage/branches/).\n\nWhen a successful response status is received, the compute endpoints are still active,\nand the branch is not yet deleted from storage.\nThe deletion occurs after all operations finish.\nYou cannot delete a project's root or default branch, and you cannot delete a branch that has a child branch.\nA project must have at least one branch.\n",
3675+ "tags": [
3676+ "Branch"
3677+ ],
3678+ "operationId": "deleteProjectBranch",
3679+ "responses": {
3680+ "200": {
3681+ "description": "Deleted the specified branch",
3682+ "content": {
3683+ "application/json": {
3684+ "schema": {
3685+ "$ref": "#/components/schemas/BranchOperations"
3686+ },
3687+ "example": {
3688+ "branch": {
3689+ "id": "br-aged-salad-637688",
3690+ "project_id": "shiny-wind-028834",
3691+ "name": "main",
3692+ "current_state": "ready",
3693+ "state_changed_at": "2022-11-30T20:09:48Z",
3694+ "logical_size": 28,
3695+ "created_at": "2022-11-23T17:42:25Z",
3696+ "updated_at": "2022-11-23T17:42:26Z",
3697+ "data_transfer_bytes": 1000000,
3698+ "written_data_bytes": 100800,
3699+ "compute_time_seconds": 100,
3700+ "active_time_seconds": 100,
3701+ "cpu_used_sec": 100,
3702+ "default": true,
3703+ "protected": false,
3704+ "creation_source": "console",
3705+ "init_source": "parent-data"
3706+ },
3707+ "operations": [
3708+ {
3709+ "id": "b6afbc21-2990-4a76-980b-b57d8c2948f2",
3710+ "project_id": "shiny-wind-028834",
3711+ "branch_id": "br-sweet-breeze-497520",
3712+ "endpoint_id": "ep-soft-violet-752733",
3713+ "action": "suspend_compute",
3714+ "status": "running",
3715+ "failures_count": 0,
3716+ "created_at": "2022-12-01T19:53:05Z",
3717+ "updated_at": "2022-12-01T19:53:05Z",
3718+ "total_duration_ms": 100
3719+ },
3720+ {
3721+ "id": "b6afbc21-2990-4a76-980b-b57d8c2948f2",
3722+ "project_id": "shiny-wind-028834",
3723+ "branch_id": "br-sweet-breeze-497520",
3724+ "action": "delete_timeline",
3725+ "status": "scheduling",
3726+ "failures_count": 0,
3727+ "created_at": "2022-12-01T19:53:05Z",
3728+ "updated_at": "2022-12-01T19:53:05Z",
3729+ "total_duration_ms": 100
3730+ }
3731+ ]
3732+ }
3733+ }
3734+ }
3735+ },
3736+ "204": {
3737+ "description": "Returned if the branch doesn't exist or has already been deleted"
3738+ },
3739+ "default": {
3740+ "$ref": "#/components/responses/GeneralError"
3741+ }
3742+ }
3743+ },
3744+ "patch": {
3745+ "tags": [
3746+ "Branch"
3747+ ],
3748+ "summary": "Update branch",
3749+ "description": "Updates the specified branch.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nYou can obtain the `branch_id` by listing the project's branches.\nFor more information, see [Manage branches](https://neon.tech/docs/manage/branches/).\n",
3750+ "operationId": "updateProjectBranch",
3751+ "requestBody": {
3752+ "content": {
3753+ "application/json": {
3754+ "schema": {
3755+ "$ref": "#/components/schemas/BranchUpdateRequest"
3756+ },
3757+ "example": {
3758+ "branch": {
3759+ "name": "mybranch"
3760+ }
3761+ }
3762+ }
3763+ },
3764+ "required": true
3765+ },
3766+ "responses": {
3767+ "200": {
3768+ "description": "Updated the specified branch",
3769+ "content": {
3770+ "application/json": {
3771+ "schema": {
3772+ "$ref": "#/components/schemas/BranchOperations"
3773+ },
3774+ "example": {
3775+ "branch": {
3776+ "id": "br-icy-dream-250089",
3777+ "project_id": "shiny-wind-028834",
3778+ "parent_id": "br-aged-salad-637688",
3779+ "parent_lsn": "0/1E19478",
3780+ "name": "mybranch",
3781+ "current_state": "ready",
3782+ "state_changed_at": "2022-11-30T20:09:48Z",
3783+ "created_at": "2022-11-23T17:42:25Z",
3784+ "updated_at": "2022-11-23T17:42:26Z",
3785+ "data_transfer_bytes": 1000000,
3786+ "written_data_bytes": 100800,
3787+ "compute_time_seconds": 100,
3788+ "active_time_seconds": 100,
3789+ "cpu_used_sec": 100,
3790+ "default": true,
3791+ "protected": false,
3792+ "creation_source": "console",
3793+ "init_source": "parent-data"
3794+ },
3795+ "operations": []
3796+ }
3797+ }
3798+ }
3799+ },
3800+ "default": {
3801+ "$ref": "#/components/responses/GeneralError"
3802+ }
3803+ }
3804+ }
3805+ },
3806+ "/projects/{project_id}/branches/{branch_id}/restore": {
3807+ "post": {
3808+ "tags": [
3809+ "Branch"
3810+ ],
3811+ "summary": "Restore branch",
3812+ "description": "Restores a branch to an earlier state in its own or another branch's history",
3813+ "operationId": "restoreProjectBranch",
3814+ "parameters": [
3815+ {
3816+ "name": "project_id",
3817+ "in": "path",
3818+ "description": "The Neon project ID",
3819+ "required": true,
3820+ "schema": {
3821+ "type": "string",
3822+ "pattern": "^[a-z0-9-]{1,60}$"
3823+ }
3824+ },
3825+ {
3826+ "name": "branch_id",
3827+ "in": "path",
3828+ "description": "The branch ID",
3829+ "required": true,
3830+ "schema": {
3831+ "type": "string",
3832+ "pattern": "^[a-z0-9-]{1,60}$"
3833+ }
3834+ }
3835+ ],
3836+ "requestBody": {
3837+ "content": {
3838+ "application/json": {
3839+ "schema": {
3840+ "$ref": "#/components/schemas/BranchRestoreRequest"
3841+ }
3842+ }
3843+ },
3844+ "required": true
3845+ },
3846+ "responses": {
3847+ "200": {
3848+ "description": "Updated the specified branch",
3849+ "content": {
3850+ "application/json": {
3851+ "schema": {
3852+ "$ref": "#/components/schemas/BranchOperations"
3853+ }
3854+ }
3855+ }
3856+ },
3857+ "default": {
3858+ "$ref": "#/components/responses/GeneralError"
3859+ }
3860+ }
3861+ }
3862+ },
3863+ "/projects/{project_id}/branches/{branch_id}/schema": {
3864+ "get": {
3865+ "tags": [
3866+ "Branch"
3867+ ],
3868+ "summary": "Retrieve database schema",
3869+ "description": "Retrieves the schema from the specified database. The `lsn` and `timestamp` values cannot be specified at the same time. If both are omitted, the database schema is retrieved from database's head.",
3870+ "operationId": "getProjectBranchSchema",
3871+ "parameters": [
3872+ {
3873+ "name": "project_id",
3874+ "in": "path",
3875+ "description": "The Neon project ID",
3876+ "required": true,
3877+ "schema": {
3878+ "type": "string",
3879+ "pattern": "^[a-z0-9-]{1,60}$"
3880+ }
3881+ },
3882+ {
3883+ "name": "branch_id",
3884+ "in": "path",
3885+ "description": "The branch ID",
3886+ "required": true,
3887+ "schema": {
3888+ "type": "string",
3889+ "pattern": "^[a-z0-9-]{1,60}$"
3890+ }
3891+ },
3892+ {
3893+ "name": "db_name",
3894+ "in": "query",
3895+ "description": "Name of the database for which the schema is retrieved",
3896+ "required": true,
3897+ "schema": {
3898+ "type": "string"
3899+ }
3900+ },
3901+ {
3902+ "name": "lsn",
3903+ "in": "query",
3904+ "description": "The Log Sequence Number (LSN) for which the schema is retrieved\n",
3905+ "schema": {
3906+ "type": "string"
3907+ }
3908+ },
3909+ {
3910+ "name": "timestamp",
3911+ "in": "query",
3912+ "description": "The point in time for which the schema is retrieved\n",
3913+ "schema": {
3914+ "type": "string",
3915+ "format": "date-time",
3916+ "example": "2022-11-30T20:09:48Z"
3917+ }
3918+ },
3919+ {
3920+ "name": "format",
3921+ "in": "query",
3922+ "description": "The format of the schema to retrieve. Possible values:\n- `sql` (default)\n- `json`\n",
3923+ "schema": {
3924+ "type": "string"
3925+ }
3926+ }
3927+ ],
3928+ "responses": {
3929+ "200": {
3930+ "description": "Schema definition",
3931+ "content": {
3932+ "application/json": {
3933+ "schema": {
3934+ "$ref": "#/components/schemas/BranchSchemaResponse"
3935+ }
3936+ }
3937+ }
3938+ },
3939+ "default": {
3940+ "$ref": "#/components/responses/GeneralError"
3941+ }
3942+ }
3943+ }
3944+ },
3945+ "/projects/{project_id}/branches/{branch_id}/compare_schema": {
3946+ "get": {
3947+ "tags": [
3948+ "Branch"
3949+ ],
3950+ "summary": "Compare database schema",
3951+ "description": "Compares the schema from the specified database with another branch's schema.",
3952+ "operationId": "getProjectBranchSchemaComparison",
3953+ "parameters": [
3954+ {
3955+ "name": "project_id",
3956+ "in": "path",
3957+ "description": "The Neon project ID",
3958+ "required": true,
3959+ "schema": {
3960+ "type": "string",
3961+ "pattern": "^[a-z0-9-]{1,60}$"
3962+ }
3963+ },
3964+ {
3965+ "name": "branch_id",
3966+ "in": "path",
3967+ "description": "The branch ID",
3968+ "required": true,
3969+ "schema": {
3970+ "type": "string",
3971+ "pattern": "^[a-z0-9-]{1,60}$"
3972+ }
3973+ },
3974+ {
3975+ "name": "base_branch_id",
3976+ "in": "query",
3977+ "description": "The branch ID to compare the schema with",
3978+ "required": false,
3979+ "schema": {
3980+ "type": "string",
3981+ "pattern": "^[a-z0-9-]{1,60}$"
3982+ }
3983+ },
3984+ {
3985+ "name": "db_name",
3986+ "in": "query",
3987+ "description": "Name of the database for which the schema is retrieved",
3988+ "required": true,
3989+ "schema": {
3990+ "type": "string"
3991+ }
3992+ },
3993+ {
3994+ "name": "lsn",
3995+ "in": "query",
3996+ "description": "The Log Sequence Number (LSN) for which the schema is retrieved\n",
3997+ "schema": {
3998+ "type": "string"
3999+ }
4000+ },
4001+ {
4002+ "name": "timestamp",
4003+ "in": "query",
4004+ "description": "The point in time for which the schema is retrieved\n",
4005+ "schema": {
4006+ "type": "string",
4007+ "format": "date-time",
4008+ "example": "2022-11-30T20:09:48Z"
4009+ }
4010+ },
4011+ {
4012+ "name": "base_lsn",
4013+ "in": "query",
4014+ "description": "The Log Sequence Number (LSN) for the base branch schema\n",
4015+ "schema": {
4016+ "type": "string"
4017+ }
4018+ },
4019+ {
4020+ "name": "base_timestamp",
4021+ "in": "query",
4022+ "description": "The point in time for the base branch schema\n",
4023+ "schema": {
4024+ "type": "string",
4025+ "format": "date-time",
4026+ "example": "2022-11-30T20:09:48Z"
4027+ }
4028+ }
4029+ ],
4030+ "responses": {
4031+ "200": {
4032+ "description": "Difference between the schemas",
4033+ "content": {
4034+ "application/json": {
4035+ "schema": {
4036+ "$ref": "#/components/schemas/BranchSchemaCompareResponse"
4037+ }
4038+ }
4039+ }
4040+ },
4041+ "default": {
4042+ "$ref": "#/components/responses/GeneralError"
4043+ }
4044+ }
4045+ }
4046+ },
4047+ "/projects/{project_id}/branches/{branch_id}/masking_rules": {
4048+ "parameters": [
4049+ {
4050+ "name": "project_id",
4051+ "in": "path",
4052+ "description": "The Neon project ID",
4053+ "required": true,
4054+ "schema": {
4055+ "type": "string",
4056+ "pattern": "^[a-z0-9-]{1,60}$"
4057+ }
4058+ },
4059+ {
4060+ "name": "branch_id",
4061+ "in": "path",
4062+ "description": "The branch ID",
4063+ "required": true,
4064+ "schema": {
4065+ "type": "string",
4066+ "pattern": "^[a-z0-9-]{1,60}$"
4067+ }
4068+ }
4069+ ],
4070+ "get": {
4071+ "tags": [
4072+ "Branch"
4073+ ],
4074+ "summary": "Get masking rules",
4075+ "description": "Retrieves the masking rules for the specified anonymized branch.\nMasking rules define how sensitive data should be anonymized using PostgreSQL Anonymizer.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nYou can obtain the `branch_id` by listing the project's branches.\n\n**Note**: This endpoint is currently in Beta.\n",
4076+ "operationId": "getMaskingRules",
4077+ "responses": {
4078+ "200": {
4079+ "description": "Masking rules retrieved successfully",
4080+ "content": {
4081+ "application/json": {
4082+ "schema": {
4083+ "$ref": "#/components/schemas/MaskingRulesResponse"
4084+ }
4085+ }
4086+ }
4087+ },
4088+ "default": {
4089+ "$ref": "#/components/responses/GeneralError"
4090+ }
4091+ }
4092+ },
4093+ "patch": {
4094+ "tags": [
4095+ "Branch"
4096+ ],
4097+ "summary": "Update masking rules",
4098+ "description": "Updates the masking rules for the specified anonymized branch.\nMasking rules define how sensitive data should be anonymized using PostgreSQL Anonymizer.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nYou can obtain the `branch_id` by listing the project's branches.\n\n**Note**: This endpoint is currently in Beta.\n",
4099+ "operationId": "updateMaskingRules",
4100+ "requestBody": {
4101+ "content": {
4102+ "application/json": {
4103+ "schema": {
4104+ "$ref": "#/components/schemas/MaskingRulesUpdateRequest"
4105+ }
4106+ }
4107+ },
4108+ "required": true
4109+ },
4110+ "responses": {
4111+ "200": {
4112+ "description": "Masking rules updated successfully",
4113+ "content": {
4114+ "application/json": {
4115+ "schema": {
4116+ "$ref": "#/components/schemas/MaskingRulesResponse"
4117+ }
4118+ }
4119+ }
4120+ },
4121+ "default": {
4122+ "$ref": "#/components/responses/GeneralError"
4123+ }
4124+ }
4125+ }
4126+ },
4127+ "/projects/{project_id}/branches/{branch_id}/anonymized_status": {
4128+ "parameters": [
4129+ {
4130+ "name": "project_id",
4131+ "in": "path",
4132+ "description": "The Neon project ID",
4133+ "required": true,
4134+ "schema": {
4135+ "type": "string",
4136+ "pattern": "^[a-z0-9-]{1,60}$"
4137+ }
4138+ },
4139+ {
4140+ "name": "branch_id",
4141+ "in": "path",
4142+ "description": "The branch ID",
4143+ "required": true,
4144+ "schema": {
4145+ "type": "string",
4146+ "pattern": "^[a-z0-9-]{1,60}$"
4147+ }
4148+ }
4149+ ],
4150+ "get": {
4151+ "tags": [
4152+ "Branch"
4153+ ],
4154+ "summary": "Get anonymized branch status",
4155+ "description": "Retrieves the current status of an anonymized branch, including its state and progress information.\nThis endpoint allows you to monitor the anonymization process from initialization through completion.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nYou can obtain the `branch_id` by listing the project's branches.\nOnly anonymized branches will have status information available.\n\n**Note**: This endpoint is currently in Beta.\n",
4156+ "operationId": "getAnonymizedBranchStatus",
4157+ "responses": {
4158+ "200": {
4159+ "description": "Anonymized branch status retrieved successfully",
4160+ "content": {
4161+ "application/json": {
4162+ "schema": {
4163+ "$ref": "#/components/schemas/AnonymizedBranchStatusResponse"
4164+ }
4165+ }
4166+ }
4167+ },
4168+ "default": {
4169+ "$ref": "#/components/responses/GeneralError"
4170+ }
4171+ }
4172+ }
4173+ },
4174+ "/projects/{project_id}/branches/{branch_id}/anonymize": {
4175+ "parameters": [
4176+ {
4177+ "name": "project_id",
4178+ "in": "path",
4179+ "description": "The Neon project ID",
4180+ "required": true,
4181+ "schema": {
4182+ "type": "string",
4183+ "pattern": "^[a-z0-9-]{1,60}$"
4184+ }
4185+ },
4186+ {
4187+ "name": "branch_id",
4188+ "in": "path",
4189+ "description": "The branch ID",
4190+ "required": true,
4191+ "schema": {
4192+ "type": "string",
4193+ "pattern": "^[a-z0-9-]{1,60}$"
4194+ }
4195+ }
4196+ ],
4197+ "post": {
4198+ "tags": [
4199+ "Branch"
4200+ ],
4201+ "summary": "Start anonymization",
4202+ "description": "Starts the anonymization process for an anonymized branch that is in the initialized, error, or anonymized state.\nThis will apply all defined masking rules to anonymize sensitive data in the branch databases.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nYou can obtain the `branch_id` by listing the project's branches.\nThe branch must be an anonymized branch to start anonymization.\n\n**Note**: This endpoint is currently in Beta.\n",
4203+ "operationId": "startAnonymization",
4204+ "responses": {
4205+ "200": {
4206+ "description": "Anonymization started successfully",
4207+ "content": {
4208+ "application/json": {
4209+ "schema": {
4210+ "$ref": "#/components/schemas/AnonymizedBranchStatusResponse"
4211+ }
4212+ }
4213+ }
4214+ },
4215+ "default": {
4216+ "$ref": "#/components/responses/GeneralError"
4217+ }
4218+ }
4219+ }
4220+ },
4221+ "/projects/{project_id}/branches/{branch_id}/set_as_default": {
4222+ "parameters": [
4223+ {
4224+ "name": "project_id",
4225+ "in": "path",
4226+ "description": "The Neon project ID",
4227+ "required": true,
4228+ "schema": {
4229+ "type": "string",
4230+ "pattern": "^[a-z0-9-]{1,60}$"
4231+ }
4232+ },
4233+ {
4234+ "name": "branch_id",
4235+ "in": "path",
4236+ "description": "The branch ID",
4237+ "required": true,
4238+ "schema": {
4239+ "type": "string",
4240+ "pattern": "^[a-z0-9-]{1,60}$"
4241+ }
4242+ }
4243+ ],
4244+ "post": {
4245+ "tags": [
4246+ "Branch"
4247+ ],
4248+ "summary": "Set branch as default",
4249+ "description": "Sets the specified branch as the project's default branch.\nThe default designation is automatically removed from the previous default branch.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nYou can obtain the `branch_id` by listing the project's branches.\nFor more information, see [Manage branches](https://neon.tech/docs/manage/branches/).\n",
4250+ "operationId": "setDefaultProjectBranch",
4251+ "responses": {
4252+ "200": {
4253+ "description": "Updated the specified branch",
4254+ "content": {
4255+ "application/json": {
4256+ "schema": {
4257+ "$ref": "#/components/schemas/BranchOperations"
4258+ },
4259+ "example": {
4260+ "branch": {
4261+ "cpu_used_sec": 1,
4262+ "active_time_seconds": 1,
4263+ "compute_time_seconds": 1,
4264+ "written_data_bytes": 100,
4265+ "data_transfer_bytes": 100,
4266+ "id": "br-icy-dream-250089",
4267+ "project_id": "shiny-wind-028834",
4268+ "parent_id": "br-aged-salad-637688",
4269+ "parent_lsn": "0/1E19478",
4270+ "name": "mybranch",
4271+ "current_state": "ready",
4272+ "state_changed_at": "2022-11-30T20:09:48Z",
4273+ "created_at": "2022-11-23T17:42:25Z",
4274+ "updated_at": "2022-11-23T17:42:26Z",
4275+ "default": true,
4276+ "protected": false,
4277+ "creation_source": "console",
4278+ "init_source": "parent-data"
4279+ },
4280+ "operations": []
4281+ }
4282+ }
4283+ }
4284+ },
4285+ "default": {
4286+ "$ref": "#/components/responses/GeneralError"
4287+ }
4288+ }
4289+ }
4290+ },
4291+ "/projects/{project_id}/branches/{branch_id}/finalize_restore": {
4292+ "parameters": [
4293+ {
4294+ "name": "project_id",
4295+ "in": "path",
4296+ "description": "The Neon project ID",
4297+ "required": true,
4298+ "schema": {
4299+ "type": "string",
4300+ "pattern": "^[a-z0-9-]{1,60}$"
4301+ }
4302+ },
4303+ {
4304+ "name": "branch_id",
4305+ "in": "path",
4306+ "description": "The branch ID",
4307+ "required": true,
4308+ "schema": {
4309+ "type": "string",
4310+ "pattern": "^[a-z0-9-]{1,60}$"
4311+ }
4312+ }
4313+ ],
4314+ "post": {
4315+ "summary": "Finalize restore",
4316+ "description": "Finalize the restore operation for a branch created from a snapshot.\nThis operation updates the branch so it functions as the original branch it replaced.\nThis includes:\n - Reassigning any computes from the original branch to the restored branch (this will restart the computes)\n - Renaming the restored branch to the original branch's name\n - Renaming the original branch so it no longer uses the original name\n\nThis operation only applies to branches created using the `restoreSnapshot` endpoint with `finalize_restore: false`.\n\n**Note**: This endpoint is currently in Beta.\n",
4317+ "tags": [
4318+ "Branch"
4319+ ],
4320+ "operationId": "finalizeRestoreBranch",
4321+ "requestBody": {
4322+ "required": false,
4323+ "content": {
4324+ "application/json": {
4325+ "schema": {
4326+ "type": "object",
4327+ "properties": {
4328+ "name": {
4329+ "type": "string",
4330+ "description": "used to rename the existing branch when it is replaced. if omitted, a default name is generated and used"
4331+ }
4332+ }
4333+ }
4334+ }
4335+ }
4336+ },
4337+ "responses": {
4338+ "200": {
4339+ "description": "OK",
4340+ "content": {
4341+ "application/json": {
4342+ "schema": {
4343+ "$ref": "#/components/schemas/OperationsResponse"
4344+ }
4345+ }
4346+ }
4347+ },
4348+ "default": {
4349+ "$ref": "#/components/responses/GeneralError"
4350+ }
4351+ }
4352+ }
4353+ },
4354+ "/projects/{project_id}/branches/{branch_id}/endpoints": {
4355+ "parameters": [
4356+ {
4357+ "name": "project_id",
4358+ "in": "path",
4359+ "description": "The Neon project ID",
4360+ "required": true,
4361+ "schema": {
4362+ "type": "string",
4363+ "pattern": "^[a-z0-9-]{1,60}$"
4364+ }
4365+ },
4366+ {
4367+ "name": "branch_id",
4368+ "in": "path",
4369+ "description": "The branch ID",
4370+ "required": true,
4371+ "schema": {
4372+ "type": "string",
4373+ "pattern": "^[a-z0-9-]{1,60}$"
4374+ }
4375+ }
4376+ ],
4377+ "get": {
4378+ "summary": "List branch endpoints",
4379+ "description": "Retrieves a list of compute endpoints for the specified branch.\nNeon permits only one read-write compute endpoint per branch.\nA branch can have multiple read-only compute endpoints.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nYou can obtain the `branch_id` by listing the project's branches.\n",
4380+ "tags": [
4381+ "Branch"
4382+ ],
4383+ "operationId": "listProjectBranchEndpoints",
4384+ "responses": {
4385+ "200": {
4386+ "description": "Returned a list of endpoints for the specified branch",
4387+ "content": {
4388+ "application/json": {
4389+ "schema": {
4390+ "$ref": "#/components/schemas/EndpointsResponse"
4391+ },
4392+ "example": {
4393+ "endpoints": [
4394+ {
4395+ "host": "ep-little-smoke-851426.us-east-2.aws.neon.tech",
4396+ "id": "ep-little-smoke-851426",
4397+ "project_id": "shiny-wind-028834",
4398+ "branch_id": "br-aged-salad-637688",
4399+ "autoscaling_limit_min_cu": 1,
4400+ "autoscaling_limit_max_cu": 1,
4401+ "region_id": "aws-us-east-2",
4402+ "type": "read_write",
4403+ "current_state": "idle",
4404+ "settings": {
4405+ "pg_settings": {}
4406+ },
4407+ "pooler_enabled": false,
4408+ "pooler_mode": "transaction",
4409+ "disabled": false,
4410+ "passwordless_access": true,
4411+ "last_active": "2022-11-23T17:00:00Z",
4412+ "created_at": "2022-11-23T17:42:25Z",
4413+ "updated_at": "2022-11-30T18:25:21Z",
4414+ "proxy_host": "us-east-2.aws.neon.tech",
4415+ "creation_source": "console",
4416+ "provisioner": "k8s-pod",
4417+ "suspend_timeout_seconds": 10800
4418+ }
4419+ ]
4420+ }
4421+ }
4422+ }
4423+ },
4424+ "default": {
4425+ "$ref": "#/components/responses/GeneralError"
4426+ }
4427+ }
4428+ }
4429+ },
4430+ "/projects/{project_id}/branches/{branch_id}/databases": {
4431+ "parameters": [
4432+ {
4433+ "name": "project_id",
4434+ "in": "path",
4435+ "description": "The Neon project ID",
4436+ "required": true,
4437+ "schema": {
4438+ "type": "string",
4439+ "pattern": "^[a-z0-9-]{1,60}$"
4440+ }
4441+ },
4442+ {
4443+ "name": "branch_id",
4444+ "in": "path",
4445+ "description": "The branch ID",
4446+ "required": true,
4447+ "schema": {
4448+ "type": "string",
4449+ "pattern": "^[a-z0-9-]{1,60}$"
4450+ }
4451+ }
4452+ ],
4453+ "get": {
4454+ "summary": "List databases",
4455+ "description": "Retrieves a list of databases for the specified branch.\nA branch can have multiple databases.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nYou can obtain the `branch_id` by listing the project's branches.\nFor related information, see [Manage databases](https://neon.tech/docs/manage/databases/).\n",
4456+ "tags": [
4457+ "Branch"
4458+ ],
4459+ "operationId": "listProjectBranchDatabases",
4460+ "responses": {
4461+ "200": {
4462+ "description": "Returned a list of databases of the specified branch",
4463+ "content": {
4464+ "application/json": {
4465+ "schema": {
4466+ "$ref": "#/components/schemas/DatabasesResponse"
4467+ },
4468+ "example": {
4469+ "databases": [
4470+ {
4471+ "id": 834686,
4472+ "branch_id": "br-aged-salad-637688",
4473+ "name": "main",
4474+ "owner_name": "casey",
4475+ "created_at": "2022-11-30T18:25:15Z",
4476+ "updated_at": "2022-11-30T18:25:15Z"
4477+ },
4478+ {
4479+ "id": 834686,
4480+ "branch_id": "br-aged-salad-637688",
4481+ "name": "mydb",
4482+ "owner_name": "casey",
4483+ "created_at": "2022-10-30T17:14:13Z",
4484+ "updated_at": "2022-10-30T17:14:13Z"
4485+ }
4486+ ]
4487+ }
4488+ }
4489+ }
4490+ },
4491+ "default": {
4492+ "$ref": "#/components/responses/GeneralError"
4493+ }
4494+ }
4495+ },
4496+ "post": {
4497+ "tags": [
4498+ "Branch"
4499+ ],
4500+ "summary": "Create database",
4501+ "description": "Creates a database in the specified branch.\nA branch can have multiple databases.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nYou can obtain the `branch_id` by listing the project's branches.\nFor related information, see [Manage databases](https://neon.tech/docs/manage/databases/).\n",
4502+ "operationId": "createProjectBranchDatabase",
4503+ "requestBody": {
4504+ "content": {
4505+ "application/json": {
4506+ "schema": {
4507+ "$ref": "#/components/schemas/DatabaseCreateRequest"
4508+ },
4509+ "example": {
4510+ "database": {
4511+ "name": "mydb",
4512+ "owner_name": "casey"
4513+ }
4514+ }
4515+ }
4516+ },
4517+ "required": true
4518+ },
4519+ "responses": {
4520+ "201": {
4521+ "description": "Created a database in the specified branch",
4522+ "content": {
4523+ "application/json": {
4524+ "schema": {
4525+ "$ref": "#/components/schemas/DatabaseOperations"
4526+ },
4527+ "example": {
4528+ "database": {
4529+ "id": 876692,
4530+ "branch_id": "br-aged-salad-637688",
4531+ "name": "mydb",
4532+ "owner_name": "casey",
4533+ "created_at": "2022-12-04T00:15:04Z",
4534+ "updated_at": "2022-12-04T00:15:04Z"
4535+ },
4536+ "operations": [
4537+ {
4538+ "id": "39426015-db00-40fa-85c5-1c7072df46d0",
4539+ "project_id": "shiny-wind-028834",
4540+ "branch_id": "br-aged-salad-637688",
4541+ "endpoint_id": "ep-little-smoke-851426",
4542+ "action": "apply_config",
4543+ "status": "running",
4544+ "failures_count": 0,
4545+ "created_at": "2022-12-04T00:15:04Z",
4546+ "updated_at": "2022-12-04T00:15:04Z",
4547+ "total_duration_ms": 100
4548+ },
4549+ {
4550+ "id": "b7483d4e-33da-4d40-b319-ac858d4d3e69",
4551+ "project_id": "shiny-wind-028834",
4552+ "branch_id": "br-aged-salad-637688",
4553+ "endpoint_id": "ep-little-smoke-851426",
4554+ "action": "suspend_compute",
4555+ "status": "scheduling",
4556+ "failures_count": 0,
4557+ "created_at": "2022-12-04T00:15:04Z",
4558+ "updated_at": "2022-12-04T00:15:04Z",
4559+ "total_duration_ms": 100
4560+ }
4561+ ]
4562+ }
4563+ }
4564+ }
4565+ },
4566+ "default": {
4567+ "$ref": "#/components/responses/GeneralError"
4568+ }
4569+ }
4570+ }
4571+ },
4572+ "/projects/{project_id}/branches/{branch_id}/databases/{database_name}": {
4573+ "parameters": [
4574+ {
4575+ "name": "project_id",
4576+ "in": "path",
4577+ "description": "The Neon project ID",
4578+ "required": true,
4579+ "schema": {
4580+ "type": "string",
4581+ "pattern": "^[a-z0-9-]{1,60}$"
4582+ }
4583+ },
4584+ {
4585+ "name": "branch_id",
4586+ "in": "path",
4587+ "description": "The branch ID",
4588+ "required": true,
4589+ "schema": {
4590+ "type": "string",
4591+ "pattern": "^[a-z0-9-]{1,60}$"
4592+ }
4593+ },
4594+ {
4595+ "name": "database_name",
4596+ "in": "path",
4597+ "description": "The database name",
4598+ "required": true,
4599+ "schema": {
4600+ "type": "string"
4601+ }
4602+ }
4603+ ],
4604+ "get": {
4605+ "summary": "Retrieve database details",
4606+ "description": "Retrieves information about the specified database.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nYou can obtain the `branch_id` and `database_name` by listing the branch's databases.\nFor related information, see [Manage databases](https://neon.tech/docs/manage/databases/).\n",
4607+ "tags": [
4608+ "Branch"
4609+ ],
4610+ "operationId": "getProjectBranchDatabase",
4611+ "responses": {
4612+ "200": {
4613+ "description": "Returned the database details",
4614+ "content": {
4615+ "application/json": {
4616+ "schema": {
4617+ "$ref": "#/components/schemas/DatabaseResponse"
4618+ },
4619+ "example": {
4620+ "database": {
4621+ "id": 834686,
4622+ "branch_id": "br-aged-salad-637688",
4623+ "name": "main",
4624+ "owner_name": "casey",
4625+ "created_at": "2022-11-30T18:25:15Z",
4626+ "updated_at": "2022-11-30T18:25:15Z"
4627+ }
4628+ }
4629+ }
4630+ }
4631+ },
4632+ "default": {
4633+ "$ref": "#/components/responses/GeneralError"
4634+ }
4635+ }
4636+ },
4637+ "patch": {
4638+ "tags": [
4639+ "Branch"
4640+ ],
4641+ "summary": "Update database",
4642+ "description": "Updates the specified database in the branch.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nYou can obtain the `branch_id` and `database_name` by listing the branch's databases.\nFor related information, see [Manage databases](https://neon.tech/docs/manage/databases/).\n",
4643+ "operationId": "updateProjectBranchDatabase",
4644+ "requestBody": {
4645+ "content": {
4646+ "application/json": {
4647+ "schema": {
4648+ "$ref": "#/components/schemas/DatabaseUpdateRequest"
4649+ },
4650+ "example": {
4651+ "database": {
4652+ "name": "mydb",
4653+ "owner_name": "sally"
4654+ }
4655+ }
4656+ }
4657+ },
4658+ "required": true
4659+ },
4660+ "responses": {
4661+ "200": {
4662+ "description": "Updated the database",
4663+ "content": {
4664+ "application/json": {
4665+ "schema": {
4666+ "$ref": "#/components/schemas/DatabaseOperations"
4667+ },
4668+ "example": {
4669+ "database": {
4670+ "id": 876692,
4671+ "branch_id": "br-aged-salad-637688",
4672+ "name": "mydb",
4673+ "owner_name": "sally",
4674+ "created_at": "2022-12-04T00:15:04Z",
4675+ "updated_at": "2022-12-04T00:15:04Z"
4676+ },
4677+ "operations": [
4678+ {
4679+ "id": "9ef1c2ed-dce4-43aa-bae8-78aea636bf8a",
4680+ "project_id": "shiny-wind-028834",
4681+ "branch_id": "br-aged-salad-637688",
4682+ "endpoint_id": "ep-little-smoke-851426",
4683+ "action": "apply_config",
4684+ "status": "running",
4685+ "failures_count": 0,
4686+ "created_at": "2022-12-04T00:21:01Z",
4687+ "updated_at": "2022-12-04T00:21:01Z",
4688+ "total_duration_ms": 100
4689+ },
4690+ {
4691+ "id": "42dafb46-f861-497b-ae89-f2bec54f4966",
4692+ "project_id": "shiny-wind-028834",
4693+ "branch_id": "br-aged-salad-637688",
4694+ "endpoint_id": "ep-little-smoke-851426",
4695+ "action": "suspend_compute",
4696+ "status": "scheduling",
4697+ "failures_count": 0,
4698+ "created_at": "2022-12-04T00:21:01Z",
4699+ "updated_at": "2022-12-04T00:21:01Z",
4700+ "total_duration_ms": 100
4701+ }
4702+ ]
4703+ }
4704+ }
4705+ }
4706+ },
4707+ "default": {
4708+ "$ref": "#/components/responses/GeneralError"
4709+ }
4710+ }
4711+ },
4712+ "delete": {
4713+ "summary": "Delete database",
4714+ "description": "Deletes the specified database from the branch.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nYou can obtain the `branch_id` and `database_name` by listing the branch's databases.\nFor related information, see [Manage databases](https://neon.tech/docs/manage/databases/).\n",
4715+ "tags": [
4716+ "Branch"
4717+ ],
4718+ "operationId": "deleteProjectBranchDatabase",
4719+ "responses": {
4720+ "200": {
4721+ "description": "Deleted the specified database",
4722+ "content": {
4723+ "application/json": {
4724+ "schema": {
4725+ "$ref": "#/components/schemas/DatabaseOperations"
4726+ },
4727+ "example": {
4728+ "database": {
4729+ "id": 851537,
4730+ "branch_id": "br-raspy-hill-832856",
4731+ "name": "mydb",
4732+ "owner_name": "casey",
4733+ "created_at": "2022-12-01T19:41:46Z",
4734+ "updated_at": "2022-12-01T19:41:46Z"
4735+ },
4736+ "operations": [
4737+ {
4738+ "id": "9ef1c2ed-dce4-43aa-bae8-78aea636bf8a",
4739+ "project_id": "shiny-wind-028834",
4740+ "branch_id": "br-raspy-hill-832856",
4741+ "endpoint_id": "ep-steep-bush-777093",
4742+ "action": "apply_config",
4743+ "status": "running",
4744+ "failures_count": 0,
4745+ "created_at": "2022-12-01T19:51:41Z",
4746+ "updated_at": "2022-12-01T19:51:41Z",
4747+ "total_duration_ms": 100
4748+ },
4749+ {
4750+ "id": "42dafb46-f861-497b-ae89-f2bec54f4966",
4751+ "project_id": "shiny-wind-028834",
4752+ "branch_id": "br-raspy-hill-832856",
4753+ "endpoint_id": "ep-steep-bush-777093",
4754+ "action": "suspend_compute",
4755+ "status": "scheduling",
4756+ "failures_count": 0,
4757+ "created_at": "2022-12-01T19:51:41Z",
4758+ "updated_at": "2022-12-01T19:51:41Z",
4759+ "total_duration_ms": 100
4760+ }
4761+ ]
4762+ }
4763+ }
4764+ }
4765+ },
4766+ "204": {
4767+ "description": "Returned if the database doesn't exist or has already been deleted"
4768+ },
4769+ "default": {
4770+ "$ref": "#/components/responses/GeneralError"
4771+ }
4772+ }
4773+ }
4774+ },
4775+ "/projects/{project_id}/branches/{branch_id}/roles": {
4776+ "parameters": [
4777+ {
4778+ "name": "project_id",
4779+ "in": "path",
4780+ "description": "The Neon project ID",
4781+ "required": true,
4782+ "schema": {
4783+ "type": "string",
4784+ "pattern": "^[a-z0-9-]{1,60}$"
4785+ }
4786+ },
4787+ {
4788+ "name": "branch_id",
4789+ "in": "path",
4790+ "description": "The branch ID",
4791+ "required": true,
4792+ "schema": {
4793+ "type": "string",
4794+ "pattern": "^[a-z0-9-]{1,60}$"
4795+ }
4796+ }
4797+ ],
4798+ "get": {
4799+ "summary": "List roles",
4800+ "description": "Retrieves a list of Postgres roles from the specified branch.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nYou can obtain the `branch_id` by listing the project's branches.\nFor related information, see [Manage roles](https://neon.tech/docs/manage/roles/).\n",
4801+ "tags": [
4802+ "Branch"
4803+ ],
4804+ "operationId": "listProjectBranchRoles",
4805+ "responses": {
4806+ "200": {
4807+ "description": "Returned a list of roles from the specified branch.",
4808+ "content": {
4809+ "application/json": {
4810+ "schema": {
4811+ "$ref": "#/components/schemas/RolesResponse"
4812+ },
4813+ "example": {
4814+ "roles": [
4815+ {
4816+ "branch_id": "br-aged-salad-637688",
4817+ "name": "casey",
4818+ "protected": false,
4819+ "created_at": "2022-11-23T17:42:25Z",
4820+ "updated_at": "2022-11-23T17:42:25Z"
4821+ },
4822+ {
4823+ "branch_id": "br-aged-salad-637688",
4824+ "name": "thomas",
4825+ "protected": false,
4826+ "created_at": "2022-10-22T17:38:21Z",
4827+ "updated_at": "2022-10-22T17:38:21Z"
4828+ }
4829+ ]
4830+ }
4831+ }
4832+ }
4833+ },
4834+ "default": {
4835+ "$ref": "#/components/responses/GeneralError"
4836+ }
4837+ }
4838+ },
4839+ "post": {
4840+ "summary": "Create role",
4841+ "description": "Creates a Postgres role in the specified branch.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nYou can obtain the `branch_id` by listing the project's branches.\nFor related information, see [Manage roles](https://neon.tech/docs/manage/roles/).\n\nConnections established to the active compute endpoint will be dropped.\nIf the compute endpoint is idle, the endpoint becomes active for a short period of time and is suspended afterward.\n",
4842+ "tags": [
4843+ "Branch"
4844+ ],
4845+ "operationId": "createProjectBranchRole",
4846+ "requestBody": {
4847+ "content": {
4848+ "application/json": {
4849+ "schema": {
4850+ "$ref": "#/components/schemas/RoleCreateRequest"
4851+ },
4852+ "example": {
4853+ "role": {
4854+ "name": "sally"
4855+ }
4856+ }
4857+ }
4858+ },
4859+ "required": true
4860+ },
4861+ "responses": {
4862+ "201": {
4863+ "description": "Created a role in the specified branch",
4864+ "content": {
4865+ "application/json": {
4866+ "schema": {
4867+ "$ref": "#/components/schemas/RoleOperations"
4868+ },
4869+ "example": {
4870+ "role": {
4871+ "branch_id": "br-noisy-sunset-458773",
4872+ "name": "sally",
4873+ "password": "Onf1AjayKwe0",
4874+ "protected": false,
4875+ "created_at": "2022-12-03T11:58:29Z",
4876+ "updated_at": "2022-12-03T11:58:29Z"
4877+ },
4878+ "operations": [
4879+ {
4880+ "id": "2c2be371-d5ac-4db5-8b68-79f05e8bc287",
4881+ "project_id": "shiny-wind-028834",
4882+ "branch_id": "br-noisy-sunset-458773",
4883+ "endpoint_id": "ep-small-pine-767857",
4884+ "action": "apply_config",
4885+ "status": "running",
4886+ "failures_count": 0,
4887+ "created_at": "2022-12-03T11:58:29Z",
4888+ "updated_at": "2022-12-03T11:58:29Z",
4889+ "total_duration_ms": 100
4890+ }
4891+ ]
4892+ }
4893+ }
4894+ }
4895+ },
4896+ "default": {
4897+ "$ref": "#/components/responses/GeneralError"
4898+ }
4899+ }
4900+ }
4901+ },
4902+ "/projects/{project_id}/branches/{branch_id}/roles/{role_name}": {
4903+ "parameters": [
4904+ {
4905+ "name": "project_id",
4906+ "in": "path",
4907+ "description": "The Neon project ID",
4908+ "required": true,
4909+ "schema": {
4910+ "type": "string",
4911+ "pattern": "^[a-z0-9-]{1,60}$"
4912+ }
4913+ },
4914+ {
4915+ "name": "branch_id",
4916+ "in": "path",
4917+ "description": "The branch ID",
4918+ "required": true,
4919+ "schema": {
4920+ "type": "string",
4921+ "pattern": "^[a-z0-9-]{1,60}$"
4922+ }
4923+ },
4924+ {
4925+ "name": "role_name",
4926+ "in": "path",
4927+ "description": "The role name",
4928+ "required": true,
4929+ "schema": {
4930+ "type": "string"
4931+ }
4932+ }
4933+ ],
4934+ "get": {
4935+ "summary": "Retrieve role details",
4936+ "description": "Retrieves details about the specified role.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nYou can obtain the `branch_id` by listing the project's branches.\nYou can obtain the `role_name` by listing the roles for a branch.\nIn Neon, the terms \"role\" and \"user\" are synonymous.\nFor related information, see [Manage roles](https://neon.tech/docs/manage/roles/).\n",
4937+ "tags": [
4938+ "Branch"
4939+ ],
4940+ "operationId": "getProjectBranchRole",
4941+ "responses": {
4942+ "200": {
4943+ "description": "Returned details for the specified role",
4944+ "content": {
4945+ "application/json": {
4946+ "schema": {
4947+ "$ref": "#/components/schemas/RoleResponse"
4948+ },
4949+ "example": {
4950+ "role": {
4951+ "branch_id": "br-noisy-sunset-458773",
4952+ "name": "casey",
4953+ "protected": false,
4954+ "created_at": "2022-11-23T17:42:25Z",
4955+ "updated_at": "2022-11-23T17:42:25Z"
4956+ }
4957+ }
4958+ }
4959+ }
4960+ },
4961+ "default": {
4962+ "$ref": "#/components/responses/GeneralError"
4963+ }
4964+ }
4965+ },
4966+ "delete": {
4967+ "summary": "Delete role",
4968+ "description": "Deletes the specified Postgres role from the branch.\nYou can obtain a `project_id` by listing the projects for your Neon account.\nYou can obtain the `branch_id` by listing the project's branches.\nYou can obtain the `role_name` by listing the roles for a branch.\nFor related information, see [Manage roles](https://neon.tech/docs/manage/roles/).\n",
4969+ "tags": [
4970+ "Branch"
4971+ ],
4972+ "operationId": "deleteProjectBranchRole",
4973+ "responses": {
4974+ "200": {
4975+ "description": "Deleted the specified role from the branch",
4976+ "content": {
4977+ "application/json": {
4978+ "schema": {
4979+ "$ref": "#/components/schemas/RoleOperations"
4980+ },
4981+ "example": {
4982+ "role": {
4983+ "branch_id": "br-raspy-hill-832856",
4984+ "name": "thomas",
4985+ "protected": false,
4986+ "created_at": "2022-12-01T14:36:23Z",
4987+ "updated_at": "2022-12-01T14:36:23Z"
4988+ },
4989+ "operations": [
4990+ {
4991+ "id": "db646be3-eace-4910-9f60-8150823c5cb8",
4992+ "project_id": "shiny-wind-028834",
4993+ "branch_id": "br-raspy-hill-832856",
4994+ "endpoint_id": "ep-steep-bush-777093",
4995+ "action": "apply_config",
4996+ "status": "running",
4997+ "failures_count": 0,
4998+ "created_at": "2022-12-01T19:48:11Z",
4999+ "updated_at": "2022-12-01T19:48:11Z",

9359 more lines aren’t shown here.

This diff is larger than a page shows: the files after these aren’t listed. Clone the repository to see all of it.