Skip to content

Commit

Permalink
Merge pull request #858 from saleor/update-reference
Browse files Browse the repository at this point in the history 
Update Admin & Storefront API reference
  • Loading branch information
@2can
2can committed Aug 2, 2023
2 parents 1b0d0a1 + 8eb499b commit dba46e7
Show file tree
Hide file tree
Showing 1,951 changed files with 15,147 additions and 14,236 deletions.
4 changes: 2 additions & 2 deletions docs/api-reference/apps/enums/app-error-code.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const SpecifiedBy = (props) => (

export const Badge = (props) => (
<>
<span className={"badge badge--" + props.class}>{props.text}</span>
<span className={props.class}>{props.text}</span>
</>
);

Expand Down Expand Up @@ -158,4 +158,4 @@ enum AppErrorCode {
### Member of

[`AppError`](../../../api-reference/apps/objects/app-error) <Badge class="secondary" text="object"/>
[`AppError`](../../../api-reference/apps/objects/app-error) <Badge class="badge badge--secondary" text="object"/>
4 changes: 2 additions & 2 deletions docs/api-reference/apps/enums/app-extension-mount-enum.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const SpecifiedBy = (props) => (

export const Badge = (props) => (
<>
<span className={"badge badge--" + props.class}>{props.text}</span>
<span className={props.class}>{props.text}</span>
</>
);

Expand Down Expand Up @@ -158,4 +158,4 @@ enum AppExtensionMountEnum {
### Member of

[`AppExtension`](../../../api-reference/apps/objects/app-extension) <Badge class="secondary" text="object"/><Bullet />[`AppExtensionFilterInput`](../../../api-reference/apps/inputs/app-extension-filter-input) <Badge class="secondary" text="input"/><Bullet />[`AppManifestExtension`](../../../api-reference/apps/objects/app-manifest-extension) <Badge class="secondary" text="object"/>
[`AppExtension`](../../../api-reference/apps/objects/app-extension) <Badge class="badge badge--secondary" text="object"/><Bullet />[`AppExtensionFilterInput`](../../../api-reference/apps/inputs/app-extension-filter-input) <Badge class="badge badge--secondary" text="input"/><Bullet />[`AppManifestExtension`](../../../api-reference/apps/objects/app-manifest-extension) <Badge class="badge badge--secondary" text="object"/>
4 changes: 2 additions & 2 deletions docs/api-reference/apps/enums/app-extension-target-enum.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const SpecifiedBy = (props) => (

export const Badge = (props) => (
<>
<span className={"badge badge--" + props.class}>{props.text}</span>
<span className={props.class}>{props.text}</span>
</>
);

Expand Down Expand Up @@ -96,4 +96,4 @@ enum AppExtensionTargetEnum {
### Member of

[`AppExtension`](../../../api-reference/apps/objects/app-extension) <Badge class="secondary" text="object"/><Bullet />[`AppExtensionFilterInput`](../../../api-reference/apps/inputs/app-extension-filter-input) <Badge class="secondary" text="input"/><Bullet />[`AppManifestExtension`](../../../api-reference/apps/objects/app-manifest-extension) <Badge class="secondary" text="object"/>
[`AppExtension`](../../../api-reference/apps/objects/app-extension) <Badge class="badge badge--secondary" text="object"/><Bullet />[`AppExtensionFilterInput`](../../../api-reference/apps/inputs/app-extension-filter-input) <Badge class="badge badge--secondary" text="input"/><Bullet />[`AppManifestExtension`](../../../api-reference/apps/objects/app-manifest-extension) <Badge class="badge badge--secondary" text="object"/>
4 changes: 2 additions & 2 deletions docs/api-reference/apps/enums/app-sort-field.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const SpecifiedBy = (props) => (

export const Badge = (props) => (
<>
<span className={"badge badge--" + props.class}>{props.text}</span>
<span className={props.class}>{props.text}</span>
</>
);

Expand Down Expand Up @@ -93,4 +93,4 @@ enum AppSortField {
### Member of

[`AppSortingInput`](../../../api-reference/apps/inputs/app-sorting-input) <Badge class="secondary" text="input"/>
[`AppSortingInput`](../../../api-reference/apps/inputs/app-sorting-input) <Badge class="badge badge--secondary" text="input"/>
4 changes: 2 additions & 2 deletions docs/api-reference/apps/enums/app-type-enum.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const SpecifiedBy = (props) => (

export const Badge = (props) => (
<>
<span className={"badge badge--" + props.class}>{props.text}</span>
<span className={props.class}>{props.text}</span>
</>
);

Expand Down Expand Up @@ -93,4 +93,4 @@ enum AppTypeEnum {
### Member of

[`App`](../../../api-reference/apps/objects/app) <Badge class="secondary" text="object"/><Bullet />[`AppFilterInput`](../../../api-reference/apps/inputs/app-filter-input) <Badge class="secondary" text="input"/>
[`App`](../../../api-reference/apps/objects/app) <Badge class="badge badge--secondary" text="object"/><Bullet />[`AppFilterInput`](../../../api-reference/apps/inputs/app-filter-input) <Badge class="badge badge--secondary" text="input"/>
8 changes: 4 additions & 4 deletions docs/api-reference/apps/inputs/app-extension-filter-input.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const SpecifiedBy = (props) => (

export const Badge = (props) => (
<>
<span className={"badge badge--" + props.class}>{props.text}</span>
<span className={props.class}>{props.text}</span>
</>
);

Expand Down Expand Up @@ -83,14 +83,14 @@ input AppExtensionFilterInput {

### Fields

#### [<code style={{ fontWeight: 'normal' }}>AppExtensionFilterInput.<b>mount</b></code>](#)<Bullet />[`[AppExtensionMountEnum!]`](../../../api-reference/apps/enums/app-extension-mount-enum) <Badge class="secondary" text="list"/> <Badge class="secondary" text="enum"/>
#### [<code style={{ fontWeight: 'normal' }}>AppExtensionFilterInput.<b>mount</b></code>](#)<Bullet />[`[AppExtensionMountEnum!]`](../../../api-reference/apps/enums/app-extension-mount-enum) <Badge class="badge badge--secondary" text="list"/> <Badge class="badge badge--secondary" text="enum"/>

>

#### [<code style={{ fontWeight: 'normal' }}>AppExtensionFilterInput.<b>target</b></code>](#)<Bullet />[`AppExtensionTargetEnum`](../../../api-reference/apps/enums/app-extension-target-enum) <Badge class="secondary" text="enum"/>
#### [<code style={{ fontWeight: 'normal' }}>AppExtensionFilterInput.<b>target</b></code>](#)<Bullet />[`AppExtensionTargetEnum`](../../../api-reference/apps/enums/app-extension-target-enum) <Badge class="badge badge--secondary" text="enum"/>

>

### Member of

[`appExtensions`](../../../api-reference/apps/queries/app-extensions) <Badge class="secondary" text="query"/>
[`appExtensions`](../../../api-reference/apps/queries/app-extensions) <Badge class="badge badge--secondary" text="query"/>
10 changes: 5 additions & 5 deletions docs/api-reference/apps/inputs/app-filter-input.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const SpecifiedBy = (props) => (

export const Badge = (props) => (
<>
<span className={"badge badge--" + props.class}>{props.text}</span>
<span className={props.class}>{props.text}</span>
</>
);

Expand Down Expand Up @@ -84,18 +84,18 @@ input AppFilterInput {

### Fields

#### [<code style={{ fontWeight: 'normal' }}>AppFilterInput.<b>search</b></code>](#)<Bullet />[`String`](../../../api-reference/miscellaneous/scalars/string) <Badge class="secondary" text="scalar"/>
#### [<code style={{ fontWeight: 'normal' }}>AppFilterInput.<b>search</b></code>](#)<Bullet />[`String`](../../../api-reference/miscellaneous/scalars/string) <Badge class="badge badge--secondary" text="scalar"/>

>

#### [<code style={{ fontWeight: 'normal' }}>AppFilterInput.<b>isActive</b></code>](#)<Bullet />[`Boolean`](../../../api-reference/miscellaneous/scalars/boolean) <Badge class="secondary" text="scalar"/>
#### [<code style={{ fontWeight: 'normal' }}>AppFilterInput.<b>isActive</b></code>](#)<Bullet />[`Boolean`](../../../api-reference/miscellaneous/scalars/boolean) <Badge class="badge badge--secondary" text="scalar"/>

>

#### [<code style={{ fontWeight: 'normal' }}>AppFilterInput.<b>type</b></code>](#)<Bullet />[`AppTypeEnum`](../../../api-reference/apps/enums/app-type-enum) <Badge class="secondary" text="enum"/>
#### [<code style={{ fontWeight: 'normal' }}>AppFilterInput.<b>type</b></code>](#)<Bullet />[`AppTypeEnum`](../../../api-reference/apps/enums/app-type-enum) <Badge class="badge badge--secondary" text="enum"/>

>

### Member of

[`apps`](../../../api-reference/apps/queries/apps) <Badge class="secondary" text="query"/>
[`apps`](../../../api-reference/apps/queries/apps) <Badge class="badge badge--secondary" text="query"/>
8 changes: 4 additions & 4 deletions docs/api-reference/apps/inputs/app-input.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const SpecifiedBy = (props) => (

export const Badge = (props) => (
<>
<span className={"badge badge--" + props.class}>{props.text}</span>
<span className={props.class}>{props.text}</span>
</>
);

Expand Down Expand Up @@ -83,14 +83,14 @@ input AppInput {

### Fields

#### [<code style={{ fontWeight: 'normal' }}>AppInput.<b>name</b></code>](#)<Bullet />[`String`](../../../api-reference/miscellaneous/scalars/string) <Badge class="secondary" text="scalar"/>
#### [<code style={{ fontWeight: 'normal' }}>AppInput.<b>name</b></code>](#)<Bullet />[`String`](../../../api-reference/miscellaneous/scalars/string) <Badge class="badge badge--secondary" text="scalar"/>

> Name of the app.

#### [<code style={{ fontWeight: 'normal' }}>AppInput.<b>permissions</b></code>](#)<Bullet />[`[PermissionEnum!]`](../../../api-reference/users/enums/permission-enum) <Badge class="secondary" text="list"/> <Badge class="secondary" text="enum"/>
#### [<code style={{ fontWeight: 'normal' }}>AppInput.<b>permissions</b></code>](#)<Bullet />[`[PermissionEnum!]`](../../../api-reference/users/enums/permission-enum) <Badge class="badge badge--secondary" text="list"/> <Badge class="badge badge--secondary" text="enum"/>

> List of permission code names to assign to this app.

### Member of

[`appCreate`](../../../api-reference/apps/mutations/app-create) <Badge class="secondary" text="mutation"/><Bullet />[`appUpdate`](../../../api-reference/apps/mutations/app-update) <Badge class="secondary" text="mutation"/>
[`appCreate`](../../../api-reference/apps/mutations/app-create) <Badge class="badge badge--secondary" text="mutation"/><Bullet />[`appUpdate`](../../../api-reference/apps/mutations/app-update) <Badge class="badge badge--secondary" text="mutation"/>
14 changes: 7 additions & 7 deletions docs/api-reference/apps/inputs/app-install-input.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const SpecifiedBy = (props) => (

export const Badge = (props) => (
<>
<span className={"badge badge--" + props.class}>{props.text}</span>
<span className={props.class}>{props.text}</span>
</>
);

Expand Down Expand Up @@ -85,22 +85,22 @@ input AppInstallInput {

### Fields

#### [<code style={{ fontWeight: 'normal' }}>AppInstallInput.<b>appName</b></code>](#)<Bullet />[`String`](../../../api-reference/miscellaneous/scalars/string) <Badge class="secondary" text="scalar"/>
#### [<code style={{ fontWeight: 'normal' }}>AppInstallInput.<b>appName</b></code>](#)<Bullet />[`String`](../../../api-reference/miscellaneous/scalars/string) <Badge class="badge badge--secondary" text="scalar"/>

> Name of the app to install.

#### [<code style={{ fontWeight: 'normal' }}>AppInstallInput.<b>manifestUrl</b></code>](#)<Bullet />[`String`](../../../api-reference/miscellaneous/scalars/string) <Badge class="secondary" text="scalar"/>
#### [<code style={{ fontWeight: 'normal' }}>AppInstallInput.<b>manifestUrl</b></code>](#)<Bullet />[`String`](../../../api-reference/miscellaneous/scalars/string) <Badge class="badge badge--secondary" text="scalar"/>

> URL to app's manifest in JSON format.
> Url to app's manifest in JSON format.

#### [<code style={{ fontWeight: 'normal' }}>AppInstallInput.<b>activateAfterInstallation</b></code>](#)<Bullet />[`Boolean`](../../../api-reference/miscellaneous/scalars/boolean) <Badge class="secondary" text="scalar"/>
#### [<code style={{ fontWeight: 'normal' }}>AppInstallInput.<b>activateAfterInstallation</b></code>](#)<Bullet />[`Boolean`](../../../api-reference/miscellaneous/scalars/boolean) <Badge class="badge badge--secondary" text="scalar"/>

> Determine if app will be set active or not.

#### [<code style={{ fontWeight: 'normal' }}>AppInstallInput.<b>permissions</b></code>](#)<Bullet />[`[PermissionEnum!]`](../../../api-reference/users/enums/permission-enum) <Badge class="secondary" text="list"/> <Badge class="secondary" text="enum"/>
#### [<code style={{ fontWeight: 'normal' }}>AppInstallInput.<b>permissions</b></code>](#)<Bullet />[`[PermissionEnum!]`](../../../api-reference/users/enums/permission-enum) <Badge class="badge badge--secondary" text="list"/> <Badge class="badge badge--secondary" text="enum"/>

> List of permission code names to assign to this app.

### Member of

[`appInstall`](../../../api-reference/apps/mutations/app-install) <Badge class="secondary" text="mutation"/>
[`appInstall`](../../../api-reference/apps/mutations/app-install) <Badge class="badge badge--secondary" text="mutation"/>
8 changes: 4 additions & 4 deletions docs/api-reference/apps/inputs/app-sorting-input.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const SpecifiedBy = (props) => (

export const Badge = (props) => (
<>
<span className={"badge badge--" + props.class}>{props.text}</span>
<span className={props.class}>{props.text}</span>
</>
);

Expand Down Expand Up @@ -83,14 +83,14 @@ input AppSortingInput {

### Fields

#### [<code style={{ fontWeight: 'normal' }}>AppSortingInput.<b>direction</b></code>](#)<Bullet />[`OrderDirection!`](../../../api-reference/miscellaneous/enums/order-direction) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="enum"/>
#### [<code style={{ fontWeight: 'normal' }}>AppSortingInput.<b>direction</b></code>](#)<Bullet />[`OrderDirection!`](../../../api-reference/miscellaneous/enums/order-direction) <Badge class="badge badge--secondary" text="non-null"/> <Badge class="badge badge--secondary" text="enum"/>

> Specifies the direction in which to sort apps.

#### [<code style={{ fontWeight: 'normal' }}>AppSortingInput.<b>field</b></code>](#)<Bullet />[`AppSortField!`](../../../api-reference/apps/enums/app-sort-field) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="enum"/>
#### [<code style={{ fontWeight: 'normal' }}>AppSortingInput.<b>field</b></code>](#)<Bullet />[`AppSortField!`](../../../api-reference/apps/enums/app-sort-field) <Badge class="badge badge--secondary" text="non-null"/> <Badge class="badge badge--secondary" text="enum"/>

> Sort apps by the selected field.

### Member of

[`apps`](../../../api-reference/apps/queries/apps) <Badge class="secondary" text="query"/>
[`apps`](../../../api-reference/apps/queries/apps) <Badge class="badge badge--secondary" text="query"/>
8 changes: 4 additions & 4 deletions docs/api-reference/apps/inputs/app-token-input.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const SpecifiedBy = (props) => (

export const Badge = (props) => (
<>
<span className={"badge badge--" + props.class}>{props.text}</span>
<span className={props.class}>{props.text}</span>
</>
);

Expand Down Expand Up @@ -83,14 +83,14 @@ input AppTokenInput {

### Fields

#### [<code style={{ fontWeight: 'normal' }}>AppTokenInput.<b>name</b></code>](#)<Bullet />[`String`](../../../api-reference/miscellaneous/scalars/string) <Badge class="secondary" text="scalar"/>
#### [<code style={{ fontWeight: 'normal' }}>AppTokenInput.<b>name</b></code>](#)<Bullet />[`String`](../../../api-reference/miscellaneous/scalars/string) <Badge class="badge badge--secondary" text="scalar"/>

> Name of the token.

#### [<code style={{ fontWeight: 'normal' }}>AppTokenInput.<b>app</b></code>](#)<Bullet />[`ID!`](../../../api-reference/miscellaneous/scalars/id) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>
#### [<code style={{ fontWeight: 'normal' }}>AppTokenInput.<b>app</b></code>](#)<Bullet />[`ID!`](../../../api-reference/miscellaneous/scalars/id) <Badge class="badge badge--secondary" text="non-null"/> <Badge class="badge badge--secondary" text="scalar"/>

> ID of app.

### Member of

[`appTokenCreate`](../../../api-reference/apps/mutations/app-token-create) <Badge class="secondary" text="mutation"/>
[`appTokenCreate`](../../../api-reference/apps/mutations/app-token-create) <Badge class="badge badge--secondary" text="mutation"/>
6 changes: 3 additions & 3 deletions docs/api-reference/apps/mutations/app-activate.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const SpecifiedBy = (props) => (

export const Badge = (props) => (
<>
<span className={"badge badge--" + props.class}>{props.text}</span>
<span className={props.class}>{props.text}</span>
</>
);

Expand Down Expand Up @@ -87,13 +87,13 @@ appActivate(

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>appActivate.<b>id</b></code>](#)<Bullet />[`ID!`](../../../api-reference/miscellaneous/scalars/id) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>
#### [<code style={{ fontWeight: 'normal' }}>appActivate.<b>id</b></code>](#)<Bullet />[`ID!`](../../../api-reference/miscellaneous/scalars/id) <Badge class="badge badge--secondary" text="non-null"/> <Badge class="badge badge--secondary" text="scalar"/>

> ID of app to activate.
### Type

#### [`AppActivate`](../../../api-reference/apps/objects/app-activate) <Badge class="secondary" text="object"/>
#### [`AppActivate`](../../../api-reference/apps/objects/app-activate) <Badge class="badge badge--secondary" text="object"/>

> Activate the app.
Expand Down
6 changes: 3 additions & 3 deletions docs/api-reference/apps/mutations/app-create.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const SpecifiedBy = (props) => (

export const Badge = (props) => (
<>
<span className={"badge badge--" + props.class}>{props.text}</span>
<span className={props.class}>{props.text}</span>
</>
);

Expand Down Expand Up @@ -87,13 +87,13 @@ appCreate(

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>appCreate.<b>input</b></code>](#)<Bullet />[`AppInput!`](../../../api-reference/apps/inputs/app-input) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="input"/>
#### [<code style={{ fontWeight: 'normal' }}>appCreate.<b>input</b></code>](#)<Bullet />[`AppInput!`](../../../api-reference/apps/inputs/app-input) <Badge class="badge badge--secondary" text="non-null"/> <Badge class="badge badge--secondary" text="input"/>

> Fields required to create a new app.
### Type

#### [`AppCreate`](../../../api-reference/apps/objects/app-create) <Badge class="secondary" text="object"/>
#### [`AppCreate`](../../../api-reference/apps/objects/app-create) <Badge class="badge badge--secondary" text="object"/>

> Creates a new app.
Expand Down
6 changes: 3 additions & 3 deletions docs/api-reference/apps/mutations/app-deactivate.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const SpecifiedBy = (props) => (

export const Badge = (props) => (
<>
<span className={"badge badge--" + props.class}>{props.text}</span>
<span className={props.class}>{props.text}</span>
</>
);

Expand Down Expand Up @@ -87,13 +87,13 @@ appDeactivate(

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>appDeactivate.<b>id</b></code>](#)<Bullet />[`ID!`](../../../api-reference/miscellaneous/scalars/id) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>
#### [<code style={{ fontWeight: 'normal' }}>appDeactivate.<b>id</b></code>](#)<Bullet />[`ID!`](../../../api-reference/miscellaneous/scalars/id) <Badge class="badge badge--secondary" text="non-null"/> <Badge class="badge badge--secondary" text="scalar"/>

> ID of app to deactivate.
### Type

#### [`AppDeactivate`](../../../api-reference/apps/objects/app-deactivate) <Badge class="secondary" text="object"/>
#### [`AppDeactivate`](../../../api-reference/apps/objects/app-deactivate) <Badge class="badge badge--secondary" text="object"/>

> Deactivate the app.
Expand Down
6 changes: 3 additions & 3 deletions docs/api-reference/apps/mutations/app-delete-failed-installation.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const SpecifiedBy = (props) => (

export const Badge = (props) => (
<>
<span className={"badge badge--" + props.class}>{props.text}</span>
<span className={props.class}>{props.text}</span>
</>
);

Expand Down Expand Up @@ -87,13 +87,13 @@ appDeleteFailedInstallation(

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>appDeleteFailedInstallation.<b>id</b></code>](#)<Bullet />[`ID!`](../../../api-reference/miscellaneous/scalars/id) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>
#### [<code style={{ fontWeight: 'normal' }}>appDeleteFailedInstallation.<b>id</b></code>](#)<Bullet />[`ID!`](../../../api-reference/miscellaneous/scalars/id) <Badge class="badge badge--secondary" text="non-null"/> <Badge class="badge badge--secondary" text="scalar"/>

> ID of failed installation to delete.
### Type

#### [`AppDeleteFailedInstallation`](../../../api-reference/apps/objects/app-delete-failed-installation) <Badge class="secondary" text="object"/>
#### [`AppDeleteFailedInstallation`](../../../api-reference/apps/objects/app-delete-failed-installation) <Badge class="badge badge--secondary" text="object"/>

> Delete failed installation.
Expand Down
Loading

1 comment on commit dba46e7

@vercel
Copy link

@vercel vercel bot commented on dba46e7 Aug 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

saleor-docs – ./

saleor-docs.vercel.app
saleor-docs-git-main-saleorcommerce.vercel.app
saleor-docs-saleorcommerce.vercel.app
docs.saleor.io

Please sign in to comment.