Skip to content

Commit

Permalink
Update API reference
Browse files Browse the repository at this point in the history
  • Loading branch information
korycins committed Jul 4, 2023
1 parent d498561 commit e2c69cd
Show file tree
Hide file tree
Showing 480 changed files with 9,158 additions and 559 deletions.
2 changes: 1 addition & 1 deletion docs/api-reference/apps/inputs/app-install-input.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ input AppInstallInput {

#### [<code style={{ fontWeight: 'normal' }}>AppInstallInput.<b>manifestUrl</b></code>](#)<Bullet />[`String`](../../../api-reference/miscellaneous/scalars/string) <Badge class="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"/>

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/apps/mutations/app-fetch-manifest.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ appFetchManifest(

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

>
> URL to app's manifest in JSON format.
### Type

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/apps/objects/app-activate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Activate the app.

```graphql
type AppActivate {
appErrors: [AppError!]!
appErrors: [AppError!]! @deprecated
errors: [AppError!]!
app: App
}
Expand Down
113 changes: 113 additions & 0 deletions docs/api-reference/apps/objects/app-brand-logo.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
---
id: app-brand-logo
title: AppBrandLogo
hide_table_of_contents: false
---

export const Bullet = () => (
<>
<span
style={{
fontWeight: "normal",
fontSize: ".5em",
color: "var(--ifm-color-secondary-darkest)",
}}
>
&nbsp;&nbsp;
</span>
</>
);

export const SpecifiedBy = (props) => (
<>
Specification
<a
className="link"
style={{ fontSize: "1.5em", paddingLeft: "4px" }}
target="\_blank"
href={props.url}
title={"Specified by " + props.url}
>
</a>
</>
);

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

import { useState } from "react";

export const Details = ({
dataOpen,
dataClose,
children,
startOpen = false,
}) => {
const [open, setOpen] = useState(startOpen);
return (
<details
{...(open ? { open: true } : {})}
className="details"
style={{
border: "none",
boxShadow: "none",
background: "var(--ifm-background-color)",
}}
>
<summary
onClick={(e) => {
e.preventDefault();
setOpen((open) => !open);
}}
style={{ listStyle: "none" }}
>
{open ? dataOpen : dataClose}
</summary>
{open && children}
</details>
);
};

Represents the app's brand logo data.

<Badge text="Added in Saleor 3.14" class="secondary margin-bottom--sm" />

<FeaturePreview />

```graphql
type AppBrandLogo {
default(size: Int, format: IconThumbnailFormatEnum = ORIGINAL): String!
}
```

### Fields

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

> URL to the default logo image.
>
> <Badge text="Added in Saleor 3.14" class="secondary margin-bottom--sm" />
>
> <FeaturePreview />
>
> ##### [<code style={{ fontWeight: 'normal' }}>AppBrandLogo.default.<b>size</b></code>](#)<Bullet />[`Int`](../../../api-reference/miscellaneous/scalars/int) <Badge class="secondary" text="scalar"/>
>
> Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended).

##### [<code style={{ fontWeight: 'normal' }}>AppBrandLogo.default.<b>format</b></code>](#)<Bullet />[`IconThumbnailFormatEnum`](../../../api-reference/miscellaneous/enums/icon-thumbnail-format-enum) <Badge class="secondary" text="enum"/>

> The format of the image. When not provided, format of the original image will be used.
>
> <Badge text="Added in Saleor 3.14" class="secondary margin-bottom--sm" />
>
> <FeaturePreview />

### Member of

[`AppBrand`](../../../api-reference/apps/objects/app-brand) <Badge class="secondary" text="object"/>

import FeaturePreview from "@site/components/FeaturePreview";
101 changes: 101 additions & 0 deletions docs/api-reference/apps/objects/app-brand.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
---
id: app-brand
title: AppBrand
hide_table_of_contents: false
---

export const Bullet = () => (
<>
<span
style={{
fontWeight: "normal",
fontSize: ".5em",
color: "var(--ifm-color-secondary-darkest)",
}}
>
&nbsp;&nbsp;
</span>
</>
);

export const SpecifiedBy = (props) => (
<>
Specification
<a
className="link"
style={{ fontSize: "1.5em", paddingLeft: "4px" }}
target="\_blank"
href={props.url}
title={"Specified by " + props.url}
>
</a>
</>
);

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

import { useState } from "react";

export const Details = ({
dataOpen,
dataClose,
children,
startOpen = false,
}) => {
const [open, setOpen] = useState(startOpen);
return (
<details
{...(open ? { open: true } : {})}
className="details"
style={{
border: "none",
boxShadow: "none",
background: "var(--ifm-background-color)",
}}
>
<summary
onClick={(e) => {
e.preventDefault();
setOpen((open) => !open);
}}
style={{ listStyle: "none" }}
>
{open ? dataOpen : dataClose}
</summary>
{open && children}
</details>
);
};

Represents the app's brand data.

<Badge text="Added in Saleor 3.14" class="secondary margin-bottom--sm" />

<FeaturePreview />

```graphql
type AppBrand {
logo: AppBrandLogo!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>AppBrand.<b>logo</b></code>](#)<Bullet />[`AppBrandLogo!`](../../../api-reference/apps/objects/app-brand-logo) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="object"/>

> App's logos details.
>
> <Badge text="Added in Saleor 3.14" class="secondary margin-bottom--sm" />
>
> <FeaturePreview />

### Member of

[`App`](../../../api-reference/apps/objects/app) <Badge class="secondary" text="object"/><Bullet />[`AppInstallation`](../../../api-reference/apps/objects/app-installation) <Badge class="secondary" text="object"/>

import FeaturePreview from "@site/components/FeaturePreview";
2 changes: 1 addition & 1 deletion docs/api-reference/apps/objects/app-create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Creates a new app.
```graphql
type AppCreate {
authToken: String
appErrors: [AppError!]!
appErrors: [AppError!]! @deprecated
errors: [AppError!]!
app: App
}
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/apps/objects/app-deactivate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Deactivate the app.

```graphql
type AppDeactivate {
appErrors: [AppError!]!
appErrors: [AppError!]! @deprecated
errors: [AppError!]!
app: App
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Delete failed installation.

```graphql
type AppDeleteFailedInstallation {
appErrors: [AppError!]!
appErrors: [AppError!]! @deprecated
errors: [AppError!]!
appInstallation: AppInstallation
}
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/apps/objects/app-delete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Deletes an app.

```graphql
type AppDelete {
appErrors: [AppError!]!
appErrors: [AppError!]! @deprecated
errors: [AppError!]!
app: App
}
Expand Down
6 changes: 3 additions & 3 deletions docs/api-reference/apps/objects/app-extension.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ type AppExtension implements Node {

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

>
> The ID of the app extension.

#### [<code style={{ fontWeight: 'normal' }}>AppExtension.<b>permissions</b></code>](#)<Bullet />[`[Permission!]!`](../../../api-reference/authentication/objects/permission) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="object"/>

Expand All @@ -115,11 +115,11 @@ type AppExtension implements Node {

#### [<code style={{ fontWeight: 'normal' }}>AppExtension.<b>app</b></code>](#)<Bullet />[`App!`](../../../api-reference/apps/objects/app) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="object"/>

>
> The app assigned to app extension.

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

> JWT token used to authenticate by thridparty app extension.
> JWT token used to authenticate by third-party app extension.

### Interfaces

Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/apps/objects/app-fetch-manifest.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Fetch and validate manifest.
```graphql
type AppFetchManifest {
manifest: Manifest
appErrors: [AppError!]!
appErrors: [AppError!]! @deprecated
errors: [AppError!]!
}
```
Expand All @@ -91,7 +91,7 @@ type AppFetchManifest {

#### [<code style={{ fontWeight: 'normal' }}>AppFetchManifest.<b>manifest</b></code>](#)<Bullet />[`Manifest`](../../../api-reference/apps/objects/manifest) <Badge class="secondary" text="object"/>

>
> The validated manifest.

#### [<code style={{ fontWeight: 'normal' }}>AppFetchManifest.<b>appErrors</b></code>](#)<Bullet />[`[AppError!]!`](../../../api-reference/apps/objects/app-error) <Badge class="secondary" text="deprecated"/> <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="object"/>

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/apps/objects/app-install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Install new app by using app manifest.

```graphql
type AppInstall {
appErrors: [AppError!]!
appErrors: [AppError!]! @deprecated
errors: [AppError!]!
appInstallation: AppInstallation
}
Expand Down
15 changes: 13 additions & 2 deletions docs/api-reference/apps/objects/app-installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,14 +83,15 @@ type AppInstallation implements Node, Job {
message: String
appName: String!
manifestUrl: String!
brand: AppBrand
}
```

### Fields

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

>
> The ID of the app installation.

#### [<code style={{ fontWeight: 'normal' }}>AppInstallation.<b>status</b></code>](#)<Bullet />[`JobStatusEnum!`](../../../api-reference/miscellaneous/enums/job-status-enum) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="enum"/>

Expand All @@ -110,11 +111,19 @@ type AppInstallation implements Node, Job {

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

>
> The name of the app installation.

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

> The URL address of manifest for the app installation.

#### [<code style={{ fontWeight: 'normal' }}>AppInstallation.<b>brand</b></code>](#)<Bullet />[`AppBrand`](../../../api-reference/apps/objects/app-brand) <Badge class="secondary" text="object"/>

> App's brand data.
>
> <Badge text="Added in Saleor 3.14" class="secondary margin-bottom--sm" />
>
> <FeaturePreview />

### Interfaces

Expand All @@ -133,3 +142,5 @@ type AppInstallation implements Node, Job {
### Member of

[`AppDeleteFailedInstallation`](../../../api-reference/apps/objects/app-delete-failed-installation) <Badge class="secondary" text="object"/><Bullet />[`AppInstall`](../../../api-reference/apps/objects/app-install) <Badge class="secondary" text="object"/><Bullet />[`AppRetryInstall`](../../../api-reference/apps/objects/app-retry-install) <Badge class="secondary" text="object"/>

import FeaturePreview from "@site/components/FeaturePreview";
Loading

1 comment on commit e2c69cd

@vercel
Copy link

@vercel vercel bot commented on e2c69cd Jul 4, 2023

Choose a reason for hiding this comment

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

Please sign in to comment.