Skip to content

Update SwagCommercial admin API schema #437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Bojan Rajh (bojanrajh) merged 1 commit into from
Mar 13, 2026
Merged

Update SwagCommercial admin API schema #437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
290 changes: 0 additions & 290 deletions SwagCommercial-adminapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35791,296 +35791,6 @@
}
}
},
"/_action/media/{mediaId}/external-thumbnails": {
"post": {
"tags": [
"Asset Management"
],
"summary": "Add external thumbnails to media",
"description": "Attaches external thumbnail URLs to an existing external media entity. The media must have an HTTP/HTTPS path (i.e. be an external media link).\n\nUsed for CDNs that pre-generated thumbnails alongside the main media file.\nNot to be confused with [remote thumbnails](https://developer.shopware.com/docs/guides/plugins/plugins/content/media/remote-thumbnail-generation.html#remote-thumbnail-generation), which are generated based on a pattern.\n\nThe thumbnail sized are matched against existing thumbnails sizes and a matching size will automatically be assigned. If there's not existing size, a **new thumbnail size will automatically be created** for each missing size.",
"operationId": "addExternalThumbnails",
"parameters": [
{
"name": "mediaId",
"in": "path",
"description": "ID of the external media entity the thumbnails will be attached to.",
"required": true,
"schema": {
"$ref": "#/components/schemas/MediaId"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"thumbnails": {
"type": "array",
"description": "List of external thumbnails to attach",
"items": {
"$ref": "#/components/schemas/ExternalThumbnail"
}
}
}
}
}
}
},
"responses": {
"201": {
"description": "Thumbnails attached successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mediaId": {
"description": "ID of the media entity the thumbnails were attached to.",
"$ref": "#/components/schemas/MediaId"
},
"thumbnailsCreated": {
"type": "integer"
}
}
}
}
}
},
"400": {
"description": "Media is not an external media entity or path is missing"
},
"404": {
"description": "Media entity not found"
}
}
},
"delete": {
"tags": [
"Asset Management"
],
"summary": "Delete all external thumbnails from media",
"description": "Removes all externally stored thumbnail entries from the given media entity. Only works on external media (media with an HTTP/HTTPS path). Used to replace outdated thumbnails with new ones.",
"operationId": "deleteExternalThumbnails",
"parameters": [
{
"name": "mediaId",
"in": "path",
"description": "ID of the external media entity the thumbnails will be deleted from..",
"required": true,
"schema": {
"$ref": "#/components/schemas/MediaId"
}
}
],
"responses": {
"200": {
"description": "Thumbnails deleted successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mediaId": {
"description": "ID of the media entity the thumbnails were deleted from.",
"$ref": "#/components/schemas/MediaId"
}
}
}
}
}
},
"400": {
"description": "Media is not an external media entity or path is missing"
},
"404": {
"description": "Media entity not found"
}
}
}
},
"/_action/system-config": {
"get": {
"tags": [
"System Config"
],
"summary": "Get configuration values",
"description": "Returns the configuration values for the given domain and optional sales channel.",
"operationId": "getConfigurationValues",
"parameters": [
{
"name": "domain",
"in": "query",
"description": "The configuration domain.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "salesChannelId",
"in": "query",
"description": "The sales channel ID to scope the configuration to.",
"schema": {
"type": "string"
}
},
{
"name": "inherit",
"in": "query",
"description": "Whether to include inherited (global) values.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Returns the configuration values as a key-value object."
}
}
},
"post": {
"tags": [
"System Config"
],
"summary": "Save configuration values",
"description": "Saves the given configuration key-value pairs for the given sales channel.",
"operationId": "saveConfiguration",
"parameters": [
{
"name": "salesChannelId",
"in": "query",
"description": "The sales channel ID to scope the configuration to.",
"schema": {
"type": "string"
}
},
{
"name": "silent",
"in": "query",
"description": "If true, the HTTP cache will not be invalidated. Use this for internal configuration values that do not affect the storefront.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"description": "Key-value pairs of configuration values to save.",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
},
"responses": {
"204": {
"description": "Configuration saved successfully."
}
}
}
},
"/_action/system-config/check": {
"get": {
"tags": [
"System Config"
],
"summary": "Check configuration",
"description": "Checks if a configuration domain exists.",
"operationId": "checkConfiguration",
"parameters": [
{
"name": "domain",
"in": "query",
"description": "The configuration domain to check.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns whether the configuration domain exists."
}
}
}
},
"/_action/system-config/schema": {
"get": {
"tags": [
"System Config"
],
"summary": "Get configuration schema",
"description": "Returns the configuration schema for the given domain.",
"operationId": "getConfiguration",
"parameters": [
{
"name": "domain",
"in": "query",
"description": "The configuration domain.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the configuration schema."
}
}
}
},
"/_action/system-config/batch": {
"post": {
"tags": [
"System Config"
],
"summary": "Batch save configuration values",
"description": "Saves configuration values for multiple sales channels at once. The request body is keyed by sales channel ID (use \"null\" for global scope).",
"operationId": "batchSaveConfiguration",
"parameters": [
{
"name": "silent",
"in": "query",
"description": "If true, the HTTP cache will not be invalidated. Use this for internal configuration values that do not affect the storefront.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"description": "Object keyed by sales channel ID, each containing key-value pairs of configuration values.",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"responses": {
"204": {
"description": "Configuration saved successfully."
}
}
}
},
"/_action/custom-price": {
"post": {
"tags": [
Expand Down
5 changes: 0 additions & 5 deletions SwagCommercial-adminapi.summary.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,12 @@
"/_action/create-employee",
"/_action/custom-price",
"/_action/invite-employee",
"/_action/media/{mediaId}/external-thumbnails",
"/_action/quote/{quoteId}/comment",
"/_action/quote/{quoteId}/lineItem",
"/_action/quote/{quoteId}/product/{productId}",
"/_action/quote/{quoteId}/recalculate",
"/_action/share-config/download/{entity}/{id}",
"/_action/share-config/upload/{entity}",
"/_action/system-config",
"/_action/system-config/batch",
"/_action/system-config/check",
"/_action/system-config/schema",
"/_action/text-to-image/generate",
"/_action/update-employee",
"/_proxy-quote/{salesChannelId}",
Expand Down