api-ref: custom API reference (#4770)
* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
This commit is contained in:
Shahed Nasser
@@ -0,0 +1,195 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: RetryConfig
|
||||
|
||||
[internal](../modules/internal.md).RetryConfig
|
||||
|
||||
Configuration for the Axios `request` method.
|
||||
|
||||
## Properties
|
||||
|
||||
### backoffType
|
||||
|
||||
• `Optional` **backoffType**: ``"linear"`` \| ``"static"`` \| ``"exponential"``
|
||||
|
||||
Backoff Type; 'linear', 'static' or 'exponential'.
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:47
|
||||
|
||||
___
|
||||
|
||||
### checkRetryAfter
|
||||
|
||||
• `Optional` **checkRetryAfter**: `boolean`
|
||||
|
||||
Whether to check for 'Retry-After' header in response and use value as delay. Defaults to true.
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:51
|
||||
|
||||
___
|
||||
|
||||
### currentRetryAttempt
|
||||
|
||||
• `Optional` **currentRetryAttempt**: `number`
|
||||
|
||||
The number of retries already attempted.
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:13
|
||||
|
||||
___
|
||||
|
||||
### httpMethodsToRetry
|
||||
|
||||
• `Optional` **httpMethodsToRetry**: `string`[]
|
||||
|
||||
The HTTP Methods that will be automatically retried.
|
||||
Defaults to ['GET','PUT','HEAD','OPTIONS','DELETE']
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:26
|
||||
|
||||
___
|
||||
|
||||
### instance
|
||||
|
||||
• `Optional` **instance**: [`AxiosInstance`](internal.AxiosInstance.md)
|
||||
|
||||
The instance of the axios object to which the interceptor is attached.
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:21
|
||||
|
||||
___
|
||||
|
||||
### maxRetryAfter
|
||||
|
||||
• `Optional` **maxRetryAfter**: `number`
|
||||
|
||||
Max permitted Retry-After value (in ms) - rejects if greater. Defaults to 5 mins.
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:55
|
||||
|
||||
___
|
||||
|
||||
### maxRetryDelay
|
||||
|
||||
• `Optional` **maxRetryDelay**: `number`
|
||||
|
||||
Ceiling for calculated delay (in ms) - delay will not exceed this value.
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:59
|
||||
|
||||
___
|
||||
|
||||
### noResponseRetries
|
||||
|
||||
• `Optional` **noResponseRetries**: `number`
|
||||
|
||||
When there is no response, the number of retries to attempt. Defaults to 2.
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:43
|
||||
|
||||
___
|
||||
|
||||
### onRetryAttempt
|
||||
|
||||
• `Optional` **onRetryAttempt**: (`err`: [`AxiosError`](internal.AxiosError.md)<`any`, `any`\>) => `void`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
▸ (`err`): `void`
|
||||
|
||||
Function to invoke when a retry attempt is made.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `err` | [`AxiosError`](internal.AxiosError.md)<`any`, `any`\> |
|
||||
|
||||
##### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:35
|
||||
|
||||
___
|
||||
|
||||
### retry
|
||||
|
||||
• `Optional` **retry**: `number`
|
||||
|
||||
The number of times to retry the request. Defaults to 3.
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:9
|
||||
|
||||
___
|
||||
|
||||
### retryDelay
|
||||
|
||||
• `Optional` **retryDelay**: `number`
|
||||
|
||||
The amount of time to initially delay the retry. Defaults to 100.
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:17
|
||||
|
||||
___
|
||||
|
||||
### shouldRetry
|
||||
|
||||
• `Optional` **shouldRetry**: (`err`: [`AxiosError`](internal.AxiosError.md)<`any`, `any`\>) => `boolean`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
▸ (`err`): `boolean`
|
||||
|
||||
Function to invoke which determines if you should retry
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `err` | [`AxiosError`](internal.AxiosError.md)<`any`, `any`\> |
|
||||
|
||||
##### Returns
|
||||
|
||||
`boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:39
|
||||
|
||||
___
|
||||
|
||||
### statusCodesToRetry
|
||||
|
||||
• `Optional` **statusCodesToRetry**: `number`[][]
|
||||
|
||||
The HTTP response status codes that will automatically be retried.
|
||||
Defaults to: [[100, 199], [429, 429], [500, 599]]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:31
|
||||
Reference in New Issue
Block a user