{ "openapi": "3.0.4", "info": { "title": "Files.v1", "description": "API collection that allows for handling files.

This endpoint collection is transcoded from the gRPC service contract. The Protobuf file can be retrieved via gRPC Server Reflection on the base URI. Use of gRPC is more preferable because of better performance and native streaming capabilities", "termsOfService": "https://www.bergstein.com/privacy-policy-2/", "contact": { "name": "support@bergstein.com", "url": "https://bergstein.com", "email": "support@bergstein.com" }, "version": "v1.3.0.0" }, "paths": { "/files_module/v1/file_handle": { "post": { "tags": [ "FileHandleService" ], "operationId": "POSTfiles_module_v1_file_handle", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.CreateFileHandleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.CreateFileHandleReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "get": { "tags": [ "FileHandleService" ], "operationId": "GETfiles_module_v1_file_handle", "parameters": [ { "name": "paging.pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "paging.pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "paging.includeTotalSize", "in": "query", "schema": { "type": "boolean" } }, { "name": "descending", "in": "query", "schema": { "type": "boolean" } }, { "name": "order.id", "in": "query", "schema": { "type": "string" } }, { "name": "order.fileSourceHandleId", "in": "query", "schema": { "type": "string" } }, { "name": "order.fileSourceHandle.id", "in": "query", "schema": { "type": "string" } }, { "name": "order.fileSourceHandle.name", "in": "query", "schema": { "type": "string" } }, { "name": "order.fileSourceHandle.type", "in": "query", "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileType" } }, { "name": "order.fileSourceHandle.audit.CreatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "order.fileSourceHandle.audit.CreatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "order.fileSourceHandle.audit.UpdatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "order.fileSourceHandle.audit.UpdatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "order.fileType", "in": "query", "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileType" } }, { "name": "order.topicType", "in": "query", "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.TopicType" } }, { "name": "order.topicKey", "in": "query", "schema": { "type": "string" } }, { "name": "order.topicKeyChecksum", "in": "query", "schema": { "type": "string" } }, { "name": "order.workerStatus", "in": "query", "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.ProcessStatus" } }, { "name": "order.storageStatus", "in": "query", "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.ProcessStatus" } }, { "name": "order.audit.CreatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "order.audit.CreatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "order.audit.UpdatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "order.audit.UpdatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "filter.id", "in": "query", "schema": { "type": "string" } }, { "name": "filter.fileSourceHandleId", "in": "query", "schema": { "type": "string" } }, { "name": "filter.fileSourceHandle.id", "in": "query", "schema": { "type": "string" } }, { "name": "filter.fileSourceHandle.name", "in": "query", "schema": { "type": "string" } }, { "name": "filter.fileSourceHandle.type", "in": "query", "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileType" } }, { "name": "filter.fileSourceHandle.audit.CreatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "filter.fileSourceHandle.audit.CreatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "filter.fileSourceHandle.audit.UpdatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "filter.fileSourceHandle.audit.UpdatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "filter.fileType", "in": "query", "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileType" } }, { "name": "filter.topicType", "in": "query", "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.TopicType" } }, { "name": "filter.topicKey", "in": "query", "schema": { "type": "string" } }, { "name": "filter.topicKeyChecksum", "in": "query", "schema": { "type": "string" } }, { "name": "filter.workerStatus", "in": "query", "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.ProcessStatus" } }, { "name": "filter.storageStatus", "in": "query", "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.ProcessStatus" } }, { "name": "filter.audit.CreatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "filter.audit.CreatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "filter.audit.UpdatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "filter.audit.UpdatedDateTimeUtc", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.ListFileHandleReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "patch": { "tags": [ "FileHandleService" ], "operationId": "PATCHfiles_module_v1_file_handle", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.UpdateFileHandleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.UpdateFileHandleReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/files_module/v1/file_handle_partial/initiate": { "post": { "tags": [ "FileHandleService" ], "operationId": "POSTfiles_module_v1_file_handle_partial_initiate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.InitiateCreateFileHandlePartialRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.InitiateCreateFileHandlePartialReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/files_module/v1/file_handle_partial/{id}/part/{partNumber}": { "post": { "tags": [ "FileHandleService" ], "operationId": "POSTfiles_module_v1_file_handle_partial_{id}_part_{partNumber}", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "partNumber", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.UploadFileHandlePartialRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Empty" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/files_module/v1/file_handle_partial/{id}/complete": { "post": { "tags": [ "FileHandleService" ], "operationId": "POSTfiles_module_v1_file_handle_partial_{id}_complete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.CompleteCreateFileHandlePartialRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.CreateFileHandleReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/files_module/v1/file_handle/{id}": { "get": { "tags": [ "FileHandleService" ], "operationId": "GETfiles_module_v1_file_handle_{id}", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.GetFileHandleReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "delete": { "tags": [ "FileHandleService" ], "operationId": "DELETEfiles_module_v1_file_handle_{id}", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Empty" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/files_module/v1/file_handle/{id}/download": { "get": { "tags": [ "FileHandleService" ], "operationId": "GETfiles_module_v1_file_handle_{id}_download", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "topicType", "in": "query", "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.TopicType" } }, { "name": "topicKey", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.DownloadFileHandleReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/files_module/v1/file_handle/{id}/download_stream": { "get": { "tags": [ "FileHandleService" ], "operationId": "GETfiles_module_v1_file_handle_{id}_download_stream", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "topicType", "in": "query", "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.TopicType" } }, { "name": "topicKey", "in": "query", "schema": { "type": "string" } }, { "name": "chunkSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.DownloadFileHandleStreamReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/files_module/v1/module_info": { "get": { "tags": [ "FilesModuleInfoService" ], "operationId": "GETfiles_module_v1_module_info", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.ModuleInfoReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/files_module/v1/feature_flags": { "get": { "tags": [ "FilesModuleInfoService" ], "operationId": "GETfiles_module_v1_feature_flags", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.FeatureFlagsReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/files_module/v1/release_notes": { "get": { "tags": [ "FilesModuleInfoService" ], "operationId": "GETfiles_module_v1_release_notes", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.ReleaseNotesReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/files_module/v1/health_checks": { "get": { "tags": [ "FilesModuleInfoService" ], "operationId": "GETfiles_module_v1_health_checks", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.HealthChecksReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/files_module/v1/file_source_handle": { "post": { "tags": [ "FileSourceHandleService" ], "operationId": "POSTfiles_module_v1_file_source_handle", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.CreateFileSourceHandleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.CreateFileSourceHandleReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "get": { "tags": [ "FileSourceHandleService" ], "operationId": "GETfiles_module_v1_file_source_handle", "parameters": [ { "name": "paging.pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "paging.pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "paging.includeTotalSize", "in": "query", "schema": { "type": "boolean" } }, { "name": "descending", "in": "query", "schema": { "type": "boolean" } }, { "name": "order.id", "in": "query", "schema": { "type": "string" } }, { "name": "order.name", "in": "query", "schema": { "type": "string" } }, { "name": "order.type", "in": "query", "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileType" } }, { "name": "order.audit.CreatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "order.audit.CreatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "order.audit.UpdatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "order.audit.UpdatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "filter.id", "in": "query", "schema": { "type": "string" } }, { "name": "filter.name", "in": "query", "schema": { "type": "string" } }, { "name": "filter.type", "in": "query", "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileType" } }, { "name": "filter.audit.CreatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "filter.audit.CreatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "filter.audit.UpdatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "filter.audit.UpdatedDateTimeUtc", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.ListFileSourceHandleReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "patch": { "tags": [ "FileSourceHandleService" ], "operationId": "PATCHfiles_module_v1_file_source_handle", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.UpdateFileSourceHandleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.UpdateFileSourceHandleReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/files_module/v1/file_source_handle_partial/initiate": { "post": { "tags": [ "FileSourceHandleService" ], "operationId": "POSTfiles_module_v1_file_source_handle_partial_initiate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.InitiateCreateFileSourceHandlePartialRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.InitiateCreateFileSourceHandlePartialReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/files_module/v1/file_source_handle_partial/{id}/part/{partNumber}": { "post": { "tags": [ "FileSourceHandleService" ], "operationId": "POSTfiles_module_v1_file_source_handle_partial_{id}_part_{partNumber}", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "partNumber", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.UploadFileSourceHandlePartialRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Empty" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/files_module/v1/file_source_handle_partial/{id}/complete": { "post": { "tags": [ "FileSourceHandleService" ], "operationId": "POSTfiles_module_v1_file_source_handle_partial_{id}_complete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.CompleteCreateFileSourceHandlePartialRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.CreateFileSourceHandleReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/files_module/v1/file_source_handle/{id}": { "get": { "tags": [ "FileSourceHandleService" ], "operationId": "GETfiles_module_v1_file_source_handle_{id}", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.GetFileSourceHandleReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "delete": { "tags": [ "FileSourceHandleService" ], "operationId": "DELETEfiles_module_v1_file_source_handle_{id}", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Empty" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } } }, "components": { "schemas": { "Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.FeatureFlag": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "boolean" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.FeatureFlagsReply": { "type": "object", "properties": { "featureFlags": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.FeatureFlag" } } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.HealthCheck": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.HealthStatus" }, "moduleName": { "type": "string" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.HealthChecksReply": { "type": "object", "properties": { "healthChecks": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.HealthCheck" } } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.HealthStatus": { "enum": [ "UNKNOWN", "HEALTHY", "DEGRADED", "UNHEALTHY", "HEALTHCHECKDISABLED" ], "type": "string" }, "Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.Module": { "type": "object", "properties": { "name": { "type": "string" }, "version": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.Version" }, "shortDescription": { "type": "string" }, "description": { "type": "string" }, "protobuf": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.ProtoBuf" } }, "openapi": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.ModuleInfoReply": { "type": "object", "properties": { "module": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.Module" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.ProtoBuf": { "type": "object", "properties": { "name": { "type": "string" }, "contents": { "type": "string" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.ReleaseNotesReply": { "type": "object", "properties": { "releaseNote": { "type": "string" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.Version": { "type": "object", "properties": { "name": { "type": "string" }, "major": { "type": "integer", "format": "int32" }, "minor": { "type": "integer", "format": "int32" }, "revision": { "type": "integer", "format": "int32" }, "build": { "type": "string" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Audit.Protos.V1.Audit": { "type": "object", "properties": { "CreatedByUserName": { "type": "string" }, "CreatedDateTimeUtc": { "type": "string" }, "UpdatedByUserName": { "type": "string" }, "UpdatedDateTimeUtc": { "type": "string" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.CompleteCreateFileHandlePartialRequest": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "parts": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.CompletedPart" } } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.CompleteCreateFileSourceHandlePartialRequest": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "parts": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.CompletedPart" } } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.CompletedPart": { "type": "object", "properties": { "partNumber": { "type": "integer", "format": "int64" }, "hash": { "type": "string" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.CreateFileHandleReply": { "type": "object", "properties": { "fileHandle": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileHandle" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.CreateFileHandleRequest": { "type": "object", "properties": { "fileHandle": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileHandle" }, "fileSourceHandleRequest": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.CreateFileSourceHandleRequest" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.CreateFileSourceHandleReply": { "type": "object", "properties": { "fileSourceHandle": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileSourceHandle" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.CreateFileSourceHandleRequest": { "type": "object", "properties": { "id": { "type": "string" }, "fileName": { "type": "string" }, "fileType": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileType" }, "fileData": { "type": "string" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.DownloadFileHandleReply": { "type": "object", "properties": { "fileData": { "type": "string" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.DownloadFileHandleStreamReply": { "type": "object", "properties": { "id": { "type": "string" }, "chunkData": { "type": "string" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileHandle": { "type": "object", "properties": { "id": { "type": "string" }, "fileSourceHandleId": { "type": "string" }, "fileSourceHandle": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileSourceHandle" }, "fileType": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileType" }, "topicType": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.TopicType" }, "topicKey": { "type": "string" }, "topicKeyChecksum": { "type": "string" }, "workerStatus": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.ProcessStatus" }, "storageStatus": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.ProcessStatus" }, "audit": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Audit.Protos.V1.Audit" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileSourceHandle": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileType" }, "fileHandles": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileHandle" } }, "audit": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Audit.Protos.V1.Audit" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileType": { "enum": [ "FILE_TYPE_UNKNOWN", "FILE_TYPE_PDF", "FILE_TYPE_ISI", "FILE_TYPE_TIFF", "FILE_TYPE_DJOB", "FILE_TYPE_BMP", "FILE_TYPE_PNG", "FILE_TYPE_ZIP" ], "type": "string" }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.GetFileHandleReply": { "type": "object", "properties": { "fileHandle": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileHandle" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.GetFileSourceHandleReply": { "type": "object", "properties": { "fileSourceHandle": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileSourceHandle" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.InitiateCreateFileHandlePartialReply": { "type": "object", "properties": { "creationId": { "type": "string" }, "chunkSize": { "type": "integer", "format": "int64" }, "key": { "type": "string" }, "uris": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.PresignedPartUri" } } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.InitiateCreateFileHandlePartialRequest": { "type": "object", "properties": { "fileName": { "type": "string" }, "fileType": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileType" }, "fileSize": { "type": "integer", "format": "int64" }, "maxChunkSize": { "type": "integer", "format": "int64" }, "hash": { "type": "string" }, "uploadMode": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.UploadMode" }, "storageStatus": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.ProcessStatus" }, "workerStatus": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.ProcessStatus" }, "topicType": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.TopicType" }, "topicKey": { "type": "string" }, "topicKeyChecksum": { "type": "string" }, "fileSourceHandleId": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.InitiateCreateFileSourceHandlePartialReply": { "type": "object", "properties": { "creationId": { "type": "string" }, "chunkSize": { "type": "integer", "format": "int64" }, "key": { "type": "string" }, "uris": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.PresignedPartUri" } } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.InitiateCreateFileSourceHandlePartialRequest": { "type": "object", "properties": { "fileName": { "type": "string" }, "fileType": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileType" }, "fileSize": { "type": "integer", "format": "int64" }, "maxChunkSize": { "type": "integer", "format": "int64" }, "hash": { "type": "string" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.ListFileHandleReply": { "type": "object", "properties": { "fileHandles": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileHandle" } }, "paging": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Paging.Protos.V1.PagingReply" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.ListFileSourceHandleReply": { "type": "object", "properties": { "fileSourceHandles": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileSourceHandle" } }, "paging": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Paging.Protos.V1.PagingReply" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.PresignedPartUri": { "type": "object", "properties": { "partNumber": { "type": "integer", "format": "int64" }, "uri": { "type": "string" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.ProcessStatus": { "enum": [ "PROCESS_STATUS_UNPROCESSED", "PROCESS_STATUS_QUEUED", "PROCESS_STATUS_IN_PROGRESS", "PROCESS_STATUS_FINISHED", "PROCESS_STATUS_REJECTED", "PROCESS_STATUS_ERROR" ], "type": "string" }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.TopicType": { "enum": [ "TOPIC_TYPE_SOURCE", "TOPIC_TYPE_THUMBNAIL", "TOPIC_TYPE_RASTERIZED", "TOPIC_TYPE_INTERMEDIATE" ], "type": "string" }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.UpdateFileHandleReply": { "type": "object", "properties": { "fileHandle": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileHandle" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.UpdateFileHandleRequest": { "type": "object", "properties": { "fileHandle": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileHandle" }, "fileSourceHandleRequest": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.CreateFileSourceHandleRequest" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.UpdateFileSourceHandleReply": { "type": "object", "properties": { "fileSourceHandle": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileSourceHandle" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.UpdateFileSourceHandleRequest": { "type": "object", "properties": { "fileSourceHandle": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.FileSourceHandle" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.UploadFileHandlePartialRequest": { "type": "object", "properties": { "key": { "type": "string" }, "hash": { "type": "string" }, "chunkData": { "type": "string" }, "id": { "type": "string" }, "partNumber": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.UploadFileSourceHandlePartialRequest": { "type": "object", "properties": { "key": { "type": "string" }, "hash": { "type": "string" }, "chunkData": { "type": "string" }, "id": { "type": "string" }, "partNumber": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Files.Protos.V1.UploadMode": { "enum": [ "UPLOAD_MODE_UNKNOWN", "UPLOAD_MODE_CREATE", "UPLOAD_MODE_UPDATE" ], "type": "string" }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Paging.Protos.V1.PagingReply": { "type": "object", "properties": { "totalSize": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Google.Protobuf.WellKnownTypes.Any": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string" } }, "additionalProperties": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Value" } }, "Google.Protobuf.WellKnownTypes.Empty": { "type": "object", "additionalProperties": false }, "Google.Protobuf.WellKnownTypes.ListValue": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Value" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Google.Protobuf.WellKnownTypes.NullValue": { "enum": [ 0 ], "type": "integer", "format": "int32" }, "Google.Protobuf.WellKnownTypes.Struct": { "type": "object", "properties": { "fields": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Value" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Google.Protobuf.WellKnownTypes.Value": { "type": "object", "properties": { "nullValue": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.NullValue" }, "hasNullValue": { "type": "boolean", "readOnly": true }, "numberValue": { "type": "number", "format": "double" }, "hasNumberValue": { "type": "boolean", "readOnly": true }, "stringValue": { "type": "string", "nullable": true }, "hasStringValue": { "type": "boolean", "readOnly": true }, "boolValue": { "type": "boolean" }, "hasBoolValue": { "type": "boolean", "readOnly": true }, "structValue": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Struct" }, "listValue": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.ListValue" }, "kindCase": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Value.KindOneofCase" } }, "additionalProperties": false }, "Google.Protobuf.WellKnownTypes.Value.KindOneofCase": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32" }, "Google.Rpc.Status": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Any" } } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "http", "description": "Please enter a valid token!", "scheme": "Bearer", "bearerFormat": "JWT" } } }, "security": [ { "Bearer": [ ] } ], "tags": [ { "name": "FileHandleService" }, { "name": "FilesModuleInfoService" }, { "name": "FileSourceHandleService" } ] }