Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Graphql api docs #19122

Draft
wants to merge 6 commits into
base: production
Choose a base branch
from
Draft

Graphql api docs #19122

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ebc0f3a
Merge branch 'production' of https://github.com/cloudflare/cloudflare…
Ankcorn Jan 8, 2025
1f66f33
add graphql client
Ankcorn Jan 10, 2025
8316a97
fix build error
Ankcorn Jan 10, 2025
519b3fe
preview link
Ankcorn Jan 10, 2025
5d76497
loadcss
Ankcorn Jan 10, 2025
0d75985
some more styles
Ankcorn Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
some more styles
  • Loading branch information
@Ankcorn
Ankcorn committed Jan 10, 2025
commit 0d7598512cc210eef0e17b0ad5fa01547d8d8d00
28 changes: 28 additions & 0 deletions src/components/CollapsibleSection.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { type ReactNode, useState } from "react";

interface CollapsibleSectionProps {
title: string;
children: ReactNode;
defaultOpen?: boolean;
}

export const CollapsibleSection = ({
title,
children,
defaultOpen = false,
}: CollapsibleSectionProps) => {
const [isOpen, setIsOpen] = useState(defaultOpen);

return (
<div className="mb-4 rounded-lg border">
<button
onClick={() => setIsOpen(!isOpen)}
className="flex h-full w-full cursor-pointer items-center justify-between rounded-t-lg bg-gray-50 p-4 hover:bg-gray-100"
>
<h3 className="text-lg font-semibold">{title}</h3>
<span className="text-lg">{isOpen ? "▼" : "▶"}</span>
</button>
{isOpen && <span className="border-t">{children}</span>}
</div>
);
};
39 changes: 25 additions & 14 deletions src/pages/analytics/graphql-api/api/[name].astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import StarlightPage from "@astrojs/starlight/components/StarlightPage.astro";
import SchemaViewer from "~/components/models/SchemaViewer.astro";
import { Code } from "~/components";
import { LinkButton } from "~/components";
import { CollapsibleSection } from "~/components/CollapsibleSection";
import {
GraphQLToJSONSchemaBuilder,
type Field,
Expand Down Expand Up @@ -59,7 +60,10 @@ const typescriptInput = await compile(
{ additionalProperties: false, bannerComment: "" },
);

const [group, queryName] = name.split(".");
const [group, queryName] = name.split(".") as [
"account" | "zone" | "organization",
string,
];
const gqlQuery = graphQLJSONSchemaToExample(
`${group}s`,
queryName,
Expand All @@ -74,19 +78,26 @@ const gqlQuery = graphQLJSONSchemaToExample(
>
<h2>{name.split(".").join(" ")}</h2>
<p>{query.description}</p>
<h3>Example</h3>
<LinkButton href={`/analytics/graphql-api/graphiql?query=${btoa(gqlQuery)}`}
>Open in GraphiQL</LinkButton
>
<Code code={gqlQuery} lang="graphql" />
<h3 id="Parameters">Parameters</h3>
<SchemaViewer schema={completeInputType} />
<h4>Typescript definition</h4>
<Code code={typescriptInput} lang="typescript" />
<h3 id="Output">Output</h3>
<SchemaViewer schema={completeResponseType} />
<h4>Typescript definition</h4>
<Code code={typescriptOutput} lang="typescript" />
<div class="mt-4">
<CollapsibleSection client:load title="Example GraphQL Query" defaultOpen>
<LinkButton
href={`/analytics/graphql-api/graphiql?query=${btoa(gqlQuery)}`}
>Open in GraphiQL</LinkButton
>
<Code code={gqlQuery} lang="graphql" />
</CollapsibleSection>

<CollapsibleSection client:load title="Parameters">
<SchemaViewer schema={completeInputType} />
<h4>Typescript definition</h4>
<Code code={typescriptInput} lang="typescript" />
</CollapsibleSection>
<CollapsibleSection client:load title="Output">
<SchemaViewer schema={completeResponseType} />
<h4>Typescript definition</h4>
<Code code={typescriptOutput} lang="typescript" />
</CollapsibleSection>
</div>
</StarlightPage>

<style>
Expand Down
1 change: 1 addition & 0 deletions src/pages/analytics/graphql-api/graphiql.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import "~/tailwind.css";
},
}}
/>

<style>
:root {
--sl-content-width: 100% !important;
Expand Down
1 change: 0 additions & 1 deletion src/util/graphQLJSONSchemaToExample.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ export function graphQLJSONSchemaToExample(
const outputSections = Object.keys(output.properties || {}).reduce(
(outputQuery, key) => {
const type = output.properties?.[key].type;
console.log(type);

let outputQueryType = "";
if (type === "object") {
Expand Down
Loading