diff --git a/website/src/components/ApiRequest/ApiRequest.stories.jsx b/website/src/components/ApiRequest/ApiRequest.stories.jsx index 8a0aff8d9f..257fc77afc 100644 --- a/website/src/components/ApiRequest/ApiRequest.stories.jsx +++ b/website/src/components/ApiRequest/ApiRequest.stories.jsx @@ -16,41 +16,40 @@ const Template = (args) => ( ); -export const Step1 = Template.bind({}); -Step1.args = { - open: true, - seedData: { - currentStep: 1, - }, +export const GET = Template.bind({}); +GET.args = { + verb: 'get', + url: 'api/admin/segments', + title: 'List all segments (example).', }; -export const Step2 = Template.bind({}); -Step2.args = { - seedData: { - currentStep: 2, - }, - open: true, +export const POST = Template.bind({}); +POST.args = { + verb: 'post', + payload: { name: '', impressionData: true }, + url: 'api/admin/projects//features', + title: 'Create a feature toggle with impression data enabled. (example)', }; -export const Step3 = Template.bind({}); -Step3.args = { - seedData: { - currentStep: 3, - }, - open: true, +export const PUT = Template.bind({}); +PUT.args = { + verb: 'put', + payload: { name: '', impressionData: true }, + url: 'api/admin/projects//features/', + title: 'Create a feature toggle with impression data enabled (example).', }; -export const Step4 = Template.bind({}); -Step4.args = { - seedData: { - currentStep: 4, - }, - open: true, +export const PATCH = Template.bind({}); +PATCH.args = { + verb: 'patch', + payload: [{ op: 'replace', path: '/impressionData', value: true }], + url: 'api/admin/projects//features/', + title: 'Enable impression data on an existing toggle (example).', }; -export const WithLocalStorage = Template.bind({}); -WithLocalStorage.args = { - open: true, +export const DELETE = Template.bind({}); +DELETE.args = { + verb: 'delete', + url: 'api/admin/projects//features/', + title: 'Create a feature toggle with impression data enabled.', }; - -export const Closed = Template.bind({}); diff --git a/website/src/components/ApiRequest/index.tsx b/website/src/components/ApiRequest/index.tsx index 725b066959..0e0bc3caef 100644 --- a/website/src/components/ApiRequest/index.tsx +++ b/website/src/components/ApiRequest/index.tsx @@ -17,40 +17,67 @@ import CodeBlock from '@theme/CodeBlock'; const indentation = 2; -const Component = ({ verb, payload, url, title }) => { +type Props = { + verb: string, + payload?: any, + url: string, + title?: string +} + +type PropsWithoutPayload = Omit + + +const Component: React.FC = ({ verb, payload, url, title }) => { const verbUpper = verb?.toUpperCase() || ''; const prettyPayload = JSON.stringify(payload, null, indentation); + const httpBlock = (payload ? ` +${verbUpper} /${url} +Authorization: +content-type: application/json + +${prettyPayload}` :` +${verbUpper} /${url} +Authorization: +content-type: application/json`).trim() + + const curlBlock = (payload ? ` +curl -H "Content-Type: application/json" \\ + -H "Authorization: " \\ + -X ${verbUpper} \\ + -d '${prettyPayload}' \\ + /${url}` : ` +curl -H "Content-Type: application/json" \\ + -H "Authorization: " \\ + -X ${verbUpper} \\ + /${url}` ).trim() + + const httpieBlock = (payload ? + `echo '${prettyPayload}' \\ +| http ${verbUpper} \\ + /${url} \\ + Authorization:` + : ` +http ${verbUpper} \\ + /${url} \\ + Authorization:`.trim() + ).trim() + return ( - {` -${verbUpper} /${url} -Authorization: -content-type: application/json - -${prettyPayload} -`.trim()} + {httpBlock} - {` -curl -H "Content-Type: application/json" \\ - -H "Authorization: " \\ - -X ${verbUpper} \\ - -d '${prettyPayload}' \\ - /${url} -`.trim()} + {curlBlock} - {`echo '${prettyPayload}' \\ -| http ${verbUpper} \\ - /${url} \\ - Authorization:`.trim()} + {httpieBlock}