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,519 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: AxiosDefaults<D\>
|
||||
|
||||
[internal](../modules/internal.md).AxiosDefaults
|
||||
|
||||
## Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `D` | `any` |
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `Omit`<[`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\>, ``"headers"``\>
|
||||
|
||||
↳ **`AxiosDefaults`**
|
||||
|
||||
## Properties
|
||||
|
||||
### adapter
|
||||
|
||||
• `Optional` **adapter**: [`AxiosAdapter`](internal.AxiosAdapter.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.adapter
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:75
|
||||
|
||||
___
|
||||
|
||||
### auth
|
||||
|
||||
• `Optional` **auth**: [`AxiosBasicCredentials`](internal.AxiosBasicCredentials.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.auth
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:76
|
||||
|
||||
___
|
||||
|
||||
### baseURL
|
||||
|
||||
• `Optional` **baseURL**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.baseURL
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:65
|
||||
|
||||
___
|
||||
|
||||
### cancelToken
|
||||
|
||||
• `Optional` **cancelToken**: [`CancelToken`](internal.CancelToken.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.cancelToken
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:90
|
||||
|
||||
___
|
||||
|
||||
### data
|
||||
|
||||
• `Optional` **data**: `D`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.data
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:71
|
||||
|
||||
___
|
||||
|
||||
### decompress
|
||||
|
||||
• `Optional` **decompress**: `boolean`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.decompress
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:91
|
||||
|
||||
___
|
||||
|
||||
### headers
|
||||
|
||||
• **headers**: [`HeadersDefaults`](internal.HeadersDefaults.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:112
|
||||
|
||||
___
|
||||
|
||||
### httpAgent
|
||||
|
||||
• `Optional` **httpAgent**: `any`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.httpAgent
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:87
|
||||
|
||||
___
|
||||
|
||||
### httpsAgent
|
||||
|
||||
• `Optional` **httpsAgent**: `any`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.httpsAgent
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:88
|
||||
|
||||
___
|
||||
|
||||
### insecureHTTPParser
|
||||
|
||||
• `Optional` **insecureHTTPParser**: `boolean`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.insecureHTTPParser
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:94
|
||||
|
||||
___
|
||||
|
||||
### maxBodyLength
|
||||
|
||||
• `Optional` **maxBodyLength**: `number`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.maxBodyLength
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:84
|
||||
|
||||
___
|
||||
|
||||
### maxContentLength
|
||||
|
||||
• `Optional` **maxContentLength**: `number`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.maxContentLength
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:82
|
||||
|
||||
___
|
||||
|
||||
### maxRedirects
|
||||
|
||||
• `Optional` **maxRedirects**: `number`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.maxRedirects
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:85
|
||||
|
||||
___
|
||||
|
||||
### method
|
||||
|
||||
• `Optional` **method**: [`Method`](../modules/internal.md#method)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.method
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:64
|
||||
|
||||
___
|
||||
|
||||
### onDownloadProgress
|
||||
|
||||
• `Optional` **onDownloadProgress**: (`progressEvent`: `any`) => `void`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
▸ (`progressEvent`): `void`
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `progressEvent` | `any` |
|
||||
|
||||
##### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.onDownloadProgress
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:81
|
||||
|
||||
___
|
||||
|
||||
### onUploadProgress
|
||||
|
||||
• `Optional` **onUploadProgress**: (`progressEvent`: `any`) => `void`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
▸ (`progressEvent`): `void`
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `progressEvent` | `any` |
|
||||
|
||||
##### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.onUploadProgress
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:80
|
||||
|
||||
___
|
||||
|
||||
### params
|
||||
|
||||
• `Optional` **params**: `any`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.params
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:69
|
||||
|
||||
___
|
||||
|
||||
### paramsSerializer
|
||||
|
||||
• `Optional` **paramsSerializer**: (`params`: `any`) => `string`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
▸ (`params`): `string`
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `params` | `any` |
|
||||
|
||||
##### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.paramsSerializer
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:70
|
||||
|
||||
___
|
||||
|
||||
### proxy
|
||||
|
||||
• `Optional` **proxy**: ``false`` \| [`AxiosProxyConfig`](internal.AxiosProxyConfig.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.proxy
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:89
|
||||
|
||||
___
|
||||
|
||||
### raxConfig
|
||||
|
||||
• `Optional` **raxConfig**: [`RetryConfig`](internal.RetryConfig.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.raxConfig
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:89
|
||||
|
||||
___
|
||||
|
||||
### responseType
|
||||
|
||||
• `Optional` **responseType**: [`ResponseType`](../modules/internal.md#responsetype)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.responseType
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:77
|
||||
|
||||
___
|
||||
|
||||
### signal
|
||||
|
||||
• `Optional` **signal**: `AbortSignal`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.signal
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:93
|
||||
|
||||
___
|
||||
|
||||
### socketPath
|
||||
|
||||
• `Optional` **socketPath**: ``null`` \| `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.socketPath
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:86
|
||||
|
||||
___
|
||||
|
||||
### timeout
|
||||
|
||||
• `Optional` **timeout**: `number`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.timeout
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:72
|
||||
|
||||
___
|
||||
|
||||
### timeoutErrorMessage
|
||||
|
||||
• `Optional` **timeoutErrorMessage**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.timeoutErrorMessage
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:73
|
||||
|
||||
___
|
||||
|
||||
### transformRequest
|
||||
|
||||
• `Optional` **transformRequest**: [`AxiosRequestTransformer`](internal.AxiosRequestTransformer.md) \| [`AxiosRequestTransformer`](internal.AxiosRequestTransformer.md)[]
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.transformRequest
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:66
|
||||
|
||||
___
|
||||
|
||||
### transformResponse
|
||||
|
||||
• `Optional` **transformResponse**: [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.md) \| [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.md)[]
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.transformResponse
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:67
|
||||
|
||||
___
|
||||
|
||||
### transitional
|
||||
|
||||
• `Optional` **transitional**: [`TransitionalOptions`](internal.TransitionalOptions.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.transitional
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:92
|
||||
|
||||
___
|
||||
|
||||
### url
|
||||
|
||||
• `Optional` **url**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.url
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:63
|
||||
|
||||
___
|
||||
|
||||
### validateStatus
|
||||
|
||||
• `Optional` **validateStatus**: ``null`` \| (`status`: `number`) => `boolean`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.validateStatus
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:83
|
||||
|
||||
___
|
||||
|
||||
### withCredentials
|
||||
|
||||
• `Optional` **withCredentials**: `boolean`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.withCredentials
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:74
|
||||
|
||||
___
|
||||
|
||||
### xsrfCookieName
|
||||
|
||||
• `Optional` **xsrfCookieName**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.xsrfCookieName
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:78
|
||||
|
||||
___
|
||||
|
||||
### xsrfHeaderName
|
||||
|
||||
• `Optional` **xsrfHeaderName**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.xsrfHeaderName
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:79
|
||||
Reference in New Issue
Block a user