asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

api-ref: custom API reference (#4770)

Browse Source 
* 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
2023-08-15 18:07:54 +03:00
committed by GitHub
parent 16249ec280
commit 914d773d3a
3270 changed files with 22075 additions and 192064 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/docs/content/references/js-client/interfaces/internal.AxiosInstance.md
+377
View File
@@ -0,0 +1,377 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: AxiosInstance
[internal](../modules/internal.md).AxiosInstance
## Hierarchy
- [`Axios`](../classes/internal.Axios.md)
↳ **`AxiosInstance`**
## Callable
### AxiosInstance
▸ **AxiosInstance**(`config`): [`AxiosPromise`](internal.AxiosPromise.md)<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `config` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\> |
#### Returns
[`AxiosPromise`](internal.AxiosPromise.md)<`any`\>
#### Defined in
medusa-js/node_modules/axios/index.d.ts:188
### AxiosInstance
▸ **AxiosInstance**(`url`, `config?`): [`AxiosPromise`](internal.AxiosPromise.md)<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\> |
#### Returns
[`AxiosPromise`](internal.AxiosPromise.md)<`any`\>
#### Defined in
medusa-js/node_modules/axios/index.d.ts:189
## Properties
### defaults
• **defaults**: [`AxiosDefaults`](internal.AxiosDefaults.md)<`any`\>
#### Inherited from
[Axios](../classes/internal.Axios.md).[defaults](../classes/internal.Axios.md#defaults)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:171
___
### interceptors
• **interceptors**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `request` | [`AxiosInterceptorManager`](internal.AxiosInterceptorManager.md)<[`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\>\> |
| `response` | [`AxiosInterceptorManager`](internal.AxiosInterceptorManager.md)<[`AxiosResponse`](internal.AxiosResponse.md)<`any`, `any`\>\> |
#### Inherited from
[Axios](../classes/internal.Axios.md).[interceptors](../classes/internal.Axios.md#interceptors)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:172
## Methods
### delete
▸ **delete**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
#### Returns
`Promise`<`R`\>
#### Inherited from
[Axios](../classes/internal.Axios.md).[delete](../classes/internal.Axios.md#delete)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:179
___
### get
▸ **get**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
#### Returns
`Promise`<`R`\>
#### Inherited from
[Axios](../classes/internal.Axios.md).[get](../classes/internal.Axios.md#get)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:178
___
### getUri
▸ **getUri**(`config?`): `string`
#### Parameters
| Name | Type |
| :------ | :------ |
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\> |
#### Returns
`string`
#### Inherited from
[Axios](../classes/internal.Axios.md).[getUri](../classes/internal.Axios.md#geturi)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:176
___
### head
▸ **head**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
#### Returns
`Promise`<`R`\>
#### Inherited from
[Axios](../classes/internal.Axios.md).[head](../classes/internal.Axios.md#head)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:180
___
### options
▸ **options**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
#### Returns
`Promise`<`R`\>
#### Inherited from
[Axios](../classes/internal.Axios.md).[options](../classes/internal.Axios.md#options)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:181
___
### patch
▸ **patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `data?` | `D` |
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
#### Returns
`Promise`<`R`\>
#### Inherited from
[Axios](../classes/internal.Axios.md).[patch](../classes/internal.Axios.md#patch)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:184
___
### post
▸ **post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `data?` | `D` |
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
#### Returns
`Promise`<`R`\>
#### Inherited from
[Axios](../classes/internal.Axios.md).[post](../classes/internal.Axios.md#post)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:182
___
### put
▸ **put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `data?` | `D` |
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
#### Returns
`Promise`<`R`\>
#### Inherited from
[Axios](../classes/internal.Axios.md).[put](../classes/internal.Axios.md#put)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:183
___
### request
▸ **request**<`T`, `R`, `D`\>(`config`): `Promise`<`R`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `config` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
#### Returns
`Promise`<`R`\>
#### Inherited from
[Axios](../classes/internal.Axios.md).[request](../classes/internal.Axios.md#request)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:177