mirror of
https://github.com/supabase/supabase.git
synced 2026-06-24 09:55:17 +08:00
Refactor tabs so that: - Behavior add-ons, such as query params, are HOCs in ui-patterns, to keep the basic Tabs minimal - No dependency on next/router (this is to smooth out a separate App Router migration PR) - No dependency on useSearchParams either (this is to preserve static generation of as much HTML content as possible, for SEO purposes -- see comment about client-rendering bailout when using useSearchParams) - Syncing behavior better localized in a hook Minor enhancement to save tab preferences to local storage so they are remembered between sessions
118 lines
4.6 KiB
TypeScript
118 lines
4.6 KiB
TypeScript
import { CodeBlock } from 'ui'
|
|
import Param from '~/components/Params'
|
|
import RefSubLayout from '~/layouts/ref/RefSubLayout'
|
|
import { Tabs, TabPanel } from '~/components/Tabs'
|
|
import { ReactMarkdown } from 'react-markdown/lib/react-markdown'
|
|
|
|
const ApiOperationSection = (props) => {
|
|
const operation = props.spec.operations.find((x: any) => x.operationId === props.funcData.id)
|
|
|
|
// gracefully return nothing if function does not exist
|
|
if (!operation) return <></>
|
|
|
|
return (
|
|
<RefSubLayout.Section
|
|
key={operation.operationId}
|
|
slug={operation.operationId}
|
|
title={operation.summary}
|
|
id={operation.operationId}
|
|
scrollSpyHeader={true}
|
|
monoFont={false}
|
|
>
|
|
<RefSubLayout.Details>
|
|
<div className="mt-4">
|
|
<code className="text-md flex gap-4 text-md text-foreground-lighter break-all">
|
|
<span
|
|
className="
|
|
uppercase
|
|
whitespace-nowrap
|
|
bg-foreground text-background
|
|
flex items-center justify-center
|
|
rounded-full font-mono font-medium text-xs px-2 py-0.5"
|
|
>
|
|
{operation.operation}
|
|
</span>
|
|
{operation.path}
|
|
</code>
|
|
</div>
|
|
<div className="prose py-4">
|
|
<p>{operation.description}</p>
|
|
</div>
|
|
{/* Path Parameters */}
|
|
{operation.parameters &&
|
|
operation.parameters.filter((parameter) => parameter.in === 'path').length > 0 && (
|
|
<div className="not-prose mt-12">
|
|
<h5 className="mb-3 text-base text-foreground">Path Parameters</h5>
|
|
<ul className="mt-4">
|
|
{operation.parameters &&
|
|
operation.parameters
|
|
.filter((parameter: any) => parameter.in === 'path')
|
|
.map((parameter: any, index: number) => (
|
|
<Param key={index} {...parameter} isOptional={!parameter.required}></Param>
|
|
))}
|
|
</ul>
|
|
</div>
|
|
)}
|
|
|
|
{/* Query Parameters */}
|
|
{operation.parameters &&
|
|
operation.parameters.filter((parameter) => parameter.in === 'query').length > 0 && (
|
|
<div className="not-prose mt-12">
|
|
<h5 className="mb-3 text-base text-foreground">Query Parameters</h5>
|
|
<ul className="mt-4">
|
|
{operation.parameters &&
|
|
operation.parameters
|
|
.filter((parameter: any) => parameter.in === 'query')
|
|
.map((parameter: any, index: number) => (
|
|
<Param key={index} {...parameter} isOptional={!parameter.required}></Param>
|
|
))}
|
|
</ul>
|
|
</div>
|
|
)}
|
|
|
|
{/* Header Parameters */}
|
|
{operation.parameters &&
|
|
operation.parameters.filter((parameter) => parameter.in === 'header').length > 0 && (
|
|
<div className="not-prose mt-12">
|
|
<h5 className="mb-3 text-base text-foreground">Query Parameters</h5>
|
|
<ul className="mt-4">
|
|
{operation.parameters &&
|
|
operation.parameters
|
|
.filter((parameter: any) => parameter.in === 'header')
|
|
.map((parameter: any, index) => (
|
|
<Param key={index} {...parameter} isOptional={!parameter.required}></Param>
|
|
))}
|
|
</ul>
|
|
</div>
|
|
)}
|
|
</RefSubLayout.Details>
|
|
{operation.responseList && operation.responseList.length > 0 && (
|
|
<RefSubLayout.Examples>
|
|
<h5 className="mb-3 text-base text-foreground">Responses</h5>
|
|
<Tabs
|
|
scrollable
|
|
size="small"
|
|
type="underlined"
|
|
defaultActiveId={operation.responseList[0].responseCode}
|
|
queryGroup="response-status"
|
|
>
|
|
{operation.responseList.map((response: any, i: number) => (
|
|
<TabPanel key={i} id={response.responseCode} label={response.responseCode}>
|
|
<ReactMarkdown className="text-foreground">{response.description}</ReactMarkdown>
|
|
{response?.content && response?.content['application/json'] && (
|
|
<div className="mt-8">
|
|
<CodeBlock language="bash" className="relative">
|
|
{JSON.stringify(response.content['application/json'], null, 2)}
|
|
</CodeBlock>
|
|
</div>
|
|
)}
|
|
</TabPanel>
|
|
))}
|
|
</Tabs>
|
|
</RefSubLayout.Examples>
|
|
)}
|
|
</RefSubLayout.Section>
|
|
)
|
|
}
|
|
export default ApiOperationSection
|