{ "openapi": "3.0.4", "info": { "title": "buzzle Digital Commerce Services Layer — Catalog", "description": "OpenAPI surface for module `Catalog` within the buzzle Digital Commerce Services Layer.", "contact": { "name": "bambit ag", "url": "https://bambit.ch", "email": "hello@bambit.ch" }, "version": "1.0" }, "servers": [ { "url": "/catalog" } ], "paths": { "/api/CatalogCategory/SearchIndex/recreate": { "post": { "tags": [ "CatalogCategory" ], "description": "Reindex the search-index for entity CatalogCategory.", "operationId": "/api/CatalogCategory/SearchIndex/recreate::Reindex Search-Index for entity CatalogCategory", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/CatalogPriceList/SearchIndex/recreate": { "post": { "tags": [ "CatalogPriceList" ], "description": "Reindex the search-index for entity CatalogPriceList.", "operationId": "/api/CatalogPriceList/SearchIndex/recreate::Reindex Search-Index for entity CatalogPriceList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/CatalogProduct/SearchIndex/recreate": { "post": { "tags": [ "CatalogProduct" ], "description": "Reindex the search-index for entity CatalogProduct.", "operationId": "/api/CatalogProduct/SearchIndex/recreate::Reindex Search-Index for entity CatalogProduct", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/CatalogProductPrice": { "post": { "tags": [ "CatalogProductPrice" ], "description": "Executes the CatalogProductPrice create action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/CatalogProductPrice::POST EntityStructure CatalogProductPriceModel (/api/CatalogProductPrice)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Catalog.CatalogProductPriceModel" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel>" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/CatalogProductPrice/{id}": { "put": { "tags": [ "CatalogProductPrice" ], "description": "Executes the CatalogProductPrice update action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/CatalogProductPrice/{id}::PUT EntityStructure CatalogProductPriceModel (/api/CatalogProductPrice/{id})", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Catalog.CatalogProductPriceModel" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel>" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } }, "delete": { "tags": [ "CatalogProductPrice" ], "description": "Executes the CatalogProductPrice delete action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/CatalogProductPrice/{id}::DELETE EntityStructure CatalogProductPriceModel (/api/CatalogProductPrice/{id})", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel>" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/CatalogProductPrice/definition": { "get": { "tags": [ "CatalogProductPrice" ], "description": "Executes the CatalogProductPrice definition action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/CatalogProductPrice/definition::GET EntityStructure CatalogProductPriceModel (/api/CatalogProductPrice/definition)", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel" } } } } } } }, "/api/CatalogProductPrice/fromcatalogpricelist/{priceListId}": { "get": { "tags": [ "CatalogProductPrice" ], "description": "Executes the CatalogProductPrice get-all-related-paged action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/CatalogProductPrice/fromcatalogpricelist/{priceListId}::GET EntityStructure CatalogProductPriceModel (/api/CatalogProductPrice/fromcatalogpricelist/{priceListId})", "parameters": [ { "name": "priceListId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ListResultModel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/CatalogProductPrice/fromcatalogpricelist/{priceListId}/all": { "get": { "tags": [ "CatalogProductPrice" ], "description": "Executes the CatalogProductPrice get-all-related action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/CatalogProductPrice/fromcatalogpricelist/{priceListId}/all::GET EntityStructure CatalogProductPriceModel (/api/CatalogProductPrice/fromcatalogpricelist/{priceListId}/all)", "parameters": [ { "name": "priceListId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ListResultModel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/CatalogProductPrice/fromcatalogproduct/{productId}": { "get": { "tags": [ "CatalogProductPrice" ], "description": "Executes the CatalogProductPrice get-all-related-paged action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/CatalogProductPrice/fromcatalogproduct/{productId}::GET EntityStructure CatalogProductPriceModel (/api/CatalogProductPrice/fromcatalogproduct/{productId})", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ListResultModel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/CatalogProductPrice/fromcatalogproduct/{productId}/all": { "get": { "tags": [ "CatalogProductPrice" ], "description": "Executes the CatalogProductPrice get-all-related action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/CatalogProductPrice/fromcatalogproduct/{productId}/all::GET EntityStructure CatalogProductPriceModel (/api/CatalogProductPrice/fromcatalogproduct/{productId}/all)", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ListResultModel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/CatalogProductRelation": { "post": { "tags": [ "CatalogProductRelation" ], "description": "Executes the CatalogProductRelation create action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/CatalogProductRelation::POST EntityStructure CatalogProductRelationModel (/api/CatalogProductRelation)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Catalog.CatalogProductRelationModel" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel>" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/CatalogProductRelation/{id}": { "delete": { "tags": [ "CatalogProductRelation" ], "description": "Executes the CatalogProductRelation delete action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/CatalogProductRelation/{id}::DELETE EntityStructure CatalogProductRelationModel (/api/CatalogProductRelation/{id})", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel>" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/CatalogProductRelation/definition": { "get": { "tags": [ "CatalogProductRelation" ], "description": "Executes the CatalogProductRelation definition action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/CatalogProductRelation/definition::GET EntityStructure CatalogProductRelationModel (/api/CatalogProductRelation/definition)", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel" } } } } } } }, "/api/CatalogProductRelation/fromsourceproduct/{sourceProductId}/all": { "get": { "tags": [ "CatalogProductRelation" ], "description": "Executes the CatalogProductRelation get-all-related action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/CatalogProductRelation/fromsourceproduct/{sourceProductId}/all::GET EntityStructure CatalogProductRelationModel (/api/CatalogProductRelation/fromsourceproduct/{sourceProductId}/all)", "parameters": [ { "name": "sourceProductId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ListResultModel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/CatalogProductRelation/fromtargetproduct/{targetProductId}/all": { "get": { "tags": [ "CatalogProductRelation" ], "description": "Executes the CatalogProductRelation get-all-related action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/CatalogProductRelation/fromtargetproduct/{targetProductId}/all::GET EntityStructure CatalogProductRelationModel (/api/CatalogProductRelation/fromtargetproduct/{targetProductId}/all)", "parameters": [ { "name": "targetProductId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ListResultModel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/CatalogSupplier/SearchIndex/recreate": { "post": { "tags": [ "CatalogSupplier" ], "description": "Reindex the search-index for entity CatalogSupplier.", "operationId": "/api/CatalogSupplier/SearchIndex/recreate::Reindex Search-Index for entity CatalogSupplier", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/DataSources": { "get": { "tags": [ "DataSources" ], "description": "Get all data sources.", "operationId": "/api/DataSources::GetDataSources", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ListResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/Entities": { "get": { "tags": [ "Entities" ], "description": "Get all entity structures of this module with their names and label formats.", "operationId": "/api/Entities::Entities", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ListResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/Validators": { "get": { "tags": [ "Validators" ], "description": "Get all available validators.", "operationId": "/api/Validators::Validators", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ListResultModel" } } } } } } } }, "components": { "schemas": { "Buzzle.ServicePlatform.Infrastructure.Features.AttributeSystem.Validation.Models.ValidatorDefinitionModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "typeDiscriminator": { "type": "string", "nullable": true }, "settings": { "type": "object", "additionalProperties": { }, "nullable": true }, "translations": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.ServicePlatform.Infrastructure.Features.DataSource.Models.DataSourceDefinitionModel": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "providerName": { "type": "object", "additionalProperties": { "type": "string", "example": "Localized Text" }, "nullable": true, "example": { "de-CH": "Beispieltext", "fr-CH": "Exemple de texte", "it-CH": "Esempio di testo", "en-US": "Example text" } }, "dataSourceName": { "type": "object", "additionalProperties": { "type": "string", "example": "Localized Text" }, "nullable": true, "example": { "de-CH": "Beispieltext", "fr-CH": "Exemple de texte", "it-CH": "Esempio di testo", "en-US": "Example text" } }, "actionName": { "type": "object", "additionalProperties": { "type": "string", "example": "Localized Text" }, "nullable": true, "example": { "de-CH": "Beispieltext", "fr-CH": "Exemple de texte", "it-CH": "Esempio di testo", "en-US": "Example text" } }, "providerTypeDiscriminator": { "type": "string", "nullable": true }, "dataSourceTypeDiscriminator": { "type": "string", "nullable": true }, "actionDiscriminator": { "type": "string", "nullable": true }, "configuration": { "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.ApiResultModel": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.AttributeSystem.ChangeRequestModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "userName": { "type": "string", "nullable": true }, "loginId": { "type": "string", "format": "uuid", "nullable": true }, "propertyName": { "type": "string", "nullable": true }, "originalValue": { "nullable": true }, "value": { "nullable": true }, "workflow": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.ChangeRequestWorkflow" }, "status": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.ChangeRequestStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.AttributeSystem.ChangeRequestSettings": { "type": "object", "properties": { "changeRequestsEnabled": { "type": "boolean", "nullable": true }, "workflow": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.ChangeRequestWorkflow" } }, "additionalProperties": false }, "Buzzle.Shared.Models.AttributeSystem.ChangeRequestStatus": { "enum": [ "Open", "Approved", "Closed", "Declined", "Replaced" ], "type": "string" }, "Buzzle.Shared.Models.AttributeSystem.ChangeRequestWorkflow": { "enum": [ "Invalid", "RequestAcceptConfirm", "RequestAcceptOnly", "RequestEmailConfirmation" ], "type": "string" }, "Buzzle.Shared.Models.AttributeSystem.EntityDescriptionModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "The technical name, e.g. `PersonAddress`.", "nullable": true }, "translations": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { }, "nullable": true }, "description": "Display name per culture — \"Adresse\" rather than \"PersonAddress\".", "nullable": true }, "labelFormat": { "type": "string", "description": "How a record of this structure is labelled, e.g. `{Street} {HouseNumber}, {ZipCode} {City}`.", "nullable": true }, "businessDomainName": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "What an entity structure is called and how a record of it is labelled." }, "Buzzle.Shared.Models.AttributeSystem.EntityStructureModel": { "type": "object", "properties": { "labelFormat": { "type": "string", "nullable": true }, "translations": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { }, "nullable": true }, "description": "Display name per culture - \"Adresse\" rather than \"PersonAddress\".", "nullable": true }, "supportsChangeRequests": { "type": "boolean" }, "supportsNotes": { "type": "boolean" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.EntityStructurePropertyModel" }, "nullable": true }, "businessDomainName": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "haveRelations": { "type": "boolean" }, "foreignKeyPropertyNames": { "type": "array", "items": { "type": "string" }, "description": "Foreign-key property names in declaration order. Related-entity queries and endpoints address relations by\nthese names rather than by position.", "nullable": true }, "relationsCount": { "type": "integer", "format": "int32", "readOnly": true }, "haveChangeRequests": { "type": "boolean" }, "configuration": { "type": "object", "additionalProperties": { "nullable": true }, "description": "Per-feature configuration of this entity structure, keyed by feature - `{ \"assignments\": { \"enabled\": true } }`.", "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.AttributeSystem.EntityStructurePropertyModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "attributeCode": { "type": "string", "nullable": true }, "attributeTypeDiscriminator": { "type": "string", "nullable": true }, "changeRequestSettings": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.ChangeRequestSettings" }, "settings": { "type": "object", "additionalProperties": { }, "nullable": true }, "translations": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { }, "nullable": true }, "nullable": true }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.AttributeSystem.ValueModelWithChangeRequests": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Catalog.CatalogProductPriceModel" }, "changeRequests": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.ChangeRequestModel" }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.AttributeSystem.ValueModelWithChangeRequests": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Catalog.CatalogProductRelationModel" }, "changeRequests": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.ChangeRequestModel" }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.AttributeSystem.ValueStatus": { "enum": [ "New", "Ok", "HaveOpenChangeRequests", "HavePendingChangeRequests" ], "type": "string" }, "Buzzle.Shared.Models.ListResultModel": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.ServicePlatform.Infrastructure.Features.AttributeSystem.Validation.Models.ValidatorDefinitionModel" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.ListResultModel": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.ServicePlatform.Infrastructure.Features.DataSource.Models.DataSourceDefinitionModel" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.ListResultModel": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.EntityDescriptionModel" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.ListResultModel": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Catalog.CatalogProductPriceModel" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.ListResultModel": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Catalog.CatalogProductRelationModel" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.NotFoundApiResultModel": { "type": "object", "properties": { "entityId": { "type": "string", "format": "uuid", "nullable": true }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.PermissionDeniedResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.SingleResultModel": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.EntityStructureModel" }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.SingleResultModel>": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.ValueModelWithChangeRequests" }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.SingleResultModel>": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.ValueModelWithChangeRequests" }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "ExampleOnline.Shared.Models.Catalog.CatalogProductPriceModel": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "priceListId": { "type": "string", "format": "uuid" }, "price": { "type": "number", "format": "double" }, "id": { "type": "string", "format": "uuid", "nullable": true }, "status": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.ValueStatus" }, "relatedEntitiesWithRequiredActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "created": { "type": "string", "format": "date-time", "nullable": true }, "updated": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": { } }, "ExampleOnline.Shared.Models.Catalog.CatalogProductRelationModel": { "type": "object", "properties": { "sourceProductId": { "type": "string", "format": "uuid" }, "targetProductId": { "type": "string", "format": "uuid" }, "relationKind": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid", "nullable": true }, "status": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.ValueStatus" }, "relatedEntitiesWithRequiredActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "created": { "type": "string", "format": "date-time", "nullable": true }, "updated": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": { } } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Bearer Authentication token (using 'bearer ').", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ], "tags": [ { "name": "CatalogCategory", "description": "Endpoints exposed for data source CatalogCategory from provider SearchIndexing." }, { "name": "CatalogPriceList", "description": "Endpoints exposed for data source CatalogPriceList from provider SearchIndexing." }, { "name": "CatalogProduct", "description": "Endpoints exposed for data source CatalogProduct from provider SearchIndexing." }, { "name": "CatalogProductPrice", "description": "Endpoints exposed for data source CatalogProductPrice from provider EntityStructure." }, { "name": "CatalogProductRelation", "description": "Endpoints exposed for data source CatalogProductRelation from provider EntityStructure." }, { "name": "CatalogSupplier", "description": "Endpoints exposed for data source CatalogSupplier from provider SearchIndexing." }, { "name": "DataSources", "description": "Endpoints exposed for data source DataSources from provider DataSources." }, { "name": "Entities", "description": "Endpoints exposed for data source Entities from provider Entities." }, { "name": "Validators", "description": "Endpoints exposed for data source Validators from provider Validators." } ] }