docs: general fixes and improvements (#7918)
* docs improvements and changes * updated module definition * modules + dml changes * fix build * fix vale error * fix lint errors * fixes to stripe docs * fix condition * fix condition * fix module defintion * fix checkout * disable UI action * change oas preview action * flatten provider module options * fix lint errors * add module link docs * pr comments fixes * fix vale error * change node engine version * links -> linkable * add note about database name * small fixes * link fixes * fix response code in api reference * added migrations step
This commit is contained in:
Shahed Nasser
@@ -17,130 +17,128 @@ type ApiRunnerProps = {
|
||||
bodyData?: Record<string, unknown>
|
||||
}
|
||||
|
||||
export const ApiRunner = ({
|
||||
apiMethod,
|
||||
apiUrl,
|
||||
pathData,
|
||||
bodyData,
|
||||
queryData,
|
||||
}: ApiRunnerProps) => {
|
||||
// assemble api testing options
|
||||
const [apiTestingOptions, setApiTestingOptions] = useState<ApiTestingOptions>(
|
||||
{
|
||||
method: apiMethod,
|
||||
url: apiUrl,
|
||||
pathData,
|
||||
bodyData,
|
||||
queryData,
|
||||
}
|
||||
)
|
||||
const [isRunning, setIsRunning] = useState(false)
|
||||
const [ran, setRan] = useState(false)
|
||||
const hasData = (data?: Record<string, unknown>): boolean =>
|
||||
data !== undefined && Object.keys(data).length > 0
|
||||
// TODO change to be based on whether auth/data needed
|
||||
const manualTestTrigger = useMemo(
|
||||
() =>
|
||||
hasData(apiTestingOptions.pathData) ||
|
||||
hasData(apiTestingOptions.queryData) ||
|
||||
hasData(apiTestingOptions.bodyData),
|
||||
[apiTestingOptions]
|
||||
)
|
||||
const [responseLogs, setResponseLogs] = useState<string[]>([])
|
||||
const [responseCode, setResponseCode] = useState<string | undefined>()
|
||||
const pushMessage = (...message: string[]) =>
|
||||
setResponseLogs((prev) => [...prev, ...message])
|
||||
const { runRequest } = useRequestRunner({
|
||||
pushLog: pushMessage,
|
||||
onFinish: (_message, statusCode) => {
|
||||
setIsRunning(false)
|
||||
setResponseCode(statusCode)
|
||||
},
|
||||
replaceLog: (message) => setResponseLogs([message]),
|
||||
})
|
||||
export const ApiRunner = React.forwardRef<HTMLDivElement, ApiRunnerProps>(
|
||||
function ApiRunner(
|
||||
{ apiMethod, apiUrl, pathData, bodyData, queryData }: ApiRunnerProps,
|
||||
ref
|
||||
) {
|
||||
// assemble api testing options
|
||||
const [apiTestingOptions, setApiTestingOptions] =
|
||||
useState<ApiTestingOptions>({
|
||||
method: apiMethod,
|
||||
url: apiUrl,
|
||||
pathData,
|
||||
bodyData,
|
||||
queryData,
|
||||
})
|
||||
const [isRunning, setIsRunning] = useState(false)
|
||||
const [ran, setRan] = useState(false)
|
||||
const hasData = (data?: Record<string, unknown>): boolean =>
|
||||
data !== undefined && Object.keys(data).length > 0
|
||||
// TODO change to be based on whether auth/data needed
|
||||
const manualTestTrigger = useMemo(
|
||||
() =>
|
||||
hasData(apiTestingOptions.pathData) ||
|
||||
hasData(apiTestingOptions.queryData) ||
|
||||
hasData(apiTestingOptions.bodyData),
|
||||
[apiTestingOptions]
|
||||
)
|
||||
const [responseLogs, setResponseLogs] = useState<string[]>([])
|
||||
const [responseCode, setResponseCode] = useState<string | undefined>()
|
||||
const pushMessage = (...message: string[]) =>
|
||||
setResponseLogs((prev) => [...prev, ...message])
|
||||
const { runRequest } = useRequestRunner({
|
||||
pushLog: pushMessage,
|
||||
onFinish: (_message, statusCode) => {
|
||||
setIsRunning(false)
|
||||
setResponseCode(statusCode)
|
||||
},
|
||||
replaceLog: (message) => setResponseLogs([message]),
|
||||
})
|
||||
|
||||
useEffect(() => {
|
||||
if (!isRunning && !manualTestTrigger && !ran) {
|
||||
setIsRunning(true)
|
||||
}
|
||||
}, [apiTestingOptions, manualTestTrigger, isRunning, ran])
|
||||
useEffect(() => {
|
||||
if (!isRunning && !manualTestTrigger && !ran) {
|
||||
setIsRunning(true)
|
||||
}
|
||||
}, [apiTestingOptions, manualTestTrigger, isRunning, ran])
|
||||
|
||||
useEffect(() => {
|
||||
if (isRunning && !ran) {
|
||||
setRan(true)
|
||||
setResponseLogs(["Sending request..."])
|
||||
runRequest(apiTestingOptions)
|
||||
}
|
||||
}, [isRunning, ran])
|
||||
useEffect(() => {
|
||||
if (isRunning && !ran) {
|
||||
setRan(true)
|
||||
setResponseLogs(["Sending request..."])
|
||||
runRequest(apiTestingOptions)
|
||||
}
|
||||
}, [isRunning, ran])
|
||||
|
||||
return (
|
||||
<>
|
||||
{manualTestTrigger && (
|
||||
<Card className="font-base mb-docs_1" contentClassName="gap-docs_0.5">
|
||||
{apiTestingOptions.pathData && (
|
||||
<ApiRunnerParamInputs
|
||||
data={apiTestingOptions.pathData}
|
||||
title="Path Parameters"
|
||||
baseObjPath="pathData"
|
||||
setValue={
|
||||
setApiTestingOptions as React.Dispatch<
|
||||
React.SetStateAction<unknown>
|
||||
>
|
||||
}
|
||||
/>
|
||||
)}
|
||||
{apiTestingOptions.bodyData && (
|
||||
<ApiRunnerParamInputs
|
||||
data={apiTestingOptions.bodyData}
|
||||
title="Request Body Parameters"
|
||||
baseObjPath="bodyData"
|
||||
setValue={
|
||||
setApiTestingOptions as React.Dispatch<
|
||||
React.SetStateAction<unknown>
|
||||
>
|
||||
}
|
||||
/>
|
||||
)}
|
||||
{apiTestingOptions.queryData && (
|
||||
<ApiRunnerParamInputs
|
||||
data={apiTestingOptions.queryData}
|
||||
title="Request Query Parameters"
|
||||
baseObjPath="queryData"
|
||||
setValue={
|
||||
setApiTestingOptions as React.Dispatch<
|
||||
React.SetStateAction<unknown>
|
||||
>
|
||||
}
|
||||
/>
|
||||
)}
|
||||
<Button
|
||||
onClick={() => {
|
||||
setIsRunning(true)
|
||||
setRan(false)
|
||||
}}
|
||||
>
|
||||
Send Request
|
||||
</Button>
|
||||
</Card>
|
||||
)}
|
||||
{(isRunning || ran) && (
|
||||
<CodeBlock
|
||||
source={responseLogs.join("\n")}
|
||||
lang="json"
|
||||
title="Testing Result"
|
||||
collapsed={true}
|
||||
blockStyle="subtle"
|
||||
noReport={true}
|
||||
badgeLabel={responseCode}
|
||||
badgeColor={
|
||||
!responseCode
|
||||
? undefined
|
||||
: responseCode.startsWith("2")
|
||||
? "green"
|
||||
: "red"
|
||||
}
|
||||
/>
|
||||
)}
|
||||
</>
|
||||
)
|
||||
}
|
||||
return (
|
||||
<div ref={ref}>
|
||||
{manualTestTrigger && (
|
||||
<Card className="font-base mb-docs_1" contentClassName="gap-docs_0.5">
|
||||
{apiTestingOptions.pathData && (
|
||||
<ApiRunnerParamInputs
|
||||
data={apiTestingOptions.pathData}
|
||||
title="Path Parameters"
|
||||
baseObjPath="pathData"
|
||||
setValue={
|
||||
setApiTestingOptions as React.Dispatch<
|
||||
React.SetStateAction<unknown>
|
||||
>
|
||||
}
|
||||
/>
|
||||
)}
|
||||
{apiTestingOptions.bodyData && (
|
||||
<ApiRunnerParamInputs
|
||||
data={apiTestingOptions.bodyData}
|
||||
title="Request Body Parameters"
|
||||
baseObjPath="bodyData"
|
||||
setValue={
|
||||
setApiTestingOptions as React.Dispatch<
|
||||
React.SetStateAction<unknown>
|
||||
>
|
||||
}
|
||||
/>
|
||||
)}
|
||||
{apiTestingOptions.queryData && (
|
||||
<ApiRunnerParamInputs
|
||||
data={apiTestingOptions.queryData}
|
||||
title="Request Query Parameters"
|
||||
baseObjPath="queryData"
|
||||
setValue={
|
||||
setApiTestingOptions as React.Dispatch<
|
||||
React.SetStateAction<unknown>
|
||||
>
|
||||
}
|
||||
/>
|
||||
)}
|
||||
<Button
|
||||
onClick={() => {
|
||||
setIsRunning(true)
|
||||
setRan(false)
|
||||
}}
|
||||
>
|
||||
Send Request
|
||||
</Button>
|
||||
</Card>
|
||||
)}
|
||||
{(isRunning || ran) && (
|
||||
<CodeBlock
|
||||
source={responseLogs.join("\n")}
|
||||
lang="json"
|
||||
title="Testing Result"
|
||||
collapsed={true}
|
||||
blockStyle="subtle"
|
||||
noReport={true}
|
||||
badgeLabel={responseCode}
|
||||
badgeColor={
|
||||
!responseCode
|
||||
? undefined
|
||||
: responseCode.startsWith("2")
|
||||
? "green"
|
||||
: "red"
|
||||
}
|
||||
/>
|
||||
)}
|
||||
</div>
|
||||
)
|
||||
}
|
||||
)
|
||||
|
||||
Reference in New Issue
Block a user