{ "openapi": "3.0.4", "info": { "title": "buzzle Digital Commerce Services Layer — Search", "description": "OpenAPI surface for module `Search` within the buzzle Digital Commerce Services Layer.", "contact": { "name": "bambit ag", "url": "https://bambit.ch", "email": "hello@bambit.ch" }, "version": "1.0" }, "servers": [ { "url": "/search" } ], "paths": { "/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/PermissionSecurity/PermissionGroups": { "get": { "tags": [ "PermissionSecurity" ], "description": "Executes action get-all-permissiongroups in the DataSource PermissionSecurityDataSource with the given parameters.", "operationId": "/api/PermissionSecurity/PermissionGroups::Get all PermissionGroups", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ListResultModel" } } } } } } }, "/api/search/company/query": { "post": { "tags": [ "SearchIndex" ], "description": "Query the given index by a search query.", "operationId": "/api/search/company/query::Query index company by query-model", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Search.Models.SearchQueryModel" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Search.Models.SearchQueryResultModel" } } } }, "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/search/company/searchbyids": { "post": { "tags": [ "SearchIndex" ], "description": "Query the given index by a list of ids.", "operationId": "/api/search/company/searchbyids::Query index company by id", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Search.Models.SearchByIdModel" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Search.Models.SearchByIdResultModel" } } } }, "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/search/companyservice/query": { "post": { "tags": [ "SearchIndex" ], "description": "Query the given index by a search query.", "operationId": "/api/search/companyservice/query::Query index companyservice by query-model", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Search.Models.SearchQueryModel" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Search.Models.SearchQueryResultModel" } } } }, "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/search/companyservice/searchbyids": { "post": { "tags": [ "SearchIndex" ], "description": "Query the given index by a list of ids.", "operationId": "/api/search/companyservice/searchbyids::Query index companyservice by id", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Search.Models.SearchByIdModel" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Search.Models.SearchByIdResultModel" } } } }, "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/search/person/query": { "post": { "tags": [ "SearchIndex" ], "description": "Query the given index by a search query.", "operationId": "/api/search/person/query::Query index person by query-model", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Search.Models.SearchQueryModel" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Search.Models.SearchQueryResultModel" } } } }, "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/search/person/searchbyids": { "post": { "tags": [ "SearchIndex" ], "description": "Query the given index by a list of ids.", "operationId": "/api/search/person/searchbyids::Query index person by id", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Search.Models.SearchByIdModel" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Search.Models.SearchByIdResultModel" } } } }, "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/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.Module.Abstractions.Search.Models.FilterValueModel": { "type": "object", "properties": { "label": { "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" } }, "value": { "type": "string", "nullable": true }, "count": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "Buzzle.Module.Abstractions.Search.Models.SearchByIdModel": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "nullable": true }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Search.Models.SearchIndexFieldFilterModel" }, "nullable": true }, "sort": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Search.Models.SearchIndexFieldSortModel" }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Module.Abstractions.Search.Models.SearchByIdResultModel": { "type": "object", "properties": { "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalItems": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "result": { "type": "array", "items": { "type": "object", "additionalProperties": { } }, "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.Module.Abstractions.Search.Models.SearchIndexFieldFilterDefinitionModel": { "type": "object", "properties": { "label": { "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" } }, "filterType": { "type": "string", "nullable": true }, "name": { "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" } }, "options": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Search.Models.FilterValueModel" }, "nullable": true }, "minValue": { "type": "number", "format": "double", "nullable": true }, "maxValue": { "type": "number", "format": "double", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "isHidden": { "type": "boolean" }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Buzzle.Module.Abstractions.Search.Models.SearchIndexFieldFilterModel": { "type": "object", "properties": { "displayName": { "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" } }, "filterType": { "type": "string", "nullable": true }, "values": { "type": "array", "items": { }, "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Buzzle.Module.Abstractions.Search.Models.SearchIndexFieldHitColumnDefinition": { "type": "object", "properties": { "displayName": { "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" } }, "sortOrder": { "type": "integer", "format": "int32" }, "badgeVariantFieldName": { "type": "string", "nullable": true }, "isRightAligned": { "type": "boolean" }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Buzzle.Module.Abstractions.Search.Models.SearchIndexFieldSortDefinitionModel": { "type": "object", "properties": { "displayName": { "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" } }, "name": { "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" } }, "isDefault": { "type": "boolean" }, "isDescending": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Buzzle.Module.Abstractions.Search.Models.SearchIndexFieldSortModel": { "type": "object", "properties": { "isDescending": { "type": "boolean" }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Buzzle.Module.Abstractions.Search.Models.SearchQueryModel": { "type": "object", "properties": { "language": { "type": "string", "nullable": true }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Search.Models.SearchIndexFieldFilterModel" }, "nullable": true }, "sort": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Search.Models.SearchIndexFieldSortModel" }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Module.Abstractions.Search.Models.SearchQueryResultModel": { "type": "object", "properties": { "filters": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Search.Models.SearchIndexFieldFilterDefinitionModel" }, "nullable": true }, "sort": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Search.Models.SearchIndexFieldSortDefinitionModel" }, "nullable": true }, "hitColumns": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Search.Models.SearchIndexFieldHitColumnDefinition" }, "nullable": true }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalItems": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "result": { "type": "array", "items": { "type": "object", "additionalProperties": { } }, "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.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.ServicePlatform.Shared.Models.PermissionSecurity.GroupPermissionModel": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "groupType": { "type": "string", "nullable": true }, "parameters": { "type": "array", "items": { "type": "string" }, "nullable": true }, "permissions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "usedTypes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Buzzle.ServicePlatform.Shared.Models.PermissionSecurity.IPermissionGroupModel": { "type": "object", "properties": { "name": { "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" } }, "type": { "type": "string", "nullable": true }, "key": { "type": "string", "nullable": true }, "groupKey": { "type": "string", "nullable": true }, "permissions": { "$ref": "#/components/schemas/Buzzle.ServicePlatform.Shared.Models.PermissionSecurity.GroupPermissionModel" }, "configuration": { "type": "object", "additionalProperties": { }, "nullable": true }, "order": { "type": "integer", "format": "int32" }, "deactivatesGroupsWhenActive": { "type": "array", "items": { "type": "string" }, "nullable": true }, "deactivatesAllGroupsWhenActive": { "type": "boolean" } }, "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.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.ServicePlatform.Shared.Models.PermissionSecurity.IPermissionGroupModel" }, "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 } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Bearer Authentication token (using 'bearer ').", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ], "tags": [ { "name": "DataSources", "description": "Endpoints exposed for data source DataSources from provider DataSources." }, { "name": "PermissionSecurity", "description": "Endpoints exposed for data source PermissionSecurity from provider PermissionSecurity." }, { "name": "SearchIndex", "description": "Endpoints exposed for data source SearchIndex from provider SearchIndex." }, { "name": "Validators", "description": "Endpoints exposed for data source Validators from provider Validators." } ] }