Update API Reference (#1351)

saleor · Oct 11, 2024 · 20bf62c · 20bf62c
1 parent 263589c
commit 20bf62c
Show file tree

Hide file tree

Showing 424 changed files with 5 additions and 3,883 deletions.
diff --git a/.gitignore b/.gitignore
@@ -15,3 +15,4 @@ node_modules/
 
 build/
 .vercel/
+schema.graphql
diff --git a/README.md b/README.md
@@ -215,7 +215,8 @@ Files in `/docs/api-reference` folder are generated by `@graphql-markdown/docusa
 
 To update the API reference:
 
-1. Put `schema.graphql` locally into the root of the saleor-docs repository
+1. Get `schema.graphql` locally into the root of the saleor-docs repository by running
+   `curl -O https://raw.githubusercontent.com/saleor/saleor/refs/heads/main/saleor/graphql/schema.graphql`
 1. Run `npm run update-api-reference`
 
 The script behind the scenes does several steps:

diff --git a/docs/api-reference/apps/objects/app-brand-logo.mdx b/docs/api-reference/apps/objects/app-brand-logo.mdx
@@ -30,12 +30,6 @@ style={{ listStyle:'none' }} >
 
 Represents the app's brand logo data.
 
-
-<Badge text="Added in Saleor 3.14" class="badge badge--secondary margin-bottom--sm" />
-
-
-<FeaturePreview />
-
 ```graphql
 type AppBrandLogo {
   default(size: Int, format: IconThumbnailFormatEnum = ORIGINAL): String!
@@ -48,12 +42,6 @@ type AppBrandLogo {
 
 URL to the default logo image.
 
-
-<Badge text="Added in Saleor 3.14" class="badge badge--secondary margin-bottom--sm" />
-
-
-<FeaturePreview />
-
 ##### [<code style={{ fontWeight: 'normal' }}>AppBrandLogo.default.<b>size</b></code>](#)<Bullet />[`Int`](../../../api-reference/miscellaneous/scalars/int.mdx) <Badge class="badge badge--secondary" text="scalar"/> <Badge class="badge badge--secondary" text="miscellaneous"/>
 
 Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended).
@@ -62,14 +50,6 @@ Desired longest side the image in pixels. Defaults to 4096. Images are never cro
 
 The format of the image. When not provided, format of the original image will be used.
 
-
-<Badge text="Added in Saleor 3.14" class="badge badge--secondary margin-bottom--sm" />
-
-
-<FeaturePreview />
-
 ### Member Of
 
 [`AppBrand`](../../../api-reference/apps/objects/app-brand.mdx) <Badge class="badge badge--secondary" text="object"/>
-
-import FeaturePreview from "@site/components/FeaturePreview";
diff --git a/docs/api-reference/apps/objects/app-brand.mdx b/docs/api-reference/apps/objects/app-brand.mdx
@@ -30,12 +30,6 @@ style={{ listStyle:'none' }} >
 
 Represents the app's brand data.
 
-
-<Badge text="Added in Saleor 3.14" class="badge badge--secondary margin-bottom--sm" />
-
-
-<FeaturePreview />
-
 ```graphql
 type AppBrand {
   logo: AppBrandLogo!
@@ -48,14 +42,6 @@ type AppBrand {
 
 App's logos details.
 
-
-<Badge text="Added in Saleor 3.14" class="badge badge--secondary margin-bottom--sm" />
-
-
-<FeaturePreview />
-
 ### Member Of
 
 [`App`](../../../api-reference/apps/objects/app.mdx) <Badge class="badge badge--secondary" text="object"/><Bullet />[`AppInstallation`](../../../api-reference/apps/objects/app-installation.mdx) <Badge class="badge badge--secondary" text="object"/>
-
-import FeaturePreview from "@site/components/FeaturePreview";
diff --git a/docs/api-reference/apps/objects/app-deleted.mdx b/docs/api-reference/apps/objects/app-deleted.mdx
@@ -30,10 +30,6 @@ style={{ listStyle:'none' }} >
 
 Event sent when app is deleted.
 
-
-<Badge text="Added in Saleor 3.4" class="badge badge--secondary margin-bottom--sm" />
-
-
 ```graphql
 type AppDeleted implements Event {
   issuedAt: DateTime

diff --git a/docs/api-reference/apps/objects/app-installation.mdx b/docs/api-reference/apps/objects/app-installation.mdx
@@ -77,12 +77,6 @@ The URL address of manifest for the app installation.
 
 App's brand data.
 
-
-<Badge text="Added in Saleor 3.14" class="badge badge--secondary margin-bottom--sm" />
-
-
-<FeaturePreview />
-
 ### Interfaces
 
 #### [`Node`](../../../api-reference/miscellaneous/interfaces/node.mdx) <Badge class="badge badge--secondary" text="interface"/> <Badge class="badge badge--secondary" text="miscellaneous"/>
@@ -98,5 +92,3 @@ An object with an ID
 ### Member Of
 
 [`AppDeleteFailedInstallation`](../../../api-reference/apps/objects/app-delete-failed-installation.mdx) <Badge class="badge badge--secondary" text="object"/><Bullet />[`AppInstall`](../../../api-reference/apps/objects/app-install.mdx) <Badge class="badge badge--secondary" text="object"/><Bullet />[`AppRetryInstall`](../../../api-reference/apps/objects/app-retry-install.mdx) <Badge class="badge badge--secondary" text="object"/>
-
-import FeaturePreview from "@site/components/FeaturePreview";
diff --git a/docs/api-reference/apps/objects/app-installed.mdx b/docs/api-reference/apps/objects/app-installed.mdx
@@ -30,10 +30,6 @@ style={{ listStyle:'none' }} >
 
 Event sent when new app is installed.
 
-
-<Badge text="Added in Saleor 3.4" class="badge badge--secondary margin-bottom--sm" />
-
-
 ```graphql
 type AppInstalled implements Event {
   issuedAt: DateTime

diff --git a/docs/api-reference/apps/objects/app-manifest-brand-logo.mdx b/docs/api-reference/apps/objects/app-manifest-brand-logo.mdx
@@ -30,12 +30,6 @@ style={{ listStyle:'none' }} >
 
 Represents the app's manifest brand data.
 
-
-<Badge text="Added in Saleor 3.14" class="badge badge--secondary margin-bottom--sm" />
-
-
-<FeaturePreview />
-
 ```graphql
 type AppManifestBrandLogo {
   default(size: Int, format: IconThumbnailFormatEnum = ORIGINAL): String!
@@ -48,12 +42,6 @@ type AppManifestBrandLogo {
 
 Data URL with a base64 encoded logo image.
 
-
-<Badge text="Added in Saleor 3.14" class="badge badge--secondary margin-bottom--sm" />
-
-
-<FeaturePreview />
-
 ##### [<code style={{ fontWeight: 'normal' }}>AppManifestBrandLogo.default.<b>size</b></code>](#)<Bullet />[`Int`](../../../api-reference/miscellaneous/scalars/int.mdx) <Badge class="badge badge--secondary" text="scalar"/> <Badge class="badge badge--secondary" text="miscellaneous"/>
 
 Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended).
@@ -62,14 +50,6 @@ Desired longest side the image in pixels. Defaults to 4096. Images are never cro
 
 The format of the image. When not provided, format of the original image will be used.
 
-
-<Badge text="Added in Saleor 3.14" class="badge badge--secondary margin-bottom--sm" />
-
-
-<FeaturePreview />
-
 ### Member Of
 
 [`AppManifestBrand`](../../../api-reference/apps/objects/app-manifest-brand.mdx) <Badge class="badge badge--secondary" text="object"/>
-
-import FeaturePreview from "@site/components/FeaturePreview";
diff --git a/docs/api-reference/apps/objects/app-manifest-brand.mdx b/docs/api-reference/apps/objects/app-manifest-brand.mdx
@@ -30,12 +30,6 @@ style={{ listStyle:'none' }} >
 
 Represents the app's manifest brand data.
 
-
-<Badge text="Added in Saleor 3.14" class="badge badge--secondary margin-bottom--sm" />
-
-
-<FeaturePreview />
-
 ```graphql
 type AppManifestBrand {
   logo: AppManifestBrandLogo!
@@ -48,14 +42,6 @@ type AppManifestBrand {
 
 App's logos details.
 
-
-<Badge text="Added in Saleor 3.14" class="badge badge--secondary margin-bottom--sm" />
-
-
-<FeaturePreview />
-
 ### Member Of
 
 [`Manifest`](../../../api-reference/apps/objects/manifest.mdx) <Badge class="badge badge--secondary" text="object"/>
-
-import FeaturePreview from "@site/components/FeaturePreview";
diff --git a/docs/api-reference/apps/objects/app-manifest-required-saleor-version.mdx b/docs/api-reference/apps/objects/app-manifest-required-saleor-version.mdx
@@ -43,24 +43,10 @@ type AppManifestRequiredSaleorVersion {
 
 Required Saleor version as semver range.
 
-
-<Badge text="Added in Saleor 3.13" class="badge badge--secondary margin-bottom--sm" />
-
-
-<FeaturePreview />
-
 #### [<code style={{ fontWeight: 'normal' }}>AppManifestRequiredSaleorVersion.<b>satisfied</b></code>](#)<Bullet />[`Boolean!`](../../../api-reference/miscellaneous/scalars/boolean.mdx) <Badge class="badge badge--secondary" text="non-null"/> <Badge class="badge badge--secondary" text="scalar"/> <Badge class="badge badge--secondary" text="miscellaneous"/>
 
 Informs if the Saleor version matches the required one.
 
-
-<Badge text="Added in Saleor 3.13" class="badge badge--secondary margin-bottom--sm" />
-
-
-<FeaturePreview />
-
 ### Member Of
 
 [`Manifest`](../../../api-reference/apps/objects/manifest.mdx) <Badge class="badge badge--secondary" text="object"/>
-
-import FeaturePreview from "@site/components/FeaturePreview";
diff --git a/docs/api-reference/apps/objects/app-status-changed.mdx b/docs/api-reference/apps/objects/app-status-changed.mdx
@@ -30,10 +30,6 @@ style={{ listStyle:'none' }} >
 
 Event sent when app status has changed.
 
-
-<Badge text="Added in Saleor 3.4" class="badge badge--secondary margin-bottom--sm" />
-
-
 ```graphql
 type AppStatusChanged implements Event {
   issuedAt: DateTime

diff --git a/docs/api-reference/apps/objects/app-updated.mdx b/docs/api-reference/apps/objects/app-updated.mdx
@@ -30,10 +30,6 @@ style={{ listStyle:'none' }} >
 
 Event sent when app is updated.
 
-
-<Badge text="Added in Saleor 3.4" class="badge badge--secondary margin-bottom--sm" />
-
-
 ```graphql
 type AppUpdated implements Event {
   issuedAt: DateTime

diff --git a/docs/api-reference/apps/objects/app.mdx b/docs/api-reference/apps/objects/app.mdx
@@ -79,20 +79,12 @@ A single key from private metadata. Requires staff permissions to access.
 
 Tip: Use GraphQL aliases to fetch multiple keys.
 
-
-<Badge text="Added in Saleor 3.3" class="badge badge--secondary margin-bottom--sm" />
-
-
 ##### [<code style={{ fontWeight: 'normal' }}>App.privateMetafield.<b>key</b></code>](#)<Bullet />[`String!`](../../../api-reference/miscellaneous/scalars/string.mdx) <Badge class="badge badge--secondary" text="non-null"/> <Badge class="badge badge--secondary" text="scalar"/> <Badge class="badge badge--secondary" text="miscellaneous"/>
 
 #### [<code style={{ fontWeight: 'normal' }}>App.<b>privateMetafields</b></code>](#)<Bullet />[`Metadata`](../../../api-reference/miscellaneous/scalars/metadata.mdx) <Badge class="badge badge--secondary" text="scalar"/> <Badge class="badge badge--secondary" text="miscellaneous"/>
 
 Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
 
-
-<Badge text="Added in Saleor 3.3" class="badge badge--secondary margin-bottom--sm" />
-
-
 ##### [<code style={{ fontWeight: 'normal' }}>App.privateMetafields.<b>keys</b></code>](#)<Bullet />[`[String!]`](../../../api-reference/miscellaneous/scalars/string.mdx) <Badge class="badge badge--secondary" text="list"/> <Badge class="badge badge--secondary" text="scalar"/> <Badge class="badge badge--secondary" text="miscellaneous"/>
 
 #### [<code style={{ fontWeight: 'normal' }}>App.<b>metadata</b></code>](#)<Bullet />[`[MetadataItem!]!`](../../../api-reference/miscellaneous/objects/metadata-item.mdx) <Badge class="badge badge--secondary" text="non-null"/> <Badge class="badge badge--secondary" text="object"/> <Badge class="badge badge--secondary" text="miscellaneous"/>
@@ -105,20 +97,12 @@ A single key from public metadata.
 
 Tip: Use GraphQL aliases to fetch multiple keys.
 
-
-<Badge text="Added in Saleor 3.3" class="badge badge--secondary margin-bottom--sm" />
-
-
 ##### [<code style={{ fontWeight: 'normal' }}>App.metafield.<b>key</b></code>](#)<Bullet />[`String!`](../../../api-reference/miscellaneous/scalars/string.mdx) <Badge class="badge badge--secondary" text="non-null"/> <Badge class="badge badge--secondary" text="scalar"/> <Badge class="badge badge--secondary" text="miscellaneous"/>
 
 #### [<code style={{ fontWeight: 'normal' }}>App.<b>metafields</b></code>](#)<Bullet />[`Metadata`](../../../api-reference/miscellaneous/scalars/metadata.mdx) <Badge class="badge badge--secondary" text="scalar"/> <Badge class="badge badge--secondary" text="miscellaneous"/>
 
 Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
 
-
-<Badge text="Added in Saleor 3.3" class="badge badge--secondary margin-bottom--sm" />
-
-
 ##### [<code style={{ fontWeight: 'normal' }}>App.metafields.<b>keys</b></code>](#)<Bullet />[`[String!]`](../../../api-reference/miscellaneous/scalars/string.mdx) <Badge class="badge badge--secondary" text="list"/> <Badge class="badge badge--secondary" text="scalar"/> <Badge class="badge badge--secondary" text="miscellaneous"/>
 
 #### [<code style={{ fontWeight: 'normal' }}>App.<b>identifier</b></code>](#)<Bullet />[`String`](../../../api-reference/miscellaneous/scalars/string.mdx) <Badge class="badge badge--secondary" text="scalar"/> <Badge class="badge badge--secondary" text="miscellaneous"/>
@@ -209,10 +193,6 @@ URL to iframe with the app.
 
 URL to manifest used during app's installation.
 
-
-<Badge text="Added in Saleor 3.5" class="badge badge--secondary margin-bottom--sm" />
-
-
 #### [<code style={{ fontWeight: 'normal' }}>App.<b>version</b></code>](#)<Bullet />[`String`](../../../api-reference/miscellaneous/scalars/string.mdx) <Badge class="badge badge--secondary" text="scalar"/> <Badge class="badge badge--secondary" text="miscellaneous"/>
 
 Version number of the app.
@@ -225,30 +205,14 @@ JWT token used to authenticate by third-party app.
 
 The App's author name.
 
-
-<Badge text="Added in Saleor 3.13" class="badge badge--secondary margin-bottom--sm" />
-
-
-<FeaturePreview />
-
 #### [<code style={{ fontWeight: 'normal' }}>App.<b>extensions</b></code>](#)<Bullet />[`[AppExtension!]!`](../../../api-reference/apps/objects/app-extension.mdx) <Badge class="badge badge--secondary" text="non-null"/> <Badge class="badge badge--secondary" text="object"/> <Badge class="badge badge--secondary" text="apps"/>
 
 App's dashboard extensions.
 
-
-<Badge text="Added in Saleor 3.1" class="badge badge--secondary margin-bottom--sm" />
-
-
 #### [<code style={{ fontWeight: 'normal' }}>App.<b>brand</b></code>](#)<Bullet />[`AppBrand`](../../../api-reference/apps/objects/app-brand.mdx) <Badge class="badge badge--secondary" text="object"/> <Badge class="badge badge--secondary" text="apps"/>
 
 App's brand data.
 
-
-<Badge text="Added in Saleor 3.14" class="badge badge--secondary margin-bottom--sm" />
-
-
-<FeaturePreview />
-
 ### Interfaces
 
 #### [`Node`](../../../api-reference/miscellaneous/interfaces/node.mdx) <Badge class="badge badge--secondary" text="interface"/> <Badge class="badge badge--secondary" text="miscellaneous"/>
@@ -269,6 +233,4 @@ An object with an ID
 
 [`_Entity`](../../../api-reference/miscellaneous/unions/entity.mdx) <Badge class="badge badge--secondary" text="union"/><Bullet />[`IssuingPrincipal`](../../../api-reference/miscellaneous/unions/issuing-principal.mdx) <Badge class="badge badge--secondary" text="union"/><Bullet />[`UserOrApp`](../../../api-reference/miscellaneous/unions/user-or-app.mdx) <Badge class="badge badge--secondary" text="union"/>
 
-import FeaturePreview from "@site/components/FeaturePreview";
-
 import Permissions from "@site/components/Permissions";
diff --git a/docs/api-reference/apps/objects/manifest.mdx b/docs/api-reference/apps/objects/manifest.mdx
@@ -123,50 +123,22 @@ List of extensions that will be mounted in Saleor's dashboard. For details, plea
 
 List of the app's webhooks.
 
-
-<Badge text="Added in Saleor 3.5" class="badge badge--secondary margin-bottom--sm" />
-
-
 #### [<code style={{ fontWeight: 'normal' }}>Manifest.<b>audience</b></code>](#)<Bullet />[`String`](../../../api-reference/miscellaneous/scalars/string.mdx) <Badge class="badge badge--secondary" text="scalar"/> <Badge class="badge badge--secondary" text="miscellaneous"/>
 
 The audience that will be included in all JWT tokens for the app.
 
-
-<Badge text="Added in Saleor 3.8" class="badge badge--secondary margin-bottom--sm" />
-
-
 #### [<code style={{ fontWeight: 'normal' }}>Manifest.<b>requiredSaleorVersion</b></code>](#)<Bullet />[`AppManifestRequiredSaleorVersion`](../../../api-reference/apps/objects/app-manifest-required-saleor-version.mdx) <Badge class="badge badge--secondary" text="object"/> <Badge class="badge badge--secondary" text="apps"/>
 
 Determines the app's required Saleor version as semver range.
 
-
-<Badge text="Added in Saleor 3.13" class="badge badge--secondary margin-bottom--sm" />
-
-
-<FeaturePreview />
-
 #### [<code style={{ fontWeight: 'normal' }}>Manifest.<b>author</b></code>](#)<Bullet />[`String`](../../../api-reference/miscellaneous/scalars/string.mdx) <Badge class="badge badge--secondary" text="scalar"/> <Badge class="badge badge--secondary" text="miscellaneous"/>
 
 The App's author name.
 
-
-<Badge text="Added in Saleor 3.13" class="badge badge--secondary margin-bottom--sm" />
-
-
-<FeaturePreview />
-
 #### [<code style={{ fontWeight: 'normal' }}>Manifest.<b>brand</b></code>](#)<Bullet />[`AppManifestBrand`](../../../api-reference/apps/objects/app-manifest-brand.mdx) <Badge class="badge badge--secondary" text="object"/> <Badge class="badge badge--secondary" text="apps"/>
 
 App's brand data.
 
-
-<Badge text="Added in Saleor 3.14" class="badge badge--secondary margin-bottom--sm" />
-
-
-<FeaturePreview />
-
 ### Member Of
 
 [`AppFetchManifest`](../../../api-reference/apps/objects/app-fetch-manifest.mdx) <Badge class="badge badge--secondary" text="object"/>
-
-import FeaturePreview from "@site/components/FeaturePreview";
diff --git a/docs/api-reference/apps/queries/app-extension.mdx b/docs/api-reference/apps/queries/app-extension.mdx
@@ -31,10 +31,6 @@ style={{ listStyle:'none' }} >
 Look up an app extension by ID.
 
 
-<Badge text="Added in Saleor 3.1" class="badge badge--secondary margin-bottom--sm" />
-
-
-
 <Permissions permissions={"AUTHENTICATED_STAFF_USER,AUTHENTICATED_APP"} text={"Requires one of the following permissions"} />
Original file line number	Diff line number	Diff line change
Expand Up		@@ -15,3 +15,4 @@ node_modules/

		build/
		.vercel/
		schema.graphql
Original file line number	Diff line number	Diff line change
Expand Up		@@ -31,10 +31,6 @@ style={{ listStyle:'none' }} >
		Look up an app extension by ID.


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



		<Permissions permissions={"AUTHENTICATED_STAFF_USER,AUTHENTICATED_APP"} text={"Requires one of the following permissions"} />


Expand Down