@shopware/api-client

{ "openapi": "3.0.0", "info": { "title": "Shopware Admin API", "description": "This endpoint reference contains an overview of all endpoints comprising the Shopware Admin API.\n\nFor a better overview, all CRUD-endpoints are hidden by default. If you want to show also CRUD-endpoints\nadd the query parameter `type=jsonapi`.", "license": { "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, "version": "6.6.6.0" }, "servers": [{ "url": "https://demo-frontends.shopware.store/api" }], "paths": { "/acl-role": { "get": { "tags": ["Acl Role"], "summary": "List with basic information of Acl Role resources.", "description": "Available since: 6.0.0.0", "operationId": "getAclRoleList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Acl Role resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AclRole" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/acl-role?limit=25" }, "last": { "example": "/acl-role?limit=25&page=11" }, "next": { "example": "/acl-role?limit=25&page=4" }, "prev": { "example": "/acl-role?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AclRole" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Acl Role"], "summary": "Create a new Acl Role resources.", "description": "Available since: 6.0.0.0", "operationId": "createAclRole", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AclRole" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/resource" }, "uniqueItems": true } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/AclRole" } } } }, "responses": { "200": { "description": "Detail of AclRole", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AclRole" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AclRole" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/acl-role": { "post": { "tags": ["Acl Role"], "summary": "Search for the Acl Role resources.", "description": "Available since: 6.0.0.0", "operationId": "searchAclRole", "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of AclRole", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AclRole" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AclRole" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/acl-role/{id}": { "get": { "tags": ["Acl Role"], "summary": "Detailed information about a Acl Role resource.", "description": "Available since: 6.0.0.0", "operationId": "getAclRole", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the acl_role", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AclRole", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AclRole" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AclRole" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Acl Role"], "summary": "Delete a Acl Role resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteAclRole", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the acl_role", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Acl Role"], "summary": "Partially update information about a Acl Role resource.", "description": "Available since: 6.0.0.0", "operationId": "updateAclRole", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the acl_role", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Acl Role resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AclRole" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/resource" }, "uniqueItems": true } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/AclRole" } } } }, "responses": { "200": { "description": "Detail of AclRole", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AclRole" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AclRole" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/advanced-search-action": { "get": { "tags": ["Advanced Search Action"], "summary": "List with basic information of Advanced Search Action resources.", "description": "", "operationId": "getAdvancedSearchActionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Advanced Search Action resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchAction" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/advanced-search-action?limit=25" }, "last": { "example": "/advanced-search-action?limit=25&page=11" }, "next": { "example": "/advanced-search-action?limit=25&page=4" }, "prev": { "example": "/advanced-search-action?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Advanced Search Action"], "summary": "Create a new Advanced Search Action resources.", "description": "", "operationId": "createAdvancedSearchAction", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchAction" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/resource" }, "uniqueItems": true } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchAction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/advanced-search-action": { "post": { "tags": ["Advanced Search Action"], "summary": "Search for the Advanced Search Action resources.", "description": "", "operationId": "searchAdvancedSearchAction", "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of AdvancedSearchAction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/advanced-search-action/{id}": { "get": { "tags": ["Advanced Search Action"], "summary": "Detailed information about a Advanced Search Action resource.", "description": "", "operationId": "getAdvancedSearchAction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_action", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AdvancedSearchAction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Advanced Search Action"], "summary": "Delete a Advanced Search Action resource.", "description": "", "operationId": "deleteAdvancedSearchAction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_action", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Advanced Search Action"], "summary": "Partially update information about a Advanced Search Action resource.", "description": "", "operationId": "updateAdvancedSearchAction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_action", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Advanced Search Action resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchAction" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/resource" }, "uniqueItems": true } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchAction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/advanced-search-action-search-term": { "get": { "tags": ["Advanced Search Action Search Term"], "summary": "List with basic information of Advanced Search Action Search Term resources.", "description": "", "operationId": "getAdvancedSearchActionSearchTermList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Advanced Search Action Search Term resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/advanced-search-action-search-term?limit=25" }, "last": { "example": "/advanced-search-action-search-term?limit=25&page=11" }, "next": { "example": "/advanced-search-action-search-term?limit=25&page=4" }, "prev": { "example": "/advanced-search-action-search-term?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Advanced Search Action Search Term"], "summary": "Create a new Advanced Search Action Search Term resources.", "description": "", "operationId": "createAdvancedSearchActionSearchTerm", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/resource" }, "uniqueItems": true } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchActionSearchTerm", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/advanced-search-action-search-term": { "post": { "tags": ["Advanced Search Action Search Term"], "summary": "Search for the Advanced Search Action Search Term resources.", "description": "", "operationId": "searchAdvancedSearchActionSearchTerm", "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of AdvancedSearchActionSearchTerm", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/advanced-search-action-search-term/{id}": { "get": { "tags": ["Advanced Search Action Search Term"], "summary": "Detailed information about a Advanced Search Action Search Term resource.", "description": "", "operationId": "getAdvancedSearchActionSearchTerm", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_action_search_term", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AdvancedSearchActionSearchTerm", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Advanced Search Action Search Term"], "summary": "Delete a Advanced Search Action Search Term resource.", "description": "", "operationId": "deleteAdvancedSearchActionSearchTerm", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_action_search_term", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Advanced Search Action Search Term"], "summary": "Partially update information about a Advanced Search Action Search Term resource.", "description": "", "operationId": "updateAdvancedSearchActionSearchTerm", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_action_search_term", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Advanced Search Action Search Term resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/resource" }, "uniqueItems": true } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchActionSearchTerm", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/advanced-search-boosting": { "get": { "tags": ["Advanced Search Boosting"], "summary": "List with basic information of Advanced Search Boosting resources.", "description": "", "operationId": "getAdvancedSearchBoostingList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Advanced Search Boosting resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/advanced-search-boosting?limit=25" }, "last": { "example": "/advanced-search-boosting?limit=25&page=11" }, "next": { "example": "/advanced-search-boosting?limit=25&page=4" }, "prev": { "example": "/advanced-search-boosting?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Advanced Search Boosting"], "summary": "Create a new Advanced Search Boosting resources.", "description": "", "operationId": "createAdvancedSearchBoosting", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchBoosting" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/resource" }, "uniqueItems": true } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchBoosting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/advanced-search-boosting": { "post": { "tags": ["Advanced Search Boosting"], "summary": "Search for the Advanced Search Boosting resources.", "description": "", "operationId": "searchAdvancedSearchBoosting", "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of AdvancedSearchBoosting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/advanced-search-boosting/{id}": { "get": { "tags": ["Advanced Search Boosting"], "summary": "Detailed information about a Advanced Search Boosting resource.", "description": "", "operationId": "getAdvancedSearchBoosting", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_boosting", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AdvancedSearchBoosting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Advanced Search Boosting"], "summary": "Delete a Advanced Search Boosting resource.", "description": "", "operationId": "deleteAdvancedSearchBoosting", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_boosting", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404