Files
supabase/studio/components/interfaces/ProjectAPIDocs/Content/RPC.tsx
T
Joshen LimandTerry Sutton 94f5fc5a61 Feat/api side panel (#17880)
* Demo api side panel

* Add docs for storage and edge functions

* Add content

* fix

* Add scroll to logic

* Add storage docs

* Add docs URLs

* Add connecting to project section in getting started

* Link back to docs site for product + resource specific docs

* Add entry points into API side panel for table editor, auth users and storage

* Add entry points into API side panel for edge functions

* Beef up feature preview modal with content

* Fix asset path

* Address several feedback

* Addressing more feedback

* Shift GraphiQL page to database if new api docs flag enabled

* Spelling

* Wording changes

* Spacing and wording

* Fix small issues

* Fix

* Update key showing toggle button

---------

Co-authored-by: Terry Sutton <saltcod@gmail.com>
2023-10-05 13:30:12 +08:00

78 lines
2.7 KiB
TypeScript

import { useParams } from 'common'
import { Badge } from 'ui'
import Table from 'components/to-be-cleaned/Table'
import { useProjectJsonSchemaQuery } from 'data/docs/project-json-schema-query'
import { useOpenAPISpecQuery } from 'data/open-api/api-spec-query'
import { useAppStateSnapshot } from 'state/app-state'
import { DOCS_RESOURCE_CONTENT } from '../ProjectAPIDocs.constants'
import ResourceContent from '../ResourceContent'
import { ContentProps } from './Content.types'
const RPC = ({ language }: ContentProps) => {
const { ref } = useParams()
const snap = useAppStateSnapshot()
const { data: jsonSchema } = useProjectJsonSchemaQuery({ projectRef: ref })
const { data } = useOpenAPISpecQuery({ projectRef: ref })
const functions = data?.functions ?? []
const rpcName = snap.activeDocsSection[1]
const rpc = functions.find((fn) => fn.name === rpcName)
const rpcJsonSchema = jsonSchema?.paths[rpc?.path]
const summary = rpcJsonSchema?.post.summary
const parameters = rpc?.get.parameters ?? []
if (rpc === undefined) return null
return (
<div className="divide-y">
<div className="space-y-1 px-4 py-6">
<h2 className="text-xl">{rpc.name}</h2>
<p className="text-sm text-foreground-light">{summary ?? 'No description available'}</p>
</div>
<div className="space-y-2 px-4 py-4">
<p className="text-sm text-foreground-light">Function arguments</p>
<Table
head={[
<Table.th key="name">Name</Table.th>,
<Table.th key="format">Format</Table.th>,
<Table.th key="type">Type</Table.th>,
<Table.th key="required"></Table.th>,
]}
body={parameters.map((parameter: any) => (
<Table.tr key={parameter.name}>
<Table.td title={parameter.name}>
<p className="font-mono text-xs text-foreground truncate">{parameter.name}</p>
</Table.td>
<Table.td title={parameter.format}>{parameter.format}</Table.td>
<Table.td title={parameter.type}>{parameter.type}</Table.td>
<Table.td>
{parameter.required ? (
<Badge color="amber">Required</Badge>
) : (
<p className="text-foreground-light">Optional</p>
)}
</Table.td>
</Table.tr>
))}
/>
</div>
<ResourceContent
selectedLanguage={language}
snippet={DOCS_RESOURCE_CONTENT.rpcSingle}
codeSnippets={DOCS_RESOURCE_CONTENT.rpcSingle.code({
rpcName,
rpcParams: parameters,
endpoint: 'endpoint',
apiKey: 'apiKey',
showBearer: true,
})}
/>
</div>
)
}
export default RPC