From 1665c2fc7751ea6b5d9f2dc087ad51428bfeb74a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Niggemann?= Date: Wed, 4 Nov 2026 01:24:18 +0100 Subject: [PATCH 01/16] Migrate to Microsoft.AspNetCore.OpenApi instead of swagger to generate api specs. Add option to document SseItems properly --- Directory.Packages.props | 12 +- src/Moryx.AspNetCore/Moryx.AspNetCore.csproj | 6 +- .../MoryxOpenApiDocumentTransformer.cs | 177 + .../ProducesSseEventAttribute.cs | 28 + src/StartProject.Asp/Program.cs | 28 +- src/StartProject.Asp/StartProject.Asp.csproj | 15 +- src/StartProject.Asp/StartProject.Asp.json | 13386 ++++++++++++++++ 7 files changed, 13634 insertions(+), 18 deletions(-) create mode 100644 src/Moryx.AspNetCore/MoryxOpenApiDocumentTransformer.cs create mode 100644 src/Moryx.AspNetCore/ProducesSseEventAttribute.cs create mode 100644 src/StartProject.Asp/StartProject.Asp.json diff --git a/Directory.Packages.props b/Directory.Packages.props index 5490678bae..9312762a94 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -13,6 +13,10 @@ + + + + @@ -22,8 +26,8 @@ - + @@ -51,13 +55,9 @@ - - - - @@ -73,4 +73,4 @@ - + \ No newline at end of file diff --git a/src/Moryx.AspNetCore/Moryx.AspNetCore.csproj b/src/Moryx.AspNetCore/Moryx.AspNetCore.csproj index dff8919339..eb21120a96 100644 --- a/src/Moryx.AspNetCore/Moryx.AspNetCore.csproj +++ b/src/Moryx.AspNetCore/Moryx.AspNetCore.csproj @@ -10,7 +10,11 @@ - + + + + + diff --git a/src/Moryx.AspNetCore/MoryxOpenApiDocumentTransformer.cs b/src/Moryx.AspNetCore/MoryxOpenApiDocumentTransformer.cs new file mode 100644 index 0000000000..d2dd2a76db --- /dev/null +++ b/src/Moryx.AspNetCore/MoryxOpenApiDocumentTransformer.cs @@ -0,0 +1,177 @@ +// Copyright (c) 2026 Phoenix Contact GmbH & Co. KG +// Licensed under the Apache License, Version 2.0 + +using System.Globalization; +using System.Net; +using System.Text; +using Microsoft.AspNetCore.Mvc.Controllers; +using Microsoft.AspNetCore.OpenApi; +using Microsoft.OpenApi; + +namespace Moryx.AspNetCore; + +public class MoryxOpenApiDocumentTransformer : IOpenApiDocumentTransformer +{ + private const string SseItemBaseSchemaId = "SseItemBase"; + private const string EventStreamResponseType = "text/event-stream"; + + public async Task TransformAsync(OpenApiDocument document, OpenApiDocumentTransformerContext context, CancellationToken cancellationToken) + { + SortPathEntries(document); + + EnsureSseItemBaseExists(document); + + foreach (var (path, pathEntry) in document.Paths) + { + var pathString = new string(path.AsSpan(1)); + foreach (var (method, operation) in (pathEntry.Operations)) + { + var description = context.DescriptionGroups.SelectMany(dg => dg.Items) + .FirstOrDefault(description => + description.RelativePath == pathString && description.HttpMethod == method.Method); // Find a better way to populate + + await UpdateOperation(operation, new OpenApiOperationTransformerContext() + { + ApplicationServices = context.ApplicationServices, + Document = document, + DocumentName = context.DocumentName, + Description = description, + }, cancellationToken); + } + } + } + + private static void SortPathEntries(OpenApiDocument document) + { + var path = new OpenApiPaths(); + var sortLookup = new Dictionary(); + document.Tags = document.Tags.OrderBy(t => t.Name).ToHashSet(); + + var sorted = document.Paths.OrderBy((p) => + { + if (p.Value.Operations.Count == 0) + { + return int.MaxValue; + } + + var op = p.Value.Operations.First().Value; + var tag = op.Tags.FirstOrDefault()?.Name ?? ""; + tag = tag.ToLower(); + if (sortLookup.TryGetValue(tag, out var key)) + { + return key; + } + + Span b = stackalloc byte[8]; + Encoding.UTF8.GetBytes(tag.AsSpan(0, Math.Min(4, tag.Length)), b); + (b[0], b[1], b[2], b[3]) = (b[3], b[2], b[1], b[0]); + key = BitConverter.ToInt32(b); + sortLookup[tag] = key; + return key; + }); + + foreach (var item in sorted) + { + path.Add(item.Key, item.Value); + } + + document.Paths = path; + } + + public async Task UpdateOperation(OpenApiOperation operation, OpenApiOperationTransformerContext context, CancellationToken cancellationToken) + { + SetOperationIds(operation, context); + + await AddSseDocs(operation, context); + } + + private static async Task AddSseDocs(OpenApiOperation operation, OpenApiOperationTransformerContext context) + { + var producesAttributes = context.Description.ActionDescriptor.EndpointMetadata.OfType().ToList(); + + if (producesAttributes.Count == 0) + { + return; + } + + var responseKey = ((int)HttpStatusCode.OK).ToString(CultureInfo.InvariantCulture); + if (!operation.Responses.TryGetValue(responseKey, out var response)) + { + response = new OpenApiResponse(); + operation.Responses.Add(responseKey, response); + } + if (!response.Content.TryGetValue(EventStreamResponseType, out var mediaType)) + { + mediaType = new OpenApiMediaType(); + response.Content[EventStreamResponseType] = mediaType; + } + + Dictionary schemas = new(); + foreach (var a in producesAttributes) + { + var dataSchema = await context.GetOrCreateSchemaAsync(a.PayloadType); + + var dataSchemaId = dataSchema.Metadata.TryGetValue("x-schema-id", out var x) && x is string id ? id : a.PayloadType.Name; + if (!context.Document.Components.Schemas.ContainsKey(dataSchemaId)) + { + context.Document.AddComponent(dataSchemaId, dataSchema); + } + + var schemaId = $"SseItemOf{a.PayloadType.Name}"; + if (!context.Document.Components.Schemas.TryGetValue(schemaId, out var schema)) + { + context.Document.AddComponent(schemaId, new OpenApiSchema() + { + AllOf = [new OpenApiSchemaReference(SseItemBaseSchemaId)], + Properties = new Dictionary() + { + { "data", new OpenApiSchemaReference(dataSchemaId) } + } + }); + } + var description = string.IsNullOrEmpty(a.Description) + ? $"Published with type '{a.EventType}'" + : $"Published with type '{a.EventType}': {a.Description}"; + + schemas.Add(a.EventType, new OpenApiSchemaReference(schemaId) { Description = description }); + } + + mediaType.Schema = new OpenApiSchema() + { + Discriminator = new OpenApiDiscriminator() + { + PropertyName = "type", + Mapping = schemas, + }, + OneOf = schemas.Values.ToList(), + }; + } + + private static void SetOperationIds(OpenApiOperation operation, OpenApiOperationTransformerContext context) + { + if (context.Description.ActionDescriptor is ControllerActionDescriptor controllerActionDescriptor) + { + operation.OperationId = controllerActionDescriptor.MethodInfo.Name; // TODO: This keeps the old behavior, but it's actually violating guidelines regrading uniqueness + } + } + + private static void EnsureSseItemBaseExists(OpenApiDocument document) + { + var sseItemBaseSchema = new OpenApiSchema() + { + Type = JsonSchemaType.Object, + Properties = new Dictionary() + { + { "type", new OpenApiSchema() { Type = JsonSchemaType.String } }, + { "eventId", new OpenApiSchema() { Type = JsonSchemaType.String } }, + { "reconnectInterval", new OpenApiSchema() + { + Type = JsonSchemaType.String, + Pattern = "^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$", + } + } + } + }; + document.AddComponent(SseItemBaseSchemaId, sseItemBaseSchema); + } +} diff --git a/src/Moryx.AspNetCore/ProducesSseEventAttribute.cs b/src/Moryx.AspNetCore/ProducesSseEventAttribute.cs new file mode 100644 index 0000000000..8e46e699f5 --- /dev/null +++ b/src/Moryx.AspNetCore/ProducesSseEventAttribute.cs @@ -0,0 +1,28 @@ +// Copyright (c) 2026 Phoenix Contact GmbH & Co. KG +// Licensed under the Apache License, Version 2.0 + +namespace Moryx.AspNetCore; + +/// +/// Augmentation to AspNetCore build in ProducesAttribute to document sse events. +/// Need to map to the openapi spec explicitly +/// +/// +/// +[AttributeUsage(AttributeTargets.Method, AllowMultiple = true)] +public class ProducesSseEventAttribute(string? eventType, Type payloadType) : Attribute +{ + public string EventType { get; set; } = eventType; + public Type PayloadType { get; set; } = payloadType; + + public string Description { get; set; } +} + +/// +/// Helper to use ProducesSseEvent when enums are used as event types +/// +/// Enum type used to discriminate events +public class ProducesSseEventAttribute(T key, Type responseType) : ProducesSseEventAttribute(key.ToString(), responseType) where T : Enum +{ + +} diff --git a/src/StartProject.Asp/Program.cs b/src/StartProject.Asp/Program.cs index ea1855b795..445c9d693a 100644 --- a/src/StartProject.Asp/Program.cs +++ b/src/StartProject.Asp/Program.cs @@ -5,7 +5,7 @@ using System.Text.Json.Serialization; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Localization; -using Microsoft.AspNetCore.Mvc.Controllers; +using Moryx.AspNetCore; using Moryx.Launcher; using Moryx.Model; using Moryx.Runtime.Kernel; @@ -51,13 +51,21 @@ builder.Services.AddRazorPages(); -builder.Services.AddControllers() - .AddJsonOptions(jo => jo.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter())); - -builder.Services.AddSwaggerGen(c => +builder.Services.ConfigureHttpJsonOptions(options => { - c.CustomOperationIds(api => ((ControllerActionDescriptor)api.ActionDescriptor).MethodInfo.Name); + options.SerializerOptions.Converters.Add(new JsonStringEnumConverter()); + options.SerializerOptions.NumberHandling = JsonNumberHandling.Strict; // https://github.com/dotnet/aspnetcore/issues/64501 }); +builder.Services.AddControllers(); + +builder.Services.AddOpenApi(options => +{ + + options.OpenApiVersion = Microsoft.OpenApi.OpenApiSpecVersion.OpenApi3_1; // OpenApi3_2 is only available with .net 11 + //options.AddOperationTransformer(); + options.AddDocumentTransformer(); +} +); builder.Services.AddSingleton(); @@ -82,10 +90,12 @@ if (app.Environment.IsDevelopment()) { app.UseDeveloperExceptionPage(); - app.UseSwagger(); - app.UseSwaggerUI(); -} + app.MapOpenApi(); + app.UseSwaggerUI(options => + options.SwaggerEndpoint("/openapi/v1.json", "v1") + ); +} app.UseRequestLocalization(); app.UseStaticFiles(); app.UseHttpsRedirection(); diff --git a/src/StartProject.Asp/StartProject.Asp.csproj b/src/StartProject.Asp/StartProject.Asp.csproj index b26c157d51..527cadabb6 100644 --- a/src/StartProject.Asp/StartProject.Asp.csproj +++ b/src/StartProject.Asp/StartProject.Asp.csproj @@ -1,4 +1,4 @@ - + net10.0 @@ -6,13 +6,24 @@ - + + + runtime; build; native; contentfiles; analyzers; buildtransitive + all + + all runtime; build; native; analyzers; buildtransitive + + false + $(MSBuildProjectDirectory) + --openapi-version OpenApi3_1 + + diff --git a/src/StartProject.Asp/StartProject.Asp.json b/src/StartProject.Asp/StartProject.Asp.json new file mode 100644 index 0000000000..41a30da11a --- /dev/null +++ b/src/StartProject.Asp/StartProject.Asp.json @@ -0,0 +1,13386 @@ +{ + "openapi": "3.0.4", + "info": { + "title": "StartProject.Asp", + "version": "1.0" + }, + "paths": { + "/common/time": { + "get": { + "tags": [ + "Common" + ], + "operationId": "GetServerTime", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServerTimeResponse" + } + } + } + } + } + } + }, + "/common/info/application": { + "get": { + "tags": [ + "Common" + ], + "operationId": "GetApplicationInfo", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationInformationResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/common/info/system": { + "get": { + "tags": [ + "Common" + ], + "operationId": "GetHostInfo", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HostInformationResponse" + } + } + } + } + } + } + }, + "/databases": { + "get": { + "tags": [ + "Database" + ], + "operationId": "GetAll", + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/DatabasesResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DatabasesResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/DatabasesResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Database" + ], + "operationId": "EraseAll", + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/InvocationResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/InvocationResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InvocationResponse" + } + } + } + } + } + } + }, + "/databases/{targetModel}": { + "get": { + "tags": [ + "Database" + ], + "operationId": "GetModel", + "parameters": [ + { + "name": "targetModel", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/DataModel" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DataModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/DataModel" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Database" + ], + "operationId": "EraseDatabase", + "parameters": [ + { + "name": "targetModel", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DatabaseConfigModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/DatabaseConfigModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/DatabaseConfigModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/InvocationResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/InvocationResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InvocationResponse" + } + } + } + } + } + } + }, + "/databases/{targetModel}/config": { + "post": { + "tags": [ + "Database" + ], + "operationId": "SetDatabaseConfig", + "parameters": [ + { + "name": "targetModel", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DatabaseConfigModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/DatabaseConfigModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/DatabaseConfigModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/DataModel" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DataModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/DataModel" + } + } + } + } + } + } + }, + "/databases/{targetModel}/config/test": { + "post": { + "tags": [ + "Database" + ], + "operationId": "TestDatabaseConfig", + "parameters": [ + { + "name": "targetModel", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DatabaseConfigModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/DatabaseConfigModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/DatabaseConfigModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/TestConnectionResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestConnectionResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/TestConnectionResponse" + } + } + } + } + } + } + }, + "/databases/createall": { + "post": { + "tags": [ + "Database" + ], + "operationId": "CreateAll", + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/InvocationResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/InvocationResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InvocationResponse" + } + } + } + } + } + } + }, + "/databases/{targetModel}/create": { + "post": { + "tags": [ + "Database" + ], + "operationId": "CreateDatabase", + "parameters": [ + { + "name": "targetModel", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DatabaseConfigModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/DatabaseConfigModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/DatabaseConfigModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/InvocationResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/InvocationResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InvocationResponse" + } + } + } + } + } + } + }, + "/databases/{targetModel}/migrate": { + "post": { + "tags": [ + "Database" + ], + "operationId": "MigrateDatabaseModel", + "parameters": [ + { + "name": "targetModel", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DatabaseConfigModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/DatabaseConfigModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/DatabaseConfigModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/DatabaseMigrationSummary" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DatabaseMigrationSummary" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/DatabaseMigrationSummary" + } + } + } + } + } + } + }, + "/databases/{targetModel}/setup": { + "post": { + "tags": [ + "Database" + ], + "operationId": "ExecuteSetup", + "parameters": [ + { + "name": "targetModel", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExecuteSetupRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ExecuteSetupRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ExecuteSetupRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/InvocationResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/InvocationResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InvocationResponse" + } + } + } + } + } + } + }, + "/api/moryx/factory-monitor/state": { + "get": { + "tags": [ + "FactoryMonitor" + ], + "operationId": "InitialFactoryState", + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/FactoryStateModel" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/FactoryStateModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/FactoryStateModel" + } + } + } + } + } + } + }, + "/api/moryx/factory-monitor/cells": { + "get": { + "tags": [ + "FactoryMonitor" + ], + "operationId": "AllCells", + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VisualizableItemModel" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VisualizableItemModel" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VisualizableItemModel" + } + } + } + } + } + } + } + }, + "/api/moryx/factory-monitor/factory-content/{factoryId}": { + "get": { + "tags": [ + "FactoryMonitor" + ], + "operationId": "FactoryContent", + "parameters": [ + { + "name": "factoryId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VisualizableItemModel" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VisualizableItemModel" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VisualizableItemModel" + } + } + } + } + } + } + } + }, + "/api/moryx/factory-monitor/navigation/{factoryId}": { + "get": { + "tags": [ + "FactoryMonitor" + ], + "operationId": "GetNavigation", + "parameters": [ + { + "name": "factoryId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/FactoryModel" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/FactoryModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/FactoryModel" + } + } + } + } + } + } + }, + "/api/moryx/factory-monitor/state-stream": { + "get": { + "tags": [ + "FactoryMonitor" + ], + "operationId": "FactoryStatesStream", + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/OrderChangedModel" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderChangedModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/OrderChangedModel" + } + } + } + } + } + } + }, + "/api/moryx/factory-monitor/move-cell": { + "post": { + "tags": [ + "FactoryMonitor" + ], + "operationId": "MoveCell", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CellLocationModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/CellLocationModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/CellLocationModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/CellLocationModel" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CellLocationModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/CellLocationModel" + } + } + } + } + } + } + }, + "/api/moryx/factory-monitor/background": { + "post": { + "tags": [ + "FactoryMonitor" + ], + "operationId": "ChangeBackground", + "parameters": [ + { + "name": "resourceId", + "in": "query", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "url", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Content", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/factory-monitor/cell-properties/{identifier}": { + "get": { + "tags": [ + "FactoryMonitor" + ], + "operationId": "GetCellPropertiesSettings", + "parameters": [ + { + "name": "identifier", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/CellPropertySettings" + } + } + }, + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/CellPropertySettings" + } + } + }, + "text/json": { + "schema": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/CellPropertySettings" + } + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/factory-monitor/traceroute": { + "post": { + "tags": [ + "FactoryMonitor" + ], + "operationId": "TraceRoute", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransportRouteModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/TransportRouteModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/TransportRouteModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/moryx/factory-monitor/cell-settings/{id}": { + "put": { + "tags": [ + "FactoryMonitor" + ], + "operationId": "CellSettings", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CellSettingsModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/CellSettingsModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/CellSettingsModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/moryx/factory-monitor/routes": { + "post": { + "tags": [ + "FactoryMonitor" + ], + "operationId": "GetRoutes", + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TransportRouteModel" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TransportRouteModel" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TransportRouteModel" + } + } + } + } + } + } + } + }, + "/api/moryx/jobs/{jobId}": { + "get": { + "tags": [ + "JobManagement" + ], + "operationId": "GetJob", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JobModel" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/jobs": { + "get": { + "tags": [ + "JobManagement" + ], + "operationId": "GetAll", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/JobModel" + } + } + } + } + } + } + } + }, + "/api/moryx/jobs/{jobId}/complete": { + "post": { + "tags": [ + "JobManagement" + ], + "operationId": "Complete", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/moryx/jobs/{jobId}/abort": { + "post": { + "tags": [ + "JobManagement" + ], + "operationId": "Abort", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/moryx/jobs/stream": { + "get": { + "tags": [ + "JobManagement" + ], + "operationId": "ProgressStream", + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/moryx/media": { + "get": { + "tags": [ + "MediaServer" + ], + "operationId": "GetAll", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ContentDescriptorModel" + } + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/media/{guid}": { + "get": { + "tags": [ + "MediaServer" + ], + "operationId": "Get", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ContentDescriptorModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "delete": { + "tags": [ + "MediaServer" + ], + "operationId": "RemoveContent", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/media/{guid}/{variantName}": { + "get": { + "tags": [ + "MediaServer" + ], + "operationId": "GetVariant", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "variantName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VariantDescriptor" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "delete": { + "tags": [ + "MediaServer" + ], + "operationId": "RemoveVariant", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "variantName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/media/{guid}/{variantName}/stream": { + "get": { + "tags": [ + "MediaServer" + ], + "operationId": "GetVariantStream", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "variantName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "preview", + "in": "query", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "responses": { + "400": { + "description": "Bad Request", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/json": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "text/json": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + } + } + } + }, + "/api/moryx/media/master": { + "post": { + "tags": [ + "MediaServer" + ], + "operationId": "AddMaster", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "formFile": { + "type": "string", + "format": "binary" + } + } + }, + "encoding": { + "formFile": { + "style": "form" + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "format": "uuid" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/media/{contentId}/{variantName}": { + "post": { + "tags": [ + "MediaServer" + ], + "operationId": "AddVariant", + "parameters": [ + { + "name": "contentId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "variantName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "formFile": { + "type": "string", + "format": "binary" + } + } + }, + "encoding": { + "formFile": { + "style": "form" + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "format": "uuid" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/modules/dependencies": { + "get": { + "tags": [ + "Modules" + ], + "operationId": "GetDependencyEvaluation", + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/DependencyEvaluation" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DependencyEvaluation" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/DependencyEvaluation" + } + } + } + } + } + } + }, + "/modules": { + "get": { + "tags": [ + "Modules" + ], + "operationId": "GetAll", + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerModuleModel" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerModuleModel" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerModuleModel" + } + } + } + } + } + } + } + }, + "/modules/{moduleName}/healthstate": { + "get": { + "tags": [ + "Modules" + ], + "operationId": "HealthState", + "parameters": [ + { + "name": "moduleName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ServerModuleState" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServerModuleState" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ServerModuleState" + } + } + } + } + } + } + }, + "/modules/{moduleName}/notifications": { + "get": { + "tags": [ + "Modules" + ], + "operationId": "Notifications", + "parameters": [ + { + "name": "moduleName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ModuleNotificationModel" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ModuleNotificationModel" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ModuleNotificationModel" + } + } + } + } + } + } + } + }, + "/modules/{moduleName}/start": { + "post": { + "tags": [ + "Modules" + ], + "operationId": "Start", + "parameters": [ + { + "name": "moduleName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/modules/{moduleName}/stop": { + "post": { + "tags": [ + "Modules" + ], + "operationId": "Stop", + "parameters": [ + { + "name": "moduleName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/modules/{moduleName}/reincarnate": { + "post": { + "tags": [ + "Modules" + ], + "operationId": "Reincarnate", + "parameters": [ + { + "name": "moduleName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/modules/{moduleName}": { + "post": { + "tags": [ + "Modules" + ], + "operationId": "Update", + "parameters": [ + { + "name": "moduleName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServerModuleModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ServerModuleModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ServerModuleModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/modules/{moduleName}/confirm": { + "post": { + "tags": [ + "Modules" + ], + "operationId": "ConfirmWarning", + "parameters": [ + { + "name": "moduleName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/modules/{moduleName}/config": { + "get": { + "tags": [ + "Modules" + ], + "operationId": "GetConfig", + "parameters": [ + { + "name": "moduleName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Config" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Config" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Config" + } + } + } + } + } + }, + "post": { + "tags": [ + "Modules" + ], + "operationId": "SetConfig", + "parameters": [ + { + "name": "moduleName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SaveConfigRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/SaveConfigRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/SaveConfigRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/modules/{moduleName}/console": { + "get": { + "tags": [ + "Modules" + ], + "operationId": "GetMethods", + "parameters": [ + { + "name": "moduleName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MethodEntry" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MethodEntry" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MethodEntry" + } + } + } + } + } + } + }, + "post": { + "tags": [ + "Modules" + ], + "operationId": "InvokeMethod", + "parameters": [ + { + "name": "moduleName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MethodEntry" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/MethodEntry" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/MethodEntry" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Entry" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Entry" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Entry" + } + } + } + } + } + } + }, + "/api/moryx/notifications": { + "get": { + "tags": [ + "NotificationPublisher" + ], + "operationId": "GetAll", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NotificationModel" + } + } + } + } + } + } + } + }, + "/api/moryx/notifications/{guid}": { + "get": { + "tags": [ + "NotificationPublisher" + ], + "operationId": "Get", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationModel" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + }, + "/api/moryx/notifications/stream": { + "get": { + "tags": [ + "NotificationPublisher" + ], + "operationId": "NotificationStream", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NotificationModel" + } + } + } + } + } + } + } + }, + "/api/moryx/notifications/{guid}/acknowledge": { + "post": { + "tags": [ + "NotificationPublisher" + ], + "operationId": "Acknowledge", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + }, + "/api/moryx/operators": { + "post": { + "tags": [ + "OperatorManagement" + ], + "operationId": "Add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OperatorModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/OperatorModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/OperatorModel" + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "delete": { + "tags": [ + "OperatorManagement" + ], + "operationId": "DeleteOperator", + "parameters": [ + { + "name": "operatorIdentifier", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "get": { + "tags": [ + "OperatorManagement" + ], + "operationId": "GetAll", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssignableOperator" + } + } + } + } + } + } + } + }, + "/api/moryx/operators/{identifier}": { + "put": { + "tags": [ + "OperatorManagement" + ], + "operationId": "Update", + "parameters": [ + { + "name": "identifier", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OperatorModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/OperatorModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/OperatorModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "get": { + "tags": [ + "OperatorManagement" + ], + "operationId": "Get", + "parameters": [ + { + "name": "identifier", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedOperatorModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/operators/get-operators-by-resource/{resourceId}": { + "get": { + "tags": [ + "OperatorManagement" + ], + "operationId": "GetOperatorsByResource", + "parameters": [ + { + "name": "resourceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExtendedOperatorModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/operators/resources/{operatorIdentifier}": { + "get": { + "tags": [ + "OperatorManagement" + ], + "operationId": "GetResources", + "parameters": [ + { + "name": "operatorIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttendableResourceModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/operators/resources": { + "get": { + "tags": [ + "OperatorManagement" + ], + "operationId": "GetResources", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttendableResourceModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/operators/default": { + "get": { + "tags": [ + "OperatorManagement" + ], + "operationId": "GetDefaultOperator", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedOperatorModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/operators/signin": { + "put": { + "tags": [ + "OperatorManagement" + ], + "operationId": "SignIn", + "parameters": [ + { + "name": "operatorIdentifier", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "resourceId", + "in": "query", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/operators/signout": { + "put": { + "tags": [ + "OperatorManagement" + ], + "operationId": "SignOut", + "parameters": [ + { + "name": "operatorIdentifier", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "resourceId", + "in": "query", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/operators/stream": { + "get": { + "tags": [ + "OperatorManagement" + ], + "operationId": "Stream", + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/moryx/orders": { + "get": { + "tags": [ + "OrderManagement" + ], + "operationId": "GetOperations", + "parameters": [ + { + "name": "orderNumber", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "operationNumber", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OperationModel" + } + } + } + } + } + } + }, + "post": { + "tags": [ + "OrderManagement" + ], + "operationId": "AddOperation", + "parameters": [ + { + "name": "sourceId", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OperationCreationContextModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/OperationCreationContextModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/OperationCreationContextModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OperationModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/moryx/orders/stream": { + "get": { + "tags": [ + "OrderManagement" + ], + "operationId": "OperationStream", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OperationChangedModel" + } + } + } + } + } + } + }, + "/api/moryx/orders/{guid}": { + "get": { + "tags": [ + "OrderManagement" + ], + "operationId": "GetOperation", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OperationModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + }, + "/api/moryx/orders/{guid}/documents": { + "get": { + "tags": [ + "OrderManagement" + ], + "operationId": "GetDocuments", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + }, + "/api/moryx/orders/{guid}/document/{identifier}/stream": { + "get": { + "tags": [ + "OrderManagement" + ], + "operationId": "GetDocumentStream", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "identifier", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + }, + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + } + } + } + }, + "/api/moryx/orders/{guid}/productparts": { + "get": { + "tags": [ + "OrderManagement" + ], + "operationId": "GetProductParts", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductPartModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + }, + "/api/moryx/orders/{guid}/begin": { + "get": { + "tags": [ + "OrderManagement" + ], + "operationId": "GetBeginContext", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BeginContext" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "OrderManagement" + ], + "operationId": "BeginOperation", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BeginModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/BeginModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/BeginModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + }, + "/api/moryx/orders/{guid}/report": { + "get": { + "tags": [ + "OrderManagement" + ], + "operationId": "GetReportContext", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReportContext" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "OrderManagement" + ], + "operationId": "ReportOperation", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReportModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ReportModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ReportModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + }, + "/api/moryx/orders/{guid}/interrupt": { + "get": { + "tags": [ + "OrderManagement" + ], + "operationId": "GetInterruptContext", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReportContext" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "OrderManagement" + ], + "operationId": "InterruptOperation", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "userIdentifier", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + }, + "/api/moryx/orders/{guid}/advice": { + "get": { + "tags": [ + "OrderManagement" + ], + "operationId": "GetAdviceContext", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdviceContext" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "OrderManagement" + ], + "operationId": "AdviceOperation", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdviceModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/AdviceModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/AdviceModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + }, + "/api/moryx/orders/{guid}/logs": { + "get": { + "tags": [ + "OrderManagement" + ], + "operationId": "GetLogs", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OperationLogMessageModel" + } + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + }, + "/api/moryx/orders/recipes": { + "get": { + "tags": [ + "OrderManagement" + ], + "operationId": "GetAssignableRecipes", + "parameters": [ + { + "name": "identifier", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "revision", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OperationRecipeModel" + } + } + } + } + } + } + } + }, + "/api/moryx/orders/{guid}/abort": { + "post": { + "tags": [ + "OrderManagement" + ], + "operationId": "AbortOperation", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + }, + "/api/moryx/orders/{guid}/update": { + "put": { + "tags": [ + "OrderManagement" + ], + "operationId": "UpdateOperation", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OperationUpdateModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/OperationUpdateModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/OperationUpdateModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + }, + "/api/moryx/orders/{guid}/reload": { + "put": { + "tags": [ + "OrderManagement" + ], + "operationId": "Reload", + "parameters": [ + { + "name": "guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + }, + "/api/moryx/processes/job": { + "get": { + "tags": [ + "ProcessEngine" + ], + "operationId": "GetRunningProcessesOfJob", + "parameters": [ + { + "name": "jobId", + "in": "query", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "allProcesses", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/JobProcessModel" + } + } + } + } + } + } + } + }, + "/api/moryx/processes/running": { + "get": { + "tags": [ + "ProcessEngine" + ], + "operationId": "GetRunningProcesses", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/JobProcessModel" + } + } + } + } + } + } + } + }, + "/api/moryx/processes/instance/{productInstanceId}": { + "get": { + "tags": [ + "ProcessEngine" + ], + "operationId": "GetProcesses", + "parameters": [ + { + "name": "productInstanceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/JobProcessModel" + } + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/moryx/processes/running/{id}": { + "get": { + "tags": [ + "ProcessEngine" + ], + "operationId": "GetProcess", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JobProcessModel" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/moryx/processes/running/{id}/activities": { + "get": { + "tags": [ + "ProcessEngine" + ], + "operationId": "GetActivities", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProcessActivityModel" + } + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/moryx/processes/running/{id}/targets": { + "get": { + "tags": [ + "ProcessEngine" + ], + "operationId": "GetTargets", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ActivityResourceModel" + } + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/moryx/processes/running/{id}/targets/{activityId}": { + "get": { + "tags": [ + "ProcessEngine" + ], + "operationId": "GetTargets", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "activityId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ActivityResourceModel" + } + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + }, + "/api/moryx/processes/stream/processes": { + "get": { + "tags": [ + "ProcessEngine" + ], + "operationId": "ProcessUpdatesStream", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JobProcessModel" + } + } + } + } + } + } + }, + "/api/moryx/processes/stream/activities": { + "get": { + "tags": [ + "ProcessEngine" + ], + "operationId": "ActivitiesUpdatesStream", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProcessActivityModel" + } + } + } + } + } + } + }, + "/api/moryx/processes/holders/groups": { + "get": { + "tags": [ + "ProcessEngine" + ], + "operationId": "GetGroups", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProcessHolderGroupModelArrayApiResponse" + } + } + } + } + } + } + }, + "/api/moryx/processes/holders/stream": { + "get": { + "tags": [ + "ProcessEngine" + ], + "operationId": "GroupStream", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProcessHolderGroupModel" + } + } + } + } + } + } + }, + "/api/moryx/processes/holders/groups/{id}/reset": { + "post": { + "tags": [ + "ProcessEngine" + ], + "operationId": "ResetGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/moryx/processes/holders/positions/{id}/reset": { + "post": { + "tags": [ + "ProcessEngine" + ], + "operationId": "ResetPosition", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/moryx/products/configuration": { + "get": { + "tags": [ + "ProductManagement" + ], + "operationId": "GetProductCustomization", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductCustomization" + } + } + } + } + } + } + }, + "/api/moryx/products/importers/{importerName}": { + "post": { + "tags": [ + "ProductManagement" + ], + "operationId": "Import", + "parameters": [ + { + "name": "importerName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Entry" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Entry" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/Entry" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/products/types": { + "post": { + "tags": [ + "ProductManagement" + ], + "operationId": "SaveType", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProductModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ProductModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "integer", + "format": "int64" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "get": { + "tags": [ + "ProductManagement" + ], + "operationId": "GetTypeByIdentity", + "parameters": [ + { + "name": "identity", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/products/types/query": { + "post": { + "tags": [ + "ProductManagement" + ], + "operationId": "GetTypes", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductQuery" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProductQuery" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ProductQuery" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductModel" + } + } + } + } + } + } + } + }, + "/api/moryx/products/types/{id}": { + "get": { + "tags": [ + "ProductManagement" + ], + "operationId": "GetTypeById", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "delete": { + "tags": [ + "ProductManagement" + ], + "operationId": "DeleteType", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "put": { + "tags": [ + "ProductManagement" + ], + "operationId": "UpdateType", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProductModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ProductModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "integer", + "format": "int64" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "post": { + "tags": [ + "ProductManagement" + ], + "operationId": "Duplicate", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + }, + "text/json": { + "schema": { + "type": "string" + } + }, + "application/*+json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/products/types/{id}/recipes/{classification}": { + "get": { + "tags": [ + "ProductManagement" + ], + "operationId": "GetRecipes", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "classification", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RecipeModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/products/instances/{id}": { + "get": { + "tags": [ + "ProductManagement" + ], + "operationId": "GetInstance", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductInstanceModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/products/instances": { + "get": { + "tags": [ + "ProductManagement" + ], + "operationId": "GetInstances", + "parameters": [ + { + "name": "ids", + "in": "query", + "schema": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductInstanceModel" + } + } + } + } + } + } + }, + "post": { + "tags": [ + "ProductManagement" + ], + "operationId": "CreateInstance", + "parameters": [ + { + "name": "identifier", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "revision", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "save", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductInstanceModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "put": { + "tags": [ + "ProductManagement" + ], + "operationId": "SaveInstance", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductInstanceModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProductInstanceModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ProductInstanceModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/products/recipes/{id}": { + "get": { + "tags": [ + "ProductManagement" + ], + "operationId": "GetRecipe", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RecipeModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "put": { + "tags": [ + "ProductManagement" + ], + "operationId": "UpdateRecipe", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RecipeModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/RecipeModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/RecipeModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "integer", + "format": "int64" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/products/recipes": { + "post": { + "tags": [ + "ProductManagement" + ], + "operationId": "SaveRecipe", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RecipeModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/RecipeModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/RecipeModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "integer", + "format": "int64" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/products/recipe/construct/{recipeType}": { + "get": { + "tags": [ + "ProductManagement" + ], + "operationId": "CreateRecipe", + "parameters": [ + { + "name": "recipeType", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RecipeModel" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/resources/types": { + "get": { + "tags": [ + "ResourceModification" + ], + "operationId": "GetTypeTree", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceTypeModel" + } + } + } + }, + "417": { + "description": "Expectation Failed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/resources": { + "get": { + "tags": [ + "ResourceModification" + ], + "operationId": "GetDetailsBatch", + "parameters": [ + { + "name": "ids", + "in": "query", + "schema": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ResourceModel" + } + } + } + } + }, + "417": { + "description": "Expectation Failed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "post": { + "tags": [ + "ResourceModification" + ], + "operationId": "Save", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ResourceModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ResourceModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceModel" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/api/moryx/resources/query": { + "post": { + "tags": [ + "ResourceModification" + ], + "operationId": "GetResources", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceQuery" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ResourceQuery" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ResourceQuery" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ResourceModel" + } + } + } + } + }, + "417": { + "description": "Expectation Failed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/resources/{id}": { + "get": { + "tags": [ + "ResourceModification" + ], + "operationId": "GetDetails", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceModel" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "417": { + "description": "Expectation Failed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "put": { + "tags": [ + "ResourceModification" + ], + "operationId": "Update", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ResourceModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ResourceModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "ResourceModification" + ], + "operationId": "Remove", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "417": { + "description": "Expectation Failed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/resources/{id}/invoke/{method}": { + "post": { + "tags": [ + "ResourceModification" + ], + "operationId": "InvokeMethod", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "method", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Entry" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Entry" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/Entry" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Entry" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "417": { + "description": "Expectation Failed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/resources/types/{type}": { + "post": { + "tags": [ + "ResourceModification" + ], + "operationId": "ConstructWithParameters", + "parameters": [ + { + "name": "type", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "method", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Entry" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Entry" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/Entry" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceModel" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "417": { + "description": "Expectation Failed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/shifts": { + "get": { + "tags": [ + "ShiftManagement" + ], + "operationId": "GetShifts", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShiftModel" + } + } + } + } + } + } + }, + "post": { + "tags": [ + "ShiftManagement" + ], + "operationId": "CreateShift", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShiftCreationContextModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ShiftCreationContextModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ShiftCreationContextModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShiftModel" + } + } + } + } + } + }, + "put": { + "tags": [ + "ShiftManagement" + ], + "operationId": "UpdateShift", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShiftModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ShiftModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ShiftModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/moryx/shifts/filter": { + "get": { + "tags": [ + "ShiftManagement" + ], + "operationId": "GetShifts", + "parameters": [ + { + "name": "earliestDate", + "in": "query", + "schema": { + "type": "string", + "format": "time" + } + }, + { + "name": "latestDate", + "in": "query", + "schema": { + "type": "string", + "format": "time" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShiftModel" + } + } + } + } + } + } + } + }, + "/api/moryx/shifts/{id}": { + "delete": { + "tags": [ + "ShiftManagement" + ], + "operationId": "DeleteShift", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/moryx/shifts/types": { + "get": { + "tags": [ + "ShiftManagement" + ], + "operationId": "GetShiftTypes", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShiftTypeModel" + } + } + } + } + } + } + }, + "post": { + "tags": [ + "ShiftManagement" + ], + "operationId": "CreateShiftType", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShiftTypeCreationContextModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ShiftTypeCreationContextModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ShiftTypeCreationContextModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShiftTypeModel" + } + } + } + } + } + }, + "put": { + "tags": [ + "ShiftManagement" + ], + "operationId": "UpdateShiftType", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShiftTypeModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ShiftTypeModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ShiftTypeModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/moryx/shifts/types/{id}": { + "delete": { + "tags": [ + "ShiftManagement" + ], + "operationId": "DeleteShiftType", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/moryx/shifts/assignements": { + "get": { + "tags": [ + "ShiftManagement" + ], + "operationId": "GetShiftAssignements", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShiftAssignementModel" + } + } + } + } + } + } + }, + "post": { + "tags": [ + "ShiftManagement" + ], + "operationId": "CreateShiftAssignement", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShiftAssignementCreationContextModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ShiftAssignementCreationContextModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ShiftAssignementCreationContextModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShiftAssignementModel" + } + } + } + } + } + }, + "put": { + "tags": [ + "ShiftManagement" + ], + "operationId": "UpdateShiftAssignement", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShiftAssignementModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ShiftAssignementModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ShiftAssignementModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/moryx/shifts/assignements/filter": { + "get": { + "tags": [ + "ShiftManagement" + ], + "operationId": "GetShiftAssignements", + "parameters": [ + { + "name": "earliestDate", + "in": "query", + "schema": { + "type": "string", + "format": "time" + } + }, + { + "name": "latestDate", + "in": "query", + "schema": { + "type": "string", + "format": "time" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShiftAssignementModel" + } + } + } + } + } + } + } + }, + "/api/moryx/shifts/assignements/{id}": { + "delete": { + "tags": [ + "ShiftManagement" + ], + "operationId": "DeleteShiftAssignement", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/moryx/skills/types": { + "get": { + "tags": [ + "SkillManagement" + ], + "operationId": "GetTypes", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SkillTypeModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + } + }, + "post": { + "tags": [ + "SkillManagement" + ], + "operationId": "Create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SkillTypeCreationContextModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/SkillTypeCreationContextModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/SkillTypeCreationContextModel" + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SkillTypeModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + } + }, + "put": { + "tags": [ + "SkillManagement" + ], + "operationId": "Update", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SkillTypeModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/SkillTypeModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/SkillTypeModel" + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/moryx/skills/types/{id}": { + "get": { + "tags": [ + "SkillManagement" + ], + "operationId": "GetType", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SkillTypeModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + } + }, + "delete": { + "tags": [ + "SkillManagement" + ], + "operationId": "DeleteType", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/moryx/skills/types/prototype": { + "get": { + "tags": [ + "SkillManagement" + ], + "operationId": "GetTypePrototype", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SkillTypeModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/moryx/skills": { + "get": { + "tags": [ + "SkillManagement" + ], + "operationId": "GetSkills", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SkillModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + } + }, + "post": { + "tags": [ + "SkillManagement" + ], + "operationId": "Create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SkillCreationContextModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/SkillCreationContextModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/SkillCreationContextModel" + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SkillModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/moryx/skills/{id}": { + "get": { + "tags": [ + "SkillManagement" + ], + "operationId": "GetSkill", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SkillModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + } + }, + "delete": { + "tags": [ + "SkillManagement" + ], + "operationId": "DeleteSkill", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/foo/{value}": { + "get": { + "tags": [ + "Test" + ], + "operationId": "GetFoo", + "parameters": [ + { + "name": "value", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Foo" + } + } + } + } + } + } + }, + "/api/moryx/instructions/stream": { + "get": { + "tags": [ + "VisualInstructions" + ], + "operationId": "InstructionStream", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InstructionModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/moryx/instructions/{identifier}": { + "get": { + "tags": [ + "VisualInstructions" + ], + "operationId": "GetAll", + "parameters": [ + { + "name": "identifier", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InstructionModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + } + }, + "post": { + "tags": [ + "VisualInstructions" + ], + "operationId": "AddInstruction", + "parameters": [ + { + "name": "identifier", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InstructionModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InstructionModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/InstructionModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + }, + "delete": { + "tags": [ + "VisualInstructions" + ], + "operationId": "ClearInstruction", + "parameters": [ + { + "name": "identifier", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InstructionModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InstructionModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/InstructionModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/moryx/instructions/{identifier}/response": { + "put": { + "tags": [ + "VisualInstructions" + ], + "operationId": "CompleteInstruction", + "parameters": [ + { + "name": "identifier", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InstructionResponseModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InstructionResponseModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/InstructionResponseModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/instructions/instructors": { + "get": { + "tags": [ + "VisualInstructions" + ], + "operationId": "GetInstructors", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "/api/moryx/workplans": { + "get": { + "tags": [ + "Workplan" + ], + "operationId": "GetAllWorkplans", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkplanModel" + } + } + } + } + } + } + }, + "post": { + "tags": [ + "Workplan" + ], + "operationId": "SaveWorkplan", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/WorkplanModel" + } + } + } + }, + "responses": { + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/workplans/{id}/versions": { + "get": { + "tags": [ + "Workplan" + ], + "operationId": "GetVersions", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkplanModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/workplans/{id}": { + "get": { + "tags": [ + "Workplan" + ], + "operationId": "GetWorkplan", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Workplan" + ], + "operationId": "DeleteWorkplan", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "put": { + "tags": [ + "Workplan" + ], + "operationId": "UpdateWorkplan", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/WorkplanModel" + } + } + } + }, + "responses": { + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/moryx/workplans/steps": { + "get": { + "tags": [ + "WorkplanEditing" + ], + "operationId": "AvailableSteps", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkplanStepRecipe" + } + } + } + } + } + } + } + }, + "/api/moryx/workplans/sessions": { + "post": { + "tags": [ + "WorkplanEditing" + ], + "operationId": "EditWorkplan", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenSessionRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/OpenSessionRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/OpenSessionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanSessionModel" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + }, + "/api/moryx/workplans/sessions/{sessionId}": { + "get": { + "tags": [ + "WorkplanEditing" + ], + "operationId": "OpenSession", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanSessionModel" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "WorkplanEditing" + ], + "operationId": "UpdateSession", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanSessionModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanSessionModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/WorkplanSessionModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanSessionModel" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "WorkplanEditing" + ], + "operationId": "CloseSession", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/moryx/workplans/sessions/{sessionId}/autolayout": { + "get": { + "tags": [ + "WorkplanEditing" + ], + "operationId": "AutoLayout", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanSessionModel" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + }, + "/api/moryx/workplans/sessions/{sessionId}/save": { + "post": { + "tags": [ + "WorkplanEditing" + ], + "operationId": "SaveSession", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanSessionModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanSessionModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/WorkplanSessionModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanSessionModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + }, + "/api/moryx/workplans/sessions/{sessionId}/validate": { + "get": { + "tags": [ + "WorkplanEditing" + ], + "operationId": "ValidateSession", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationResultModel" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + }, + "/api/moryx/workplans/sessions/{sessionId}/nodes": { + "post": { + "tags": [ + "WorkplanEditing" + ], + "operationId": "AddStep", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanStepRecipe" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanStepRecipe" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/WorkplanStepRecipe" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanNodeModel" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + }, + "/api/moryx/workplans/sessions/{sessionId}/nodes/{nodeId}": { + "put": { + "tags": [ + "WorkplanEditing" + ], + "operationId": "UpdateStep", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanNodeModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanNodeModel" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/WorkplanNodeModel" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanNodeModel" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "WorkplanEditing" + ], + "operationId": "RemoveNode", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanSessionModel" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + }, + "/api/moryx/workplans/sessions/{sessionId}/nodes/{targetNodeId}/{targetIndex}": { + "post": { + "tags": [ + "WorkplanEditing" + ], + "operationId": "ConnectStep", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "targetNodeId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "targetIndex", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NodeConnector" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/NodeConnector" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/NodeConnector" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanSessionModel" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "WorkplanEditing" + ], + "operationId": "DisconnectStep", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "targetNodeId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "targetIndex", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NodeConnector" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/NodeConnector" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/NodeConnector" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkplanSessionModel" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MoryxExceptionResponse" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "ActivityChangedModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "resourceId": { + "type": "integer", + "format": "int64" + }, + "classification": { + "$ref": "#/components/schemas/ActivityClassification" + }, + "orderReferenceModel": { + "$ref": "#/components/schemas/OrderReferenceModel" + } + }, + "additionalProperties": false + }, + "ActivityClassification": { + "enum": [ + "Unknown", + "Production", + "Setup", + "Maintenance", + "Preparation" + ], + "type": "string" + }, + "ActivityResourceModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "AdviceContext": { + "type": "object", + "properties": { + "advicedAmount": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "AdviceModel": { + "type": "object", + "properties": { + "toteBoxNumber": { + "type": "string", + "nullable": true + }, + "amount": { + "type": "integer", + "format": "int32" + }, + "partId": { + "type": "integer", + "format": "int64", + "nullable": true + } + }, + "additionalProperties": false + }, + "ApiError": { + "type": "object", + "properties": { + "errorCode": { + "type": "string", + "nullable": true + }, + "message": { + "type": "string", + "nullable": true + }, + "exception": { + "$ref": "#/components/schemas/Exception" + } + }, + "additionalProperties": false + }, + "ApplicationInformationResponse": { + "type": "object", + "properties": { + "assemblyProduct": { + "type": "string", + "nullable": true + }, + "assemblyVersion": { + "type": "string", + "nullable": true + }, + "assemblyInformationalVersion": { + "type": "string", + "nullable": true + }, + "assemblyDescription": { + "type": "string", + "nullable": true + }, + "assemblyCompanyName": { + "type": "string", + "nullable": true + }, + "assemblyTitle": { + "type": "string", + "nullable": true + }, + "assemblyConfiguration": { + "type": "string", + "nullable": true + }, + "targetFramework": { + "type": "string", + "nullable": true + }, + "assemblyCopyright": { + "type": "string", + "nullable": true + }, + "assemblyTrademark": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "Assembly": { + "type": "object", + "properties": { + "definedTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeInfo" + }, + "nullable": true, + "readOnly": true + }, + "exportedTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Type" + }, + "nullable": true, + "readOnly": true + }, + "codeBase": { + "type": "string", + "nullable": true, + "readOnly": true, + "deprecated": true + }, + "entryPoint": { + "$ref": "#/components/schemas/MethodInfo" + }, + "fullName": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "imageRuntimeVersion": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "isDynamic": { + "type": "boolean", + "readOnly": true + }, + "location": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "reflectionOnly": { + "type": "boolean", + "readOnly": true + }, + "isCollectible": { + "type": "boolean", + "readOnly": true + }, + "isFullyTrusted": { + "type": "boolean", + "readOnly": true + }, + "customAttributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeData" + }, + "nullable": true, + "readOnly": true + }, + "escapedCodeBase": { + "type": "string", + "nullable": true, + "readOnly": true, + "deprecated": true + }, + "manifestModule": { + "$ref": "#/components/schemas/Module" + }, + "modules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Module" + }, + "nullable": true, + "readOnly": true + }, + "globalAssemblyCache": { + "type": "boolean", + "readOnly": true, + "deprecated": true + }, + "hostContext": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "securityRuleSet": { + "$ref": "#/components/schemas/SecurityRuleSet" + } + }, + "additionalProperties": false + }, + "AssemblyModel": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "version": { + "type": "string", + "nullable": true + }, + "fileVersion": { + "type": "string", + "nullable": true + }, + "informationalVersion": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "AssignableOperator": { + "type": "object", + "properties": { + "identifier": { + "type": "string", + "nullable": true + }, + "firstName": { + "type": "string", + "nullable": true + }, + "lastName": { + "type": "string", + "nullable": true + }, + "pseudonym": { + "type": "string", + "nullable": true + }, + "signedIn": { + "type": "boolean", + "readOnly": true + }, + "assignedResources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IOperatorAssignable" + }, + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false + }, + "AssignedDays": { + "enum": [ + "All", + "First", + "Second", + "Third", + "Fourth", + "Fifth", + "Sixth", + "Seventh", + "Eighth", + "Ninth", + "Tenth", + "Eleventh", + "Twelfth", + "Thirteenth", + "Fourteenth", + "Fifteenth", + "Sixteenth", + "Seventeenth", + "Eighteenth", + "Nineteenth", + "Twentieth", + "TwentyFirst", + "TwentySecond", + "TwentyThird", + "TwentyFourth", + "TwentyFifth", + "TwentySixth", + "TwentySeventh", + "TwentyEighth", + "TwentyNinth", + "Thirtieth", + "ThirtyFirst" + ], + "type": "string" + }, + "AttendableResourceModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + }, + "requiredSkills": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "BeginContext": { + "type": "object", + "properties": { + "successCount": { + "type": "integer", + "format": "int32" + }, + "scrapCount": { + "type": "integer", + "format": "int32" + }, + "residualAmount": { + "type": "integer", + "format": "int32" + }, + "partialAmount": { + "type": "integer", + "format": "int32" + }, + "minimalTargetAmount": { + "type": "integer", + "format": "int32" + }, + "canBegin": { + "type": "boolean" + }, + "canReduce": { + "type": "boolean" + }, + "restrictions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RestrictionDescription" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "BeginModel": { + "type": "object", + "properties": { + "amount": { + "type": "integer", + "format": "int32" + }, + "userId": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "CallingConventions": { + "enum": [ + "Standard", + "VarArgs", + "Any", + "HasThis", + "ExplicitThis" + ], + "type": "string" + }, + "Category": { + "enum": [ + "ProcessHolderGroup", + "ParentResource" + ], + "type": "string" + }, + "CellLocationModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "positionX": { + "type": "number", + "format": "double" + }, + "positionY": { + "type": "number", + "format": "double" + } + }, + "additionalProperties": false + }, + "CellPropertySettings": { + "type": "object", + "properties": { + "valueUnit": { + "type": "string", + "nullable": true + }, + "iconName": { + "type": "string", + "nullable": true + }, + "isDisplayed": { + "type": "boolean" + }, + "currentValue": { + "nullable": true + }, + "displayName": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "CellSettingsModel": { + "type": "object", + "properties": { + "image": { + "type": "string", + "nullable": true + }, + "icon": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "CellState": { + "enum": [ + "Idle", + "Requested", + "Running", + "NotReadyToWork" + ], + "type": "string" + }, + "CellStateChangedModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "state": { + "$ref": "#/components/schemas/CellState" + } + }, + "additionalProperties": false + }, + "Config": { + "type": "object", + "properties": { + "root": { + "$ref": "#/components/schemas/Entry" + } + }, + "additionalProperties": false + }, + "ConfigUpdateMode": { + "enum": [ + "OnlySave", + "SaveAndReincarnate", + "UpdateLiveAndSave" + ], + "type": "string" + }, + "ConfirmationType": { + "enum": [ + "Partial", + "Final" + ], + "type": "string" + }, + "ConstructorInfo": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "declaringType": { + "$ref": "#/components/schemas/Type" + }, + "reflectedType": { + "$ref": "#/components/schemas/Type" + }, + "module": { + "$ref": "#/components/schemas/Module" + }, + "customAttributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeData" + }, + "nullable": true, + "readOnly": true + }, + "isCollectible": { + "type": "boolean", + "readOnly": true + }, + "metadataToken": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "attributes": { + "$ref": "#/components/schemas/MethodAttributes" + }, + "methodImplementationFlags": { + "$ref": "#/components/schemas/MethodImplAttributes" + }, + "callingConvention": { + "$ref": "#/components/schemas/CallingConventions" + }, + "isAbstract": { + "type": "boolean", + "readOnly": true + }, + "isConstructor": { + "type": "boolean", + "readOnly": true + }, + "isFinal": { + "type": "boolean", + "readOnly": true + }, + "isHideBySig": { + "type": "boolean", + "readOnly": true + }, + "isSpecialName": { + "type": "boolean", + "readOnly": true + }, + "isStatic": { + "type": "boolean", + "readOnly": true + }, + "isVirtual": { + "type": "boolean", + "readOnly": true + }, + "isAssembly": { + "type": "boolean", + "readOnly": true + }, + "isFamily": { + "type": "boolean", + "readOnly": true + }, + "isFamilyAndAssembly": { + "type": "boolean", + "readOnly": true + }, + "isFamilyOrAssembly": { + "type": "boolean", + "readOnly": true + }, + "isPrivate": { + "type": "boolean", + "readOnly": true + }, + "isPublic": { + "type": "boolean", + "readOnly": true + }, + "isConstructedGenericMethod": { + "type": "boolean", + "readOnly": true + }, + "isGenericMethod": { + "type": "boolean", + "readOnly": true + }, + "isGenericMethodDefinition": { + "type": "boolean", + "readOnly": true + }, + "containsGenericParameters": { + "type": "boolean", + "readOnly": true + }, + "methodHandle": { + "$ref": "#/components/schemas/RuntimeMethodHandle" + }, + "isSecurityCritical": { + "type": "boolean", + "readOnly": true + }, + "isSecuritySafeCritical": { + "type": "boolean", + "readOnly": true + }, + "isSecurityTransparent": { + "type": "boolean", + "readOnly": true + }, + "memberType": { + "$ref": "#/components/schemas/MemberTypes" + } + }, + "additionalProperties": false + }, + "ContentDescriptorModel": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string", + "nullable": true + }, + "variants": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VariantDescriptor" + }, + "nullable": true + }, + "master": { + "$ref": "#/components/schemas/VariantDescriptor" + } + }, + "additionalProperties": false + }, + "CustomAttributeData": { + "type": "object", + "properties": { + "attributeType": { + "$ref": "#/components/schemas/Type" + }, + "constructor": { + "$ref": "#/components/schemas/ConstructorInfo" + }, + "constructorArguments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeTypedArgument" + }, + "nullable": true, + "readOnly": true + }, + "namedArguments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeNamedArgument" + }, + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false + }, + "CustomAttributeNamedArgument": { + "type": "object", + "properties": { + "memberInfo": { + "$ref": "#/components/schemas/MemberInfo" + }, + "typedValue": { + "$ref": "#/components/schemas/CustomAttributeTypedArgument" + }, + "memberName": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "isField": { + "type": "boolean", + "readOnly": true + } + }, + "additionalProperties": false + }, + "CustomAttributeTypedArgument": { + "type": "object", + "properties": { + "argumentType": { + "$ref": "#/components/schemas/Type" + }, + "value": { + "nullable": true + } + }, + "additionalProperties": false + }, + "DataModel": { + "type": "object", + "properties": { + "targetModel": { + "type": "string", + "nullable": true + }, + "config": { + "$ref": "#/components/schemas/DatabaseConfigModel" + }, + "possibleConfigurators": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + }, + "setups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetupModel" + }, + "nullable": true + }, + "availableMigrations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DbMigrationsModel" + }, + "nullable": true + }, + "appliedMigrations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DbMigrationsModel" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "DataType": { + "enum": [ + "Custom", + "DateTime", + "Date", + "Time", + "Duration", + "PhoneNumber", + "Currency", + "Text", + "Html", + "MultilineText", + "EmailAddress", + "Password", + "Url", + "ImageUrl", + "CreditCard", + "PostalCode", + "Upload" + ], + "type": "string" + }, + "DatabaseConfigModel": { + "type": "object", + "properties": { + "configuratorType": { + "type": "string", + "nullable": true + }, + "connectionString": { + "type": "string", + "nullable": true + }, + "properties": { + "$ref": "#/components/schemas/Entry" + } + }, + "additionalProperties": false + }, + "DatabaseMigrationSummary": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/MigrationResult" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + }, + "executedMigrations": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "DatabasesResponse": { + "type": "object", + "properties": { + "databases": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DataModel" + }, + "nullable": true + }, + "configurators": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ModelConfiguratorModel" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "DbMigrationsModel": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "DependencyEvaluation": { + "type": "object", + "properties": { + "rootModules": { + "type": "integer", + "format": "int32" + }, + "maxDepth": { + "type": "integer", + "format": "int32" + }, + "maxDependencies": { + "type": "integer", + "format": "int32" + }, + "maxDependends": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "DocumentModel": { + "type": "object", + "properties": { + "identifier": { + "type": "string", + "nullable": true + }, + "number": { + "type": "string", + "nullable": true + }, + "revision": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + }, + "contentType": { + "type": "string", + "nullable": true + }, + "source": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "Entry": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "nullable": true + }, + "identifier": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + }, + "value": { + "$ref": "#/components/schemas/EntryValue" + }, + "validation": { + "$ref": "#/components/schemas/EntryValidation" + }, + "subEntries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Entry" + }, + "nullable": true + }, + "prototypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Entry" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "EntryPossible": { + "type": "object", + "properties": { + "key": { + "type": "string", + "nullable": true + }, + "displayName": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "EntryUnitType": { + "enum": [ + "None", + "Password", + "FilePath", + "DirectoryPath", + "Flags", + "Base64" + ], + "type": "string" + }, + "EntryValidation": { + "type": "object", + "properties": { + "dataType": { + "$ref": "#/components/schemas/DataType" + }, + "minimum": { + "type": "number", + "format": "double" + }, + "maximum": { + "type": "number", + "format": "double" + }, + "regex": { + "type": "string", + "nullable": true + }, + "isRequired": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "EntryValue": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/EntryValueType" + }, + "unitType": { + "$ref": "#/components/schemas/EntryUnitType" + }, + "current": { + "type": "string", + "nullable": true + }, + "default": { + "type": "string", + "nullable": true + }, + "possible": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EntryPossible" + }, + "nullable": true + }, + "isReadOnly": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "EntryValueType": { + "enum": [ + "Byte", + "Boolean", + "Int16", + "UInt16", + "Int32", + "UInt32", + "Int64", + "UInt64", + "Single", + "Double", + "String", + "Enum", + "Class", + "Collection", + "Exception", + "Stream", + "Struct", + "DateTime", + "Date", + "Time", + "TimeSpan" + ], + "type": "string" + }, + "EventAttributes": { + "enum": [ + "None", + "SpecialName", + "RTSpecialName" + ], + "type": "string" + }, + "EventInfo": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "declaringType": { + "$ref": "#/components/schemas/Type" + }, + "reflectedType": { + "$ref": "#/components/schemas/Type" + }, + "module": { + "$ref": "#/components/schemas/Module" + }, + "customAttributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeData" + }, + "nullable": true, + "readOnly": true + }, + "isCollectible": { + "type": "boolean", + "readOnly": true + }, + "metadataToken": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "memberType": { + "$ref": "#/components/schemas/MemberTypes" + }, + "attributes": { + "$ref": "#/components/schemas/EventAttributes" + }, + "isSpecialName": { + "type": "boolean", + "readOnly": true + }, + "addMethod": { + "$ref": "#/components/schemas/MethodInfo" + }, + "removeMethod": { + "$ref": "#/components/schemas/MethodInfo" + }, + "raiseMethod": { + "$ref": "#/components/schemas/MethodInfo" + }, + "isMulticast": { + "type": "boolean", + "readOnly": true + }, + "eventHandlerType": { + "$ref": "#/components/schemas/Type" + } + }, + "additionalProperties": false + }, + "Exception": { + "type": "object", + "properties": { + "targetSite": { + "$ref": "#/components/schemas/MethodBase" + }, + "message": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "data": { + "type": "object", + "additionalProperties": {}, + "nullable": true, + "readOnly": true + }, + "innerException": { + "$ref": "#/components/schemas/Exception" + }, + "helpLink": { + "type": "string", + "nullable": true + }, + "source": { + "type": "string", + "nullable": true + }, + "hResult": { + "type": "integer", + "format": "int32" + }, + "stackTrace": { + "type": "string", + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false + }, + "ExecuteSetupRequest": { + "type": "object", + "properties": { + "config": { + "$ref": "#/components/schemas/DatabaseConfigModel" + }, + "setup": { + "$ref": "#/components/schemas/SetupModel" + } + }, + "additionalProperties": false + }, + "ExtendedOperatorModel": { + "type": "object", + "properties": { + "identifier": { + "type": "string", + "nullable": true + }, + "firstName": { + "type": "string", + "nullable": true + }, + "lastName": { + "type": "string", + "nullable": true + }, + "pseudonym": { + "type": "string", + "nullable": true + }, + "assignedResources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttendableResourceModel" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "FactoryModel": { + "type": "object", + "properties": { + "parentId": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "backgroundURL": { + "type": "string", + "nullable": true + }, + "title": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "FactoryStateModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "location": { + "$ref": "#/components/schemas/CellLocationModel" + }, + "iconName": { + "type": "string", + "nullable": true + }, + "isACell": { + "type": "boolean" + }, + "backgroundURL": { + "type": "string", + "nullable": true + }, + "hasManufacturingFactory": { + "type": "boolean" + }, + "orderModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderModel" + }, + "nullable": true + }, + "activityChangedModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ActivityChangedModel" + }, + "nullable": true + }, + "cellStateChangedModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CellStateChangedModel" + }, + "nullable": true + }, + "resourceChangedModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ResourceChangedModel" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "FailureBehaviour": { + "enum": [ + "Stop", + "StopAndNotify" + ], + "type": "string" + }, + "FieldAttributes": { + "enum": [ + "PrivateScope", + "Private", + "FamANDAssem", + "Assembly", + "Family", + "FamORAssem", + "Public", + "FieldAccessMask", + "Static", + "InitOnly", + "Literal", + "NotSerialized", + "HasFieldRVA", + "SpecialName", + "RTSpecialName", + "HasFieldMarshal", + "PinvokeImpl", + "HasDefault", + "ReservedMask" + ], + "type": "string" + }, + "FieldInfo": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "declaringType": { + "$ref": "#/components/schemas/Type" + }, + "reflectedType": { + "$ref": "#/components/schemas/Type" + }, + "module": { + "$ref": "#/components/schemas/Module" + }, + "customAttributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeData" + }, + "nullable": true, + "readOnly": true + }, + "isCollectible": { + "type": "boolean", + "readOnly": true + }, + "metadataToken": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "memberType": { + "$ref": "#/components/schemas/MemberTypes" + }, + "attributes": { + "$ref": "#/components/schemas/FieldAttributes" + }, + "fieldType": { + "$ref": "#/components/schemas/Type" + }, + "isInitOnly": { + "type": "boolean", + "readOnly": true + }, + "isLiteral": { + "type": "boolean", + "readOnly": true + }, + "isNotSerialized": { + "type": "boolean", + "readOnly": true, + "deprecated": true + }, + "isPinvokeImpl": { + "type": "boolean", + "readOnly": true + }, + "isSpecialName": { + "type": "boolean", + "readOnly": true + }, + "isStatic": { + "type": "boolean", + "readOnly": true + }, + "isAssembly": { + "type": "boolean", + "readOnly": true + }, + "isFamily": { + "type": "boolean", + "readOnly": true + }, + "isFamilyAndAssembly": { + "type": "boolean", + "readOnly": true + }, + "isFamilyOrAssembly": { + "type": "boolean", + "readOnly": true + }, + "isPrivate": { + "type": "boolean", + "readOnly": true + }, + "isPublic": { + "type": "boolean", + "readOnly": true + }, + "isSecurityCritical": { + "type": "boolean", + "readOnly": true + }, + "isSecuritySafeCritical": { + "type": "boolean", + "readOnly": true + }, + "isSecurityTransparent": { + "type": "boolean", + "readOnly": true + }, + "fieldHandle": { + "$ref": "#/components/schemas/RuntimeFieldHandle" + } + }, + "additionalProperties": false + }, + "Foo": { + "type": "object", + "properties": { + "value": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "GenericParameterAttributes": { + "enum": [ + "None", + "Covariant", + "Contravariant", + "VarianceMask", + "ReferenceTypeConstraint", + "NotNullableValueTypeConstraint", + "DefaultConstructorConstraint", + "SpecialConstraintMask", + "AllowByRefLike" + ], + "type": "string" + }, + "HostInformationResponse": { + "type": "object", + "properties": { + "machineName": { + "type": "string", + "nullable": true + }, + "osInformation": { + "type": "string", + "nullable": true + }, + "upTime": { + "type": "integer", + "format": "int64" + } + }, + "additionalProperties": false + }, + "ICapabilities": { + "type": "object", + "properties": { + "isCombined": { + "type": "boolean", + "readOnly": true + } + }, + "additionalProperties": false + }, + "ICustomAttributeProvider": { + "type": "object", + "additionalProperties": false + }, + "IOperatorAssignable": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "name": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "capabilities": { + "$ref": "#/components/schemas/ICapabilities" + }, + "requiredSkills": { + "$ref": "#/components/schemas/ICapabilities" + } + }, + "additionalProperties": false + }, + "InstructionContentType": { + "enum": [ + "Unknown", + "Text", + "Media" + ], + "type": "string" + }, + "InstructionItemModel": { + "type": "object", + "properties": { + "contentType": { + "$ref": "#/components/schemas/InstructionContentType" + }, + "content": { + "type": "string", + "nullable": true + }, + "preview": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "InstructionModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "sender": { + "type": "string", + "nullable": true + }, + "type": { + "$ref": "#/components/schemas/InstructionType" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InstructionItemModel" + }, + "nullable": true + }, + "inputs": { + "$ref": "#/components/schemas/Entry" + }, + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InstructionResultModel" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "InstructionResponseModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "inputs": { + "$ref": "#/components/schemas/Entry" + }, + "result": { + "type": "string", + "nullable": true + }, + "selectedResult": { + "$ref": "#/components/schemas/InstructionResultModel" + } + }, + "additionalProperties": false + }, + "InstructionResultModel": { + "type": "object", + "properties": { + "key": { + "type": "string", + "nullable": true + }, + "displayValue": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "InstructionType": { + "enum": [ + "Display", + "Execute" + ], + "type": "string" + }, + "IntPtr": { + "type": "object", + "additionalProperties": false + }, + "InternalOperationClassification": { + "enum": [ + "Initial", + "Assigning", + "Failed", + "Aborted", + "Ready", + "Running", + "Interrupting", + "Interrupted", + "Completed", + "AmountReached" + ], + "type": "string" + }, + "InvocationResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "exceptionType": { + "type": "string", + "nullable": true + }, + "errorMessage": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "JobModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "recipeId": { + "type": "integer", + "format": "int64" + }, + "state": { + "type": "string", + "nullable": true + }, + "displayState": { + "type": "string", + "nullable": true + }, + "workplan": { + "type": "string", + "nullable": true + }, + "canComplete": { + "type": "boolean" + }, + "canAbort": { + "type": "boolean" + }, + "isWaiting": { + "type": "boolean" + }, + "isRunning": { + "type": "boolean" + }, + "productionJob": { + "$ref": "#/components/schemas/ProductionJobModel" + }, + "setupJob": { + "$ref": "#/components/schemas/SetupJobModel" + } + }, + "additionalProperties": false + }, + "JobProcessModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "recipeId": { + "type": "integer", + "format": "int64" + }, + "state": { + "$ref": "#/components/schemas/ProcessProgress" + }, + "rework": { + "type": "boolean" + }, + "started": { + "type": "string", + "format": "date-time" + }, + "completed": { + "type": "string", + "format": "date-time" + }, + "activities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProcessActivityModel" + }, + "nullable": true + }, + "isRunning": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "LayoutKind": { + "enum": [ + "Sequential", + "Explicit", + "Auto" + ], + "type": "string" + }, + "LogLevel": { + "enum": [ + "Trace", + "Debug", + "Information", + "Warning", + "Error", + "Critical", + "None" + ], + "type": "string" + }, + "MemberInfo": { + "type": "object", + "properties": { + "memberType": { + "$ref": "#/components/schemas/MemberTypes" + }, + "name": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "declaringType": { + "$ref": "#/components/schemas/Type" + }, + "reflectedType": { + "$ref": "#/components/schemas/Type" + }, + "module": { + "$ref": "#/components/schemas/Module" + }, + "customAttributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeData" + }, + "nullable": true, + "readOnly": true + }, + "isCollectible": { + "type": "boolean", + "readOnly": true + }, + "metadataToken": { + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "additionalProperties": false + }, + "MemberTypes": { + "enum": [ + "Constructor", + "Event", + "Field", + "Method", + "Property", + "TypeInfo", + "Custom", + "NestedType", + "All" + ], + "type": "string" + }, + "MethodAttributes": { + "enum": [ + "PrivateScope", + "Private", + "FamANDAssem", + "Assembly", + "Family", + "FamORAssem", + "Public", + "MemberAccessMask", + "UnmanagedExport", + "Static", + "Final", + "Virtual", + "HideBySig", + "NewSlot", + "CheckAccessOnOverride", + "Abstract", + "SpecialName", + "RTSpecialName", + "PinvokeImpl", + "HasSecurity", + "RequireSecObject", + "ReservedMask" + ], + "type": "string" + }, + "MethodBase": { + "type": "object", + "properties": { + "memberType": { + "$ref": "#/components/schemas/MemberTypes" + }, + "name": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "declaringType": { + "$ref": "#/components/schemas/Type" + }, + "reflectedType": { + "$ref": "#/components/schemas/Type" + }, + "module": { + "$ref": "#/components/schemas/Module" + }, + "customAttributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeData" + }, + "nullable": true, + "readOnly": true + }, + "isCollectible": { + "type": "boolean", + "readOnly": true + }, + "metadataToken": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "attributes": { + "$ref": "#/components/schemas/MethodAttributes" + }, + "methodImplementationFlags": { + "$ref": "#/components/schemas/MethodImplAttributes" + }, + "callingConvention": { + "$ref": "#/components/schemas/CallingConventions" + }, + "isAbstract": { + "type": "boolean", + "readOnly": true + }, + "isConstructor": { + "type": "boolean", + "readOnly": true + }, + "isFinal": { + "type": "boolean", + "readOnly": true + }, + "isHideBySig": { + "type": "boolean", + "readOnly": true + }, + "isSpecialName": { + "type": "boolean", + "readOnly": true + }, + "isStatic": { + "type": "boolean", + "readOnly": true + }, + "isVirtual": { + "type": "boolean", + "readOnly": true + }, + "isAssembly": { + "type": "boolean", + "readOnly": true + }, + "isFamily": { + "type": "boolean", + "readOnly": true + }, + "isFamilyAndAssembly": { + "type": "boolean", + "readOnly": true + }, + "isFamilyOrAssembly": { + "type": "boolean", + "readOnly": true + }, + "isPrivate": { + "type": "boolean", + "readOnly": true + }, + "isPublic": { + "type": "boolean", + "readOnly": true + }, + "isConstructedGenericMethod": { + "type": "boolean", + "readOnly": true + }, + "isGenericMethod": { + "type": "boolean", + "readOnly": true + }, + "isGenericMethodDefinition": { + "type": "boolean", + "readOnly": true + }, + "containsGenericParameters": { + "type": "boolean", + "readOnly": true + }, + "methodHandle": { + "$ref": "#/components/schemas/RuntimeMethodHandle" + }, + "isSecurityCritical": { + "type": "boolean", + "readOnly": true + }, + "isSecuritySafeCritical": { + "type": "boolean", + "readOnly": true + }, + "isSecurityTransparent": { + "type": "boolean", + "readOnly": true + } + }, + "additionalProperties": false + }, + "MethodEntry": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "isConstructor": { + "type": "boolean" + }, + "displayName": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + }, + "parameters": { + "$ref": "#/components/schemas/Entry" + }, + "isAsync": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "MethodImplAttributes": { + "enum": [ + "IL", + "Native", + "OPTIL", + "CodeTypeMask", + "ManagedMask", + "NoInlining", + "ForwardRef", + "Synchronized", + "NoOptimization", + "PreserveSig", + "AggressiveInlining", + "AggressiveOptimization", + "InternalCall", + "Async", + "MaxMethodImplVal" + ], + "type": "string" + }, + "MethodInfo": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "declaringType": { + "$ref": "#/components/schemas/Type" + }, + "reflectedType": { + "$ref": "#/components/schemas/Type" + }, + "module": { + "$ref": "#/components/schemas/Module" + }, + "customAttributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeData" + }, + "nullable": true, + "readOnly": true + }, + "isCollectible": { + "type": "boolean", + "readOnly": true + }, + "metadataToken": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "attributes": { + "$ref": "#/components/schemas/MethodAttributes" + }, + "methodImplementationFlags": { + "$ref": "#/components/schemas/MethodImplAttributes" + }, + "callingConvention": { + "$ref": "#/components/schemas/CallingConventions" + }, + "isAbstract": { + "type": "boolean", + "readOnly": true + }, + "isConstructor": { + "type": "boolean", + "readOnly": true + }, + "isFinal": { + "type": "boolean", + "readOnly": true + }, + "isHideBySig": { + "type": "boolean", + "readOnly": true + }, + "isSpecialName": { + "type": "boolean", + "readOnly": true + }, + "isStatic": { + "type": "boolean", + "readOnly": true + }, + "isVirtual": { + "type": "boolean", + "readOnly": true + }, + "isAssembly": { + "type": "boolean", + "readOnly": true + }, + "isFamily": { + "type": "boolean", + "readOnly": true + }, + "isFamilyAndAssembly": { + "type": "boolean", + "readOnly": true + }, + "isFamilyOrAssembly": { + "type": "boolean", + "readOnly": true + }, + "isPrivate": { + "type": "boolean", + "readOnly": true + }, + "isPublic": { + "type": "boolean", + "readOnly": true + }, + "isConstructedGenericMethod": { + "type": "boolean", + "readOnly": true + }, + "isGenericMethod": { + "type": "boolean", + "readOnly": true + }, + "isGenericMethodDefinition": { + "type": "boolean", + "readOnly": true + }, + "containsGenericParameters": { + "type": "boolean", + "readOnly": true + }, + "methodHandle": { + "$ref": "#/components/schemas/RuntimeMethodHandle" + }, + "isSecurityCritical": { + "type": "boolean", + "readOnly": true + }, + "isSecuritySafeCritical": { + "type": "boolean", + "readOnly": true + }, + "isSecurityTransparent": { + "type": "boolean", + "readOnly": true + }, + "memberType": { + "$ref": "#/components/schemas/MemberTypes" + }, + "returnParameter": { + "$ref": "#/components/schemas/ParameterInfo" + }, + "returnType": { + "$ref": "#/components/schemas/Type" + }, + "returnTypeCustomAttributes": { + "$ref": "#/components/schemas/ICustomAttributeProvider" + } + }, + "additionalProperties": false + }, + "MigrationResult": { + "enum": [ + "Migrated", + "NoMigrationsAvailable", + "Error" + ], + "type": "string" + }, + "ModelConfiguratorModel": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "configuratorType": { + "type": "string", + "nullable": true + }, + "connectionStringKeys": { + "type": "object", + "additionalProperties": { + "type": "string", + "nullable": true + }, + "nullable": true + }, + "connectionStringPrototype": { + "type": "string", + "nullable": true + }, + "configPrototype": { + "$ref": "#/components/schemas/Entry" + } + }, + "additionalProperties": false + }, + "Module": { + "type": "object", + "properties": { + "assembly": { + "$ref": "#/components/schemas/Assembly" + }, + "fullyQualifiedName": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "name": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "mdStreamVersion": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "moduleVersionId": { + "type": "string", + "format": "uuid", + "readOnly": true + }, + "scopeName": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "moduleHandle": { + "$ref": "#/components/schemas/ModuleHandle" + }, + "customAttributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeData" + }, + "nullable": true, + "readOnly": true + }, + "metadataToken": { + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "additionalProperties": false + }, + "ModuleHandle": { + "type": "object", + "properties": { + "mdStreamVersion": { + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "additionalProperties": false + }, + "ModuleNotificationModel": { + "type": "object", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time" + }, + "exception": { + "$ref": "#/components/schemas/SerializableException" + }, + "message": { + "type": "string", + "nullable": true + }, + "severity": { + "$ref": "#/components/schemas/Severity" + } + }, + "additionalProperties": false + }, + "ModuleStartBehaviour": { + "enum": [ + "Auto", + "Manual", + "OnDependency" + ], + "type": "string" + }, + "MoryxExceptionResponse": { + "type": "object", + "properties": { + "title": { + "type": "string", + "nullable": true + }, + "exception": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "NodeConnectionPoint": { + "type": "object", + "properties": { + "index": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true + }, + "connections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NodeConnector" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "NodeConnector": { + "type": "object", + "properties": { + "nodeId": { + "type": "integer", + "format": "int64" + }, + "index": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "NotificationModel": { + "type": "object", + "properties": { + "identifier": { + "type": "string", + "format": "uuid" + }, + "type": { + "type": "string", + "nullable": true + }, + "title": { + "type": "string", + "nullable": true + }, + "message": { + "type": "string", + "nullable": true + }, + "severity": { + "$ref": "#/components/schemas/Severity" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "acknowledged": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "isAcknowledgable": { + "type": "boolean" + }, + "properties": { + "$ref": "#/components/schemas/Entry" + }, + "sender": { + "type": "string", + "nullable": true + }, + "source": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "OpenSessionRequest": { + "type": "object", + "properties": { + "workplanId": { + "type": "integer", + "format": "int64" + }, + "duplicate": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "OperationAdvicedModel": { + "type": "object", + "properties": { + "operationModel": { + "$ref": "#/components/schemas/OperationModel" + }, + "advice": { + "$ref": "#/components/schemas/AdviceModel" + } + }, + "additionalProperties": false + }, + "OperationChangedModel": { + "type": "object", + "properties": { + "startedModel": { + "$ref": "#/components/schemas/OperationStartedModel" + }, + "reportedModel": { + "$ref": "#/components/schemas/OperationReportedModel" + }, + "advicedModel": { + "$ref": "#/components/schemas/OperationAdvicedModel" + } + }, + "additionalProperties": false + }, + "OperationCreationContextModel": { + "type": "object", + "properties": { + "totalAmount": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true + }, + "orderNumber": { + "type": "string", + "nullable": true + }, + "operationNumber": { + "type": "string", + "nullable": true + }, + "productIdentifier": { + "type": "string", + "nullable": true + }, + "productRevision": { + "type": "integer", + "format": "int32" + }, + "productName": { + "type": "string", + "nullable": true + }, + "recipePreselection": { + "type": "integer", + "format": "int64" + }, + "overDeliveryAmount": { + "type": "integer", + "format": "int32" + }, + "underDeliveryAmount": { + "type": "integer", + "format": "int32" + }, + "plannedStart": { + "type": "string", + "format": "date-time" + }, + "plannedEnd": { + "type": "string", + "format": "date-time" + }, + "targetCycleTime": { + "type": "number", + "format": "double" + }, + "unit": { + "type": "string", + "nullable": true + }, + "targetStock": { + "type": "string", + "nullable": true + }, + "parts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartCreationContext" + }, + "nullable": true + }, + "materialParameters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Entry" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "OperationLogMessageModel": { + "type": "object", + "properties": { + "logLevel": { + "$ref": "#/components/schemas/LogLevel" + }, + "message": { + "type": "string", + "nullable": true + }, + "exception": { + "type": "string", + "nullable": true + }, + "timeStamp": { + "type": "string", + "format": "date-time" + } + }, + "additionalProperties": false + }, + "OperationModel": { + "type": "object", + "properties": { + "identifier": { + "type": "string", + "format": "uuid" + }, + "totalAmount": { + "type": "integer", + "format": "int32" + }, + "number": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + }, + "overDeliveryAmount": { + "type": "integer", + "format": "int32" + }, + "underDeliveryAmount": { + "type": "integer", + "format": "int32" + }, + "plannedStart": { + "type": "string", + "format": "date-time" + }, + "plannedEnd": { + "type": "string", + "format": "date-time" + }, + "start": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "end": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "targetCycleTime": { + "type": "number", + "format": "double" + }, + "unit": { + "type": "string", + "nullable": true + }, + "sortOrder": { + "type": "integer", + "format": "int32" + }, + "order": { + "type": "string", + "nullable": true + }, + "classification": { + "$ref": "#/components/schemas/OperationStateClassification" + }, + "stateDisplayName": { + "type": "string", + "nullable": true + }, + "productId": { + "type": "integer", + "format": "int64" + }, + "productIdentifier": { + "type": "string", + "nullable": true + }, + "productRevision": { + "type": "integer", + "format": "int32" + }, + "productName": { + "type": "string", + "nullable": true + }, + "recipeName": { + "type": "string", + "nullable": true + }, + "recipeIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + }, + "nullable": true + }, + "jobIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + }, + "nullable": true + }, + "reportedSuccessCount": { + "type": "integer", + "format": "int32" + }, + "reportedFailureCount": { + "type": "integer", + "format": "int32" + }, + "canAssign": { + "type": "boolean" + }, + "canBegin": { + "type": "boolean" + }, + "canInterrupt": { + "type": "boolean" + }, + "canReport": { + "type": "boolean" + }, + "canAdvice": { + "type": "boolean" + }, + "isCreated": { + "type": "boolean" + }, + "isFailed": { + "type": "boolean" + }, + "isAssigning": { + "type": "boolean" + }, + "isAborted": { + "type": "boolean" + }, + "isAmountReached": { + "type": "boolean" + }, + "runningCount": { + "type": "integer", + "format": "int32" + }, + "successCount": { + "type": "integer", + "format": "int32" + }, + "scrapCount": { + "type": "integer", + "format": "int32" + }, + "pendingCount": { + "type": "integer", + "format": "int32" + }, + "progressRunning": { + "type": "integer", + "format": "int32" + }, + "progressSuccess": { + "type": "integer", + "format": "int32" + }, + "progressScrap": { + "type": "integer", + "format": "int32" + }, + "progressPending": { + "type": "integer", + "format": "int32" + }, + "hasDocuments": { + "type": "boolean" + }, + "hasPartList": { + "type": "boolean" + }, + "operationSource": { + "$ref": "#/components/schemas/Entry" + } + }, + "additionalProperties": false + }, + "OperationRecipeModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "OperationReportedModel": { + "type": "object", + "properties": { + "operationModel": { + "$ref": "#/components/schemas/OperationModel" + }, + "report": { + "$ref": "#/components/schemas/ReportModel" + } + }, + "additionalProperties": false + }, + "OperationStartedModel": { + "type": "object", + "properties": { + "operationModel": { + "$ref": "#/components/schemas/OperationModel" + }, + "userId": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "OperationStateClassification": { + "enum": [ + "Initial", + "Assigning", + "Failed", + "Aborted", + "Ready", + "Running", + "Interrupting", + "Interrupted", + "Completed", + "CanReload", + "CanBegin", + "CanInterrupt", + "CanReport", + "CanAdvice", + "IsAmountReached" + ], + "type": "string" + }, + "OperationUpdateModel": { + "type": "object", + "properties": { + "sortIndex": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "plannedStart": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "plannedEnd": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "totalAmount": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "overDeliveryAmount": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "underDeliveryAmount": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "targetCycleTime": { + "type": "number", + "format": "double", + "nullable": true + }, + "targetStock": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "OperatorModel": { + "type": "object", + "properties": { + "identifier": { + "type": "string", + "nullable": true + }, + "firstName": { + "type": "string", + "nullable": true + }, + "lastName": { + "type": "string", + "nullable": true + }, + "pseudonym": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "OrderChangedModel": { + "type": "object", + "properties": { + "order": { + "type": "string", + "nullable": true + }, + "operation": { + "type": "string", + "nullable": true + }, + "state": { + "$ref": "#/components/schemas/InternalOperationClassification" + } + }, + "additionalProperties": false + }, + "OrderModel": { + "type": "object", + "properties": { + "order": { + "type": "string", + "nullable": true + }, + "operation": { + "type": "string", + "nullable": true + }, + "state": { + "$ref": "#/components/schemas/InternalOperationClassification" + }, + "color": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "OrderReferenceModel": { + "type": "object", + "properties": { + "order": { + "type": "string", + "nullable": true + }, + "operation": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "ParameterAttributes": { + "enum": [ + "None", + "In", + "Out", + "Lcid", + "Retval", + "Optional", + "HasDefault", + "HasFieldMarshal", + "Reserved3", + "Reserved4", + "ReservedMask" + ], + "type": "string" + }, + "ParameterInfo": { + "type": "object", + "properties": { + "attributes": { + "$ref": "#/components/schemas/ParameterAttributes" + }, + "member": { + "$ref": "#/components/schemas/MemberInfo" + }, + "name": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "parameterType": { + "$ref": "#/components/schemas/Type" + }, + "position": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "isIn": { + "type": "boolean", + "readOnly": true + }, + "isLcid": { + "type": "boolean", + "readOnly": true + }, + "isOptional": { + "type": "boolean", + "readOnly": true + }, + "isOut": { + "type": "boolean", + "readOnly": true + }, + "isRetval": { + "type": "boolean", + "readOnly": true + }, + "defaultValue": { + "nullable": true, + "readOnly": true + }, + "rawDefaultValue": { + "nullable": true, + "readOnly": true + }, + "hasDefaultValue": { + "type": "boolean", + "readOnly": true + }, + "customAttributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeData" + }, + "nullable": true, + "readOnly": true + }, + "metadataToken": { + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "additionalProperties": false + }, + "PartClassification": { + "enum": [ + "Unknown", + "Material", + "InfoComponent", + "CarrierMaterial", + "ScrapMaterial", + "BranchMaterial" + ], + "type": "string" + }, + "PartConnector": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "displayName": { + "type": "string", + "nullable": true + }, + "type": { + "type": "string", + "nullable": true + }, + "isCollection": { + "type": "boolean" + }, + "parts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartModel" + }, + "nullable": true + }, + "propertyTemplates": { + "$ref": "#/components/schemas/Entry" + } + }, + "additionalProperties": false + }, + "PartCreationContext": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "number": { + "type": "string", + "nullable": true + }, + "quantity": { + "type": "number", + "format": "double" + }, + "unit": { + "type": "string", + "nullable": true + }, + "stagingIndicator": { + "$ref": "#/components/schemas/StagingIndicator" + }, + "classification": { + "$ref": "#/components/schemas/PartClassification" + } + }, + "additionalProperties": false + }, + "PartModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "properties": { + "$ref": "#/components/schemas/Entry" + }, + "product": { + "$ref": "#/components/schemas/ProductModel" + } + }, + "additionalProperties": false + }, + "Position": { + "type": "object", + "properties": { + "positionX": { + "type": "number", + "format": "double" + }, + "positionY": { + "type": "number", + "format": "double" + } + }, + "additionalProperties": false + }, + "PreviewDescriptor": { + "type": "object", + "properties": { + "fileHash": { + "type": "string", + "nullable": true + }, + "extension": { + "type": "string", + "nullable": true + }, + "mimeType": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer", + "format": "int64" + }, + "state": { + "$ref": "#/components/schemas/PreviewState" + } + }, + "additionalProperties": false + }, + "PreviewState": { + "enum": [ + "Creating", + "Created", + "Failed", + "Unsupported", + "Removed" + ], + "type": "string" + }, + "ProblemDetails": { + "type": "object", + "properties": { + "type": { + "type": "string", + "nullable": true + }, + "title": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "instance": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": {} + }, + "ProcessActivityModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "resource": { + "$ref": "#/components/schemas/ActivityResourceModel" + }, + "type": { + "type": "string", + "nullable": true + }, + "state": { + "type": "string", + "nullable": true + }, + "classification": { + "$ref": "#/components/schemas/ActivityClassification" + }, + "requiredCapabilities": { + "type": "string", + "nullable": true + }, + "possibleResources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ActivityResourceModel" + }, + "nullable": true + }, + "result": { + "type": "integer", + "format": "int64", + "nullable": true + }, + "resultName": { + "type": "string", + "nullable": true + }, + "instanceId": { + "type": "integer", + "format": "int64", + "nullable": true + }, + "tracing": { + "$ref": "#/components/schemas/TracingModel" + }, + "isCompleted": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "ProcessHolderGroupModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string", + "nullable": true + }, + "isEmpty": { + "type": "boolean", + "readOnly": true + }, + "positions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProcessHolderPositionModel" + }, + "nullable": true + }, + "visualization": { + "$ref": "#/components/schemas/VisualizationModel" + } + }, + "additionalProperties": false + }, + "ProcessHolderGroupModelArrayApiResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProcessHolderGroupModel" + }, + "nullable": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiError" + }, + "nullable": true, + "readOnly": true + }, + "succeeded": { + "type": "boolean", + "readOnly": true + }, + "timestamp": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "additionalProperties": false + }, + "ProcessHolderPositionModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "groupId": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string", + "nullable": true + }, + "position": { + "type": "integer", + "format": "int32" + }, + "activity": { + "type": "string", + "nullable": true + }, + "order": { + "type": "string", + "nullable": true + }, + "process": { + "type": "string", + "nullable": true + }, + "isEmpty": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "ProcessProgress": { + "enum": [ + "Ready", + "Running", + "Interrupted", + "Completed" + ], + "type": "string" + }, + "ProductCustomization": { + "type": "object", + "properties": { + "productTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDefinitionModel" + }, + "nullable": true + }, + "recipeTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RecipeDefinitionModel" + }, + "nullable": true + }, + "importers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductImporter" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "ProductDefinitionModel": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "displayName": { + "type": "string", + "nullable": true + }, + "baseDefinition": { + "type": "string", + "nullable": true + }, + "properties": { + "$ref": "#/components/schemas/Entry" + } + }, + "additionalProperties": false + }, + "ProductImporter": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "parameters": { + "$ref": "#/components/schemas/Entry" + } + }, + "additionalProperties": false + }, + "ProductInstanceModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string", + "nullable": true + }, + "state": { + "$ref": "#/components/schemas/ProductInstanceState" + }, + "properties": { + "$ref": "#/components/schemas/Entry" + } + }, + "additionalProperties": false + }, + "ProductInstanceState": { + "enum": [ + "Unset", + "InProduction", + "Paused", + "Success", + "Failure" + ], + "type": "string" + }, + "ProductModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string", + "nullable": true + }, + "state": { + "$ref": "#/components/schemas/ProductState" + }, + "identifier": { + "type": "string", + "nullable": true + }, + "revision": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string", + "nullable": true + }, + "properties": { + "$ref": "#/components/schemas/Entry" + }, + "parts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartConnector" + }, + "nullable": true + }, + "recipes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RecipeModel" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "ProductPartModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string", + "nullable": true + }, + "identifier": { + "type": "string", + "nullable": true + }, + "quantity": { + "type": "number", + "format": "double" + }, + "unit": { + "type": "string", + "nullable": true + }, + "stagingIndicator": { + "$ref": "#/components/schemas/StagingIndicator" + }, + "classification": { + "$ref": "#/components/schemas/PartClassification" + } + }, + "additionalProperties": false + }, + "ProductQuery": { + "type": "object", + "properties": { + "includeDeleted": { + "type": "boolean" + }, + "typeName": { + "type": "string", + "nullable": true + }, + "excludeDerivedTypes": { + "type": "boolean" + }, + "identifier": { + "type": "string", + "nullable": true + }, + "requiredState": { + "$ref": "#/components/schemas/ProductState" + }, + "revisionFilter": { + "$ref": "#/components/schemas/RevisionFilter" + }, + "name": { + "type": "string", + "nullable": true + }, + "revision": { + "type": "integer", + "format": "int32" + }, + "recipeFilter": { + "$ref": "#/components/schemas/RecipeFilter" + }, + "selector": { + "$ref": "#/components/schemas/Selector" + }, + "propertyFilters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyFilter" + }, + "nullable": true + }, + "loadFullTypeInformation": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "ProductState": { + "enum": [ + "Created", + "Released", + "Deprecated", + "Generated" + ], + "type": "string" + }, + "ProductionJobModel": { + "type": "object", + "properties": { + "productIdentity": { + "type": "string", + "nullable": true + }, + "amount": { + "type": "integer", + "format": "int32" + }, + "successCount": { + "type": "integer", + "format": "int32" + }, + "failureCount": { + "type": "integer", + "format": "int32" + }, + "runningCount": { + "type": "integer", + "format": "int32" + }, + "reworkedCount": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "PropertyAttributes": { + "enum": [ + "None", + "SpecialName", + "RTSpecialName", + "HasDefault", + "Reserved2", + "Reserved3", + "Reserved4", + "ReservedMask" + ], + "type": "string" + }, + "PropertyFilter": { + "type": "object", + "properties": { + "entry": { + "$ref": "#/components/schemas/Entry" + }, + "operator": { + "$ref": "#/components/schemas/PropertyFilterOperator" + } + }, + "additionalProperties": false + }, + "PropertyFilterOperator": { + "enum": [ + "Equals", + "GreaterThen", + "LessThen" + ], + "type": "string" + }, + "PropertyInfo": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "declaringType": { + "$ref": "#/components/schemas/Type" + }, + "reflectedType": { + "$ref": "#/components/schemas/Type" + }, + "module": { + "$ref": "#/components/schemas/Module" + }, + "customAttributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeData" + }, + "nullable": true, + "readOnly": true + }, + "isCollectible": { + "type": "boolean", + "readOnly": true + }, + "metadataToken": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "memberType": { + "$ref": "#/components/schemas/MemberTypes" + }, + "propertyType": { + "$ref": "#/components/schemas/Type" + }, + "attributes": { + "$ref": "#/components/schemas/PropertyAttributes" + }, + "isSpecialName": { + "type": "boolean", + "readOnly": true + }, + "canRead": { + "type": "boolean", + "readOnly": true + }, + "canWrite": { + "type": "boolean", + "readOnly": true + }, + "getMethod": { + "$ref": "#/components/schemas/MethodInfo" + }, + "setMethod": { + "$ref": "#/components/schemas/MethodInfo" + } + }, + "additionalProperties": false + }, + "RecipeClassificationModel": { + "enum": [ + "Unset", + "Default", + "Alternative", + "Intermediate", + "Part" + ], + "type": "string" + }, + "RecipeDefinitionModel": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "displayName": { + "type": "string", + "nullable": true + }, + "hasWorkplans": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "RecipeFilter": { + "enum": [ + "Unset", + "WithRecipe", + "WithoutRecipes" + ], + "type": "string" + }, + "RecipeModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string", + "nullable": true + }, + "state": { + "$ref": "#/components/schemas/RecipeState" + }, + "revision": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string", + "nullable": true + }, + "properties": { + "$ref": "#/components/schemas/Entry" + }, + "workplanModel": { + "$ref": "#/components/schemas/WorkplanModel" + }, + "classification": { + "$ref": "#/components/schemas/RecipeClassificationModel" + }, + "isClone": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "RecipeState": { + "enum": [ + "New", + "Released", + "Revoked" + ], + "type": "string" + }, + "ReferenceFilter": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "relationType": { + "$ref": "#/components/schemas/ResourceRelationType" + }, + "role": { + "$ref": "#/components/schemas/ResourceReferenceRole" + }, + "valueConstraint": { + "$ref": "#/components/schemas/ReferenceValue" + } + }, + "additionalProperties": false + }, + "ReferenceTypeModel": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "isCollection": { + "type": "boolean" + }, + "displayName": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + }, + "isRequired": { + "type": "boolean" + }, + "supportedTypes": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + }, + "role": { + "$ref": "#/components/schemas/ResourceReferenceRole" + }, + "relationType": { + "$ref": "#/components/schemas/ResourceRelationType" + } + }, + "additionalProperties": false + }, + "ReferenceValue": { + "enum": [ + "Irrelevant", + "NullOrEmpty", + "NotEmpty" + ], + "type": "string" + }, + "ReportContext": { + "type": "object", + "properties": { + "successCount": { + "type": "integer", + "format": "int32" + }, + "scrapCount": { + "type": "integer", + "format": "int32" + }, + "canPartial": { + "type": "boolean" + }, + "canFinal": { + "type": "boolean" + }, + "reportedSuccess": { + "type": "integer", + "format": "int32" + }, + "reportedFailure": { + "type": "integer", + "format": "int32" + }, + "unreportedSuccess": { + "type": "integer", + "format": "int32" + }, + "unreportedFailure": { + "type": "integer", + "format": "int32" + }, + "restrictions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RestrictionDescription" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "ReportModel": { + "type": "object", + "properties": { + "confirmationType": { + "$ref": "#/components/schemas/ConfirmationType" + }, + "comment": { + "type": "string", + "nullable": true + }, + "successCount": { + "type": "integer", + "format": "int32" + }, + "failureCount": { + "type": "integer", + "format": "int32" + }, + "userIdentifier": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "ResourceChangedModel": { + "type": "object", + "properties": { + "location": { + "$ref": "#/components/schemas/CellLocationModel" + }, + "iconName": { + "type": "string", + "nullable": true + }, + "isACell": { + "type": "boolean" + }, + "cellName": { + "type": "string", + "nullable": true + }, + "cellIconName": { + "type": "string", + "nullable": true + }, + "cellImageURL": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer", + "format": "int64" + }, + "cellLocation": { + "$ref": "#/components/schemas/CellLocationModel" + }, + "cellPropertySettings": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/CellPropertySettings" + }, + "nullable": true + }, + "factoryId": { + "type": "integer", + "format": "int64", + "readOnly": true + } + }, + "additionalProperties": false + }, + "ResourceModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "referenceId": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + }, + "type": { + "type": "string", + "nullable": true + }, + "partiallyLoaded": { + "type": "boolean" + }, + "properties": { + "$ref": "#/components/schemas/Entry" + }, + "methods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MethodEntry" + }, + "nullable": true + }, + "references": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ResourceReferenceModel" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "ResourceQuery": { + "type": "object", + "properties": { + "types": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + }, + "referenceCondition": { + "$ref": "#/components/schemas/ReferenceFilter" + }, + "referenceRecursion": { + "type": "boolean" + }, + "includedReferences": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReferenceFilter" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "ResourceReferenceModel": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "targets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ResourceModel" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "ResourceReferenceRole": { + "enum": [ + "Target", + "Source" + ], + "type": "string" + }, + "ResourceRelationType": { + "enum": [ + "Unset", + "Aggregation", + "Composition", + "Usage", + "ParentChild", + "Driver", + "TransportSystem", + "TransportRoute", + "CurrentExchangeablePart", + "PossibleExchangeablePart", + "Decorated", + "Extension", + "Custom" + ], + "type": "string" + }, + "ResourceTypeModel": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "displayName": { + "type": "string", + "nullable": true + }, + "creatable": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "constructors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MethodEntry" + }, + "nullable": true + }, + "references": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReferenceTypeModel" + }, + "nullable": true + }, + "baseType": { + "type": "string", + "nullable": true + }, + "derivedTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ResourceTypeModel" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "RestrictionDescription": { + "type": "object", + "properties": { + "text": { + "type": "string", + "nullable": true + }, + "severity": { + "$ref": "#/components/schemas/RestrictionSeverity" + } + }, + "additionalProperties": false + }, + "RestrictionSeverity": { + "enum": [ + "Info", + "Warning", + "Error" + ], + "type": "string" + }, + "RevisionFilter": { + "enum": [ + "All", + "Latest", + "Specific" + ], + "type": "string" + }, + "RuntimeFieldHandle": { + "type": "object", + "properties": { + "value": { + "$ref": "#/components/schemas/IntPtr" + } + }, + "additionalProperties": false + }, + "RuntimeMethodHandle": { + "type": "object", + "properties": { + "value": { + "$ref": "#/components/schemas/IntPtr" + } + }, + "additionalProperties": false + }, + "RuntimeTypeHandle": { + "type": "object", + "properties": { + "value": { + "$ref": "#/components/schemas/IntPtr" + } + }, + "additionalProperties": false + }, + "SaveConfigRequest": { + "type": "object", + "properties": { + "config": { + "$ref": "#/components/schemas/Config" + }, + "updateMode": { + "$ref": "#/components/schemas/ConfigUpdateMode" + } + }, + "additionalProperties": false + }, + "SecurityRuleSet": { + "enum": [ + "None", + "Level1", + "Level2" + ], + "type": "string" + }, + "Selector": { + "enum": [ + "Direct", + "Parent", + "Parts" + ], + "type": "string" + }, + "SerializableException": { + "type": "object", + "properties": { + "exceptionTypeName": { + "type": "string", + "nullable": true + }, + "message": { + "type": "string", + "nullable": true + }, + "stackTrace": { + "type": "string", + "nullable": true + }, + "innerException": { + "$ref": "#/components/schemas/SerializableException" + } + }, + "additionalProperties": false + }, + "ServerModuleModel": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "healthState": { + "$ref": "#/components/schemas/ServerModuleState" + }, + "startBehaviour": { + "$ref": "#/components/schemas/ModuleStartBehaviour" + }, + "failureBehaviour": { + "$ref": "#/components/schemas/FailureBehaviour" + }, + "dependencies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerModuleModel" + }, + "nullable": true + }, + "notifications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ModuleNotificationModel" + }, + "nullable": true + }, + "assembly": { + "$ref": "#/components/schemas/AssemblyModel" + } + }, + "additionalProperties": false + }, + "ServerModuleState": { + "enum": [ + "Stopped", + "Ready", + "Initializing", + "Starting", + "Failure", + "Missing", + "Running", + "Stopping" + ], + "type": "string" + }, + "ServerTimeResponse": { + "type": "object", + "properties": { + "serverTime": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "SetupJobClassification": { + "enum": [ + "None", + "Prepare", + "Cleanup", + "Manual" + ], + "type": "string" + }, + "SetupJobModel": { + "type": "object", + "properties": { + "classification": { + "$ref": "#/components/schemas/SetupJobClassification" + }, + "targetRecipeId": { + "type": "integer", + "format": "int64" + }, + "steps": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetupStepModel" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "SetupModel": { + "type": "object", + "properties": { + "fullname": { + "type": "string", + "nullable": true + }, + "sortOrder": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + }, + "supportedFileRegex": { + "type": "string", + "nullable": true + }, + "setupData": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "SetupStepModel": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "state": { + "$ref": "#/components/schemas/StepState" + } + }, + "additionalProperties": false + }, + "Severity": { + "enum": [ + "Info", + "Warning", + "Error", + "Fatal" + ], + "type": "string" + }, + "ShiftAssignementCreationContextModel": { + "type": "object", + "properties": { + "resourceId": { + "type": "integer", + "format": "int64" + }, + "shiftId": { + "type": "integer", + "format": "int64" + }, + "operatorIdentifier": { + "type": "string", + "nullable": true + }, + "note": { + "type": "string", + "nullable": true + }, + "priority": { + "type": "integer", + "format": "int32" + }, + "assignedDays": { + "$ref": "#/components/schemas/AssignedDays" + } + }, + "additionalProperties": false + }, + "ShiftAssignementModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "resourceId": { + "type": "integer", + "format": "int64" + }, + "operatorIdentifier": { + "type": "string", + "nullable": true + }, + "shiftId": { + "type": "integer", + "format": "int64" + }, + "note": { + "type": "string", + "nullable": true + }, + "priority": { + "type": "integer", + "format": "int32" + }, + "assignedDays": { + "$ref": "#/components/schemas/AssignedDays" + } + }, + "additionalProperties": false + }, + "ShiftCreationContextModel": { + "type": "object", + "properties": { + "typeId": { + "type": "integer", + "format": "int64" + }, + "date": { + "type": "string", + "format": "date" + } + }, + "additionalProperties": false + }, + "ShiftModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "typeId": { + "type": "integer", + "format": "int64" + }, + "date": { + "type": "string", + "format": "date" + } + }, + "additionalProperties": false + }, + "ShiftTypeCreationContextModel": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "startTime": { + "type": "string", + "format": "time" + }, + "endtime": { + "type": "string", + "format": "time" + }, + "periode": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "ShiftTypeModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string", + "nullable": true + }, + "startTime": { + "type": "string", + "format": "time" + }, + "endtime": { + "type": "string", + "format": "time" + }, + "periode": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "SkillCreationContextModel": { + "type": "object", + "properties": { + "obtainedOn": { + "type": "string", + "format": "date" + }, + "typeId": { + "type": "integer", + "format": "int64" + }, + "operatorIdentifier": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "SkillModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "obtainedOn": { + "type": "string", + "format": "date" + }, + "expiresOn": { + "type": "string", + "format": "date" + }, + "typeId": { + "type": "integer", + "format": "int64" + }, + "operatorIdentifier": { + "type": "string", + "nullable": true + }, + "isExpired": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "SkillTypeCreationContextModel": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "duration": { + "type": "string", + "format": "date-span" + }, + "capabilities": { + "$ref": "#/components/schemas/Entry" + } + }, + "additionalProperties": false + }, + "SkillTypeModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string", + "nullable": true + }, + "duration": { + "type": "string", + "format": "date-span" + }, + "capabilities": { + "$ref": "#/components/schemas/Entry" + } + }, + "additionalProperties": false + }, + "StagingIndicator": { + "enum": [ + "NotRelevant", + "PickPart", + "CrateOrKanbanPart", + "ReleaseOrderPart", + "ManualStaging", + "EwmStaging" + ], + "type": "string" + }, + "StepState": { + "enum": [ + "Initial", + "Running", + "Completed" + ], + "type": "string" + }, + "StructLayoutAttribute": { + "type": "object", + "properties": { + "typeId": { + "nullable": true, + "readOnly": true + }, + "value": { + "$ref": "#/components/schemas/LayoutKind" + } + }, + "additionalProperties": false + }, + "TestConnectionResponse": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/TestConnectionResult" + } + }, + "additionalProperties": false + }, + "TestConnectionResult": { + "enum": [ + "ConfigurationError", + "ConnectionError", + "ConnectionOkDbDoesNotExist", + "PendingMigrations", + "Success" + ], + "type": "string" + }, + "TracingModel": { + "type": "object", + "properties": { + "type": { + "type": "string", + "nullable": true + }, + "text": { + "type": "string", + "nullable": true + }, + "started": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "completed": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "errorCode": { + "type": "integer", + "format": "int32" + }, + "properties": { + "$ref": "#/components/schemas/Entry" + } + }, + "additionalProperties": false + }, + "TransportRouteModel": { + "type": "object", + "properties": { + "idCellOfOrigin": { + "type": "integer", + "format": "int64" + }, + "idCellOfDestination": { + "type": "integer", + "format": "int64" + }, + "paths": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Position" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "Type": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "customAttributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeData" + }, + "nullable": true, + "readOnly": true + }, + "isCollectible": { + "type": "boolean", + "readOnly": true + }, + "metadataToken": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "memberType": { + "$ref": "#/components/schemas/MemberTypes" + }, + "namespace": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "assemblyQualifiedName": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "fullName": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "assembly": { + "$ref": "#/components/schemas/Assembly" + }, + "module": { + "$ref": "#/components/schemas/Module" + }, + "isInterface": { + "type": "boolean", + "readOnly": true + }, + "isNested": { + "type": "boolean", + "readOnly": true + }, + "declaringType": { + "$ref": "#/components/schemas/Type" + }, + "declaringMethod": { + "$ref": "#/components/schemas/MethodBase" + }, + "reflectedType": { + "$ref": "#/components/schemas/Type" + }, + "underlyingSystemType": { + "$ref": "#/components/schemas/Type" + }, + "isTypeDefinition": { + "type": "boolean", + "readOnly": true + }, + "isArray": { + "type": "boolean", + "readOnly": true + }, + "isByRef": { + "type": "boolean", + "readOnly": true + }, + "isPointer": { + "type": "boolean", + "readOnly": true + }, + "isConstructedGenericType": { + "type": "boolean", + "readOnly": true + }, + "isGenericParameter": { + "type": "boolean", + "readOnly": true + }, + "isGenericTypeParameter": { + "type": "boolean", + "readOnly": true + }, + "isGenericMethodParameter": { + "type": "boolean", + "readOnly": true + }, + "isGenericType": { + "type": "boolean", + "readOnly": true + }, + "isGenericTypeDefinition": { + "type": "boolean", + "readOnly": true + }, + "isSZArray": { + "type": "boolean", + "readOnly": true + }, + "isVariableBoundArray": { + "type": "boolean", + "readOnly": true + }, + "isByRefLike": { + "type": "boolean", + "readOnly": true + }, + "isFunctionPointer": { + "type": "boolean", + "readOnly": true + }, + "isUnmanagedFunctionPointer": { + "type": "boolean", + "readOnly": true + }, + "hasElementType": { + "type": "boolean", + "readOnly": true + }, + "genericTypeArguments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Type" + }, + "nullable": true, + "readOnly": true + }, + "genericParameterPosition": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "genericParameterAttributes": { + "$ref": "#/components/schemas/GenericParameterAttributes" + }, + "attributes": { + "$ref": "#/components/schemas/TypeAttributes" + }, + "isAbstract": { + "type": "boolean", + "readOnly": true + }, + "isImport": { + "type": "boolean", + "readOnly": true + }, + "isSealed": { + "type": "boolean", + "readOnly": true + }, + "isSpecialName": { + "type": "boolean", + "readOnly": true + }, + "isClass": { + "type": "boolean", + "readOnly": true + }, + "isNestedAssembly": { + "type": "boolean", + "readOnly": true + }, + "isNestedFamANDAssem": { + "type": "boolean", + "readOnly": true + }, + "isNestedFamily": { + "type": "boolean", + "readOnly": true + }, + "isNestedFamORAssem": { + "type": "boolean", + "readOnly": true + }, + "isNestedPrivate": { + "type": "boolean", + "readOnly": true + }, + "isNestedPublic": { + "type": "boolean", + "readOnly": true + }, + "isNotPublic": { + "type": "boolean", + "readOnly": true + }, + "isPublic": { + "type": "boolean", + "readOnly": true + }, + "isAutoLayout": { + "type": "boolean", + "readOnly": true + }, + "isExplicitLayout": { + "type": "boolean", + "readOnly": true + }, + "isLayoutSequential": { + "type": "boolean", + "readOnly": true + }, + "isAnsiClass": { + "type": "boolean", + "readOnly": true + }, + "isAutoClass": { + "type": "boolean", + "readOnly": true + }, + "isUnicodeClass": { + "type": "boolean", + "readOnly": true + }, + "isCOMObject": { + "type": "boolean", + "readOnly": true + }, + "isContextful": { + "type": "boolean", + "readOnly": true + }, + "isEnum": { + "type": "boolean", + "readOnly": true + }, + "isMarshalByRef": { + "type": "boolean", + "readOnly": true + }, + "isPrimitive": { + "type": "boolean", + "readOnly": true + }, + "isValueType": { + "type": "boolean", + "readOnly": true + }, + "isSignatureType": { + "type": "boolean", + "readOnly": true + }, + "isSecurityCritical": { + "type": "boolean", + "readOnly": true + }, + "isSecuritySafeCritical": { + "type": "boolean", + "readOnly": true + }, + "isSecurityTransparent": { + "type": "boolean", + "readOnly": true + }, + "structLayoutAttribute": { + "$ref": "#/components/schemas/StructLayoutAttribute" + }, + "typeInitializer": { + "$ref": "#/components/schemas/ConstructorInfo" + }, + "typeHandle": { + "$ref": "#/components/schemas/RuntimeTypeHandle" + }, + "guid": { + "type": "string", + "format": "uuid", + "readOnly": true + }, + "baseType": { + "$ref": "#/components/schemas/Type" + }, + "isSerializable": { + "type": "boolean", + "readOnly": true, + "deprecated": true + }, + "containsGenericParameters": { + "type": "boolean", + "readOnly": true + }, + "isVisible": { + "type": "boolean", + "readOnly": true + } + }, + "additionalProperties": false + }, + "TypeAttributes": { + "enum": [ + "NotPublic", + "Public", + "NestedPublic", + "NestedPrivate", + "NestedFamily", + "NestedAssembly", + "NestedFamANDAssem", + "VisibilityMask", + "SequentialLayout", + "ExplicitLayout", + "LayoutMask", + "Interface", + "Abstract", + "Sealed", + "SpecialName", + "RTSpecialName", + "Import", + "Serializable", + "WindowsRuntime", + "UnicodeClass", + "AutoClass", + "StringFormatMask", + "HasSecurity", + "ReservedMask", + "BeforeFieldInit", + "CustomFormatMask" + ], + "type": "string" + }, + "TypeInfo": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "customAttributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeData" + }, + "nullable": true, + "readOnly": true + }, + "isCollectible": { + "type": "boolean", + "readOnly": true + }, + "metadataToken": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "memberType": { + "$ref": "#/components/schemas/MemberTypes" + }, + "namespace": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "assemblyQualifiedName": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "fullName": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "assembly": { + "$ref": "#/components/schemas/Assembly" + }, + "module": { + "$ref": "#/components/schemas/Module" + }, + "isInterface": { + "type": "boolean", + "readOnly": true + }, + "isNested": { + "type": "boolean", + "readOnly": true + }, + "declaringType": { + "$ref": "#/components/schemas/Type" + }, + "declaringMethod": { + "$ref": "#/components/schemas/MethodBase" + }, + "reflectedType": { + "$ref": "#/components/schemas/Type" + }, + "underlyingSystemType": { + "$ref": "#/components/schemas/Type" + }, + "isTypeDefinition": { + "type": "boolean", + "readOnly": true + }, + "isArray": { + "type": "boolean", + "readOnly": true + }, + "isByRef": { + "type": "boolean", + "readOnly": true + }, + "isPointer": { + "type": "boolean", + "readOnly": true + }, + "isConstructedGenericType": { + "type": "boolean", + "readOnly": true + }, + "isGenericParameter": { + "type": "boolean", + "readOnly": true + }, + "isGenericTypeParameter": { + "type": "boolean", + "readOnly": true + }, + "isGenericMethodParameter": { + "type": "boolean", + "readOnly": true + }, + "isGenericType": { + "type": "boolean", + "readOnly": true + }, + "isGenericTypeDefinition": { + "type": "boolean", + "readOnly": true + }, + "isSZArray": { + "type": "boolean", + "readOnly": true + }, + "isVariableBoundArray": { + "type": "boolean", + "readOnly": true + }, + "isByRefLike": { + "type": "boolean", + "readOnly": true + }, + "isFunctionPointer": { + "type": "boolean", + "readOnly": true + }, + "isUnmanagedFunctionPointer": { + "type": "boolean", + "readOnly": true + }, + "hasElementType": { + "type": "boolean", + "readOnly": true + }, + "genericTypeArguments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Type" + }, + "nullable": true, + "readOnly": true + }, + "genericParameterPosition": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "genericParameterAttributes": { + "$ref": "#/components/schemas/GenericParameterAttributes" + }, + "attributes": { + "$ref": "#/components/schemas/TypeAttributes" + }, + "isAbstract": { + "type": "boolean", + "readOnly": true + }, + "isImport": { + "type": "boolean", + "readOnly": true + }, + "isSealed": { + "type": "boolean", + "readOnly": true + }, + "isSpecialName": { + "type": "boolean", + "readOnly": true + }, + "isClass": { + "type": "boolean", + "readOnly": true + }, + "isNestedAssembly": { + "type": "boolean", + "readOnly": true + }, + "isNestedFamANDAssem": { + "type": "boolean", + "readOnly": true + }, + "isNestedFamily": { + "type": "boolean", + "readOnly": true + }, + "isNestedFamORAssem": { + "type": "boolean", + "readOnly": true + }, + "isNestedPrivate": { + "type": "boolean", + "readOnly": true + }, + "isNestedPublic": { + "type": "boolean", + "readOnly": true + }, + "isNotPublic": { + "type": "boolean", + "readOnly": true + }, + "isPublic": { + "type": "boolean", + "readOnly": true + }, + "isAutoLayout": { + "type": "boolean", + "readOnly": true + }, + "isExplicitLayout": { + "type": "boolean", + "readOnly": true + }, + "isLayoutSequential": { + "type": "boolean", + "readOnly": true + }, + "isAnsiClass": { + "type": "boolean", + "readOnly": true + }, + "isAutoClass": { + "type": "boolean", + "readOnly": true + }, + "isUnicodeClass": { + "type": "boolean", + "readOnly": true + }, + "isCOMObject": { + "type": "boolean", + "readOnly": true + }, + "isContextful": { + "type": "boolean", + "readOnly": true + }, + "isEnum": { + "type": "boolean", + "readOnly": true + }, + "isMarshalByRef": { + "type": "boolean", + "readOnly": true + }, + "isPrimitive": { + "type": "boolean", + "readOnly": true + }, + "isValueType": { + "type": "boolean", + "readOnly": true + }, + "isSignatureType": { + "type": "boolean", + "readOnly": true + }, + "isSecurityCritical": { + "type": "boolean", + "readOnly": true + }, + "isSecuritySafeCritical": { + "type": "boolean", + "readOnly": true + }, + "isSecurityTransparent": { + "type": "boolean", + "readOnly": true + }, + "structLayoutAttribute": { + "$ref": "#/components/schemas/StructLayoutAttribute" + }, + "typeInitializer": { + "$ref": "#/components/schemas/ConstructorInfo" + }, + "typeHandle": { + "$ref": "#/components/schemas/RuntimeTypeHandle" + }, + "guid": { + "type": "string", + "format": "uuid", + "readOnly": true + }, + "baseType": { + "$ref": "#/components/schemas/Type" + }, + "isSerializable": { + "type": "boolean", + "readOnly": true, + "deprecated": true + }, + "containsGenericParameters": { + "type": "boolean", + "readOnly": true + }, + "isVisible": { + "type": "boolean", + "readOnly": true + }, + "genericTypeParameters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Type" + }, + "nullable": true, + "readOnly": true + }, + "declaredConstructors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConstructorInfo" + }, + "nullable": true, + "readOnly": true + }, + "declaredEvents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EventInfo" + }, + "nullable": true, + "readOnly": true + }, + "declaredFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FieldInfo" + }, + "nullable": true, + "readOnly": true + }, + "declaredMembers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MemberInfo" + }, + "nullable": true, + "readOnly": true + }, + "declaredMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MethodInfo" + }, + "nullable": true, + "readOnly": true + }, + "declaredNestedTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeInfo" + }, + "nullable": true, + "readOnly": true + }, + "declaredProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyInfo" + }, + "nullable": true, + "readOnly": true + }, + "implementedInterfaces": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Type" + }, + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false + }, + "ValidationErrorModel": { + "type": "object", + "properties": { + "error": { + "type": "string", + "nullable": true + }, + "position": { + "type": "integer", + "format": "int64" + } + }, + "additionalProperties": false + }, + "ValidationResultModel": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ValidationErrorModel" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "VariantDescriptor": { + "type": "object", + "properties": { + "fileHash": { + "type": "string", + "nullable": true + }, + "extension": { + "type": "string", + "nullable": true + }, + "mimeType": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string", + "nullable": true + }, + "creationDate": { + "type": "string", + "format": "date-time" + }, + "preview": { + "$ref": "#/components/schemas/PreviewDescriptor" + } + }, + "additionalProperties": false + }, + "VisualizableItemModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "location": { + "$ref": "#/components/schemas/CellLocationModel" + }, + "iconName": { + "type": "string", + "nullable": true + }, + "isACell": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "VisualizationModel": { + "type": "object", + "properties": { + "icon": { + "type": "string", + "nullable": true + }, + "category": { + "$ref": "#/components/schemas/Category" + } + }, + "additionalProperties": false + }, + "WorkplanModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string", + "nullable": true + }, + "version": { + "type": "integer", + "format": "int32" + }, + "state": { + "$ref": "#/components/schemas/WorkplanState" + } + }, + "additionalProperties": false + }, + "WorkplanNodeClassification": { + "enum": [ + "Input", + "Output", + "Execution", + "ControlFlow", + "Subworkplan" + ], + "type": "string" + }, + "WorkplanNodeModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + }, + "displayName": { + "type": "string", + "nullable": true + }, + "positionTop": { + "type": "integer", + "format": "int32" + }, + "positionLeft": { + "type": "integer", + "format": "int32" + }, + "classification": { + "$ref": "#/components/schemas/WorkplanNodeClassification" + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NodeConnectionPoint" + }, + "nullable": true + }, + "outputs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NodeConnectionPoint" + }, + "nullable": true + }, + "properties": { + "$ref": "#/components/schemas/Entry" + }, + "subworkplanId": { + "type": "integer", + "format": "int64" + } + }, + "additionalProperties": false + }, + "WorkplanSessionModel": { + "type": "object", + "properties": { + "sessionToken": { + "type": "string", + "nullable": true + }, + "workplanId": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string", + "nullable": true + }, + "version": { + "type": "integer", + "format": "int32" + }, + "state": { + "$ref": "#/components/schemas/WorkplanState" + }, + "nodes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkplanNodeModel" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "WorkplanState": { + "enum": [ + "New", + "Released", + "Revoked" + ], + "type": "string" + }, + "WorkplanStepRecipe": { + "type": "object", + "properties": { + "type": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + }, + "positionTop": { + "type": "integer", + "format": "int32" + }, + "positionLeft": { + "type": "integer", + "format": "int32" + }, + "classification": { + "$ref": "#/components/schemas/WorkplanNodeClassification" + }, + "constructor": { + "$ref": "#/components/schemas/MethodEntry" + }, + "subworkplanId": { + "type": "integer", + "format": "int64" + } + }, + "additionalProperties": false + } + } + }, + "tags": [ + { + "name": "Common" + }, + { + "name": "Database" + }, + { + "name": "FactoryMonitor" + }, + { + "name": "JobManagement" + }, + { + "name": "MediaServer" + }, + { + "name": "Modules" + }, + { + "name": "NotificationPublisher" + }, + { + "name": "OperatorManagement" + }, + { + "name": "OrderManagement" + }, + { + "name": "ProcessEngine" + }, + { + "name": "ProductManagement" + }, + { + "name": "ResourceModification" + }, + { + "name": "ShiftManagement" + }, + { + "name": "SkillManagement" + }, + { + "name": "Test" + }, + { + "name": "VisualInstructions" + }, + { + "name": "Workplan" + }, + { + "name": "WorkplanEditing" + } + ] +} From 1ce46d070285e814e0dc2e247f1d13b4adc4af75 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Niggemann?= Date: Wed, 4 Nov 2026 10:16:09 +0100 Subject: [PATCH 02/16] Add yaml api spec too --- src/StartProject.Asp/Program.cs | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/src/StartProject.Asp/Program.cs b/src/StartProject.Asp/Program.cs index 445c9d693a..6bbf0c411b 100644 --- a/src/StartProject.Asp/Program.cs +++ b/src/StartProject.Asp/Program.cs @@ -5,6 +5,8 @@ using System.Text.Json.Serialization; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Localization; +using Microsoft.AspNetCore.OpenApi; +using Microsoft.OpenApi; using Moryx.AspNetCore; using Moryx.Launcher; using Moryx.Model; @@ -92,6 +94,21 @@ app.UseDeveloperExceptionPage(); app.MapOpenApi(); + // Map open api spec as yaml to, if someone requires it + app.MapGet("/openapi/v1.yaml", + async ([FromKeyedServices("v1")] IOpenApiDocumentProvider provider) => + { + var document = await provider.GetOpenApiDocumentAsync(); + + using var stringWriter = new StringWriter(); + var writer = new OpenApiYamlWriter(stringWriter); + + document.SerializeAsV31(writer); + + return Results.Text( + stringWriter.ToString(), + "application/yaml"); + }); app.UseSwaggerUI(options => options.SwaggerEndpoint("/openapi/v1.json", "v1") ); From 167a82b85c506b2edb9f5ea1935a0afc3532295f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Niggemann?= Date: Wed, 4 Nov 2026 01:25:21 +0100 Subject: [PATCH 03/16] Add doc comments to the OrderManagement endpoint --- .../Moryx.Orders.Endpoints.csproj | 1 + .../OrderManagementController.cs | 135 ++++++++++++++++-- 2 files changed, 124 insertions(+), 12 deletions(-) diff --git a/src/Moryx.Orders.Endpoints/Moryx.Orders.Endpoints.csproj b/src/Moryx.Orders.Endpoints/Moryx.Orders.Endpoints.csproj index 56f1336eec..0d3b3f4a65 100644 --- a/src/Moryx.Orders.Endpoints/Moryx.Orders.Endpoints.csproj +++ b/src/Moryx.Orders.Endpoints/Moryx.Orders.Endpoints.csproj @@ -4,6 +4,7 @@ net10.0 Endpoints for the order management true + true diff --git a/src/Moryx.Orders.Endpoints/OrderManagementController.cs b/src/Moryx.Orders.Endpoints/OrderManagementController.cs index aeedc234e3..11e3378b03 100644 --- a/src/Moryx.Orders.Endpoints/OrderManagementController.cs +++ b/src/Moryx.Orders.Endpoints/OrderManagementController.cs @@ -1,19 +1,19 @@ // Copyright (c) 2026 Phoenix Contact GmbH & Co. KG // Licensed under the Apache License, Version 2.0 -using Microsoft.AspNetCore.Authorization; -using Microsoft.AspNetCore.Http; -using Microsoft.AspNetCore.Mvc; -using Moryx.AbstractionLayer.Products; -using Moryx.Orders.Endpoints.Properties; -using Moryx.Users; using System.Net; using System.Net.ServerSentEvents; using System.Text.Json; using System.Text.Json.Serialization; using System.Threading.Channels; +using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Http; +using Microsoft.AspNetCore.Mvc; +using Moryx.AbstractionLayer.Products; using Moryx.AspNetCore; using Moryx.Orders.Endpoints.Models; +using Moryx.Orders.Endpoints.Properties; +using Moryx.Users; namespace Moryx.Orders.Endpoints; @@ -41,21 +41,41 @@ public OrderManagementController(IOrderManagement orderManagement, IUserManageme } #region HttpGet + /// + /// Retrieve all current operations that match the given filter parameters. + /// Already completed or aborted Operations won't be included. + /// + /// Optional. If specified only operations that belong to this order will be returned + /// Optional. If specified only operations with this operation number will be returned [HttpGet] [ProducesResponseType(typeof(OperationModel[]), StatusCodes.Status200OK)] [Authorize(Policy = OrderPermissions.CanView)] public ActionResult GetOperations(string orderNumber = null, string operationNumber = null) { - var operations = _orderManagement.GetOperations(_ => true) - .Where(o => orderNumber is null || o.Order.Number == orderNumber) - .Where(o => operationNumber is null || o.Number == operationNumber) + Func filter = (orderNumber, operationNumber) switch + { + (null, null) => _ => true, + (string order, null) => o => o.Order.Number == order, + (null, string operation) => o => o.Number == operation, + (string order, string operation) => o => o.Number == operation && o.Order.Number == order + }; + var operations = _orderManagement.GetOperations(filter) .Select(Converter.ToModel).ToArray(); return operations; } + /// + /// Stream that allow subscribing to operation changes. + /// [HttpGet("stream")] - [ProducesResponseType(typeof(OperationChangedModel), StatusCodes.Status200OK)] + [ProducesSseEvent(OperationTypes.Start, typeof(OperationStartedModel), Description = "Published when operation has been started")] + [ProducesSseEvent(OperationTypes.Progress, typeof(OperationModel))] + [ProducesSseEvent(OperationTypes.Completed, typeof(OperationReportedModel))] + [ProducesSseEvent(OperationTypes.Interrupted, typeof(OperationReportedModel))] + [ProducesSseEvent(OperationTypes.Report, typeof(OperationReportedModel))] + [ProducesSseEvent(OperationTypes.Advice, typeof(OperationAdvicedModel))] + [ProducesSseEvent(OperationTypes.Update, typeof(OperationModel))] public async Task OperationStream(CancellationToken cancellationToken) { var channel = Channel.CreateUnbounded>(); @@ -142,6 +162,12 @@ void Broadcast(string eventType, object data) } } + /// + /// Retrieves an operationmodel using the unique id of the operation + /// (Can load completed operations from storage) + /// + /// + /// [HttpGet] [ProducesResponseType(typeof(OperationModel), StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -157,6 +183,11 @@ public async Task> GetOperation(Guid guid) return Converter.ToModel(operation); } + /// + /// Retrieve the documents attached to operation with the given id + /// + /// Id of the operation + /// A list of document models describing the available documents [HttpGet] [ProducesResponseType(typeof(DocumentModel[]), StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -172,6 +203,12 @@ public async Task> GetDocuments(Guid guid) return operation.Documents.Select(Converter.ToModel).ToArray(); } + /// + /// Retrieves the content of the document specified using the operation id and the identifier of the document + /// + /// Id of the operation + /// Identifier of the document + /// [HttpGet] [ProducesResponseType(StatusCodes.Status400BadRequest)] [ProducesResponseType(typeof(MoryxExceptionResponse), StatusCodes.Status404NotFound)] @@ -188,13 +225,18 @@ public async Task GetDocumentStream(Guid guid, string identifier) var document = operation.Documents.FirstOrDefault(x => x.Identifier == identifier); if (document == null) return NotFound(new MoryxExceptionResponse { Title = Strings.OrderManagementController_GetDocuments_DocumentNotFound }); - + // TODO: Change the return value here. This is not a bad request. It's not the callers fault that the ContentType is not set if (string.IsNullOrEmpty(document.ContentType)) return BadRequest(); return new FileStreamResult(document.GetStream(), document.ContentType); } + /// + /// Retrieve a list of product parts attached to the given operation + /// + /// If of the operation + /// The list of product parts [HttpGet] [ProducesResponseType(typeof(ProductPartModel[]), StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -210,6 +252,11 @@ public async Task> GetProductParts(Guid guid) return operation.Parts.Select(Converter.ToModel).ToArray(); } + /// + /// Retrieves the begin context for the given operation + /// + /// Id of the operation + /// An object that can be used to popualte a begin dialog to the user [HttpGet] [ProducesResponseType(typeof(BeginContext), StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -233,6 +280,11 @@ public async Task> GetBeginContext(Guid guid) return beginContext; } + /// + /// Retrieves a report context for the given operation + /// + /// Id of the operation + /// An object that can be used to populate a report dialog for the user [HttpGet] [ProducesResponseType(typeof(ReportContext), StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -252,6 +304,11 @@ public async Task> GetReportContext(Guid guid) return reportContext; } + /// + /// Retrieves a interrupt context for the given operation + /// + /// Id of the operation + /// An object that can be used to populate a interrupt dialog for the user [HttpGet] [ProducesResponseType(typeof(ReportContext), StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -270,7 +327,11 @@ public async Task> GetInterruptContext(Guid guid) return reportContext; } - + /// + /// Retrieves a advice context for the given operation + /// + /// Id of the operation + /// An object that can be used to populate a advice dialog for the user [HttpGet] [ProducesResponseType(typeof(AdviceContext), StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -290,6 +351,11 @@ public async Task> GetAdviceContext(Guid guid) return adviceContext; } + /// + /// Retrieves logs written during the creation of the operation + /// + /// Id of the operation + /// A list of log messages [HttpGet] [Route("{guid}/logs")] [ProducesResponseType(typeof(OperationLogMessageModel[]), StatusCodes.Status200OK)] @@ -304,6 +370,12 @@ public async Task> GetLogs(Guid guid) return _orderManagement.GetLogs(operation).Select(Converter.ToModel).ToArray(); } + /// + /// Get's the list of recipes available to produce the given product + /// + /// Product identifier + /// Product revision + /// [HttpGet] [Route("recipes")] [ProducesResponseType(typeof(OperationRecipeModel[]), StatusCodes.Status200OK)] @@ -317,6 +389,12 @@ public async Task> GetAssignableRecipes(str #endregion #region HttpPost + /// + /// Add an operation to the order stock + /// + /// Description of the operation + /// Identifier of the application adding the operation + /// [HttpPost] [ProducesResponseType(typeof(OperationModel), StatusCodes.Status200OK)] [ProducesResponseType(typeof(string), StatusCodes.Status400BadRequest)] @@ -340,6 +418,11 @@ public async Task> AddOperation(OperationCreationCo } } + /// + /// Begin producing the operation using the given parameters + /// + /// Id of the operation + /// Begin parameters [HttpPost] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -364,6 +447,10 @@ public async Task BeginOperation(Guid guid, BeginModel beginModel) return Ok(); } + /// + /// Abort the specified operation (Remove it before being started) + /// + /// Id of the operation [HttpPost] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -380,6 +467,11 @@ public async Task AbortOperation(Guid guid) return Ok(); } + /// + /// Report produced amounts of a given operation + /// + /// Id of the operation + /// Parameter object [HttpPost] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -398,6 +490,11 @@ public async Task ReportOperation(Guid guid, ReportModel report) return Ok(); } + /// + /// Interrupt the given operation + /// + /// Id of the operation + /// Identifier of the user requesting the interrupt (Optional depending on configuration) [HttpPost] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -418,6 +515,11 @@ public async Task InterruptOperation(Guid guid, string userIdentif return Ok(); } + /// + /// Advice operation + /// + /// Id of the operation + /// Parameter object [HttpPost] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(typeof(string), StatusCodes.Status400BadRequest)] @@ -440,6 +542,11 @@ public async Task AdviceOperation(Guid guid, AdviceModel advice) #region HttpPut + /// + /// Update the operation + /// + /// Id of the operation + /// Paramter object [HttpPut] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -456,6 +563,10 @@ public async Task UpdateOperation(Guid guid, OperationUpdateModel return Ok(); } + /// + /// Reload the operation, rerunning the order assignment steps + /// + /// Id of the operation [HttpPut] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] From 412f2c8eba4d2622c06ccc6cb35e28cf0776f24c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Niggemann?= Date: Wed, 4 Nov 2026 01:51:01 +0100 Subject: [PATCH 04/16] Add doc comment for the ProductManagement controller --- .../ProductManagementController.cs | 86 ++++++++++++++++++- 1 file changed, 83 insertions(+), 3 deletions(-) diff --git a/src/Moryx.AbstractionLayer.Products.Endpoints/ProductManagementController.cs b/src/Moryx.AbstractionLayer.Products.Endpoints/ProductManagementController.cs index a384ebd2f3..a6cc977b4e 100644 --- a/src/Moryx.AbstractionLayer.Products.Endpoints/ProductManagementController.cs +++ b/src/Moryx.AbstractionLayer.Products.Endpoints/ProductManagementController.cs @@ -6,14 +6,14 @@ using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Mvc; -using Moryx.AbstractionLayer.Recipes; -using Moryx.Tools; -using Moryx.Serialization; using Moryx.AbstractionLayer.Products.Endpoints.Models; using Moryx.AbstractionLayer.Products.Endpoints.Properties; +using Moryx.AbstractionLayer.Recipes; using Moryx.AspNetCore; using Moryx.Configuration; using Moryx.Runtime.Modules; +using Moryx.Serialization; +using Moryx.Tools; namespace Moryx.AbstractionLayer.Products.Endpoints; @@ -43,6 +43,9 @@ public ProductManagementController(IProductManagement productManagement, } #region importers + /// + /// Loads dataset of existing products, recipes and importers for the UI + /// [HttpGet] [Route("configuration")] [Authorize(Policy = ProductPermissions.CanViewTypes)] @@ -78,6 +81,11 @@ private RecipeDefinitionModel[] GetRecipeTypes() return typeModels.ToArray(); } + /// + /// Run the product importer with the given parameters + /// + /// Name of the importer + /// Parameters for the importer [HttpPost] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -111,6 +119,11 @@ private object ConvertParametersBack(string importerName, Entry currentParameter #endregion #region product type + /// + /// Store the product type in the database + /// + /// Model of the new product + /// The assigned database id of the product [HttpPost] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -129,6 +142,10 @@ public async Task> SaveType(ProductModel newTypeModel) return await _productManagement.SaveTypeAsync(newType); } + /// + /// Retrieves all product types, if no identity is specified. Otherwise the model identified by that id is returned + /// + /// Optional. The id to look for [HttpGet] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -160,6 +177,11 @@ await _productConverter.ConvertProduct(productType, false) }; } + /// + /// Query the product type database + /// + /// Query parameters + /// The products models matching the query [HttpPost] [Route("types/query")] [Authorize(Policy = ProductPermissions.CanViewTypes)] @@ -174,6 +196,10 @@ public async Task> GetTypes(ProductQuery query) return productModels.ToArray(); } + /// + /// Get's a product type using the database id + /// + /// Database id [HttpGet] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -197,6 +223,11 @@ public async Task> GetTypeById(long id) return await _productConverter.ConvertProduct(productType, false); } + /// + /// Deletes the product type with the given id + /// + /// + /// [HttpDelete] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] @@ -210,6 +241,11 @@ public async Task> DeleteType(long id) return result; } + /// + /// Updates the existing product type + /// + /// Database id of the product type + /// New product model [HttpPut] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -226,6 +262,11 @@ public async Task> UpdateType(long id, ProductModel modifiedT return await _productManagement.SaveTypeAsync(type); } + /// + /// Create a clone of the product type identified with the id with the new identitiy + /// + /// Database id of the existing product type + /// Product identifier of the new product [HttpPost] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -256,6 +297,11 @@ public async Task> Duplicate(long id, [FromBody] stri return await _productConverter.ConvertProduct(newProductType, false); } + /// + /// Loads the recipe attached to the product type with the id + /// + /// Database id + /// Recipe classification [HttpGet] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -275,6 +321,11 @@ public async Task> GetRecipes(long id, int classific #endregion #region product instances + /// + /// Get's the product instance with the given id + /// + /// Database id of the product instance + /// [HttpGet] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -291,6 +342,10 @@ public async Task> GetInstance(long id) return ProductConverter.ConvertProductInstance(productInstance); } + /// + /// Loads multiple product instances at once + /// + /// A list of product instance ids [HttpGet] [Route("instances")] [Authorize(Policy = ProductPermissions.CanViewInstances)] @@ -303,6 +358,12 @@ public async Task> GetInstances([FromQuery] return modelList.ToArray(); } + /// + /// Create a new product instace of the product type identified via the identifier and revision + /// + /// Product identifier + /// Revision of the product + /// If save is false, the new instance won't be stored in the db [HttpPost] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -318,6 +379,10 @@ public async Task> CreateInstance(string iden return ProductConverter.ConvertProductInstance(instance); } + /// + /// Save the instance in the product db + /// + /// Model of the product instance [HttpPut] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -339,6 +404,11 @@ public async Task SaveInstance(ProductInstanceModel instanceModel) #endregion #region recipes + /// + /// Get's a recipe by it's db id + /// + /// Database id of the recipe + /// [HttpGet] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -355,6 +425,11 @@ public async Task> GetRecipe(long id) return _productConverter.ConvertRecipe(recipe); } + /// + /// Saves a new recipe in the database + /// + /// Model of the recipe + /// The database id of the newly created recipe [HttpPost] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] @@ -373,6 +448,11 @@ public async Task> SaveRecipe(RecipeModel recipe) return await _productManagement.SaveRecipeAsync(await _productConverter.ConvertRecipeBack(recipe, productRecipe, null)); } + /// + /// Updates the existing recipes + /// + /// Database id of the recipe + /// Updated recipe model [HttpPut] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] From a540dfbc19a6170ab1f8b9409b0dcecd54fcf310 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Niggemann?= Date: Wed, 4 Nov 2026 13:47:08 +0100 Subject: [PATCH 05/16] Move MoryxOpenApiDocumentTransformer to Moryx.AspnetCore.OpenApi to avoid introducing a package dependency in Moryx.AspNetCore --- MORYX-Framework.slnx | 3 ++- .../Moryx.AspNetCore.OpenApi.csproj | 25 +++++++++++++++++++ .../MoryxOpenApiDocumentTransformer.cs | 16 ++++++++++-- src/Moryx.AspNetCore/Moryx.AspNetCore.csproj | 4 --- src/StartProject.Asp/Program.cs | 2 +- src/StartProject.Asp/StartProject.Asp.csproj | 1 + 6 files changed, 43 insertions(+), 8 deletions(-) create mode 100644 src/Moryx.AspNetCore.OpenApi/Moryx.AspNetCore.OpenApi.csproj rename src/{Moryx.AspNetCore => Moryx.AspNetCore.OpenApi}/MoryxOpenApiDocumentTransformer.cs (90%) diff --git a/MORYX-Framework.slnx b/MORYX-Framework.slnx index 59e3703ccb..38be555883 100644 --- a/MORYX-Framework.slnx +++ b/MORYX-Framework.slnx @@ -86,6 +86,7 @@ + @@ -186,5 +187,5 @@ - + \ No newline at end of file diff --git a/src/Moryx.AspNetCore.OpenApi/Moryx.AspNetCore.OpenApi.csproj b/src/Moryx.AspNetCore.OpenApi/Moryx.AspNetCore.OpenApi.csproj new file mode 100644 index 0000000000..5700b0580d --- /dev/null +++ b/src/Moryx.AspNetCore.OpenApi/Moryx.AspNetCore.OpenApi.csproj @@ -0,0 +1,25 @@ + + + + net10.0 + true + Extensions for the integration of MORYX in ASP.NET Core + MORYX;ASP + true + Moryx.AspNetCore.OpenApi + + + + + + + + + + + + + + + + diff --git a/src/Moryx.AspNetCore/MoryxOpenApiDocumentTransformer.cs b/src/Moryx.AspNetCore.OpenApi/MoryxOpenApiDocumentTransformer.cs similarity index 90% rename from src/Moryx.AspNetCore/MoryxOpenApiDocumentTransformer.cs rename to src/Moryx.AspNetCore.OpenApi/MoryxOpenApiDocumentTransformer.cs index d2dd2a76db..81793e6332 100644 --- a/src/Moryx.AspNetCore/MoryxOpenApiDocumentTransformer.cs +++ b/src/Moryx.AspNetCore.OpenApi/MoryxOpenApiDocumentTransformer.cs @@ -8,13 +8,17 @@ using Microsoft.AspNetCore.OpenApi; using Microsoft.OpenApi; -namespace Moryx.AspNetCore; +namespace Moryx.AspNetCore.OpenApi; +/// +/// Document transformer to improve our API documentation +/// public class MoryxOpenApiDocumentTransformer : IOpenApiDocumentTransformer { private const string SseItemBaseSchemaId = "SseItemBase"; private const string EventStreamResponseType = "text/event-stream"; + /// public async Task TransformAsync(OpenApiDocument document, OpenApiDocumentTransformerContext context, CancellationToken cancellationToken) { SortPathEntries(document); @@ -41,6 +45,10 @@ public async Task TransformAsync(OpenApiDocument document, OpenApiDocumentTransf } } + /// + /// Sort path entries by tag + /// + /// private static void SortPathEntries(OpenApiDocument document) { var path = new OpenApiPaths(); @@ -78,7 +86,11 @@ private static void SortPathEntries(OpenApiDocument document) document.Paths = path; } - public async Task UpdateOperation(OpenApiOperation operation, OpenApiOperationTransformerContext context, CancellationToken cancellationToken) + /// + /// Update logic to run per operation. Schema from + /// because it was originally separate. Moved in here to make configuration slightly simpler + /// + private async Task UpdateOperation(OpenApiOperation operation, OpenApiOperationTransformerContext context, CancellationToken cancellationToken) { SetOperationIds(operation, context); diff --git a/src/Moryx.AspNetCore/Moryx.AspNetCore.csproj b/src/Moryx.AspNetCore/Moryx.AspNetCore.csproj index eb21120a96..cdddf655b7 100644 --- a/src/Moryx.AspNetCore/Moryx.AspNetCore.csproj +++ b/src/Moryx.AspNetCore/Moryx.AspNetCore.csproj @@ -13,8 +13,4 @@ - - - - diff --git a/src/StartProject.Asp/Program.cs b/src/StartProject.Asp/Program.cs index 6bbf0c411b..64d15dc751 100644 --- a/src/StartProject.Asp/Program.cs +++ b/src/StartProject.Asp/Program.cs @@ -7,7 +7,7 @@ using Microsoft.AspNetCore.Localization; using Microsoft.AspNetCore.OpenApi; using Microsoft.OpenApi; -using Moryx.AspNetCore; +using Moryx.AspNetCore.OpenApi; using Moryx.Launcher; using Moryx.Model; using Moryx.Runtime.Kernel; diff --git a/src/StartProject.Asp/StartProject.Asp.csproj b/src/StartProject.Asp/StartProject.Asp.csproj index 527cadabb6..f5b3baeb98 100644 --- a/src/StartProject.Asp/StartProject.Asp.csproj +++ b/src/StartProject.Asp/StartProject.Asp.csproj @@ -76,6 +76,7 @@ + From 47ac0aedac1981770d20834bd6714b9ce717ee74 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Niggemann?= Date: Wed, 4 Nov 2026 13:47:36 +0100 Subject: [PATCH 06/16] Split to dedicated Transformers and fix schema inlining problems, by letting ProducesSseEventAttribute inherit from ProducesResponseTypeAttribute so that it's picked up as a response type. This includes a weird hack, because the .net10 variant only allows a single response type per response code that we can remove in .net11 --- .../MoryxOpenApiDocumentTransformer.cs | 127 +- .../MoryxOperationIdOperationTransformer.cs | 19 + .../MoryxSseOperationTransformer.cs | 90 + .../OpenApiOptionsExtension.cs | 20 + .../ProducesSseEventAttribute.cs | 25 +- src/StartProject.Asp/Program.cs | 6 +- src/StartProject.Asp/StartProject.Asp.csproj | 2 +- src/StartProject.Asp/StartProject.Asp.json | 6082 ++++++++--------- 8 files changed, 2888 insertions(+), 3483 deletions(-) create mode 100644 src/Moryx.AspNetCore.OpenApi/MoryxOperationIdOperationTransformer.cs create mode 100644 src/Moryx.AspNetCore.OpenApi/MoryxSseOperationTransformer.cs create mode 100644 src/Moryx.AspNetCore.OpenApi/OpenApiOptionsExtension.cs diff --git a/src/Moryx.AspNetCore.OpenApi/MoryxOpenApiDocumentTransformer.cs b/src/Moryx.AspNetCore.OpenApi/MoryxOpenApiDocumentTransformer.cs index 81793e6332..4b989e3704 100644 --- a/src/Moryx.AspNetCore.OpenApi/MoryxOpenApiDocumentTransformer.cs +++ b/src/Moryx.AspNetCore.OpenApi/MoryxOpenApiDocumentTransformer.cs @@ -1,10 +1,6 @@ // Copyright (c) 2026 Phoenix Contact GmbH & Co. KG // Licensed under the Apache License, Version 2.0 -using System.Globalization; -using System.Net; -using System.Text; -using Microsoft.AspNetCore.Mvc.Controllers; using Microsoft.AspNetCore.OpenApi; using Microsoft.OpenApi; @@ -13,36 +9,14 @@ namespace Moryx.AspNetCore.OpenApi; /// /// Document transformer to improve our API documentation /// -public class MoryxOpenApiDocumentTransformer : IOpenApiDocumentTransformer +internal class MoryxOpenApiDocumentTransformer : IOpenApiDocumentTransformer { - private const string SseItemBaseSchemaId = "SseItemBase"; - private const string EventStreamResponseType = "text/event-stream"; - /// public async Task TransformAsync(OpenApiDocument document, OpenApiDocumentTransformerContext context, CancellationToken cancellationToken) { SortPathEntries(document); EnsureSseItemBaseExists(document); - - foreach (var (path, pathEntry) in document.Paths) - { - var pathString = new string(path.AsSpan(1)); - foreach (var (method, operation) in (pathEntry.Operations)) - { - var description = context.DescriptionGroups.SelectMany(dg => dg.Items) - .FirstOrDefault(description => - description.RelativePath == pathString && description.HttpMethod == method.Method); // Find a better way to populate - - await UpdateOperation(operation, new OpenApiOperationTransformerContext() - { - ApplicationServices = context.ApplicationServices, - Document = document, - DocumentName = context.DocumentName, - Description = description, - }, cancellationToken); - } - } } /// @@ -59,23 +33,11 @@ private static void SortPathEntries(OpenApiDocument document) { if (p.Value.Operations.Count == 0) { - return int.MaxValue; + return ""; } var op = p.Value.Operations.First().Value; - var tag = op.Tags.FirstOrDefault()?.Name ?? ""; - tag = tag.ToLower(); - if (sortLookup.TryGetValue(tag, out var key)) - { - return key; - } - - Span b = stackalloc byte[8]; - Encoding.UTF8.GetBytes(tag.AsSpan(0, Math.Min(4, tag.Length)), b); - (b[0], b[1], b[2], b[3]) = (b[3], b[2], b[1], b[0]); - key = BitConverter.ToInt32(b); - sortLookup[tag] = key; - return key; + return op.Tags.FirstOrDefault()?.Name ?? ""; }); foreach (var item in sorted) @@ -86,87 +48,6 @@ private static void SortPathEntries(OpenApiDocument document) document.Paths = path; } - /// - /// Update logic to run per operation. Schema from - /// because it was originally separate. Moved in here to make configuration slightly simpler - /// - private async Task UpdateOperation(OpenApiOperation operation, OpenApiOperationTransformerContext context, CancellationToken cancellationToken) - { - SetOperationIds(operation, context); - - await AddSseDocs(operation, context); - } - - private static async Task AddSseDocs(OpenApiOperation operation, OpenApiOperationTransformerContext context) - { - var producesAttributes = context.Description.ActionDescriptor.EndpointMetadata.OfType().ToList(); - - if (producesAttributes.Count == 0) - { - return; - } - - var responseKey = ((int)HttpStatusCode.OK).ToString(CultureInfo.InvariantCulture); - if (!operation.Responses.TryGetValue(responseKey, out var response)) - { - response = new OpenApiResponse(); - operation.Responses.Add(responseKey, response); - } - if (!response.Content.TryGetValue(EventStreamResponseType, out var mediaType)) - { - mediaType = new OpenApiMediaType(); - response.Content[EventStreamResponseType] = mediaType; - } - - Dictionary schemas = new(); - foreach (var a in producesAttributes) - { - var dataSchema = await context.GetOrCreateSchemaAsync(a.PayloadType); - - var dataSchemaId = dataSchema.Metadata.TryGetValue("x-schema-id", out var x) && x is string id ? id : a.PayloadType.Name; - if (!context.Document.Components.Schemas.ContainsKey(dataSchemaId)) - { - context.Document.AddComponent(dataSchemaId, dataSchema); - } - - var schemaId = $"SseItemOf{a.PayloadType.Name}"; - if (!context.Document.Components.Schemas.TryGetValue(schemaId, out var schema)) - { - context.Document.AddComponent(schemaId, new OpenApiSchema() - { - AllOf = [new OpenApiSchemaReference(SseItemBaseSchemaId)], - Properties = new Dictionary() - { - { "data", new OpenApiSchemaReference(dataSchemaId) } - } - }); - } - var description = string.IsNullOrEmpty(a.Description) - ? $"Published with type '{a.EventType}'" - : $"Published with type '{a.EventType}': {a.Description}"; - - schemas.Add(a.EventType, new OpenApiSchemaReference(schemaId) { Description = description }); - } - - mediaType.Schema = new OpenApiSchema() - { - Discriminator = new OpenApiDiscriminator() - { - PropertyName = "type", - Mapping = schemas, - }, - OneOf = schemas.Values.ToList(), - }; - } - - private static void SetOperationIds(OpenApiOperation operation, OpenApiOperationTransformerContext context) - { - if (context.Description.ActionDescriptor is ControllerActionDescriptor controllerActionDescriptor) - { - operation.OperationId = controllerActionDescriptor.MethodInfo.Name; // TODO: This keeps the old behavior, but it's actually violating guidelines regrading uniqueness - } - } - private static void EnsureSseItemBaseExists(OpenApiDocument document) { var sseItemBaseSchema = new OpenApiSchema() @@ -184,6 +65,6 @@ private static void EnsureSseItemBaseExists(OpenApiDocument document) } } }; - document.AddComponent(SseItemBaseSchemaId, sseItemBaseSchema); + document.AddComponent(MoryxSseOperationTransformer.SseItemBaseSchemaId, sseItemBaseSchema); } } diff --git a/src/Moryx.AspNetCore.OpenApi/MoryxOperationIdOperationTransformer.cs b/src/Moryx.AspNetCore.OpenApi/MoryxOperationIdOperationTransformer.cs new file mode 100644 index 0000000000..03b9ddebd2 --- /dev/null +++ b/src/Moryx.AspNetCore.OpenApi/MoryxOperationIdOperationTransformer.cs @@ -0,0 +1,19 @@ +// Copyright (c) 2026 Phoenix Contact GmbH & Co. KG +// Licensed under the Apache License, Version 2.0 + +using Microsoft.AspNetCore.Mvc.Controllers; +using Microsoft.AspNetCore.OpenApi; +using Microsoft.OpenApi; + +namespace Moryx.AspNetCore.OpenApi; + +internal class MoryxOperationIdOperationTransformer : IOpenApiOperationTransformer +{ + public async Task TransformAsync(OpenApiOperation operation, OpenApiOperationTransformerContext context, CancellationToken cancellationToken) + { + if (context.Description.ActionDescriptor is ControllerActionDescriptor controllerActionDescriptor) + { + operation.OperationId = controllerActionDescriptor.MethodInfo.Name; // TODO: This keeps the old behavior, but it's actually violating guidelines regrading uniqueness + } + } +} \ No newline at end of file diff --git a/src/Moryx.AspNetCore.OpenApi/MoryxSseOperationTransformer.cs b/src/Moryx.AspNetCore.OpenApi/MoryxSseOperationTransformer.cs new file mode 100644 index 0000000000..47e3dbda55 --- /dev/null +++ b/src/Moryx.AspNetCore.OpenApi/MoryxSseOperationTransformer.cs @@ -0,0 +1,90 @@ +// Copyright (c) 2026 Phoenix Contact GmbH & Co. KG +// Licensed under the Apache License, Version 2.0 + +using System.Diagnostics; +using System.Globalization; +using System.Net; +using System.Text.Json.Serialization.Metadata; +using Microsoft.AspNetCore.Http.Json; +using Microsoft.AspNetCore.OpenApi; +using Microsoft.Extensions.Options; +using Microsoft.OpenApi; +using Moryx.AspNetCore; + +internal class MoryxSseOperationTransformer(IOptions openapiOptions) : IOpenApiOperationTransformer +{ + internal const string SseItemBaseSchemaId = "SseItemBase"; + private const string EventStreamResponseType = "text/event-stream"; + public async Task TransformAsync(OpenApiOperation operation, OpenApiOperationTransformerContext context, CancellationToken cancellationToken) + { + var producesAttributes = context.Description.ActionDescriptor.EndpointMetadata.OfType().ToList(); + + if (producesAttributes.Count == 0) + { + return; + } + + foreach (var attribute in producesAttributes) + { + + } + var pseudoResponseKeys = operation.Responses.Keys.Where(x => int.TryParse(x, out var v) && v >= 1000).ToList(); + foreach (var pseudoKeys in pseudoResponseKeys) + { + operation.Responses.Remove(pseudoKeys); + } + + var responseKey = ((int)HttpStatusCode.OK).ToString(CultureInfo.InvariantCulture); + if (!operation.Responses.TryGetValue(responseKey, out var response)) + { + response = new OpenApiResponse() + { + Description = HttpStatusCode.OK.GetDisplayName(), + Content = new Dictionary(), + }; + + operation.Responses.Add(responseKey, response); + } + if (!response.Content.TryGetValue(EventStreamResponseType, out var mediaType)) + { + mediaType = new OpenApiMediaType(); + response.Content[EventStreamResponseType] = mediaType; + } + + Dictionary schemas = new(); + foreach (var a in producesAttributes) + { + var dataSchemaId = openapiOptions.Value.CreateSchemaReferenceId(JsonTypeInfo.CreateJsonTypeInfo(a.PayloadType, new JsonOptions().SerializerOptions)); + Debug.Assert(context.Document.Components.Schemas.ContainsKey(dataSchemaId)); + + var schemaId = $"SseItemOf{a.PayloadType.Name}"; + if (!context.Document.Components.Schemas.TryGetValue(schemaId, out var schema)) + { + context.Document.AddComponent(schemaId, new OpenApiSchema() + { + AllOf = [new OpenApiSchemaReference(SseItemBaseSchemaId)], + Properties = new Dictionary() + { + { "data", new OpenApiSchemaReference(dataSchemaId) } + } + }); + } + var description = string.IsNullOrEmpty(a.Description) + ? $"Published with type '{a.EventType}'" + : $"Published with type '{a.EventType}': {a.Description}"; + + schemas.Add(a.EventType, new OpenApiSchemaReference(schemaId) { Description = description }); + } + + mediaType.Schema = new OpenApiSchema() + { + Discriminator = new OpenApiDiscriminator() + { + PropertyName = "type", + Mapping = schemas, + }, + OneOf = schemas.Values.ToList(), + }; + + } +} diff --git a/src/Moryx.AspNetCore.OpenApi/OpenApiOptionsExtension.cs b/src/Moryx.AspNetCore.OpenApi/OpenApiOptionsExtension.cs new file mode 100644 index 0000000000..ea68756789 --- /dev/null +++ b/src/Moryx.AspNetCore.OpenApi/OpenApiOptionsExtension.cs @@ -0,0 +1,20 @@ +// Copyright (c) 2026 Phoenix Contact GmbH & Co. KG +// Licensed under the Apache License, Version 2.0 + +using Microsoft.AspNetCore.OpenApi; + +namespace Moryx.AspNetCore.OpenApi; + +public static class OpenApiOptionsExtension +{ + extension(OpenApiOptions options) + { + public OpenApiOptions ConfigureMoryxTransformers() + { + options.AddDocumentTransformer(); + options.AddOperationTransformer(); + options.AddOperationTransformer(); + return options; + } + } +} \ No newline at end of file diff --git a/src/Moryx.AspNetCore/ProducesSseEventAttribute.cs b/src/Moryx.AspNetCore/ProducesSseEventAttribute.cs index 8e46e699f5..d2d6e32707 100644 --- a/src/Moryx.AspNetCore/ProducesSseEventAttribute.cs +++ b/src/Moryx.AspNetCore/ProducesSseEventAttribute.cs @@ -1,6 +1,10 @@ // Copyright (c) 2026 Phoenix Contact GmbH & Co. KG // Licensed under the Apache License, Version 2.0 +using System.Diagnostics; +using Microsoft.AspNetCore.Mvc; +using Microsoft.AspNetCore.Mvc.ApiExplorer; + namespace Moryx.AspNetCore; /// @@ -10,12 +14,27 @@ namespace Moryx.AspNetCore; /// /// [AttributeUsage(AttributeTargets.Method, AllowMultiple = true)] -public class ProducesSseEventAttribute(string? eventType, Type payloadType) : Attribute +public class ProducesSseEventAttribute(string? eventType, Type payloadType) : ProducesResponseTypeAttribute(payloadType, GetPseudoUniqueKey(eventType), "text/event-stream"), IApiResponseMetadataProvider { + /// + /// EventType used in the sse message + /// public string EventType { get; set; } = eventType; - public Type PayloadType { get; set; } = payloadType; - public string Description { get; set; } + /// + /// Type of the payload beeing send when this EventType is send + /// + public Type PayloadType => base.Type; + + /// + /// Returns a hash based id for the eventype that is greater than thousand too stop conflicts with legitamate ResponseCodes + /// + private static int GetPseudoUniqueKey(string eventType) + { + var value = (eventType.GetHashCode() % 1_000_000_000) + 1_000_001_000; + Debug.Assert(value > 1000); + return value; + } } /// diff --git a/src/StartProject.Asp/Program.cs b/src/StartProject.Asp/Program.cs index 64d15dc751..e2ff817490 100644 --- a/src/StartProject.Asp/Program.cs +++ b/src/StartProject.Asp/Program.cs @@ -60,12 +60,12 @@ }); builder.Services.AddControllers(); -builder.Services.AddOpenApi(options => +builder.Services.AddOpenApi(static options => { - options.OpenApiVersion = Microsoft.OpenApi.OpenApiSpecVersion.OpenApi3_1; // OpenApi3_2 is only available with .net 11 + options.OpenApiVersion = OpenApiSpecVersion.OpenApi3_1; // OpenApi3_2 is only available with .net 11 //options.AddOperationTransformer(); - options.AddDocumentTransformer(); + options.ConfigureMoryxTransformers(); } ); diff --git a/src/StartProject.Asp/StartProject.Asp.csproj b/src/StartProject.Asp/StartProject.Asp.csproj index f5b3baeb98..942f1a1144 100644 --- a/src/StartProject.Asp/StartProject.Asp.csproj +++ b/src/StartProject.Asp/StartProject.Asp.csproj @@ -19,7 +19,7 @@ - false + true $(MSBuildProjectDirectory) --openapi-version OpenApi3_1 diff --git a/src/StartProject.Asp/StartProject.Asp.json b/src/StartProject.Asp/StartProject.Asp.json index 41a30da11a..4017eafec6 100644 --- a/src/StartProject.Asp/StartProject.Asp.json +++ b/src/StartProject.Asp/StartProject.Asp.json @@ -1,8 +1,8 @@ { - "openapi": "3.0.4", + "openapi": "3.1.1", "info": { - "title": "StartProject.Asp", - "version": "1.0" + "title": "StartProject.Asp | v1", + "version": "1.0.0" }, "paths": { "/common/time": { @@ -204,7 +204,8 @@ "$ref": "#/components/schemas/DatabaseConfigModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -263,7 +264,8 @@ "$ref": "#/components/schemas/DatabaseConfigModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -322,7 +324,8 @@ "$ref": "#/components/schemas/DatabaseConfigModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -411,7 +414,8 @@ "$ref": "#/components/schemas/DatabaseConfigModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -470,7 +474,8 @@ "$ref": "#/components/schemas/DatabaseConfigModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -529,7 +534,8 @@ "$ref": "#/components/schemas/ExecuteSetupRequest" } } - } + }, + "required": true }, "responses": { "200": { @@ -768,7 +774,8 @@ "$ref": "#/components/schemas/CellLocationModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -842,7 +849,7 @@ } }, "422": { - "description": "Unprocessable Content", + "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { @@ -956,7 +963,8 @@ "$ref": "#/components/schemas/TransportRouteModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -999,7 +1007,8 @@ "$ref": "#/components/schemas/CellSettingsModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -1130,7 +1139,10 @@ ], "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } } } } @@ -1154,7 +1166,10 @@ ], "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } } } } @@ -1167,7 +1182,10 @@ "operationId": "ProgressStream", "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } } } } @@ -1521,20 +1539,17 @@ "content": { "text/plain": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/FileStreamResult" } }, "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/FileStreamResult" } }, "text/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/FileStreamResult" } } } @@ -1555,18 +1570,13 @@ "type": "object", "properties": { "formFile": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/IFormFile" } } - }, - "encoding": { - "formFile": { - "style": "form" - } } } - } + }, + "required": true }, "responses": { "200": { @@ -1634,18 +1644,13 @@ "type": "object", "properties": { "formFile": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/IFormFile" } } - }, - "encoding": { - "formFile": { - "style": "form" - } } } - } + }, + "required": true }, "responses": { "200": { @@ -1797,6 +1802,26 @@ } } } + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } } } @@ -1846,6 +1871,26 @@ } } } + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } } } @@ -1869,6 +1914,26 @@ "responses": { "200": { "description": "OK" + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } } } @@ -1892,6 +1957,26 @@ "responses": { "200": { "description": "OK" + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } } } @@ -1915,6 +2000,26 @@ "responses": { "200": { "description": "OK" + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } } } @@ -1952,11 +2057,52 @@ "$ref": "#/components/schemas/ServerModuleModel" } } - } + }, + "required": true }, "responses": { "200": { "description": "OK" + }, + "400": { + "description": "Bad Request", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } } } @@ -1980,6 +2126,26 @@ "responses": { "200": { "description": "OK" + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } } } @@ -2020,6 +2186,29 @@ } } } + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "500": { + "description": "Internal Server Error" } } }, @@ -2055,39 +2244,83 @@ "$ref": "#/components/schemas/SaveConfigRequest" } } - } + }, + "required": true }, "responses": { "200": { "description": "OK" - } - } - } - }, - "/modules/{moduleName}/console": { - "get": { - "tags": [ - "Modules" - ], - "operationId": "GetMethods", - "parameters": [ - { - "name": "moduleName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", + }, + "400": { + "description": "Bad Request", "content": { "text/plain": { "schema": { - "type": "array", - "items": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/modules/{moduleName}/console": { + "get": { + "tags": [ + "Modules" + ], + "operationId": "GetMethods", + "parameters": [ + { + "name": "moduleName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/MethodEntry" } } @@ -2109,6 +2342,26 @@ } } } + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } } }, @@ -2144,7 +2397,8 @@ "$ref": "#/components/schemas/MethodEntry" } } - } + }, + "required": true }, "responses": { "200": { @@ -2166,6 +2420,49 @@ } } } + }, + "400": { + "description": "Bad Request", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "500": { + "description": "Internal Server Error" } } } @@ -2276,7 +2573,10 @@ ], "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } }, "404": { "description": "Not Found", @@ -2314,7 +2614,8 @@ "$ref": "#/components/schemas/OperatorModel" } } - } + }, + "required": true }, "responses": { "201": { @@ -2365,7 +2666,10 @@ ], "responses": { "204": { - "description": "No Content" + "description": "No Content", + "content": { + "application/json": { } + } }, "400": { "description": "Bad Request", @@ -2444,7 +2748,8 @@ "$ref": "#/components/schemas/OperatorModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -2743,7 +3048,10 @@ ], "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } }, "400": { "description": "Bad Request", @@ -2793,7 +3101,10 @@ ], "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } }, "400": { "description": "Bad Request", @@ -2826,7 +3137,10 @@ "operationId": "Stream", "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } } } } @@ -2836,11 +3150,13 @@ "tags": [ "OrderManagement" ], + "summary": "Retrieve all current operations that match the given filter parameters.\r\nAlready completed or aborted Operations won't be included.", "operationId": "GetOperations", "parameters": [ { "name": "orderNumber", "in": "query", + "description": "Optional. If specified only operations that belong to this order will be returned", "schema": { "type": "string" } @@ -2848,6 +3164,7 @@ { "name": "operationNumber", "in": "query", + "description": "Optional. If specified only operations with this operation number will be returned", "schema": { "type": "string" } @@ -2873,17 +3190,20 @@ "tags": [ "OrderManagement" ], + "summary": "Add an operation to the order stock", "operationId": "AddOperation", "parameters": [ { "name": "sourceId", "in": "query", + "description": "Identifier of the application adding the operation", "schema": { "type": "string" } } ], "requestBody": { + "description": "Description of the operation", "content": { "application/json": { "schema": { @@ -2900,7 +3220,8 @@ "$ref": "#/components/schemas/OperationCreationContextModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -2931,14 +3252,56 @@ "tags": [ "OrderManagement" ], + "summary": "Stream that allow subscribing to operation changes.", "operationId": "OperationStream", "responses": { "200": { "description": "OK", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OperationChangedModel" + "text/event-stream": { + "schema": { + "oneOf": [ + { + "description": "Published with type 'Start': Published when operation has been started", + "$ref": "#/components/schemas/SseItemOfOperationStartedModel" + }, + { + "description": "Published with type 'Progress'", + "$ref": "#/components/schemas/SseItemOfOperationModel" + }, + { + "description": "Published with type 'Completed'", + "$ref": "#/components/schemas/SseItemOfOperationReportedModel" + }, + { + "description": "Published with type 'Interrupted'", + "$ref": "#/components/schemas/SseItemOfOperationReportedModel" + }, + { + "description": "Published with type 'Report'", + "$ref": "#/components/schemas/SseItemOfOperationReportedModel" + }, + { + "description": "Published with type 'Advice'", + "$ref": "#/components/schemas/SseItemOfOperationAdvicedModel" + }, + { + "description": "Published with type 'Update'", + "$ref": "#/components/schemas/SseItemOfOperationModel" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "Start": "#/components/schemas/SseItemOfOperationStartedModel", + "Progress": "#/components/schemas/SseItemOfOperationModel", + "Completed": "#/components/schemas/SseItemOfOperationReportedModel", + "Interrupted": "#/components/schemas/SseItemOfOperationReportedModel", + "Report": "#/components/schemas/SseItemOfOperationReportedModel", + "Advice": "#/components/schemas/SseItemOfOperationAdvicedModel", + "Update": "#/components/schemas/SseItemOfOperationModel" + } + } } } } @@ -2951,11 +3314,13 @@ "tags": [ "OrderManagement" ], + "summary": "Retrieves an operationmodel using the unique id of the operation\r\n(Can load completed operations from storage)", "operationId": "GetOperation", "parameters": [ { "name": "guid", "in": "path", + "description": "", "required": true, "schema": { "type": "string", @@ -3002,11 +3367,13 @@ "tags": [ "OrderManagement" ], + "summary": "Retrieve the documents attached to operation with the given id", "operationId": "GetDocuments", "parameters": [ { "name": "guid", "in": "path", + "description": "Id of the operation", "required": true, "schema": { "type": "string", @@ -3056,11 +3423,13 @@ "tags": [ "OrderManagement" ], + "summary": "Retrieves the content of the document specified using the operation id and the identifier of the document", "operationId": "GetDocumentStream", "parameters": [ { "name": "guid", "in": "path", + "description": "Id of the operation", "required": true, "schema": { "type": "string", @@ -3070,6 +3439,7 @@ { "name": "identifier", "in": "path", + "description": "Identifier of the document", "required": true, "schema": { "type": "string" @@ -3102,8 +3472,7 @@ "content": { "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/FileStreamResult" } } } @@ -3116,11 +3485,13 @@ "tags": [ "OrderManagement" ], + "summary": "Retrieve a list of product parts attached to the given operation", "operationId": "GetProductParts", "parameters": [ { "name": "guid", "in": "path", + "description": "If of the operation", "required": true, "schema": { "type": "string", @@ -3170,11 +3541,13 @@ "tags": [ "OrderManagement" ], + "summary": "Retrieves the begin context for the given operation", "operationId": "GetBeginContext", "parameters": [ { "name": "guid", "in": "path", + "description": "Id of the operation", "required": true, "schema": { "type": "string", @@ -3219,11 +3592,13 @@ "tags": [ "OrderManagement" ], + "summary": "Begin producing the operation using the given parameters", "operationId": "BeginOperation", "parameters": [ { "name": "guid", "in": "path", + "description": "Id of the operation", "required": true, "schema": { "type": "string", @@ -3232,6 +3607,7 @@ } ], "requestBody": { + "description": "Begin parameters", "content": { "application/json": { "schema": { @@ -3248,11 +3624,15 @@ "$ref": "#/components/schemas/BeginModel" } } - } + }, + "required": true }, "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } }, "400": { "description": "Bad Request", @@ -3282,11 +3662,13 @@ "tags": [ "OrderManagement" ], + "summary": "Retrieves a report context for the given operation", "operationId": "GetReportContext", "parameters": [ { "name": "guid", "in": "path", + "description": "Id of the operation", "required": true, "schema": { "type": "string", @@ -3331,11 +3713,13 @@ "tags": [ "OrderManagement" ], + "summary": "Report produced amounts of a given operation", "operationId": "ReportOperation", "parameters": [ { "name": "guid", "in": "path", + "description": "Id of the operation", "required": true, "schema": { "type": "string", @@ -3344,6 +3728,7 @@ } ], "requestBody": { + "description": "Parameter object", "content": { "application/json": { "schema": { @@ -3360,11 +3745,15 @@ "$ref": "#/components/schemas/ReportModel" } } - } + }, + "required": true }, "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } }, "400": { "description": "Bad Request", @@ -3394,11 +3783,13 @@ "tags": [ "OrderManagement" ], + "summary": "Retrieves a interrupt context for the given operation", "operationId": "GetInterruptContext", "parameters": [ { "name": "guid", "in": "path", + "description": "Id of the operation", "required": true, "schema": { "type": "string", @@ -3443,11 +3834,13 @@ "tags": [ "OrderManagement" ], + "summary": "Interrupt the given operation", "operationId": "InterruptOperation", "parameters": [ { "name": "guid", "in": "path", + "description": "Id of the operation", "required": true, "schema": { "type": "string", @@ -3457,6 +3850,7 @@ { "name": "userIdentifier", "in": "query", + "description": "Identifier of the user requesting the interrupt (Optional depending on configuration)", "schema": { "type": "string" } @@ -3464,7 +3858,10 @@ ], "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } }, "400": { "description": "Bad Request", @@ -3494,11 +3891,13 @@ "tags": [ "OrderManagement" ], + "summary": "Retrieves a advice context for the given operation", "operationId": "GetAdviceContext", "parameters": [ { "name": "guid", "in": "path", + "description": "Id of the operation", "required": true, "schema": { "type": "string", @@ -3543,11 +3942,13 @@ "tags": [ "OrderManagement" ], + "summary": "Advice operation", "operationId": "AdviceOperation", "parameters": [ { "name": "guid", "in": "path", + "description": "Id of the operation", "required": true, "schema": { "type": "string", @@ -3556,6 +3957,7 @@ } ], "requestBody": { + "description": "Parameter object", "content": { "application/json": { "schema": { @@ -3572,11 +3974,15 @@ "$ref": "#/components/schemas/AdviceModel" } } - } + }, + "required": true }, "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } }, "400": { "description": "Bad Request", @@ -3606,11 +4012,13 @@ "tags": [ "OrderManagement" ], + "summary": "Retrieves logs written during the creation of the operation", "operationId": "GetLogs", "parameters": [ { "name": "guid", "in": "path", + "description": "Id of the operation", "required": true, "schema": { "type": "string", @@ -3650,11 +4058,13 @@ "tags": [ "OrderManagement" ], + "summary": "Get's the list of recipes available to produce the given product", "operationId": "GetAssignableRecipes", "parameters": [ { "name": "identifier", "in": "query", + "description": "Product identifier", "schema": { "type": "string" } @@ -3662,15 +4072,16 @@ { "name": "revision", "in": "query", + "description": "Product revision", "schema": { "type": "integer", - "format": "int32" + "format": "int16" } } ], "responses": { "200": { - "description": "OK", + "description": "", "content": { "application/json": { "schema": { @@ -3690,11 +4101,13 @@ "tags": [ "OrderManagement" ], + "summary": "Abort the specified operation (Remove it before being started)", "operationId": "AbortOperation", "parameters": [ { "name": "guid", "in": "path", + "description": "Id of the operation", "required": true, "schema": { "type": "string", @@ -3704,7 +4117,10 @@ ], "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } }, "400": { "description": "Bad Request", @@ -3734,11 +4150,13 @@ "tags": [ "OrderManagement" ], + "summary": "Update the operation", "operationId": "UpdateOperation", "parameters": [ { "name": "guid", "in": "path", + "description": "Id of the operation", "required": true, "schema": { "type": "string", @@ -3747,6 +4165,7 @@ } ], "requestBody": { + "description": "Paramter object", "content": { "application/json": { "schema": { @@ -3763,11 +4182,15 @@ "$ref": "#/components/schemas/OperationUpdateModel" } } - } + }, + "required": true }, "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } }, "400": { "description": "Bad Request", @@ -3797,11 +4220,13 @@ "tags": [ "OrderManagement" ], + "summary": "Reload the operation, rerunning the order assignment steps", "operationId": "Reload", "parameters": [ { "name": "guid", "in": "path", + "description": "Id of the operation", "required": true, "schema": { "type": "string", @@ -3811,7 +4236,10 @@ ], "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } }, "400": { "description": "Bad Request", @@ -4177,7 +4605,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProcessHolderGroupModelArrayApiResponse" + "$ref": "#/components/schemas/ApiResponseOfProcessHolderGroupModel[]" } } } @@ -4218,13 +4646,26 @@ "required": true, "schema": { "type": "integer", - "format": "int64" + "format": "int32" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } } } @@ -4242,13 +4683,26 @@ "required": true, "schema": { "type": "integer", - "format": "int64" + "format": "int32" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } } } @@ -4258,6 +4712,7 @@ "tags": [ "ProductManagement" ], + "summary": "Loads dataset of existing products, recipes and importers for the UI", "operationId": "GetProductCustomization", "responses": { "200": { @@ -4278,11 +4733,13 @@ "tags": [ "ProductManagement" ], + "summary": "Run the product importer with the given parameters", "operationId": "Import", "parameters": [ { "name": "importerName", "in": "path", + "description": "Name of the importer", "required": true, "schema": { "type": "string" @@ -4290,6 +4747,7 @@ } ], "requestBody": { + "description": "Parameters for the importer", "content": { "application/json": { "schema": { @@ -4306,7 +4764,8 @@ "$ref": "#/components/schemas/Entry" } } - } + }, + "required": true }, "responses": { "200": { @@ -4340,8 +4799,10 @@ "tags": [ "ProductManagement" ], + "summary": "Store the product type in the database", "operationId": "SaveType", "requestBody": { + "description": "Model of the new product", "content": { "application/json": { "schema": { @@ -4358,7 +4819,8 @@ "$ref": "#/components/schemas/ProductModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -4388,11 +4850,13 @@ "tags": [ "ProductManagement" ], + "summary": "Retrieves all product types, if no identity is specified. Otherwise the model identified by that id is returned", "operationId": "GetTypeByIdentity", "parameters": [ { "name": "identity", "in": "query", + "description": "Optional. The id to look for", "schema": { "type": "string" } @@ -4440,8 +4904,10 @@ "tags": [ "ProductManagement" ], + "summary": "Query the product type database", "operationId": "GetTypes", "requestBody": { + "description": "Query parameters", "content": { "application/json": { "schema": { @@ -4458,11 +4924,12 @@ "$ref": "#/components/schemas/ProductQuery" } } - } + }, + "required": true }, "responses": { "200": { - "description": "OK", + "description": "The products models matching the query", "content": { "application/json": { "schema": { @@ -4482,11 +4949,13 @@ "tags": [ "ProductManagement" ], + "summary": "Get's a product type using the database id", "operationId": "GetTypeById", "parameters": [ { "name": "id", "in": "path", + "description": "Database id", "required": true, "schema": { "type": "integer", @@ -4531,11 +5000,13 @@ "tags": [ "ProductManagement" ], + "summary": "Deletes the product type with the given id", "operationId": "DeleteType", "parameters": [ { "name": "id", "in": "path", + "description": "", "required": true, "schema": { "type": "integer", @@ -4570,11 +5041,13 @@ "tags": [ "ProductManagement" ], + "summary": "Updates the existing product type", "operationId": "UpdateType", "parameters": [ { "name": "id", "in": "path", + "description": "Database id of the product type", "required": true, "schema": { "type": "integer", @@ -4583,6 +5056,7 @@ } ], "requestBody": { + "description": "New product model", "content": { "application/json": { "schema": { @@ -4599,7 +5073,8 @@ "$ref": "#/components/schemas/ProductModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -4629,11 +5104,13 @@ "tags": [ "ProductManagement" ], + "summary": "Create a clone of the product type identified with the id with the new identitiy", "operationId": "Duplicate", "parameters": [ { "name": "id", "in": "path", + "description": "Database id of the existing product type", "required": true, "schema": { "type": "integer", @@ -4642,6 +5119,7 @@ } ], "requestBody": { + "description": "Product identifier of the new product", "content": { "application/json": { "schema": { @@ -4658,7 +5136,8 @@ "type": "string" } } - } + }, + "required": true }, "responses": { "200": { @@ -4709,11 +5188,13 @@ "tags": [ "ProductManagement" ], + "summary": "Loads the recipe attached to the product type with the id", "operationId": "GetRecipes", "parameters": [ { "name": "id", "in": "path", + "description": "Database id", "required": true, "schema": { "type": "integer", @@ -4723,6 +5204,7 @@ { "name": "classification", "in": "path", + "description": "Recipe classification RecipeClassification", "required": true, "schema": { "type": "integer", @@ -4762,11 +5244,13 @@ "tags": [ "ProductManagement" ], + "summary": "Get's the product instance with the given id", "operationId": "GetInstance", "parameters": [ { "name": "id", "in": "path", + "description": "Database id of the product instance", "required": true, "schema": { "type": "integer", @@ -4813,11 +5297,13 @@ "tags": [ "ProductManagement" ], + "summary": "Loads multiple product instances at once", "operationId": "GetInstances", "parameters": [ { "name": "ids", "in": "query", + "description": "A list of product instance ids", "schema": { "type": "array", "items": { @@ -4847,11 +5333,13 @@ "tags": [ "ProductManagement" ], + "summary": "Create a new product instace of the product type identified via the identifier and revision", "operationId": "CreateInstance", "parameters": [ { "name": "identifier", "in": "query", + "description": "Product identifier", "schema": { "type": "string" } @@ -4859,14 +5347,16 @@ { "name": "revision", "in": "query", + "description": "Revision of the product", "schema": { "type": "integer", - "format": "int32" + "format": "int16" } }, { "name": "save", "in": "query", + "description": "If save is false, the new instance won't be stored in the db", "schema": { "type": "boolean" } @@ -4899,8 +5389,10 @@ "tags": [ "ProductManagement" ], + "summary": "Save the instance in the product db", "operationId": "SaveInstance", "requestBody": { + "description": "Model of the product instance", "content": { "application/json": { "schema": { @@ -4917,11 +5409,15 @@ "$ref": "#/components/schemas/ProductInstanceModel" } } - } + }, + "required": true }, "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } }, "400": { "description": "Bad Request", @@ -4941,11 +5437,13 @@ "tags": [ "ProductManagement" ], + "summary": "Get's a recipe by it's db id", "operationId": "GetRecipe", "parameters": [ { "name": "id", "in": "path", + "description": "Database id of the recipe", "required": true, "schema": { "type": "integer", @@ -4990,11 +5488,13 @@ "tags": [ "ProductManagement" ], + "summary": "Updates the existing recipes", "operationId": "UpdateRecipe", "parameters": [ { "name": "id", "in": "path", + "description": "Database id of the recipe", "required": true, "schema": { "type": "integer", @@ -5003,6 +5503,7 @@ } ], "requestBody": { + "description": "Updated recipe model", "content": { "application/json": { "schema": { @@ -5019,7 +5520,8 @@ "$ref": "#/components/schemas/RecipeModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -5061,8 +5563,10 @@ "tags": [ "ProductManagement" ], + "summary": "Saves a new recipe in the database", "operationId": "SaveRecipe", "requestBody": { + "description": "Model of the recipe", "content": { "application/json": { "schema": { @@ -5079,7 +5583,8 @@ "$ref": "#/components/schemas/RecipeModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -5253,7 +5758,8 @@ "$ref": "#/components/schemas/ResourceModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -5287,7 +5793,10 @@ } }, "500": { - "description": "Internal Server Error" + "description": "Internal Server Error", + "content": { + "application/json": { } + } } } } @@ -5315,7 +5824,8 @@ "$ref": "#/components/schemas/ResourceQuery" } } - } + }, + "required": true }, "responses": { "200": { @@ -5427,7 +5937,8 @@ "$ref": "#/components/schemas/ResourceModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -5461,7 +5972,10 @@ } }, "500": { - "description": "Internal Server Error" + "description": "Internal Server Error", + "content": { + "application/json": { } + } } } }, @@ -5483,7 +5997,10 @@ ], "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } }, "400": { "description": "Bad Request", @@ -5560,7 +6077,8 @@ "$ref": "#/components/schemas/Entry" } } - } + }, + "required": true }, "responses": { "200": { @@ -5726,7 +6244,8 @@ "$ref": "#/components/schemas/ShiftCreationContextModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -5763,11 +6282,15 @@ "$ref": "#/components/schemas/ShiftModel" } } - } + }, + "required": true }, "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } } } } @@ -5784,7 +6307,7 @@ "in": "query", "schema": { "type": "string", - "format": "time" + "format": "date" } }, { @@ -5792,7 +6315,7 @@ "in": "query", "schema": { "type": "string", - "format": "time" + "format": "date" } } ], @@ -5832,7 +6355,10 @@ ], "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } } } } @@ -5881,7 +6407,8 @@ "$ref": "#/components/schemas/ShiftTypeCreationContextModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -5918,11 +6445,15 @@ "$ref": "#/components/schemas/ShiftTypeModel" } } - } + }, + "required": true }, "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } } } } @@ -5946,7 +6477,10 @@ ], "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } } } } @@ -5995,7 +6529,8 @@ "$ref": "#/components/schemas/ShiftAssignementCreationContextModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -6032,11 +6567,15 @@ "$ref": "#/components/schemas/ShiftAssignementModel" } } - } + }, + "required": true }, "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } } } } @@ -6053,7 +6592,7 @@ "in": "query", "schema": { "type": "string", - "format": "time" + "format": "date" } }, { @@ -6061,7 +6600,7 @@ "in": "query", "schema": { "type": "string", - "format": "time" + "format": "date" } } ], @@ -6101,7 +6640,10 @@ ], "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } } } } @@ -6160,7 +6702,8 @@ "$ref": "#/components/schemas/SkillTypeCreationContextModel" } } - } + }, + "required": true }, "responses": { "201": { @@ -6207,11 +6750,15 @@ "$ref": "#/components/schemas/SkillTypeModel" } } - } + }, + "required": true }, "responses": { "204": { - "description": "No Content" + "description": "No Content", + "content": { + "application/json": { } + } }, "400": { "description": "Bad Request", @@ -6304,7 +6851,10 @@ ], "responses": { "204": { - "description": "No Content" + "description": "No Content", + "content": { + "application/json": { } + } }, "400": { "description": "Bad Request", @@ -6413,7 +6963,8 @@ "$ref": "#/components/schemas/SkillCreationContextModel" } } - } + }, + "required": true }, "responses": { "201": { @@ -6517,7 +7068,10 @@ ], "responses": { "204": { - "description": "No Content" + "description": "No Content", + "content": { + "application/json": { } + } }, "400": { "description": "Bad Request", @@ -6680,11 +7234,15 @@ "$ref": "#/components/schemas/InstructionModel" } } - } + }, + "required": true }, "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } } } }, @@ -6720,11 +7278,15 @@ "$ref": "#/components/schemas/InstructionModel" } } - } + }, + "required": true }, "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } } } } @@ -6762,11 +7324,15 @@ "$ref": "#/components/schemas/InstructionResponseModel" } } - } + }, + "required": true }, "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } }, "404": { "description": "Not Found", @@ -6848,7 +7414,8 @@ "$ref": "#/components/schemas/WorkplanModel" } } - } + }, + "required": true }, "responses": { "400": { @@ -6986,7 +7553,10 @@ ], "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } }, "404": { "description": "Not Found", @@ -7032,7 +7602,8 @@ "$ref": "#/components/schemas/WorkplanModel" } } - } + }, + "required": true }, "responses": { "400": { @@ -7094,7 +7665,8 @@ "$ref": "#/components/schemas/OpenSessionRequest" } } - } + }, + "required": true }, "responses": { "200": { @@ -7191,7 +7763,8 @@ "$ref": "#/components/schemas/WorkplanSessionModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -7233,7 +7806,10 @@ ], "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { } + } } } } @@ -7311,7 +7887,8 @@ "$ref": "#/components/schemas/WorkplanSessionModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -7420,7 +7997,8 @@ "$ref": "#/components/schemas/WorkplanStepRecipe" } } - } + }, + "required": true }, "responses": { "200": { @@ -7488,7 +8066,8 @@ "$ref": "#/components/schemas/WorkplanNodeModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -7612,7 +8191,8 @@ "$ref": "#/components/schemas/NodeConnector" } } - } + }, + "required": true }, "responses": { "200": { @@ -7687,7 +8267,8 @@ "$ref": "#/components/schemas/NodeConnector" } } - } + }, + "required": true }, "responses": { "200": { @@ -7733,18 +8314,11 @@ "orderReferenceModel": { "$ref": "#/components/schemas/OrderReferenceModel" } - }, - "additionalProperties": false + } }, "ActivityClassification": { - "enum": [ - "Unknown", - "Production", - "Setup", - "Maintenance", - "Preparation" - ], - "type": "string" + "type": "string", + "description": "Defines different classifications of activities. A resource will define accepted classifications\r\nin the published ReadyToWork. An activity declares its classification which is compared\r\nto the accepted classification within the kernel. While a ReadyToWork can accept multiple\r\nclassifications (by combining flags), an activity has only one classification." }, "ActivityResourceModel": { "type": "object", @@ -7754,357 +8328,310 @@ "format": "int64" }, "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "AdviceContext": { "type": "object", "properties": { "advicedAmount": { "type": "integer", + "description": "Amount which are already adviced", "format": "int32" } }, - "additionalProperties": false + "description": "Context for a new advice with all necessary information" }, "AdviceModel": { "type": "object", "properties": { "toteBoxNumber": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "amount": { "type": "integer", "format": "int32" }, "partId": { - "type": "integer", - "format": "int64", - "nullable": true + "type": [ + "null", + "integer" + ], + "format": "int64" } - }, - "additionalProperties": false + } }, "ApiError": { + "required": [ + "errorCode", + "message" + ], "type": "object", "properties": { "errorCode": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "message": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "exception": { "$ref": "#/components/schemas/Exception" } - }, - "additionalProperties": false + } + }, + "ApiResponseOfProcessHolderGroupModel[]": { + "type": "object", + "properties": { + "data": { + "type": [ + "null", + "array" + ], + "items": { + "$ref": "#/components/schemas/ProcessHolderGroupModel" + } + }, + "errors": { + "type": [ + "null", + "array" + ], + "items": { + "$ref": "#/components/schemas/ApiError" + } + }, + "succeeded": { + "type": "boolean" + }, + "timestamp": { + "type": "string", + "format": "date-time" + } + } }, "ApplicationInformationResponse": { "type": "object", "properties": { "assemblyProduct": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "assemblyVersion": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "assemblyInformationalVersion": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "assemblyDescription": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "assemblyCompanyName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "assemblyTitle": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "assemblyConfiguration": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "targetFramework": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "assemblyCopyright": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "assemblyTrademark": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, - "Assembly": { - "type": "object", - "properties": { - "definedTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TypeInfo" - }, - "nullable": true, - "readOnly": true - }, - "exportedTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Type" - }, - "nullable": true, - "readOnly": true - }, - "codeBase": { - "type": "string", - "nullable": true, - "readOnly": true, - "deprecated": true - }, - "entryPoint": { - "$ref": "#/components/schemas/MethodInfo" - }, - "fullName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "imageRuntimeVersion": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "isDynamic": { - "type": "boolean", - "readOnly": true - }, - "location": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "reflectionOnly": { - "type": "boolean", - "readOnly": true - }, - "isCollectible": { - "type": "boolean", - "readOnly": true - }, - "isFullyTrusted": { - "type": "boolean", - "readOnly": true - }, - "customAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "escapedCodeBase": { - "type": "string", - "nullable": true, - "readOnly": true, - "deprecated": true - }, - "manifestModule": { - "$ref": "#/components/schemas/Module" - }, - "modules": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Module" - }, - "nullable": true, - "readOnly": true - }, - "globalAssemblyCache": { - "type": "boolean", - "readOnly": true, - "deprecated": true - }, - "hostContext": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "securityRuleSet": { - "$ref": "#/components/schemas/SecurityRuleSet" + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "AssemblyModel": { "type": "object", "properties": { "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "version": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "fileVersion": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "informationalVersion": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "AssignableOperator": { + "required": [ + "identifier" + ], "type": "object", "properties": { + "signedIn": { + "type": "boolean" + }, + "assignedResources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IOperatorAssignable" + } + }, "identifier": { - "type": "string", - "nullable": true + "type": "string" }, "firstName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "lastName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "pseudonym": { - "type": "string", - "nullable": true - }, - "signedIn": { - "type": "boolean", - "readOnly": true - }, - "assignedResources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IOperatorAssignable" - }, - "nullable": true, - "readOnly": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "AssignedDays": { - "enum": [ - "All", - "First", - "Second", - "Third", - "Fourth", - "Fifth", - "Sixth", - "Seventh", - "Eighth", - "Ninth", - "Tenth", - "Eleventh", - "Twelfth", - "Thirteenth", - "Fourteenth", - "Fifteenth", - "Sixteenth", - "Seventeenth", - "Eighteenth", - "Nineteenth", - "Twentieth", - "TwentyFirst", - "TwentySecond", - "TwentyThird", - "TwentyFourth", - "TwentyFifth", - "TwentySixth", - "TwentySeventh", - "TwentyEighth", - "TwentyNinth", - "Thirtieth", - "ThirtyFirst" - ], "type": "string" }, "AttendableResourceModel": { "type": "object", "properties": { "id": { - "type": "integer", - "format": "int64", - "nullable": true + "type": [ + "null", + "integer" + ], + "format": "int64" }, "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "requiredSkills": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "type": "string" - }, - "nullable": true + } } - }, - "additionalProperties": false + } }, "BeginContext": { "type": "object", "properties": { - "successCount": { - "type": "integer", - "format": "int32" - }, - "scrapCount": { - "type": "integer", - "format": "int32" - }, "residualAmount": { "type": "integer", + "description": "Residual amount of the operation", "format": "int32" }, "partialAmount": { "type": "integer", + "description": "Current target amount of the operation", "format": "int32" }, "minimalTargetAmount": { "type": "integer", + "description": "Provides the minimum value that can be set for the target amount when adjusting the operation.", "format": "int32" }, "canBegin": { - "type": "boolean" + "type": "boolean", + "description": "Indicator if a begin is possible" }, "canReduce": { - "type": "boolean" + "type": "boolean", + "description": "Indicator if an adjustment of the operation is possible" }, "restrictions": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/RestrictionDescription" }, - "nullable": true + "description": "Reasons why a begin is not possible" + }, + "successCount": { + "type": "integer", + "description": "Current success count of the operation", + "format": "int32" + }, + "scrapCount": { + "type": "integer", + "description": "Current failure count of the operation", + "format": "int32" } }, - "additionalProperties": false + "description": "Context information to begin an operation production" }, "BeginModel": { "type": "object", @@ -8114,28 +8641,18 @@ "format": "int32" }, "userId": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false - }, - "CallingConventions": { - "enum": [ - "Standard", - "VarArgs", - "Any", - "HasThis", - "ExplicitThis" - ], - "type": "string" + } }, "Category": { "enum": [ "ProcessHolderGroup", "ParentResource" - ], - "type": "string" + ] }, "CellLocationModel": { "type": "object", @@ -8152,46 +8669,51 @@ "type": "number", "format": "double" } - }, - "additionalProperties": false + } }, "CellPropertySettings": { "type": "object", "properties": { "valueUnit": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "iconName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "isDisplayed": { "type": "boolean" }, - "currentValue": { - "nullable": true - }, + "currentValue": { }, "displayName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "CellSettingsModel": { "type": "object", "properties": { "image": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "icon": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "CellState": { "enum": [ @@ -8199,8 +8721,7 @@ "Requested", "Running", "NotReadyToWork" - ], - "type": "string" + ] }, "CellStateChangedModel": { "type": "object", @@ -8212,8 +8733,7 @@ "state": { "$ref": "#/components/schemas/CellState" } - }, - "additionalProperties": false + } }, "Config": { "type": "object", @@ -8221,155 +8741,21 @@ "root": { "$ref": "#/components/schemas/Entry" } - }, - "additionalProperties": false + } }, "ConfigUpdateMode": { "enum": [ "OnlySave", "SaveAndReincarnate", "UpdateLiveAndSave" - ], - "type": "string" + ] }, "ConfirmationType": { "enum": [ "Partial", "Final" ], - "type": "string" - }, - "ConstructorInfo": { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "declaringType": { - "$ref": "#/components/schemas/Type" - }, - "reflectedType": { - "$ref": "#/components/schemas/Type" - }, - "module": { - "$ref": "#/components/schemas/Module" - }, - "customAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "isCollectible": { - "type": "boolean", - "readOnly": true - }, - "metadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "attributes": { - "$ref": "#/components/schemas/MethodAttributes" - }, - "methodImplementationFlags": { - "$ref": "#/components/schemas/MethodImplAttributes" - }, - "callingConvention": { - "$ref": "#/components/schemas/CallingConventions" - }, - "isAbstract": { - "type": "boolean", - "readOnly": true - }, - "isConstructor": { - "type": "boolean", - "readOnly": true - }, - "isFinal": { - "type": "boolean", - "readOnly": true - }, - "isHideBySig": { - "type": "boolean", - "readOnly": true - }, - "isSpecialName": { - "type": "boolean", - "readOnly": true - }, - "isStatic": { - "type": "boolean", - "readOnly": true - }, - "isVirtual": { - "type": "boolean", - "readOnly": true - }, - "isAssembly": { - "type": "boolean", - "readOnly": true - }, - "isFamily": { - "type": "boolean", - "readOnly": true - }, - "isFamilyAndAssembly": { - "type": "boolean", - "readOnly": true - }, - "isFamilyOrAssembly": { - "type": "boolean", - "readOnly": true - }, - "isPrivate": { - "type": "boolean", - "readOnly": true - }, - "isPublic": { - "type": "boolean", - "readOnly": true - }, - "isConstructedGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "isGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "isGenericMethodDefinition": { - "type": "boolean", - "readOnly": true - }, - "containsGenericParameters": { - "type": "boolean", - "readOnly": true - }, - "methodHandle": { - "$ref": "#/components/schemas/RuntimeMethodHandle" - }, - "isSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "isSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "isSecurityTransparent": { - "type": "boolean", - "readOnly": true - }, - "memberType": { - "$ref": "#/components/schemas/MemberTypes" - } - }, - "additionalProperties": false + "description": "Confirmation type while reporting amounts of an operation" }, "ContentDescriptorModel": { "type": "object", @@ -8379,123 +8765,147 @@ "format": "uuid" }, "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "variants": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/VariantDescriptor" - }, - "nullable": true + } }, "master": { "$ref": "#/components/schemas/VariantDescriptor" } - }, - "additionalProperties": false + } }, - "CustomAttributeData": { + "DatabaseConfigModel": { "type": "object", "properties": { - "attributeType": { - "$ref": "#/components/schemas/Type" - }, - "constructor": { - "$ref": "#/components/schemas/ConstructorInfo" + "configuratorType": { + "type": [ + "null", + "string" + ] }, - "constructorArguments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeTypedArgument" - }, - "nullable": true, - "readOnly": true + "connectionString": { + "type": [ + "null", + "string" + ] }, - "namedArguments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeNamedArgument" - }, - "nullable": true, - "readOnly": true + "properties": { + "$ref": "#/components/schemas/Entry" } - }, - "additionalProperties": false + } }, - "CustomAttributeNamedArgument": { + "DatabaseMigrationSummary": { "type": "object", "properties": { - "memberInfo": { - "$ref": "#/components/schemas/MemberInfo" - }, - "typedValue": { - "$ref": "#/components/schemas/CustomAttributeTypedArgument" + "result": { + "description": "Flag that any updates were performed", + "$ref": "#/components/schemas/MigrationResult" }, - "memberName": { - "type": "string", - "nullable": true, - "readOnly": true + "errors": { + "type": [ + "null", + "array" + ], + "items": { + "type": "string" + }, + "description": "Reason, in case an error occured during migration" }, - "isField": { - "type": "boolean", - "readOnly": true + "executedMigrations": { + "type": [ + "null", + "array" + ], + "items": { + "type": "string" + }, + "description": "All updates that were executed" } }, - "additionalProperties": false + "description": "Result object created from running a database update" }, - "CustomAttributeTypedArgument": { + "DatabasesResponse": { "type": "object", "properties": { - "argumentType": { - "$ref": "#/components/schemas/Type" + "databases": { + "type": [ + "null", + "array" + ], + "items": { + "$ref": "#/components/schemas/DataModel" + } }, - "value": { - "nullable": true + "configurators": { + "type": [ + "null", + "array" + ], + "items": { + "$ref": "#/components/schemas/ModelConfiguratorModel" + } } - }, - "additionalProperties": false + } }, "DataModel": { "type": "object", "properties": { "targetModel": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "config": { "$ref": "#/components/schemas/DatabaseConfigModel" }, "possibleConfigurators": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "type": "string" - }, - "nullable": true + } }, "setups": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/SetupModel" - }, - "nullable": true + } }, "availableMigrations": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/DbMigrationsModel" - }, - "nullable": true + } }, "appliedMigrations": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/DbMigrationsModel" - }, - "nullable": true + } } - }, - "additionalProperties": false + } }, "DataType": { "enum": [ @@ -8516,78 +8926,18 @@ "CreditCard", "PostalCode", "Upload" - ], - "type": "string" - }, - "DatabaseConfigModel": { - "type": "object", - "properties": { - "configuratorType": { - "type": "string", - "nullable": true - }, - "connectionString": { - "type": "string", - "nullable": true - }, - "properties": { - "$ref": "#/components/schemas/Entry" - } - }, - "additionalProperties": false - }, - "DatabaseMigrationSummary": { - "type": "object", - "properties": { - "result": { - "$ref": "#/components/schemas/MigrationResult" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - }, - "executedMigrations": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "DatabasesResponse": { - "type": "object", - "properties": { - "databases": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DataModel" - }, - "nullable": true - }, - "configurators": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ModelConfiguratorModel" - }, - "nullable": true - } - }, - "additionalProperties": false + ] }, "DbMigrationsModel": { "type": "object", "properties": { "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "DependencyEvaluation": { "type": "object", @@ -8608,98 +8958,145 @@ "type": "integer", "format": "int32" } - }, - "additionalProperties": false + } }, "DocumentModel": { "type": "object", "properties": { "identifier": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "number": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "revision": { "type": "integer", - "format": "int32" + "format": "int16" }, "type": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "description": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "contentType": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "source": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } + }, + "EntityTagHeaderValue": { + "type": "object", + "properties": { + "tag": { + "$ref": "#/components/schemas/StringSegment" + }, + "isWeak": { + "type": "boolean" + } + } }, "Entry": { "type": "object", "properties": { "displayName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Name of the item - property name or list item name" }, "identifier": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Unique identifier - property name or item index" }, "description": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Description of the entry" }, "value": { + "description": "Value of the entry", "$ref": "#/components/schemas/EntryValue" }, "validation": { + "description": "Validation information", "$ref": "#/components/schemas/EntryValidation" }, "subEntries": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/Entry" }, - "nullable": true + "description": "Subentries of this entry - properties or list items" }, "prototypes": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/Entry" }, - "nullable": true + "description": "Prototypes that can be used to create subentries" } }, - "additionalProperties": false + "description": "Model class representing a single property of a config class" }, "EntryPossible": { "type": "object", "properties": { "key": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Invariant key of the possible value." }, "displayName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Display name of the possible value." }, "description": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Description of the possible value." } }, - "additionalProperties": false + "description": "Possible value for an entry." }, "EntryUnitType": { "enum": [ @@ -8710,61 +9107,80 @@ "Flags", "Base64" ], - "type": "string" + "description": "Enum describes the unit type of a entry" }, "EntryValidation": { "type": "object", "properties": { "dataType": { + "description": "Logical data types that may appear", "$ref": "#/components/schemas/DataType" }, "minimum": { "type": "number", + "description": "Minimum value or minimal length of strings", "format": "double" }, "maximum": { "type": "number", + "description": "Maximum value or maximal length of strings", "format": "double" }, "regex": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Regex pattern for this entry" }, "isRequired": { - "type": "boolean" + "type": "boolean", + "description": "Indicated if the field is required and should not be empty" } }, - "additionalProperties": false + "description": "All validation rules of an entry" }, "EntryValue": { "type": "object", "properties": { "type": { + "description": "Type of this entry", "$ref": "#/components/schemas/EntryValueType" }, "unitType": { + "description": "Unit type of this entry", "$ref": "#/components/schemas/EntryUnitType" }, "current": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Current value of this entry" }, "default": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Default value of this entry" }, "possible": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/EntryPossible" }, - "nullable": true + "description": "Possible values for this entry" }, "isReadOnly": { - "type": "boolean" + "type": "boolean", + "description": "Indicates wether the field is read only" } }, - "additionalProperties": false + "description": "Value of an config entry" }, "EntryValueType": { "enum": [ @@ -8790,78 +9206,7 @@ "Time", "TimeSpan" ], - "type": "string" - }, - "EventAttributes": { - "enum": [ - "None", - "SpecialName", - "RTSpecialName" - ], - "type": "string" - }, - "EventInfo": { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "declaringType": { - "$ref": "#/components/schemas/Type" - }, - "reflectedType": { - "$ref": "#/components/schemas/Type" - }, - "module": { - "$ref": "#/components/schemas/Module" - }, - "customAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "isCollectible": { - "type": "boolean", - "readOnly": true - }, - "metadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "memberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "attributes": { - "$ref": "#/components/schemas/EventAttributes" - }, - "isSpecialName": { - "type": "boolean", - "readOnly": true - }, - "addMethod": { - "$ref": "#/components/schemas/MethodInfo" - }, - "removeMethod": { - "$ref": "#/components/schemas/MethodInfo" - }, - "raiseMethod": { - "$ref": "#/components/schemas/MethodInfo" - }, - "isMulticast": { - "type": "boolean", - "readOnly": true - }, - "eventHandlerType": { - "$ref": "#/components/schemas/Type" - } - }, - "additionalProperties": false + "description": "Possible value types" }, "Exception": { "type": "object", @@ -8870,38 +9215,43 @@ "$ref": "#/components/schemas/MethodBase" }, "message": { - "type": "string", - "nullable": true, - "readOnly": true + "type": [ + "null", + "string" + ] }, "data": { - "type": "object", - "additionalProperties": {}, - "nullable": true, - "readOnly": true + "type": [ + "null", + "object" + ] }, "innerException": { "$ref": "#/components/schemas/Exception" }, "helpLink": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "source": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "hResult": { "type": "integer", "format": "int32" }, "stackTrace": { - "type": "string", - "nullable": true, - "readOnly": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "ExecuteSetupRequest": { "type": "object", @@ -8912,37 +9262,45 @@ "setup": { "$ref": "#/components/schemas/SetupModel" } - }, - "additionalProperties": false + } }, "ExtendedOperatorModel": { "type": "object", "properties": { + "assignedResources": { + "type": [ + "null", + "array" + ], + "items": { + "$ref": "#/components/schemas/AttendableResourceModel" + } + }, "identifier": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "firstName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "lastName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "pseudonym": { - "type": "string", - "nullable": true - }, - "assignedResources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttendableResourceModel" - }, - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "FactoryModel": { "type": "object", @@ -8956,211 +9314,128 @@ "format": "int64" }, "backgroundURL": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "title": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "FactoryStateModel": { "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "location": { - "$ref": "#/components/schemas/CellLocationModel" - }, - "iconName": { - "type": "string", - "nullable": true - }, - "isACell": { - "type": "boolean" - }, "backgroundURL": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "hasManufacturingFactory": { "type": "boolean" }, "orderModels": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/OrderModel" - }, - "nullable": true + } }, "activityChangedModels": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/ActivityChangedModel" - }, - "nullable": true + } }, "cellStateChangedModels": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/CellStateChangedModel" - }, - "nullable": true + } }, "resourceChangedModels": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/ResourceChangedModel" - }, - "nullable": true + } + }, + "id": { + "type": "integer", + "format": "int64" + }, + "location": { + "$ref": "#/components/schemas/CellLocationModel" + }, + "iconName": { + "type": [ + "null", + "string" + ] + }, + "isACell": { + "type": "boolean" } - }, - "additionalProperties": false + } }, "FailureBehaviour": { - "enum": [ - "Stop", - "StopAndNotify" - ], - "type": "string" - }, - "FieldAttributes": { - "enum": [ - "PrivateScope", - "Private", - "FamANDAssem", - "Assembly", - "Family", - "FamORAssem", - "Public", - "FieldAccessMask", - "Static", - "InitOnly", - "Literal", - "NotSerialized", - "HasFieldRVA", - "SpecialName", - "RTSpecialName", - "HasFieldMarshal", - "PinvokeImpl", - "HasDefault", - "ReservedMask" - ], - "type": "string" + "type": "string", + "description": "Enum flags: Notify - Reincarnate" }, - "FieldInfo": { + "FileStreamResult": { "type": "object", "properties": { - "name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "declaringType": { - "$ref": "#/components/schemas/Type" - }, - "reflectedType": { - "$ref": "#/components/schemas/Type" - }, - "module": { - "$ref": "#/components/schemas/Module" - }, - "customAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "isCollectible": { - "type": "boolean", - "readOnly": true - }, - "metadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "memberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "attributes": { - "$ref": "#/components/schemas/FieldAttributes" - }, - "fieldType": { - "$ref": "#/components/schemas/Type" - }, - "isInitOnly": { - "type": "boolean", - "readOnly": true + "fileStream": { + "$ref": "#/components/schemas/Stream" }, - "isLiteral": { - "type": "boolean", - "readOnly": true - }, - "isNotSerialized": { - "type": "boolean", - "readOnly": true, - "deprecated": true - }, - "isPinvokeImpl": { - "type": "boolean", - "readOnly": true - }, - "isSpecialName": { - "type": "boolean", - "readOnly": true - }, - "isStatic": { - "type": "boolean", - "readOnly": true - }, - "isAssembly": { - "type": "boolean", - "readOnly": true - }, - "isFamily": { - "type": "boolean", - "readOnly": true - }, - "isFamilyAndAssembly": { - "type": "boolean", - "readOnly": true - }, - "isFamilyOrAssembly": { - "type": "boolean", - "readOnly": true - }, - "isPrivate": { - "type": "boolean", - "readOnly": true - }, - "isPublic": { - "type": "boolean", - "readOnly": true - }, - "isSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "isSecuritySafeCritical": { - "type": "boolean", - "readOnly": true + "contentType": { + "type": [ + "null", + "string" + ] + }, + "fileDownloadName": { + "type": [ + "null", + "string" + ] + }, + "lastModified": { + "type": [ + "null", + "string" + ], + "format": "date-time" }, - "isSecurityTransparent": { - "type": "boolean", - "readOnly": true + "entityTag": { + "oneOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/EntityTagHeaderValue" + } + ] }, - "fieldHandle": { - "$ref": "#/components/schemas/RuntimeFieldHandle" + "enableRangeProcessing": { + "type": "boolean" } - }, - "additionalProperties": false + } }, "Foo": { "type": "object", @@ -9169,84 +9444,49 @@ "type": "integer", "format": "int32" } - }, - "additionalProperties": false - }, - "GenericParameterAttributes": { - "enum": [ - "None", - "Covariant", - "Contravariant", - "VarianceMask", - "ReferenceTypeConstraint", - "NotNullableValueTypeConstraint", - "DefaultConstructorConstraint", - "SpecialConstraintMask", - "AllowByRefLike" - ], - "type": "string" + } }, "HostInformationResponse": { "type": "object", "properties": { "machineName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "osInformation": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "upTime": { "type": "integer", "format": "int64" } - }, - "additionalProperties": false + } }, "ICapabilities": { "type": "object", "properties": { "isCombined": { "type": "boolean", - "readOnly": true + "description": "Flag if the capabilities of this instance are implemented by sub instances" } }, - "additionalProperties": false + "description": "Common capabilities interface" }, - "ICustomAttributeProvider": { - "type": "object", - "additionalProperties": false - }, - "IOperatorAssignable": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "capabilities": { - "$ref": "#/components/schemas/ICapabilities" - }, - "requiredSkills": { - "$ref": "#/components/schemas/ICapabilities" - } - }, - "additionalProperties": false + "IFormFile": { + "type": "string", + "format": "binary" }, "InstructionContentType": { "enum": [ "Unknown", "Text", "Media" - ], - "type": "string" + ] }, "InstructionItemModel": { "type": "object", @@ -9255,15 +9495,18 @@ "$ref": "#/components/schemas/InstructionContentType" }, "content": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "preview": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "InstructionModel": { "type": "object", @@ -9273,31 +9516,36 @@ "format": "int64" }, "sender": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "type": { "$ref": "#/components/schemas/InstructionType" }, "items": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/InstructionItemModel" - }, - "nullable": true + } }, "inputs": { "$ref": "#/components/schemas/Entry" }, "results": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/InstructionResultModel" - }, - "nullable": true + } } - }, - "additionalProperties": false + } }, "InstructionResponseModel": { "type": "object", @@ -9310,39 +9558,38 @@ "$ref": "#/components/schemas/Entry" }, "result": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "selectedResult": { "$ref": "#/components/schemas/InstructionResultModel" } - }, - "additionalProperties": false + } }, "InstructionResultModel": { "type": "object", "properties": { "key": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "displayValue": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "InstructionType": { "enum": [ "Display", "Execute" - ], - "type": "string" - }, - "IntPtr": { - "type": "object", - "additionalProperties": false + ] }, "InternalOperationClassification": { "enum": [ @@ -9356,8 +9603,7 @@ "Interrupted", "Completed", "AmountReached" - ], - "type": "string" + ] }, "InvocationResponse": { "type": "object", @@ -9366,15 +9612,42 @@ "type": "boolean" }, "exceptionType": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "errorMessage": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } + }, + "IOperatorAssignable": { + "type": "object", + "properties": { + "requiredSkills": { + "$ref": "#/components/schemas/ICapabilities" + }, + "id": { + "type": "integer", + "description": "Id of the resource", + "format": "int64" + }, + "name": { + "type": [ + "null", + "string" + ], + "description": "Name of this resource instance" + }, + "capabilities": { + "description": "The resource's capabilities", + "$ref": "#/components/schemas/ICapabilities" + } + } }, "JobModel": { "type": "object", @@ -9388,16 +9661,22 @@ "format": "int64" }, "state": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "displayState": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "workplan": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "canComplete": { "type": "boolean" @@ -9417,8 +9696,7 @@ "setupJob": { "$ref": "#/components/schemas/SetupJobModel" } - }, - "additionalProperties": false + } }, "JobProcessModel": { "type": "object", @@ -9446,25 +9724,18 @@ "format": "date-time" }, "activities": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/ProcessActivityModel" - }, - "nullable": true + } }, "isRunning": { "type": "boolean" } - }, - "additionalProperties": false - }, - "LayoutKind": { - "enum": [ - "Sequential", - "Explicit", - "Auto" - ], - "type": "string" + } }, "LogLevel": { "enum": [ @@ -9475,409 +9746,47 @@ "Error", "Critical", "None" - ], - "type": "string" + ] }, - "MemberInfo": { + "MethodBase": { }, + "MethodEntry": { "type": "object", "properties": { - "memberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "declaringType": { - "$ref": "#/components/schemas/Type" - }, - "reflectedType": { - "$ref": "#/components/schemas/Type" - }, - "module": { - "$ref": "#/components/schemas/Module" - }, - "customAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "isCollectible": { - "type": "boolean", - "readOnly": true - }, - "metadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - } - }, - "additionalProperties": false - }, - "MemberTypes": { - "enum": [ - "Constructor", - "Event", - "Field", - "Method", - "Property", - "TypeInfo", - "Custom", - "NestedType", - "All" - ], - "type": "string" - }, - "MethodAttributes": { - "enum": [ - "PrivateScope", - "Private", - "FamANDAssem", - "Assembly", - "Family", - "FamORAssem", - "Public", - "MemberAccessMask", - "UnmanagedExport", - "Static", - "Final", - "Virtual", - "HideBySig", - "NewSlot", - "CheckAccessOnOverride", - "Abstract", - "SpecialName", - "RTSpecialName", - "PinvokeImpl", - "HasSecurity", - "RequireSecObject", - "ReservedMask" - ], - "type": "string" - }, - "MethodBase": { - "type": "object", - "properties": { - "memberType": { - "$ref": "#/components/schemas/MemberTypes" - }, "name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "declaringType": { - "$ref": "#/components/schemas/Type" - }, - "reflectedType": { - "$ref": "#/components/schemas/Type" - }, - "module": { - "$ref": "#/components/schemas/Module" - }, - "customAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "isCollectible": { - "type": "boolean", - "readOnly": true - }, - "metadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "attributes": { - "$ref": "#/components/schemas/MethodAttributes" - }, - "methodImplementationFlags": { - "$ref": "#/components/schemas/MethodImplAttributes" - }, - "callingConvention": { - "$ref": "#/components/schemas/CallingConventions" - }, - "isAbstract": { - "type": "boolean", - "readOnly": true + "type": [ + "null", + "string" + ], + "description": "Name of the method" }, "isConstructor": { "type": "boolean", - "readOnly": true - }, - "isFinal": { - "type": "boolean", - "readOnly": true - }, - "isHideBySig": { - "type": "boolean", - "readOnly": true - }, - "isSpecialName": { - "type": "boolean", - "readOnly": true - }, - "isStatic": { - "type": "boolean", - "readOnly": true - }, - "isVirtual": { - "type": "boolean", - "readOnly": true - }, - "isAssembly": { - "type": "boolean", - "readOnly": true - }, - "isFamily": { - "type": "boolean", - "readOnly": true - }, - "isFamilyAndAssembly": { - "type": "boolean", - "readOnly": true - }, - "isFamilyOrAssembly": { - "type": "boolean", - "readOnly": true - }, - "isPrivate": { - "type": "boolean", - "readOnly": true - }, - "isPublic": { - "type": "boolean", - "readOnly": true - }, - "isConstructedGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "isGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "isGenericMethodDefinition": { - "type": "boolean", - "readOnly": true - }, - "containsGenericParameters": { - "type": "boolean", - "readOnly": true - }, - "methodHandle": { - "$ref": "#/components/schemas/RuntimeMethodHandle" - }, - "isSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "isSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "isSecurityTransparent": { - "type": "boolean", - "readOnly": true - } - }, - "additionalProperties": false - }, - "MethodEntry": { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "isConstructor": { - "type": "boolean" + "description": "Flag if this structure represents a server side constructor" }, "displayName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Display name for the button" }, "description": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Description of the method" }, "parameters": { + "description": "Arguments of the", "$ref": "#/components/schemas/Entry" }, "isAsync": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "MethodImplAttributes": { - "enum": [ - "IL", - "Native", - "OPTIL", - "CodeTypeMask", - "ManagedMask", - "NoInlining", - "ForwardRef", - "Synchronized", - "NoOptimization", - "PreserveSig", - "AggressiveInlining", - "AggressiveOptimization", - "InternalCall", - "Async", - "MaxMethodImplVal" - ], - "type": "string" - }, - "MethodInfo": { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "declaringType": { - "$ref": "#/components/schemas/Type" - }, - "reflectedType": { - "$ref": "#/components/schemas/Type" - }, - "module": { - "$ref": "#/components/schemas/Module" - }, - "customAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "isCollectible": { - "type": "boolean", - "readOnly": true - }, - "metadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "attributes": { - "$ref": "#/components/schemas/MethodAttributes" - }, - "methodImplementationFlags": { - "$ref": "#/components/schemas/MethodImplAttributes" - }, - "callingConvention": { - "$ref": "#/components/schemas/CallingConventions" - }, - "isAbstract": { - "type": "boolean", - "readOnly": true - }, - "isConstructor": { - "type": "boolean", - "readOnly": true - }, - "isFinal": { "type": "boolean", - "readOnly": true - }, - "isHideBySig": { - "type": "boolean", - "readOnly": true - }, - "isSpecialName": { - "type": "boolean", - "readOnly": true - }, - "isStatic": { - "type": "boolean", - "readOnly": true - }, - "isVirtual": { - "type": "boolean", - "readOnly": true - }, - "isAssembly": { - "type": "boolean", - "readOnly": true - }, - "isFamily": { - "type": "boolean", - "readOnly": true - }, - "isFamilyAndAssembly": { - "type": "boolean", - "readOnly": true - }, - "isFamilyOrAssembly": { - "type": "boolean", - "readOnly": true - }, - "isPrivate": { - "type": "boolean", - "readOnly": true - }, - "isPublic": { - "type": "boolean", - "readOnly": true - }, - "isConstructedGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "isGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "isGenericMethodDefinition": { - "type": "boolean", - "readOnly": true - }, - "containsGenericParameters": { - "type": "boolean", - "readOnly": true - }, - "methodHandle": { - "$ref": "#/components/schemas/RuntimeMethodHandle" - }, - "isSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "isSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "isSecurityTransparent": { - "type": "boolean", - "readOnly": true - }, - "memberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "returnParameter": { - "$ref": "#/components/schemas/ParameterInfo" - }, - "returnType": { - "$ref": "#/components/schemas/Type" - }, - "returnTypeCustomAttributes": { - "$ref": "#/components/schemas/ICustomAttributeProvider" + "description": "True if the method is awaitable by Task" } }, - "additionalProperties": false + "description": "Model that represents a public method on an object callable from the UI" }, "MigrationResult": { "enum": [ @@ -9885,97 +9794,42 @@ "NoMigrationsAvailable", "Error" ], - "type": "string" + "description": "Result enum for executing database migrations" }, "ModelConfiguratorModel": { "type": "object", "properties": { "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "configuratorType": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "connectionStringKeys": { - "type": "object", + "type": [ + "null", + "object" + ], "additionalProperties": { - "type": "string", - "nullable": true - }, - "nullable": true + "type": "string" + } }, "connectionStringPrototype": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "configPrototype": { "$ref": "#/components/schemas/Entry" } - }, - "additionalProperties": false - }, - "Module": { - "type": "object", - "properties": { - "assembly": { - "$ref": "#/components/schemas/Assembly" - }, - "fullyQualifiedName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "mdStreamVersion": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "moduleVersionId": { - "type": "string", - "format": "uuid", - "readOnly": true - }, - "scopeName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "moduleHandle": { - "$ref": "#/components/schemas/ModuleHandle" - }, - "customAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "metadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - } - }, - "additionalProperties": false - }, - "ModuleHandle": { - "type": "object", - "properties": { - "mdStreamVersion": { - "type": "integer", - "format": "int32", - "readOnly": true - } - }, - "additionalProperties": false + } }, "ModuleNotificationModel": { "type": "object", @@ -9988,14 +9842,15 @@ "$ref": "#/components/schemas/SerializableException" }, "message": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "severity": { "$ref": "#/components/schemas/Severity" } - }, - "additionalProperties": false + } }, "ModuleStartBehaviour": { "enum": [ @@ -10003,21 +9858,24 @@ "Manual", "OnDependency" ], - "type": "string" + "description": "Start behaviour" }, "MoryxExceptionResponse": { "type": "object", "properties": { "title": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "exception": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "NodeConnectionPoint": { "type": "object", @@ -10027,18 +9885,21 @@ "format": "int32" }, "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "connections": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/NodeConnector" - }, - "nullable": true + } } - }, - "additionalProperties": false + } }, "NodeConnector": { "type": "object", @@ -10051,8 +9912,7 @@ "type": "integer", "format": "int32" } - }, - "additionalProperties": false + } }, "NotificationModel": { "type": "object", @@ -10062,16 +9922,22 @@ "format": "uuid" }, "type": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "title": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "message": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "severity": { "$ref": "#/components/schemas/Severity" @@ -10081,9 +9947,11 @@ "format": "date-time" }, "acknowledged": { - "type": "string", - "format": "date-time", - "nullable": true + "type": [ + "null", + "string" + ], + "format": "date-time" }, "isAcknowledgable": { "type": "boolean" @@ -10092,15 +9960,18 @@ "$ref": "#/components/schemas/Entry" }, "sender": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "source": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "OpenSessionRequest": { "type": "object", @@ -10112,115 +9983,132 @@ "duplicate": { "type": "boolean" } - }, - "additionalProperties": false + } }, "OperationAdvicedModel": { "type": "object", "properties": { - "operationModel": { - "$ref": "#/components/schemas/OperationModel" - }, "advice": { "$ref": "#/components/schemas/AdviceModel" - } - }, - "additionalProperties": false - }, - "OperationChangedModel": { - "type": "object", - "properties": { - "startedModel": { - "$ref": "#/components/schemas/OperationStartedModel" - }, - "reportedModel": { - "$ref": "#/components/schemas/OperationReportedModel" }, - "advicedModel": { - "$ref": "#/components/schemas/OperationAdvicedModel" + "operationModel": { + "$ref": "#/components/schemas/OperationModel" } - }, - "additionalProperties": false + } }, "OperationCreationContextModel": { "type": "object", "properties": { "totalAmount": { "type": "integer", + "description": "The amount to produce", "format": "int32" }, "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Operation name" }, "orderNumber": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "The number of the order this operation belongs to" }, "operationNumber": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "The number of this operation" }, "productIdentifier": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Main product identifier" }, "productRevision": { "type": "integer", - "format": "int32" + "description": "Revision of the Product", + "format": "int16" }, "productName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Name of the Product" }, "recipePreselection": { "type": "integer", + "description": "Id of the preselected recipe", "format": "int64" }, "overDeliveryAmount": { "type": "integer", + "description": "Total amount planned for over delivery", "format": "int32" }, "underDeliveryAmount": { "type": "integer", + "description": "Total amount planned for under delivery", "format": "int32" }, "plannedStart": { "type": "string", + "description": "Expected start time", "format": "date-time" }, "plannedEnd": { "type": "string", + "description": "Expected end time", "format": "date-time" }, "targetCycleTime": { "type": "number", + "description": "Target cycle time for the production of the depending product", "format": "double" }, "unit": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Unit of product" }, "targetStock": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Target stock for produced parts" }, "parts": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/PartCreationContext" }, - "nullable": true + "description": "Part list of the product of this operation" }, "materialParameters": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/Entry" }, - "nullable": true + "description": "Additional operation depending parameters for the production" } - }, - "additionalProperties": false + } }, "OperationLogMessageModel": { "type": "object", @@ -10229,19 +10117,22 @@ "$ref": "#/components/schemas/LogLevel" }, "message": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "exception": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "timeStamp": { "type": "string", "format": "date-time" } - }, - "additionalProperties": false + } }, "OperationModel": { "type": "object", @@ -10255,12 +10146,16 @@ "format": "int32" }, "number": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "overDeliveryAmount": { "type": "integer", @@ -10279,73 +10174,93 @@ "format": "date-time" }, "start": { - "type": "string", - "format": "date-time", - "nullable": true + "type": [ + "null", + "string" + ], + "format": "date-time" }, "end": { - "type": "string", - "format": "date-time", - "nullable": true + "type": [ + "null", + "string" + ], + "format": "date-time" }, "targetCycleTime": { "type": "number", "format": "double" }, "unit": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "sortOrder": { "type": "integer", "format": "int32" }, "order": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "classification": { "$ref": "#/components/schemas/OperationStateClassification" }, "stateDisplayName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "productId": { "type": "integer", "format": "int64" }, "productIdentifier": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "productRevision": { "type": "integer", - "format": "int32" + "format": "int16" }, "productName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "recipeName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "recipeIds": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "type": "integer", "format": "int64" - }, - "nullable": true + } }, "jobIds": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "type": "integer", "format": "int64" - }, - "nullable": true + } }, "reportedSuccessCount": { "type": "integer", @@ -10427,7 +10342,7 @@ "$ref": "#/components/schemas/Entry" } }, - "additionalProperties": false + "description": "OrderOperation-DTO to be used with the endpoints" }, "OperationRecipeModel": { "type": "object", @@ -10437,261 +10352,193 @@ "format": "int64" }, "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "OperationReportedModel": { "type": "object", "properties": { - "operationModel": { - "$ref": "#/components/schemas/OperationModel" - }, "report": { "$ref": "#/components/schemas/ReportModel" + }, + "operationModel": { + "$ref": "#/components/schemas/OperationModel" } - }, - "additionalProperties": false + } }, "OperationStartedModel": { "type": "object", "properties": { + "userId": { + "type": [ + "null", + "string" + ] + }, "operationModel": { "$ref": "#/components/schemas/OperationModel" - }, - "userId": { - "type": "string", - "nullable": true } - }, - "additionalProperties": false + } }, "OperationStateClassification": { - "enum": [ - "Initial", - "Assigning", - "Failed", - "Aborted", - "Ready", - "Running", - "Interrupting", - "Interrupted", - "Completed", - "CanReload", - "CanBegin", - "CanInterrupt", - "CanReport", - "CanAdvice", - "IsAmountReached" - ], - "type": "string" + "type": "string", + "description": "Enum providing the classification of the internal state machine of the operation for an external representation\r\nThe lowest 8 bits define the state of the operation. The following 16 bits contain flags for the executable\r\nactions on the operation and the trailing 8 bits overall classification information.\r\nBit: 31 - 24 | 23 - 8 | 7 - 0 |\r\nFlag: Overall | Usage | State |" }, "OperationUpdateModel": { "type": "object", "properties": { "sortIndex": { - "type": "integer", - "format": "int32", - "nullable": true + "type": [ + "null", + "integer" + ], + "format": "int32" }, "plannedStart": { - "type": "string", - "format": "date-time", - "nullable": true + "type": [ + "null", + "string" + ], + "format": "date-time" }, "plannedEnd": { - "type": "string", - "format": "date-time", - "nullable": true + "type": [ + "null", + "string" + ], + "format": "date-time" }, "totalAmount": { - "type": "integer", - "format": "int32", - "nullable": true + "type": [ + "null", + "integer" + ], + "format": "int32" }, "overDeliveryAmount": { - "type": "integer", - "format": "int32", - "nullable": true + "type": [ + "null", + "integer" + ], + "format": "int32" }, "underDeliveryAmount": { - "type": "integer", - "format": "int32", - "nullable": true + "type": [ + "null", + "integer" + ], + "format": "int32" }, "targetCycleTime": { - "type": "number", - "format": "double", - "nullable": true + "type": [ + "null", + "number" + ], + "format": "double" }, "targetStock": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "OperatorModel": { "type": "object", "properties": { "identifier": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "firstName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "lastName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "pseudonym": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "OrderChangedModel": { "type": "object", "properties": { "order": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "operation": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "state": { "$ref": "#/components/schemas/InternalOperationClassification" } - }, - "additionalProperties": false + } }, "OrderModel": { "type": "object", "properties": { + "color": { + "type": [ + "null", + "string" + ] + }, "order": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "operation": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "state": { "$ref": "#/components/schemas/InternalOperationClassification" - }, - "color": { - "type": "string", - "nullable": true } - }, - "additionalProperties": false + } }, "OrderReferenceModel": { "type": "object", "properties": { "order": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "operation": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, - "ParameterAttributes": { - "enum": [ - "None", - "In", - "Out", - "Lcid", - "Retval", - "Optional", - "HasDefault", - "HasFieldMarshal", - "Reserved3", - "Reserved4", - "ReservedMask" - ], - "type": "string" - }, - "ParameterInfo": { - "type": "object", - "properties": { - "attributes": { - "$ref": "#/components/schemas/ParameterAttributes" - }, - "member": { - "$ref": "#/components/schemas/MemberInfo" - }, - "name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "parameterType": { - "$ref": "#/components/schemas/Type" - }, - "position": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "isIn": { - "type": "boolean", - "readOnly": true - }, - "isLcid": { - "type": "boolean", - "readOnly": true - }, - "isOptional": { - "type": "boolean", - "readOnly": true - }, - "isOut": { - "type": "boolean", - "readOnly": true - }, - "isRetval": { - "type": "boolean", - "readOnly": true - }, - "defaultValue": { - "nullable": true, - "readOnly": true - }, - "rawDefaultValue": { - "nullable": true, - "readOnly": true - }, - "hasDefaultValue": { - "type": "boolean", - "readOnly": true - }, - "customAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "metadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "PartClassification": { "enum": [ @@ -10701,67 +10548,85 @@ "CarrierMaterial", "ScrapMaterial", "BranchMaterial" - ], - "type": "string" + ] }, "PartConnector": { "type": "object", "properties": { "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "displayName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "type": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "isCollection": { "type": "boolean" }, "parts": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/PartModel" - }, - "nullable": true + } }, "propertyTemplates": { "$ref": "#/components/schemas/Entry" } - }, - "additionalProperties": false + } }, "PartCreationContext": { "type": "object", "properties": { "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Name of the part like the product name" }, "number": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Identifier of this part" }, "quantity": { "type": "number", + "description": "Quantity of this part which are necessary to produce one product", "format": "double" }, "unit": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Unit of the quantity" }, "stagingIndicator": { + "description": "Staging indicator", "$ref": "#/components/schemas/StagingIndicator" }, "classification": { + "description": "Classification of this part", "$ref": "#/components/schemas/PartClassification" } }, - "additionalProperties": false + "description": "Information about a part of the product which should be produced for an operation" }, "PartModel": { "type": "object", @@ -10776,8 +10641,7 @@ "product": { "$ref": "#/components/schemas/ProductModel" } - }, - "additionalProperties": false + } }, "Position": { "type": "object", @@ -10790,33 +10654,39 @@ "type": "number", "format": "double" } - }, - "additionalProperties": false + } }, "PreviewDescriptor": { "type": "object", "properties": { + "state": { + "description": "Current state of the preview", + "$ref": "#/components/schemas/PreviewState" + }, "fileHash": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "extension": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "mimeType": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "size": { "type": "integer", "format": "int64" - }, - "state": { - "$ref": "#/components/schemas/PreviewState" } }, - "additionalProperties": false + "description": "Descriptor for an preview" }, "PreviewState": { "enum": [ @@ -10826,34 +10696,43 @@ "Unsupported", "Removed" ], - "type": "string" + "description": "State of the preview" }, "ProblemDetails": { "type": "object", "properties": { "type": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "title": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "status": { - "type": "integer", - "format": "int32", - "nullable": true + "type": [ + "null", + "integer" + ], + "format": "int32" }, "detail": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "instance": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": {} + } }, "ProcessActivityModel": { "type": "object", @@ -10866,40 +10745,54 @@ "$ref": "#/components/schemas/ActivityResourceModel" }, "type": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "state": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "classification": { "$ref": "#/components/schemas/ActivityClassification" }, "requiredCapabilities": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "possibleResources": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/ActivityResourceModel" - }, - "nullable": true + } }, "result": { - "type": "integer", - "format": "int64", - "nullable": true + "type": [ + "null", + "integer" + ], + "format": "int64" }, "resultName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "instanceId": { - "type": "integer", - "format": "int64", - "nullable": true + "type": [ + "null", + "integer" + ], + "format": "int64" }, "tracing": { "$ref": "#/components/schemas/TracingModel" @@ -10907,8 +10800,7 @@ "isCompleted": { "type": "boolean" } - }, - "additionalProperties": false + } }, "ProcessHolderGroupModel": { "type": "object", @@ -10918,55 +10810,27 @@ "format": "int64" }, "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "isEmpty": { - "type": "boolean", - "readOnly": true + "type": "boolean" }, "positions": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/ProcessHolderPositionModel" - }, - "nullable": true + } }, "visualization": { "$ref": "#/components/schemas/VisualizationModel" } - }, - "additionalProperties": false - }, - "ProcessHolderGroupModelArrayApiResponse": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProcessHolderGroupModel" - }, - "nullable": true - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApiError" - }, - "nullable": true, - "readOnly": true - }, - "succeeded": { - "type": "boolean", - "readOnly": true - }, - "timestamp": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "additionalProperties": false + } }, "ProcessHolderPositionModel": { "type": "object", @@ -10980,30 +10844,37 @@ "format": "int64" }, "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "position": { "type": "integer", "format": "int32" }, "activity": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "order": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "process": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "isEmpty": { "type": "boolean" } - }, - "additionalProperties": false + } }, "ProcessProgress": { "enum": [ @@ -11012,68 +10883,79 @@ "Interrupted", "Completed" ], - "type": "string" + "description": "Enum representing the progress of a process within the kernel" }, "ProductCustomization": { "type": "object", "properties": { "productTypes": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/ProductDefinitionModel" - }, - "nullable": true + } }, "recipeTypes": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/RecipeDefinitionModel" - }, - "nullable": true + } }, "importers": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/ProductImporter" - }, - "nullable": true + } } - }, - "additionalProperties": false + } }, "ProductDefinitionModel": { "type": "object", "properties": { "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "displayName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "baseDefinition": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "properties": { "$ref": "#/components/schemas/Entry" } - }, - "additionalProperties": false + } }, "ProductImporter": { "type": "object", "properties": { "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "parameters": { "$ref": "#/components/schemas/Entry" } - }, - "additionalProperties": false + } }, "ProductInstanceModel": { "type": "object", @@ -11083,73 +10965,110 @@ "format": "int64" }, "type": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "The name of the product type of this instance" }, "state": { + "description": "The current state of the instance", "$ref": "#/components/schemas/ProductInstanceState" }, "properties": { "$ref": "#/components/schemas/Entry" } - }, - "additionalProperties": false + } }, "ProductInstanceState": { - "enum": [ - "Unset", - "InProduction", - "Paused", - "Success", - "Failure" - ], - "type": "string" + "type": "string", + "description": "The state of an ProductInstance.\r\nThis will not occupy more than 4 Bits. Other enums can be added by bit-shifting" }, - "ProductModel": { + "ProductionJobModel": { "type": "object", "properties": { - "id": { + "productIdentity": { + "type": [ + "null", + "string" + ] + }, + "amount": { "type": "integer", - "format": "int64" + "format": "int32" + }, + "successCount": { + "type": "integer", + "format": "int32" + }, + "failureCount": { + "type": "integer", + "format": "int32" + }, + "runningCount": { + "type": "integer", + "format": "int32" + }, + "reworkedCount": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" }, "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "state": { "$ref": "#/components/schemas/ProductState" }, "identifier": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "revision": { "type": "integer", - "format": "int32" + "format": "int16" }, "type": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "properties": { "$ref": "#/components/schemas/Entry" }, "parts": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/PartConnector" - }, - "nullable": true + } }, "recipes": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/RecipeModel" - }, - "nullable": true + } } - }, - "additionalProperties": false + } }, "ProductPartModel": { "type": "object", @@ -11159,20 +11078,26 @@ "format": "int64" }, "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "identifier": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "quantity": { "type": "number", "format": "double" }, "unit": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "stagingIndicator": { "$ref": "#/components/schemas/StagingIndicator" @@ -11180,122 +11105,102 @@ "classification": { "$ref": "#/components/schemas/PartClassification" } - }, - "additionalProperties": false + } }, "ProductQuery": { "type": "object", "properties": { "includeDeleted": { - "type": "boolean" + "type": "boolean", + "description": "Flag if deleted products should be included in the query" }, "typeName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Product types to filter by" }, "excludeDerivedTypes": { - "type": "boolean" + "type": "boolean", + "description": "When filtering by type exclude derived types and only return specific matches" }, "identifier": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Material identifiers" }, "requiredState": { - "$ref": "#/components/schemas/ProductState" + "oneOf": [ + { + "type": "null" + }, + { + "description": "State of the product", + "$ref": "#/components/schemas/ProductState" + } + ] }, "revisionFilter": { + "description": "Revisions to filter", "$ref": "#/components/schemas/RevisionFilter" }, "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Material identifiers" }, "revision": { "type": "integer", - "format": "int32" + "description": "Optional specific revision if RevisionFilter ProductQuery.RevisionFilter is set to\r\nRevisionFilter.Specific", + "format": "int16" }, "recipeFilter": { + "description": "Optional recipe filter", "$ref": "#/components/schemas/RecipeFilter" }, "selector": { + "description": "Selector", "$ref": "#/components/schemas/Selector" }, "propertyFilters": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/PropertyFilter" }, - "nullable": true + "description": "List of property filters" }, "loadFullTypeInformation": { - "type": "boolean" + "type": "boolean", + "description": "If set to true, product queries return fully populated product types.\r\nOtherwise only the basic type information is returned." } }, - "additionalProperties": false + "description": "Filter to fetch products from the product management" }, "ProductState": { - "enum": [ - "Created", - "Released", - "Deprecated", - "Generated" - ], - "type": "string" - }, - "ProductionJobModel": { - "type": "object", - "properties": { - "productIdentity": { - "type": "string", - "nullable": true - }, - "amount": { - "type": "integer", - "format": "int32" - }, - "successCount": { - "type": "integer", - "format": "int32" - }, - "failureCount": { - "type": "integer", - "format": "int32" - }, - "runningCount": { - "type": "integer", - "format": "int32" - }, - "reworkedCount": { - "type": "integer", - "format": "int32" - } - }, - "additionalProperties": false - }, - "PropertyAttributes": { - "enum": [ - "None", - "SpecialName", - "RTSpecialName", - "HasDefault", - "Reserved2", - "Reserved3", - "Reserved4", - "ReservedMask" - ], - "type": "string" + "type": "string", + "description": "Current state of a product" }, "PropertyFilter": { "type": "object", "properties": { "entry": { + "description": "Entry to filter", "$ref": "#/components/schemas/Entry" }, "operator": { + "description": "Operator for the filter expression", "$ref": "#/components/schemas/PropertyFilterOperator" } }, - "additionalProperties": false + "description": "Property filter wrapper for the filtered entry" }, "PropertyFilterOperator": { "enum": [ @@ -11303,71 +11208,7 @@ "GreaterThen", "LessThen" ], - "type": "string" - }, - "PropertyInfo": { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "declaringType": { - "$ref": "#/components/schemas/Type" - }, - "reflectedType": { - "$ref": "#/components/schemas/Type" - }, - "module": { - "$ref": "#/components/schemas/Module" - }, - "customAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "isCollectible": { - "type": "boolean", - "readOnly": true - }, - "metadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "memberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "propertyType": { - "$ref": "#/components/schemas/Type" - }, - "attributes": { - "$ref": "#/components/schemas/PropertyAttributes" - }, - "isSpecialName": { - "type": "boolean", - "readOnly": true - }, - "canRead": { - "type": "boolean", - "readOnly": true - }, - "canWrite": { - "type": "boolean", - "readOnly": true - }, - "getMethod": { - "$ref": "#/components/schemas/MethodInfo" - }, - "setMethod": { - "$ref": "#/components/schemas/MethodInfo" - } - }, - "additionalProperties": false + "description": "Property filter operator expression" }, "RecipeClassificationModel": { "enum": [ @@ -11377,24 +11218,27 @@ "Intermediate", "Part" ], - "type": "string" + "description": "Webservice compatible recipe classification enum" }, "RecipeDefinitionModel": { "type": "object", "properties": { "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "displayName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "hasWorkplans": { "type": "boolean" } - }, - "additionalProperties": false + } }, "RecipeFilter": { "enum": [ @@ -11402,44 +11246,57 @@ "WithRecipe", "WithoutRecipes" ], - "type": "string" + "description": "Different options regarding the recipes of the product" }, "RecipeModel": { "type": "object", "properties": { "id": { "type": "integer", + "description": "Id of the recipe", "format": "int64" }, "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Name of the recipe" }, "state": { + "description": "This recipe's state", "$ref": "#/components/schemas/RecipeState" }, "revision": { "type": "integer", + "description": "Revision of the recipe", "format": "int32" }, "type": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Type of the recipe" }, "properties": { + "description": "Properties of the recipe", "$ref": "#/components/schemas/Entry" }, "workplanModel": { + "description": "A model of the currently referenced workplan", "$ref": "#/components/schemas/WorkplanModel" }, "classification": { + "description": "Classification of the recipe", "$ref": "#/components/schemas/RecipeClassificationModel" }, "isClone": { - "type": "boolean" + "type": "boolean", + "description": "Whether this Recipe is a clone or not" } }, - "additionalProperties": false + "description": "DTO representation of a recipe" }, "RecipeState": { "enum": [ @@ -11447,63 +11304,85 @@ "Released", "Revoked" ], - "type": "string" + "description": "A Recipe's state" }, "ReferenceFilter": { "type": "object", "properties": { "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Name of the reference" }, "relationType": { + "description": "Resource relation type", "$ref": "#/components/schemas/ResourceRelationType" }, "role": { + "description": "Role of the reference", "$ref": "#/components/schemas/ResourceReferenceRole" }, "valueConstraint": { + "description": "Filter criteria for the reference property", "$ref": "#/components/schemas/ReferenceValue" } }, - "additionalProperties": false + "description": "Filter criteria for required or requested references" }, "ReferenceTypeModel": { "type": "object", "properties": { "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Name of the reference, usually name of the property" }, "isCollection": { - "type": "boolean" + "type": "boolean", + "description": "Flag if this reference is a collection" }, "displayName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Display name of the reference" }, "description": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Description of this reference" }, "isRequired": { - "type": "boolean" + "type": "boolean", + "description": "Reference is required and must be set" }, "supportedTypes": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "type": "string" }, - "nullable": true + "description": "Types that can be assigned to this reference" }, "role": { + "description": "Role of the referenced resource in the relationship", "$ref": "#/components/schemas/ResourceReferenceRole" }, "relationType": { + "description": "Type of resource relation", "$ref": "#/components/schemas/ResourceRelationType" } }, - "additionalProperties": false + "description": "Type model for a reference property on a resource type" }, "ReferenceValue": { "enum": [ @@ -11511,50 +11390,61 @@ "NullOrEmpty", "NotEmpty" ], - "type": "string" + "description": "Enum to classify the current value of the reference property" }, "ReportContext": { "type": "object", "properties": { - "successCount": { - "type": "integer", - "format": "int32" - }, - "scrapCount": { - "type": "integer", - "format": "int32" - }, "canPartial": { - "type": "boolean" + "type": "boolean", + "description": "If `true` the operation can be reported partially" }, "canFinal": { - "type": "boolean" + "type": "boolean", + "description": "If `true` the operation can be reported finally" }, "reportedSuccess": { "type": "integer", + "description": "Currently reported success count", "format": "int32" }, "reportedFailure": { "type": "integer", + "description": "Currently reported failure count", "format": "int32" }, "unreportedSuccess": { "type": "integer", + "description": "Value of unreported success parts", "format": "int32" }, "unreportedFailure": { "type": "integer", + "description": "Value of unreported failure parts", "format": "int32" }, "restrictions": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/RestrictionDescription" }, - "nullable": true + "description": "Reasons why a report is not possible" + }, + "successCount": { + "type": "integer", + "description": "Current success count of the operation", + "format": "int32" + }, + "scrapCount": { + "type": "integer", + "description": "Current failure count of the operation", + "format": "int32" } }, - "additionalProperties": false + "description": "Report which is not processed." }, "ReportModel": { "type": "object", @@ -11563,8 +11453,10 @@ "$ref": "#/components/schemas/ConfirmationType" }, "comment": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "successCount": { "type": "integer", @@ -11575,36 +11467,33 @@ "format": "int32" }, "userIdentifier": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "ResourceChangedModel": { "type": "object", "properties": { - "location": { - "$ref": "#/components/schemas/CellLocationModel" - }, - "iconName": { - "type": "string", - "nullable": true - }, - "isACell": { - "type": "boolean" - }, "cellName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "cellIconName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "cellImageURL": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "id": { "type": "integer", @@ -11614,192 +11503,253 @@ "$ref": "#/components/schemas/CellLocationModel" }, "cellPropertySettings": { - "type": "object", + "type": [ + "null", + "object" + ], "additionalProperties": { "$ref": "#/components/schemas/CellPropertySettings" - }, - "nullable": true + } }, "factoryId": { "type": "integer", - "format": "int64", - "readOnly": true + "format": "int64" + }, + "location": { + "$ref": "#/components/schemas/CellLocationModel" + }, + "iconName": { + "type": [ + "null", + "string" + ] + }, + "isACell": { + "type": "boolean" } - }, - "additionalProperties": false + } }, "ResourceModel": { "type": "object", "properties": { "id": { "type": "integer", + "description": "Id of the resource.", "format": "int64" }, "referenceId": { "type": "integer", + "description": "Reference id in case of recursion in the returned model", "format": "int64" }, "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Name of the resource." }, "description": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Description of the resource" }, "type": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Resource type model reference" }, "partiallyLoaded": { - "type": "boolean" + "type": "boolean", + "description": "Indicates that this model does not represent the full\r\nresource but only its key properties" }, "properties": { + "description": "A list of configs of the resource.", "$ref": "#/components/schemas/Entry" }, "methods": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/MethodEntry" }, - "nullable": true + "description": "User callable methods for instances of this type" }, "references": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/ResourceReferenceModel" }, - "nullable": true + "description": "References of this resource, including children" } }, - "additionalProperties": false + "description": "Base model used by details view and tree" }, "ResourceQuery": { "type": "object", "properties": { "types": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "type": "string" }, - "nullable": true + "description": "Type constraints to filter instances" }, "referenceCondition": { + "description": "Reference condition to filter instances", "$ref": "#/components/schemas/ReferenceFilter" }, "referenceRecursion": { - "type": "boolean" + "type": "boolean", + "description": "Flag if included references should be processed recursively" }, "includedReferences": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/ReferenceFilter" }, - "nullable": true + "description": "References that should be included in the response" } }, - "additionalProperties": false + "description": "Filter object to fetch resources from the server" }, "ResourceReferenceModel": { "type": "object", "properties": { "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Name of the reference, usually name of the property" }, "targets": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/ResourceModel" }, - "nullable": true + "description": "Targets of this reference" } }, - "additionalProperties": false + "description": "DTO that represents the reference of one resource with another" }, "ResourceReferenceRole": { "enum": [ "Target", "Source" ], - "type": "string" + "description": "Role of a resource in a relation decorated with the ResourceReferenceAttribute" }, "ResourceRelationType": { - "enum": [ - "Unset", - "Aggregation", - "Composition", - "Usage", - "ParentChild", - "Driver", - "TransportSystem", - "TransportRoute", - "CurrentExchangeablePart", - "PossibleExchangeablePart", - "Decorated", - "Extension", - "Custom" - ], - "type": "string" + "type": "string", + "description": "Enum representing the relation between two entities and definition of their life cycle coupling.\r\nThe lowest 3 bits define the UML association type. The other 29 bits are for free use\r\nBit: 31 - 3 | 2 | 1 | 0\r\nFlag: Type | Usage | Composition | Aggregation\r\nUsage: Pick a number and bitshift it by 3 and add the UML type, e.g. 42 => (42 << 3) + 1" }, "ResourceTypeModel": { "type": "object", "properties": { "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "The name of the resource type." }, "displayName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Display name of this resource type" }, "creatable": { - "type": "boolean" + "type": "boolean", + "description": "Flag that this type is registered and can be instantiated" }, "description": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Description of this resource type" }, "constructors": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/MethodEntry" }, - "nullable": true + "description": "Resource constructors used to build new instances" }, "references": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/ReferenceTypeModel" }, - "nullable": true + "description": "Reference properties of this type" }, "baseType": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Back reference to the base type" }, "derivedTypes": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/ResourceTypeModel" }, - "nullable": true + "description": "Types derived from this type" } }, - "additionalProperties": false + "description": "Type item for the tree" }, "RestrictionDescription": { + "required": [ + "text", + "severity" + ], "type": "object", "properties": { "text": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ], + "description": "Description of the result" }, "severity": { + "description": "Severity of the result", "$ref": "#/components/schemas/RestrictionSeverity" } }, - "additionalProperties": false + "description": "Description of the result of a performed rule" }, "RestrictionSeverity": { "enum": [ @@ -11807,7 +11757,7 @@ "Warning", "Error" ], - "type": "string" + "description": "Severity of a rule result" }, "RevisionFilter": { "enum": [ @@ -11815,34 +11765,7 @@ "Latest", "Specific" ], - "type": "string" - }, - "RuntimeFieldHandle": { - "type": "object", - "properties": { - "value": { - "$ref": "#/components/schemas/IntPtr" - } - }, - "additionalProperties": false - }, - "RuntimeMethodHandle": { - "type": "object", - "properties": { - "value": { - "$ref": "#/components/schemas/IntPtr" - } - }, - "additionalProperties": false - }, - "RuntimeTypeHandle": { - "type": "object", - "properties": { - "value": { - "$ref": "#/components/schemas/IntPtr" - } - }, - "additionalProperties": false + "description": "Filter for revisions" }, "SaveConfigRequest": { "type": "object", @@ -11853,16 +11776,7 @@ "updateMode": { "$ref": "#/components/schemas/ConfigUpdateMode" } - }, - "additionalProperties": false - }, - "SecurityRuleSet": { - "enum": [ - "None", - "Level1", - "Level2" - ], - "type": "string" + } }, "Selector": { "enum": [ @@ -11870,35 +11784,42 @@ "Parent", "Parts" ], - "type": "string" + "description": "Determine which objects to select for the query" }, "SerializableException": { "type": "object", "properties": { "exceptionTypeName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "message": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "stackTrace": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "innerException": { "$ref": "#/components/schemas/SerializableException" } - }, - "additionalProperties": false + } }, "ServerModuleModel": { "type": "object", "properties": { "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "healthState": { "$ref": "#/components/schemas/ServerModuleState" @@ -11910,24 +11831,27 @@ "$ref": "#/components/schemas/FailureBehaviour" }, "dependencies": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/ServerModuleModel" - }, - "nullable": true + } }, "notifications": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/ModuleNotificationModel" - }, - "nullable": true + } }, "assembly": { "$ref": "#/components/schemas/AssemblyModel" } - }, - "additionalProperties": false + } }, "ServerModuleState": { "enum": [ @@ -11940,17 +11864,18 @@ "Running", "Stopping" ], - "type": "string" + "description": "Different health states a server module can have" }, "ServerTimeResponse": { "type": "object", "properties": { "serverTime": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "SetupJobClassification": { "enum": [ @@ -11958,8 +11883,7 @@ "Prepare", "Cleanup", "Manual" - ], - "type": "string" + ] }, "SetupJobModel": { "type": "object", @@ -11972,57 +11896,68 @@ "format": "int64" }, "steps": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/SetupStepModel" - }, - "nullable": true + } } - }, - "additionalProperties": false + } }, "SetupModel": { "type": "object", "properties": { "fullname": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "sortOrder": { "type": "integer", "format": "int32" }, "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "description": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "supportedFileRegex": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "setupData": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "SetupStepModel": { "type": "object", "properties": { "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "state": { "$ref": "#/components/schemas/StepState" } - }, - "additionalProperties": false + } }, "Severity": { "enum": [ @@ -12031,7 +11966,7 @@ "Error", "Fatal" ], - "type": "string" + "description": "Different levels to differentiate the severity of a message" }, "ShiftAssignementCreationContextModel": { "type": "object", @@ -12045,12 +11980,16 @@ "format": "int64" }, "operatorIdentifier": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "note": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "priority": { "type": "integer", @@ -12059,8 +11998,7 @@ "assignedDays": { "$ref": "#/components/schemas/AssignedDays" } - }, - "additionalProperties": false + } }, "ShiftAssignementModel": { "type": "object", @@ -12074,16 +12012,20 @@ "format": "int64" }, "operatorIdentifier": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "shiftId": { "type": "integer", "format": "int64" }, "note": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "priority": { "type": "integer", @@ -12092,8 +12034,7 @@ "assignedDays": { "$ref": "#/components/schemas/AssignedDays" } - }, - "additionalProperties": false + } }, "ShiftCreationContextModel": { "type": "object", @@ -12106,8 +12047,7 @@ "type": "string", "format": "date" } - }, - "additionalProperties": false + } }, "ShiftModel": { "type": "object", @@ -12124,15 +12064,16 @@ "type": "string", "format": "date" } - }, - "additionalProperties": false + } }, "ShiftTypeCreationContextModel": { "type": "object", "properties": { "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "startTime": { "type": "string", @@ -12144,10 +12085,9 @@ }, "periode": { "type": "integer", - "format": "int32" + "format": "uint8" } - }, - "additionalProperties": false + } }, "ShiftTypeModel": { "type": "object", @@ -12157,8 +12097,10 @@ "format": "int64" }, "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "startTime": { "type": "string", @@ -12170,10 +12112,9 @@ }, "periode": { "type": "integer", - "format": "int32" + "format": "uint8" } - }, - "additionalProperties": false + } }, "SkillCreationContextModel": { "type": "object", @@ -12187,11 +12128,12 @@ "format": "int64" }, "operatorIdentifier": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] } - }, - "additionalProperties": false + } }, "SkillModel": { "type": "object", @@ -12205,882 +12147,283 @@ "format": "date" }, "expiresOn": { - "type": "string", - "format": "date" - }, - "typeId": { - "type": "integer", - "format": "int64" - }, - "operatorIdentifier": { - "type": "string", - "nullable": true - }, - "isExpired": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "SkillTypeCreationContextModel": { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "duration": { - "type": "string", - "format": "date-span" - }, - "capabilities": { - "$ref": "#/components/schemas/Entry" - } - }, - "additionalProperties": false - }, - "SkillTypeModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string", - "nullable": true - }, - "duration": { - "type": "string", - "format": "date-span" - }, - "capabilities": { - "$ref": "#/components/schemas/Entry" - } - }, - "additionalProperties": false - }, - "StagingIndicator": { - "enum": [ - "NotRelevant", - "PickPart", - "CrateOrKanbanPart", - "ReleaseOrderPart", - "ManualStaging", - "EwmStaging" - ], - "type": "string" - }, - "StepState": { - "enum": [ - "Initial", - "Running", - "Completed" - ], - "type": "string" - }, - "StructLayoutAttribute": { - "type": "object", - "properties": { - "typeId": { - "nullable": true, - "readOnly": true - }, - "value": { - "$ref": "#/components/schemas/LayoutKind" - } - }, - "additionalProperties": false - }, - "TestConnectionResponse": { - "type": "object", - "properties": { - "result": { - "$ref": "#/components/schemas/TestConnectionResult" - } - }, - "additionalProperties": false - }, - "TestConnectionResult": { - "enum": [ - "ConfigurationError", - "ConnectionError", - "ConnectionOkDbDoesNotExist", - "PendingMigrations", - "Success" - ], - "type": "string" - }, - "TracingModel": { - "type": "object", - "properties": { - "type": { - "type": "string", - "nullable": true - }, - "text": { - "type": "string", - "nullable": true - }, - "started": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "completed": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "errorCode": { - "type": "integer", - "format": "int32" - }, - "properties": { - "$ref": "#/components/schemas/Entry" - } - }, - "additionalProperties": false - }, - "TransportRouteModel": { - "type": "object", - "properties": { - "idCellOfOrigin": { - "type": "integer", - "format": "int64" - }, - "idCellOfDestination": { - "type": "integer", - "format": "int64" - }, - "paths": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Position" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "Type": { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "customAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "isCollectible": { - "type": "boolean", - "readOnly": true - }, - "metadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "memberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "namespace": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "assemblyQualifiedName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "fullName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "assembly": { - "$ref": "#/components/schemas/Assembly" - }, - "module": { - "$ref": "#/components/schemas/Module" - }, - "isInterface": { - "type": "boolean", - "readOnly": true - }, - "isNested": { - "type": "boolean", - "readOnly": true - }, - "declaringType": { - "$ref": "#/components/schemas/Type" - }, - "declaringMethod": { - "$ref": "#/components/schemas/MethodBase" - }, - "reflectedType": { - "$ref": "#/components/schemas/Type" - }, - "underlyingSystemType": { - "$ref": "#/components/schemas/Type" - }, - "isTypeDefinition": { - "type": "boolean", - "readOnly": true - }, - "isArray": { - "type": "boolean", - "readOnly": true - }, - "isByRef": { - "type": "boolean", - "readOnly": true - }, - "isPointer": { - "type": "boolean", - "readOnly": true - }, - "isConstructedGenericType": { - "type": "boolean", - "readOnly": true - }, - "isGenericParameter": { - "type": "boolean", - "readOnly": true - }, - "isGenericTypeParameter": { - "type": "boolean", - "readOnly": true - }, - "isGenericMethodParameter": { - "type": "boolean", - "readOnly": true - }, - "isGenericType": { - "type": "boolean", - "readOnly": true - }, - "isGenericTypeDefinition": { - "type": "boolean", - "readOnly": true - }, - "isSZArray": { - "type": "boolean", - "readOnly": true - }, - "isVariableBoundArray": { - "type": "boolean", - "readOnly": true - }, - "isByRefLike": { - "type": "boolean", - "readOnly": true - }, - "isFunctionPointer": { - "type": "boolean", - "readOnly": true - }, - "isUnmanagedFunctionPointer": { - "type": "boolean", - "readOnly": true - }, - "hasElementType": { - "type": "boolean", - "readOnly": true - }, - "genericTypeArguments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Type" - }, - "nullable": true, - "readOnly": true - }, - "genericParameterPosition": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "genericParameterAttributes": { - "$ref": "#/components/schemas/GenericParameterAttributes" - }, - "attributes": { - "$ref": "#/components/schemas/TypeAttributes" - }, - "isAbstract": { - "type": "boolean", - "readOnly": true - }, - "isImport": { - "type": "boolean", - "readOnly": true - }, - "isSealed": { - "type": "boolean", - "readOnly": true - }, - "isSpecialName": { - "type": "boolean", - "readOnly": true - }, - "isClass": { - "type": "boolean", - "readOnly": true - }, - "isNestedAssembly": { - "type": "boolean", - "readOnly": true - }, - "isNestedFamANDAssem": { - "type": "boolean", - "readOnly": true - }, - "isNestedFamily": { - "type": "boolean", - "readOnly": true - }, - "isNestedFamORAssem": { - "type": "boolean", - "readOnly": true - }, - "isNestedPrivate": { - "type": "boolean", - "readOnly": true - }, - "isNestedPublic": { - "type": "boolean", - "readOnly": true - }, - "isNotPublic": { - "type": "boolean", - "readOnly": true - }, - "isPublic": { - "type": "boolean", - "readOnly": true - }, - "isAutoLayout": { - "type": "boolean", - "readOnly": true - }, - "isExplicitLayout": { - "type": "boolean", - "readOnly": true - }, - "isLayoutSequential": { - "type": "boolean", - "readOnly": true - }, - "isAnsiClass": { - "type": "boolean", - "readOnly": true - }, - "isAutoClass": { - "type": "boolean", - "readOnly": true - }, - "isUnicodeClass": { - "type": "boolean", - "readOnly": true - }, - "isCOMObject": { - "type": "boolean", - "readOnly": true - }, - "isContextful": { - "type": "boolean", - "readOnly": true - }, - "isEnum": { - "type": "boolean", - "readOnly": true - }, - "isMarshalByRef": { - "type": "boolean", - "readOnly": true - }, - "isPrimitive": { - "type": "boolean", - "readOnly": true - }, - "isValueType": { - "type": "boolean", - "readOnly": true - }, - "isSignatureType": { - "type": "boolean", - "readOnly": true - }, - "isSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "isSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "isSecurityTransparent": { - "type": "boolean", - "readOnly": true - }, - "structLayoutAttribute": { - "$ref": "#/components/schemas/StructLayoutAttribute" - }, - "typeInitializer": { - "$ref": "#/components/schemas/ConstructorInfo" - }, - "typeHandle": { - "$ref": "#/components/schemas/RuntimeTypeHandle" - }, - "guid": { - "type": "string", - "format": "uuid", - "readOnly": true - }, - "baseType": { - "$ref": "#/components/schemas/Type" - }, - "isSerializable": { - "type": "boolean", - "readOnly": true, - "deprecated": true - }, - "containsGenericParameters": { - "type": "boolean", - "readOnly": true - }, - "isVisible": { - "type": "boolean", - "readOnly": true - } - }, - "additionalProperties": false - }, - "TypeAttributes": { - "enum": [ - "NotPublic", - "Public", - "NestedPublic", - "NestedPrivate", - "NestedFamily", - "NestedAssembly", - "NestedFamANDAssem", - "VisibilityMask", - "SequentialLayout", - "ExplicitLayout", - "LayoutMask", - "Interface", - "Abstract", - "Sealed", - "SpecialName", - "RTSpecialName", - "Import", - "Serializable", - "WindowsRuntime", - "UnicodeClass", - "AutoClass", - "StringFormatMask", - "HasSecurity", - "ReservedMask", - "BeforeFieldInit", - "CustomFormatMask" - ], - "type": "string" - }, - "TypeInfo": { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "customAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "isCollectible": { - "type": "boolean", - "readOnly": true - }, - "metadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "memberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "namespace": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "assemblyQualifiedName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "fullName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "assembly": { - "$ref": "#/components/schemas/Assembly" - }, - "module": { - "$ref": "#/components/schemas/Module" - }, - "isInterface": { - "type": "boolean", - "readOnly": true - }, - "isNested": { - "type": "boolean", - "readOnly": true - }, - "declaringType": { - "$ref": "#/components/schemas/Type" - }, - "declaringMethod": { - "$ref": "#/components/schemas/MethodBase" - }, - "reflectedType": { - "$ref": "#/components/schemas/Type" - }, - "underlyingSystemType": { - "$ref": "#/components/schemas/Type" - }, - "isTypeDefinition": { - "type": "boolean", - "readOnly": true - }, - "isArray": { - "type": "boolean", - "readOnly": true - }, - "isByRef": { - "type": "boolean", - "readOnly": true - }, - "isPointer": { - "type": "boolean", - "readOnly": true - }, - "isConstructedGenericType": { - "type": "boolean", - "readOnly": true - }, - "isGenericParameter": { - "type": "boolean", - "readOnly": true - }, - "isGenericTypeParameter": { - "type": "boolean", - "readOnly": true - }, - "isGenericMethodParameter": { - "type": "boolean", - "readOnly": true - }, - "isGenericType": { - "type": "boolean", - "readOnly": true - }, - "isGenericTypeDefinition": { - "type": "boolean", - "readOnly": true - }, - "isSZArray": { - "type": "boolean", - "readOnly": true - }, - "isVariableBoundArray": { - "type": "boolean", - "readOnly": true - }, - "isByRefLike": { - "type": "boolean", - "readOnly": true - }, - "isFunctionPointer": { - "type": "boolean", - "readOnly": true - }, - "isUnmanagedFunctionPointer": { - "type": "boolean", - "readOnly": true - }, - "hasElementType": { - "type": "boolean", - "readOnly": true - }, - "genericTypeArguments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Type" - }, - "nullable": true, - "readOnly": true - }, - "genericParameterPosition": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "genericParameterAttributes": { - "$ref": "#/components/schemas/GenericParameterAttributes" - }, - "attributes": { - "$ref": "#/components/schemas/TypeAttributes" - }, - "isAbstract": { - "type": "boolean", - "readOnly": true - }, - "isImport": { - "type": "boolean", - "readOnly": true - }, - "isSealed": { - "type": "boolean", - "readOnly": true - }, - "isSpecialName": { - "type": "boolean", - "readOnly": true - }, - "isClass": { - "type": "boolean", - "readOnly": true - }, - "isNestedAssembly": { - "type": "boolean", - "readOnly": true - }, - "isNestedFamANDAssem": { - "type": "boolean", - "readOnly": true - }, - "isNestedFamily": { - "type": "boolean", - "readOnly": true - }, - "isNestedFamORAssem": { - "type": "boolean", - "readOnly": true - }, - "isNestedPrivate": { - "type": "boolean", - "readOnly": true - }, - "isNestedPublic": { - "type": "boolean", - "readOnly": true - }, - "isNotPublic": { - "type": "boolean", - "readOnly": true - }, - "isPublic": { - "type": "boolean", - "readOnly": true - }, - "isAutoLayout": { - "type": "boolean", - "readOnly": true - }, - "isExplicitLayout": { - "type": "boolean", - "readOnly": true - }, - "isLayoutSequential": { - "type": "boolean", - "readOnly": true - }, - "isAnsiClass": { - "type": "boolean", - "readOnly": true - }, - "isAutoClass": { - "type": "boolean", - "readOnly": true - }, - "isUnicodeClass": { - "type": "boolean", - "readOnly": true - }, - "isCOMObject": { - "type": "boolean", - "readOnly": true - }, - "isContextful": { - "type": "boolean", - "readOnly": true - }, - "isEnum": { - "type": "boolean", - "readOnly": true - }, - "isMarshalByRef": { - "type": "boolean", - "readOnly": true - }, - "isPrimitive": { - "type": "boolean", - "readOnly": true - }, - "isValueType": { - "type": "boolean", - "readOnly": true + "type": "string", + "format": "date" }, - "isSignatureType": { - "type": "boolean", - "readOnly": true + "typeId": { + "type": "integer", + "format": "int64" }, - "isSecurityCritical": { - "type": "boolean", - "readOnly": true + "operatorIdentifier": { + "type": [ + "null", + "string" + ] }, - "isSecuritySafeCritical": { - "type": "boolean", - "readOnly": true + "isExpired": { + "type": "boolean" + } + } + }, + "SkillTypeCreationContextModel": { + "type": "object", + "properties": { + "name": { + "type": [ + "null", + "string" + ] }, - "isSecurityTransparent": { - "type": "boolean", - "readOnly": true + "duration": { + "pattern": "^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$", + "type": "string" }, - "structLayoutAttribute": { - "$ref": "#/components/schemas/StructLayoutAttribute" + "capabilities": { + "oneOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/Entry" + } + ] + } + } + }, + "SkillTypeModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" }, - "typeInitializer": { - "$ref": "#/components/schemas/ConstructorInfo" + "name": { + "type": [ + "null", + "string" + ] }, - "typeHandle": { - "$ref": "#/components/schemas/RuntimeTypeHandle" + "duration": { + "pattern": "^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$", + "type": "string" }, - "guid": { - "type": "string", - "format": "uuid", - "readOnly": true + "capabilities": { + "oneOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/Entry" + } + ] + } + } + }, + "SseItemBase": { + "type": "object", + "properties": { + "type": { + "type": "string" }, - "baseType": { - "$ref": "#/components/schemas/Type" + "eventId": { + "type": "string" }, - "isSerializable": { - "type": "boolean", - "readOnly": true, - "deprecated": true + "reconnectInterval": { + "pattern": "^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$", + "type": "string" + } + } + }, + "SseItemOfOperationAdvicedModel": { + "allOf": [ + { + "$ref": "#/components/schemas/SseItemBase" + } + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OperationAdvicedModel" + } + } + }, + "SseItemOfOperationModel": { + "allOf": [ + { + "$ref": "#/components/schemas/SseItemBase" + } + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OperationModel" + } + } + }, + "SseItemOfOperationReportedModel": { + "allOf": [ + { + "$ref": "#/components/schemas/SseItemBase" + } + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OperationReportedModel" + } + } + }, + "SseItemOfOperationStartedModel": { + "allOf": [ + { + "$ref": "#/components/schemas/SseItemBase" + } + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OperationStartedModel" + } + } + }, + "StagingIndicator": { + "enum": [ + "NotRelevant", + "PickPart", + "CrateOrKanbanPart", + "ReleaseOrderPart", + "ManualStaging", + "EwmStaging" + ], + "description": "The material staging indicator defines the method of how needed materials can be supplied for production with the assistance of the Warehouse Management system.\r\nAs with the location coordinates(warehouse number, storage type, and storage bin), the system files this indicator in the control cycle." + }, + "StepState": { + "enum": [ + "Initial", + "Running", + "Completed" + ] + }, + "Stream": { + "type": "string", + "format": "binary" + }, + "StringSegment": { + "type": "object", + "properties": { + "buffer": { + "type": [ + "null", + "string" + ] }, - "containsGenericParameters": { - "type": "boolean", - "readOnly": true + "offset": { + "type": "integer", + "format": "int32" }, - "isVisible": { - "type": "boolean", - "readOnly": true + "length": { + "type": "integer", + "format": "int32" }, - "genericTypeParameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Type" - }, - "nullable": true, - "readOnly": true + "value": { + "type": [ + "null", + "string" + ] }, - "declaredConstructors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConstructorInfo" - }, - "nullable": true, - "readOnly": true + "hasValue": { + "type": "boolean" + } + } + }, + "TestConnectionResponse": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/TestConnectionResult" + } + } + }, + "TestConnectionResult": { + "enum": [ + "ConfigurationError", + "ConnectionError", + "ConnectionOkDbDoesNotExist", + "PendingMigrations", + "Success" + ], + "description": "Result enum for function TestConnection" + }, + "TracingModel": { + "type": "object", + "properties": { + "type": { + "type": [ + "null", + "string" + ] }, - "declaredEvents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EventInfo" - }, - "nullable": true, - "readOnly": true + "text": { + "type": [ + "null", + "string" + ] }, - "declaredFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FieldInfo" - }, - "nullable": true, - "readOnly": true + "started": { + "type": [ + "null", + "string" + ], + "format": "date-time" }, - "declaredMembers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MemberInfo" - }, - "nullable": true, - "readOnly": true + "completed": { + "type": [ + "null", + "string" + ], + "format": "date-time" }, - "declaredMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MethodInfo" - }, - "nullable": true, - "readOnly": true + "errorCode": { + "type": "integer", + "format": "int32" }, - "declaredNestedTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TypeInfo" - }, - "nullable": true, - "readOnly": true + "properties": { + "$ref": "#/components/schemas/Entry" + } + } + }, + "TransportRouteModel": { + "type": "object", + "properties": { + "idCellOfOrigin": { + "type": "integer", + "format": "int64" }, - "declaredProperties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyInfo" - }, - "nullable": true, - "readOnly": true + "idCellOfDestination": { + "type": "integer", + "format": "int64" }, - "implementedInterfaces": { - "type": "array", + "paths": { + "type": [ + "null", + "array" + ], "items": { - "$ref": "#/components/schemas/Type" - }, - "nullable": true, - "readOnly": true + "$ref": "#/components/schemas/Position" + } } - }, - "additionalProperties": false + } }, "ValidationErrorModel": { "type": "object", "properties": { "error": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "position": { "type": "integer", "format": "int64" } - }, - "additionalProperties": false + } }, "ValidationResultModel": { "type": "object", @@ -13089,47 +12432,59 @@ "type": "boolean" }, "errors": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/ValidationErrorModel" - }, - "nullable": true + } } - }, - "additionalProperties": false + } }, "VariantDescriptor": { "type": "object", "properties": { - "fileHash": { + "name": { + "type": [ + "null", + "string" + ], + "description": "Name of the variant" + }, + "creationDate": { "type": "string", - "nullable": true + "description": "Date of the creation", + "format": "date-time" + }, + "preview": { + "description": "Preview information for this variant", + "$ref": "#/components/schemas/PreviewDescriptor" + }, + "fileHash": { + "type": [ + "null", + "string" + ] }, "extension": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "mimeType": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "size": { "type": "integer", "format": "int64" - }, - "name": { - "type": "string", - "nullable": true - }, - "creationDate": { - "type": "string", - "format": "date-time" - }, - "preview": { - "$ref": "#/components/schemas/PreviewDescriptor" } }, - "additionalProperties": false + "description": "Descriptor for an variant" }, "VisualizableItemModel": { "type": "object", @@ -13142,27 +12497,29 @@ "$ref": "#/components/schemas/CellLocationModel" }, "iconName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "isACell": { "type": "boolean" } - }, - "additionalProperties": false + } }, "VisualizationModel": { "type": "object", "properties": { "icon": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "category": { "$ref": "#/components/schemas/Category" } - }, - "additionalProperties": false + } }, "WorkplanModel": { "type": "object", @@ -13172,8 +12529,10 @@ "format": "int64" }, "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "version": { "type": "integer", @@ -13182,8 +12541,7 @@ "state": { "$ref": "#/components/schemas/WorkplanState" } - }, - "additionalProperties": false + } }, "WorkplanNodeClassification": { "enum": [ @@ -13192,8 +12550,7 @@ "Execution", "ControlFlow", "Subworkplan" - ], - "type": "string" + ] }, "WorkplanNodeModel": { "type": "object", @@ -13203,16 +12560,22 @@ "format": "int64" }, "type": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "displayName": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "positionTop": { "type": "integer", @@ -13226,18 +12589,22 @@ "$ref": "#/components/schemas/WorkplanNodeClassification" }, "inputs": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/NodeConnectionPoint" - }, - "nullable": true + } }, "outputs": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/NodeConnectionPoint" - }, - "nullable": true + } }, "properties": { "$ref": "#/components/schemas/Entry" @@ -13246,23 +12613,26 @@ "type": "integer", "format": "int64" } - }, - "additionalProperties": false + } }, "WorkplanSessionModel": { "type": "object", "properties": { "sessionToken": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "workplanId": { "type": "integer", "format": "int64" }, "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "version": { "type": "integer", @@ -13272,14 +12642,15 @@ "$ref": "#/components/schemas/WorkplanState" }, "nodes": { - "type": "array", + "type": [ + "null", + "array" + ], "items": { "$ref": "#/components/schemas/WorkplanNodeModel" - }, - "nullable": true + } } - }, - "additionalProperties": false + } }, "WorkplanState": { "enum": [ @@ -13287,22 +12658,28 @@ "Released", "Revoked" ], - "type": "string" + "description": "A workplan state" }, "WorkplanStepRecipe": { "type": "object", "properties": { "type": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "name": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "description": { - "type": "string", - "nullable": true + "type": [ + "null", + "string" + ] }, "positionTop": { "type": "integer", @@ -13322,8 +12699,7 @@ "type": "integer", "format": "int64" } - }, - "additionalProperties": false + } } } }, @@ -13383,4 +12759,4 @@ "name": "WorkplanEditing" } ] -} +} \ No newline at end of file From 4487402408d526a8f2916b543c132eb4a5445d68 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Niggemann?= Date: Thu, 5 Nov 2026 08:49:53 +0100 Subject: [PATCH 07/16] Don't start modules for compile time openapi generation --- src/StartProject.Asp/Program.cs | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/StartProject.Asp/Program.cs b/src/StartProject.Asp/Program.cs index e2ff817490..9b4010300b 100644 --- a/src/StartProject.Asp/Program.cs +++ b/src/StartProject.Asp/Program.cs @@ -2,6 +2,7 @@ // Licensed under the Apache License, Version 2.0 using System.Globalization; +using System.Reflection; using System.Text.Json.Serialization; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Localization; @@ -128,6 +129,15 @@ app.MapControllers().WithMetadata(new AllowAnonymousAttribute()); app.MapRazorPages(); +// Don't start moryx modules for openapi build time code generation +// Taken from https://github.com/dotnet/AspNetCore.Docs/blob/2c37585a425dd64e91015e60146031859ff52865/aspnetcore/fundamentals/openapi/samples/9.x/AspireApp1/AspireApp1.Web/Program.cs#L5 +// according to https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/fundamentals/openapi/aspnetcore-openapi.md#customize-runtime-behavior-during-build-time-document-generation +if (Assembly.GetEntryAssembly()?.GetName().Name == "GetDocument.Insider") +{ + await app.RunAsync(); + return; +} + var moduleManager = app.Services.GetRequiredService(); await moduleManager.StartModulesAsync(); From c1e77fa98149dbc9a3c35d27cd3d0386a78f7cab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Niggemann?= Date: Wed, 4 Nov 2026 01:57:17 +0100 Subject: [PATCH 08/16] Prototype of generated client based on the compile time generated spec using Moryx.Orders.Web --- src/Moryx.Orders.Web/app/openapi-gen.json | 2 +- .../src/app/api/fn/operator-management/add.ts | 4 +- .../fn/operator-management/delete-operator.ts | 6 +- .../app/api/fn/operator-management/sign-in.ts | 6 +- .../api/fn/operator-management/sign-out.ts | 6 +- .../app/api/fn/operator-management/stream.ts | 6 +- .../app/api/fn/operator-management/update.ts | 2 +- .../fn/order-management/abort-operation.ts | 10 +- .../api/fn/order-management/add-operation.ts | 12 +- .../fn/order-management/advice-operation.ts | 16 +- .../fn/order-management/begin-operation.ts | 16 +- .../fn/order-management/get-advice-context.ts | 4 + .../get-assignable-recipes.ts | 8 + .../fn/order-management/get-begin-context.ts | 4 + .../order-management/get-document-stream.ts | 15 +- .../api/fn/order-management/get-documents.ts | 4 + .../order-management/get-interrupt-context.ts | 4 + .../app/api/fn/order-management/get-logs.ts | 4 + .../api/fn/order-management/get-operations.ts | 8 + .../fn/order-management/get-product-parts.ts | 4 + .../fn/order-management/get-report-context.ts | 4 + .../order-management/interrupt-operation.ts | 14 +- .../fn/order-management/operation-stream.ts | 11 +- .../src/app/api/fn/order-management/reload.ts | 10 +- .../fn/order-management/report-operation.ts | 16 +- .../fn/order-management/update-operation.ts | 16 +- .../fn/product-management/create-instance.ts | 12 + .../api/fn/product-management/duplicate.ts | 10 +- .../api/fn/product-management/get-instance.ts | 4 + .../fn/product-management/get-instances.ts | 4 + .../api/fn/product-management/get-recipe.ts | 4 + .../api/fn/product-management/get-recipes.ts | 8 + .../fn/product-management/get-type-by-id.ts | 4 + .../get-type-by-identity.ts | 4 + .../api/fn/product-management/get-types.ts | 8 +- .../app/api/fn/product-management/import.ts | 10 +- .../fn/product-management/save-instance.ts | 12 +- .../api/fn/product-management/save-recipe.ts | 8 +- .../api/fn/product-management/save-type.ts | 8 +- .../fn/product-management/update-recipe.ts | 10 +- .../api/fn/product-management/update-type.ts | 10 +- .../app/api/fn/workplan/delete-workplan.ts | 6 +- .../src/app/api/fn/workplan/save-workplan.ts | 4 +- .../app/api/fn/workplan/update-workplan.ts | 2 +- .../app/src/app/api/models.ts | 46 ++-- .../app/src/app/api/models/advice-context.ts | 8 + .../app/src/app/api/models/advice-model.ts | 4 +- .../src/app/api/models/assignable-operator.ts | 10 +- .../api/models/attendable-resource-model.ts | 6 +- .../app/src/app/api/models/begin-context.ts | 38 ++- .../app/src/app/api/models/begin-model.ts | 2 +- .../src/app/api/models/confirmation-type.ts | 10 +- .../app/src/app/api/models/document-model.ts | 12 +- ...on-model.ts => entity-tag-header-value.ts} | 8 +- .../app/api/models/extended-operator-model.ts | 10 +- .../src/app/api/models/file-stream-result.ts | 18 ++ .../app/src/app/api/models/i-capabilities.ts | 8 + .../app/api/models/i-operator-assignable.ts | 14 +- .../app/src/app/api/models/log-level.ts | 11 +- .../api/models/moryx-exception-response.ts | 4 +- .../app/api/models/operation-changed-model.ts | 16 -- .../operation-creation-context-model.ts | 86 ++++++- .../api/models/operation-log-message-model.ts | 4 +- .../app/src/app/api/models/operation-model.ts | 28 ++- .../app/api/models/operation-recipe-model.ts | 2 +- .../app/api/models/operation-started-model.ts | 2 +- .../models/operation-state-classification.ts | 27 +-- .../app/api/models/operation-update-model.ts | 16 +- .../app/src/app/api/models/operator-model.ts | 8 +- .../src/app/api/models/part-classification.ts | 10 +- .../app/src/app/api/models/part-connector.ts | 19 -- .../app/api/models/part-creation-context.ts | 18 -- .../app/src/app/api/models/part-model.ts | 16 -- .../app/src/app/api/models/problem-details.ts | 12 +- .../app/api/models/product-customization.ts | 6 +- .../api/models/product-definition-model.ts | 16 -- .../app/api/models/product-instance-model.ts | 10 +- .../app/api/models/product-instance-state.ts | 14 +- .../app/src/app/api/models/product-model.ts | 10 +- .../src/app/api/models/product-part-model.ts | 6 +- .../app/src/app/api/models/product-query.ts | 60 ++++- .../app/src/app/api/models/product-state.ts | 12 +- .../app/src/app/api/models/property-filter.ts | 15 -- .../api/models/recipe-classification-model.ts | 13 +- .../app/src/app/api/models/recipe-filter.ts | 11 +- .../app/src/app/api/models/recipe-model.ts | 44 +++- .../app/src/app/api/models/recipe-state.ts | 11 +- .../app/src/app/api/models/report-context.ts | 42 +++- .../app/src/app/api/models/report-model.ts | 4 +- .../app/api/models/restriction-description.ts | 13 - .../app/src/app/api/models/revision-filter.ts | 11 +- .../app/src/app/api/models/selector.ts | 11 +- ...ty-filter-operator.ts => sse-item-base.ts} | 8 +- .../sse-item-of-operation-adviced-model.ts | 14 ++ .../api/models/sse-item-of-operation-model.ts | 14 ++ .../sse-item-of-operation-reported-model.ts | 14 ++ .../sse-item-of-operation-started-model.ts | 14 ++ .../src/app/api/models/staging-indicator.ts | 15 +- .../{restriction-severity.ts => stream.ts} | 7 +- ...{product-importer.ts => string-segment.ts} | 11 +- .../app/src/app/api/models/workplan-model.ts | 2 +- .../app/src/app/api/models/workplan-state.ts | 11 +- .../services/operator-management.service.ts | 28 +-- .../api/services/order-management.service.ts | 228 +++++++++++++++--- .../services/product-management.service.ts | 154 +++++++++++- .../src/app/api/services/workplan.service.ts | 10 +- 106 files changed, 1185 insertions(+), 467 deletions(-) rename src/Moryx.Orders.Web/app/src/app/api/models/{recipe-definition-model.ts => entity-tag-header-value.ts} (56%) create mode 100644 src/Moryx.Orders.Web/app/src/app/api/models/file-stream-result.ts delete mode 100644 src/Moryx.Orders.Web/app/src/app/api/models/operation-changed-model.ts delete mode 100644 src/Moryx.Orders.Web/app/src/app/api/models/part-connector.ts delete mode 100644 src/Moryx.Orders.Web/app/src/app/api/models/part-creation-context.ts delete mode 100644 src/Moryx.Orders.Web/app/src/app/api/models/part-model.ts delete mode 100644 src/Moryx.Orders.Web/app/src/app/api/models/product-definition-model.ts delete mode 100644 src/Moryx.Orders.Web/app/src/app/api/models/property-filter.ts delete mode 100644 src/Moryx.Orders.Web/app/src/app/api/models/restriction-description.ts rename src/Moryx.Orders.Web/app/src/app/api/models/{property-filter-operator.ts => sse-item-base.ts} (62%) create mode 100644 src/Moryx.Orders.Web/app/src/app/api/models/sse-item-of-operation-adviced-model.ts create mode 100644 src/Moryx.Orders.Web/app/src/app/api/models/sse-item-of-operation-model.ts create mode 100644 src/Moryx.Orders.Web/app/src/app/api/models/sse-item-of-operation-reported-model.ts create mode 100644 src/Moryx.Orders.Web/app/src/app/api/models/sse-item-of-operation-started-model.ts rename src/Moryx.Orders.Web/app/src/app/api/models/{restriction-severity.ts => stream.ts} (66%) rename src/Moryx.Orders.Web/app/src/app/api/models/{product-importer.ts => string-segment.ts} (55%) diff --git a/src/Moryx.Orders.Web/app/openapi-gen.json b/src/Moryx.Orders.Web/app/openapi-gen.json index 5d4128ac8b..fcbe2c54ff 100644 --- a/src/Moryx.Orders.Web/app/openapi-gen.json +++ b/src/Moryx.Orders.Web/app/openapi-gen.json @@ -1,6 +1,6 @@ { "$schema": "node_modules/ng-openapi-gen/ng-openapi-gen-schema.json", - "input": "https://localhost:5000/swagger/v1/swagger.json", + "input": "../../StartProject.Asp/StartProject.Asp.json", "output": "src/app/api", "ignoreUnusedModels": true, "includeTags": [ diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/add.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/add.ts index e58d40c141..54abeaaa48 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/add.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/add.ts @@ -15,10 +15,10 @@ import { RequestBuilder } from '../../request-builder'; import { OperatorModel } from '../../models/operator-model'; export interface Add$Params { - body?: OperatorModel + body: OperatorModel } -export function add(http: HttpClient, rootUrl: string, params?: Add$Params, context?: HttpContext): Observable> { +export function add(http: HttpClient, rootUrl: string, params: Add$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, add.PATH, 'post'); if (params) { rb.body(params.body, 'application/*+json'); diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/delete-operator.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/delete-operator.ts index 4d97805ab4..6eae0a6a79 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/delete-operator.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/delete-operator.ts @@ -17,18 +17,18 @@ export interface DeleteOperator$Params { operatorIdentifier?: string; } -export function deleteOperator(http: HttpClient, rootUrl: string, params?: DeleteOperator$Params, context?: HttpContext): Observable> { +export function deleteOperator(http: HttpClient, rootUrl: string, params?: DeleteOperator$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, deleteOperator.PATH, 'delete'); if (params) { rb.query('operatorIdentifier', params.operatorIdentifier, {}); } return http.request( - rb.build({ responseType: 'text', accept: '*/*', context }) + rb.build({ responseType: 'json', accept: 'application/json', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; + return r as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/sign-in.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/sign-in.ts index bf084832ef..60503dec35 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/sign-in.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/sign-in.ts @@ -18,7 +18,7 @@ export interface SignIn$Params { resourceId?: number; } -export function signIn(http: HttpClient, rootUrl: string, params?: SignIn$Params, context?: HttpContext): Observable> { +export function signIn(http: HttpClient, rootUrl: string, params?: SignIn$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, signIn.PATH, 'put'); if (params) { rb.query('operatorIdentifier', params.operatorIdentifier, {}); @@ -26,11 +26,11 @@ export function signIn(http: HttpClient, rootUrl: string, params?: SignIn$Params } return http.request( - rb.build({ responseType: 'text', accept: '*/*', context }) + rb.build({ responseType: 'json', accept: 'application/json', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; + return r as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/sign-out.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/sign-out.ts index 40563fa4f9..6e6beda3ee 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/sign-out.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/sign-out.ts @@ -18,7 +18,7 @@ export interface SignOut$Params { resourceId?: number; } -export function signOut(http: HttpClient, rootUrl: string, params?: SignOut$Params, context?: HttpContext): Observable> { +export function signOut(http: HttpClient, rootUrl: string, params?: SignOut$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, signOut.PATH, 'put'); if (params) { rb.query('operatorIdentifier', params.operatorIdentifier, {}); @@ -26,11 +26,11 @@ export function signOut(http: HttpClient, rootUrl: string, params?: SignOut$Para } return http.request( - rb.build({ responseType: 'text', accept: '*/*', context }) + rb.build({ responseType: 'json', accept: 'application/json', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; + return r as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/stream.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/stream.ts index e32d4de5dd..ddbaa26d94 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/stream.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/stream.ts @@ -16,17 +16,17 @@ import { RequestBuilder } from '../../request-builder'; export interface Stream$Params { } -export function stream(http: HttpClient, rootUrl: string, params?: Stream$Params, context?: HttpContext): Observable> { +export function stream(http: HttpClient, rootUrl: string, params?: Stream$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, stream.PATH, 'get'); if (params) { } return http.request( - rb.build({ responseType: 'text', accept: '*/*', context }) + rb.build({ responseType: 'json', accept: 'application/json', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; + return r as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/update.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/update.ts index a29a84d5df..25eba66887 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/update.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/update.ts @@ -16,7 +16,7 @@ import { OperatorModel } from '../../models/operator-model'; export interface Update$Params { identifier: string; - body?: OperatorModel + body: OperatorModel } export function update(http: HttpClient, rootUrl: string, params: Update$Params, context?: HttpContext): Observable> { diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/abort-operation.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/abort-operation.ts index 53c4b97c17..51402570fa 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/abort-operation.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/abort-operation.ts @@ -14,21 +14,25 @@ import { RequestBuilder } from '../../request-builder'; export interface AbortOperation$Params { + +/** + * Id of the operation + */ guid: string; } -export function abortOperation(http: HttpClient, rootUrl: string, params: AbortOperation$Params, context?: HttpContext): Observable> { +export function abortOperation(http: HttpClient, rootUrl: string, params: AbortOperation$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, abortOperation.PATH, 'post'); if (params) { rb.path('guid', params.guid, {}); } return http.request( - rb.build({ responseType: 'text', accept: '*/*', context }) + rb.build({ responseType: 'json', accept: 'application/json', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; + return r as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/add-operation.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/add-operation.ts index 7015193cec..380bf1cde4 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/add-operation.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/add-operation.ts @@ -16,11 +16,19 @@ import { OperationCreationContextModel } from '../../models/operation-creation-c import { OperationModel } from '../../models/operation-model'; export interface AddOperation$Params { + +/** + * Identifier of the application adding the operation + */ sourceId?: string; - body?: OperationCreationContextModel + + /** + * Description of the operation + */ + body: OperationCreationContextModel } -export function addOperation(http: HttpClient, rootUrl: string, params?: AddOperation$Params, context?: HttpContext): Observable> { +export function addOperation(http: HttpClient, rootUrl: string, params: AddOperation$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, addOperation.PATH, 'post'); if (params) { rb.query('sourceId', params.sourceId, {}); diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/advice-operation.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/advice-operation.ts index 383a8ab74e..07129a8d79 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/advice-operation.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/advice-operation.ts @@ -15,11 +15,19 @@ import { RequestBuilder } from '../../request-builder'; import { AdviceModel } from '../../models/advice-model'; export interface AdviceOperation$Params { + +/** + * Id of the operation + */ guid: string; - body?: AdviceModel + + /** + * Parameter object + */ + body: AdviceModel } -export function adviceOperation(http: HttpClient, rootUrl: string, params: AdviceOperation$Params, context?: HttpContext): Observable> { +export function adviceOperation(http: HttpClient, rootUrl: string, params: AdviceOperation$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, adviceOperation.PATH, 'post'); if (params) { rb.path('guid', params.guid, {}); @@ -27,11 +35,11 @@ export function adviceOperation(http: HttpClient, rootUrl: string, params: Advic } return http.request( - rb.build({ responseType: 'text', accept: '*/*', context }) + rb.build({ responseType: 'json', accept: 'application/json', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; + return r as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/begin-operation.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/begin-operation.ts index 53c1b89996..13195a61b4 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/begin-operation.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/begin-operation.ts @@ -15,11 +15,19 @@ import { RequestBuilder } from '../../request-builder'; import { BeginModel } from '../../models/begin-model'; export interface BeginOperation$Params { + +/** + * Id of the operation + */ guid: string; - body?: BeginModel + + /** + * Begin parameters + */ + body: BeginModel } -export function beginOperation(http: HttpClient, rootUrl: string, params: BeginOperation$Params, context?: HttpContext): Observable> { +export function beginOperation(http: HttpClient, rootUrl: string, params: BeginOperation$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, beginOperation.PATH, 'post'); if (params) { rb.path('guid', params.guid, {}); @@ -27,11 +35,11 @@ export function beginOperation(http: HttpClient, rootUrl: string, params: BeginO } return http.request( - rb.build({ responseType: 'text', accept: '*/*', context }) + rb.build({ responseType: 'json', accept: 'application/json', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; + return r as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-advice-context.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-advice-context.ts index c7b2859fee..758fd85b5d 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-advice-context.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-advice-context.ts @@ -15,6 +15,10 @@ import { RequestBuilder } from '../../request-builder'; import { AdviceContext } from '../../models/advice-context'; export interface GetAdviceContext$Params { + +/** + * Id of the operation + */ guid: string; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-assignable-recipes.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-assignable-recipes.ts index a462b173ca..913f35f1bb 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-assignable-recipes.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-assignable-recipes.ts @@ -15,7 +15,15 @@ import { RequestBuilder } from '../../request-builder'; import { OperationRecipeModel } from '../../models/operation-recipe-model'; export interface GetAssignableRecipes$Params { + +/** + * Product identifier + */ identifier?: string; + +/** + * Product revision + */ revision?: number; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-begin-context.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-begin-context.ts index b444031054..5405674839 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-begin-context.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-begin-context.ts @@ -15,6 +15,10 @@ import { RequestBuilder } from '../../request-builder'; import { BeginContext } from '../../models/begin-context'; export interface GetBeginContext$Params { + +/** + * Id of the operation + */ guid: string; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-document-stream.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-document-stream.ts index de4eab5fe0..12ae886b97 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-document-stream.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-document-stream.ts @@ -12,13 +12,22 @@ import { filter, map } from 'rxjs/operators'; import { StrictHttpResponse } from '../../strict-http-response'; import { RequestBuilder } from '../../request-builder'; +import { FileStreamResult } from '../../models/file-stream-result'; export interface GetDocumentStream$Params { + +/** + * Id of the operation + */ guid: string; + +/** + * Identifier of the document + */ identifier: string; } -export function getDocumentStream(http: HttpClient, rootUrl: string, params: GetDocumentStream$Params, context?: HttpContext): Observable> { +export function getDocumentStream(http: HttpClient, rootUrl: string, params: GetDocumentStream$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, getDocumentStream.PATH, 'get'); if (params) { rb.path('guid', params.guid, {}); @@ -26,11 +35,11 @@ export function getDocumentStream(http: HttpClient, rootUrl: string, params: Get } return http.request( - rb.build({ responseType: 'blob', accept: 'application/json', context }) + rb.build({ responseType: 'json', accept: 'application/json', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return r as StrictHttpResponse; + return r as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-documents.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-documents.ts index a3c6f38326..a63077785c 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-documents.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-documents.ts @@ -15,6 +15,10 @@ import { RequestBuilder } from '../../request-builder'; import { DocumentModel } from '../../models/document-model'; export interface GetDocuments$Params { + +/** + * Id of the operation + */ guid: string; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-interrupt-context.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-interrupt-context.ts index ff75ca0efd..d38b21af17 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-interrupt-context.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-interrupt-context.ts @@ -15,6 +15,10 @@ import { RequestBuilder } from '../../request-builder'; import { ReportContext } from '../../models/report-context'; export interface GetInterruptContext$Params { + +/** + * Id of the operation + */ guid: string; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-logs.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-logs.ts index f9bb8b8055..d57683544f 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-logs.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-logs.ts @@ -15,6 +15,10 @@ import { RequestBuilder } from '../../request-builder'; import { OperationLogMessageModel } from '../../models/operation-log-message-model'; export interface GetLogs$Params { + +/** + * Id of the operation + */ guid: string; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-operations.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-operations.ts index f955a41e95..4b5c463065 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-operations.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-operations.ts @@ -15,7 +15,15 @@ import { RequestBuilder } from '../../request-builder'; import { OperationModel } from '../../models/operation-model'; export interface GetOperations$Params { + +/** + * Optional. If specified only operations that belong to this order will be returned + */ orderNumber?: string; + +/** + * Optional. If specified only operations with this operation number will be returned + */ operationNumber?: string; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-product-parts.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-product-parts.ts index d808f4a298..9bd2bb23d8 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-product-parts.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-product-parts.ts @@ -15,6 +15,10 @@ import { RequestBuilder } from '../../request-builder'; import { ProductPartModel } from '../../models/product-part-model'; export interface GetProductParts$Params { + +/** + * If of the operation + */ guid: string; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-report-context.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-report-context.ts index b2e60efa65..4e1544a678 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-report-context.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-report-context.ts @@ -15,6 +15,10 @@ import { RequestBuilder } from '../../request-builder'; import { ReportContext } from '../../models/report-context'; export interface GetReportContext$Params { + +/** + * Id of the operation + */ guid: string; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/interrupt-operation.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/interrupt-operation.ts index cd245d572a..81afae770b 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/interrupt-operation.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/interrupt-operation.ts @@ -14,11 +14,19 @@ import { RequestBuilder } from '../../request-builder'; export interface InterruptOperation$Params { + +/** + * Id of the operation + */ guid: string; + +/** + * Identifier of the user requesting the interrupt (Optional depending on configuration) + */ userIdentifier?: string; } -export function interruptOperation(http: HttpClient, rootUrl: string, params: InterruptOperation$Params, context?: HttpContext): Observable> { +export function interruptOperation(http: HttpClient, rootUrl: string, params: InterruptOperation$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, interruptOperation.PATH, 'post'); if (params) { rb.path('guid', params.guid, {}); @@ -26,11 +34,11 @@ export function interruptOperation(http: HttpClient, rootUrl: string, params: In } return http.request( - rb.build({ responseType: 'text', accept: '*/*', context }) + rb.build({ responseType: 'json', accept: 'application/json', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; + return r as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/operation-stream.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/operation-stream.ts index 075476dfc6..511d88920c 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/operation-stream.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/operation-stream.ts @@ -12,22 +12,25 @@ import { filter, map } from 'rxjs/operators'; import { StrictHttpResponse } from '../../strict-http-response'; import { RequestBuilder } from '../../request-builder'; -import { OperationChangedModel } from '../../models/operation-changed-model'; +import { SseItemOfOperationAdvicedModel } from '../../models/sse-item-of-operation-adviced-model'; +import { SseItemOfOperationModel } from '../../models/sse-item-of-operation-model'; +import { SseItemOfOperationReportedModel } from '../../models/sse-item-of-operation-reported-model'; +import { SseItemOfOperationStartedModel } from '../../models/sse-item-of-operation-started-model'; export interface OperationStream$Params { } -export function operationStream(http: HttpClient, rootUrl: string, params?: OperationStream$Params, context?: HttpContext): Observable> { +export function operationStream(http: HttpClient, rootUrl: string, params?: OperationStream$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, operationStream.PATH, 'get'); if (params) { } return http.request( - rb.build({ responseType: 'json', accept: 'application/json', context }) + rb.build({ responseType: 'text', accept: 'text/event-stream', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return r as StrictHttpResponse; + return r as StrictHttpResponse<(SseItemOfOperationStartedModel | SseItemOfOperationModel | SseItemOfOperationReportedModel | SseItemOfOperationReportedModel | SseItemOfOperationReportedModel | SseItemOfOperationAdvicedModel | SseItemOfOperationModel)>; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/reload.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/reload.ts index 5846883b37..6412381552 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/reload.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/reload.ts @@ -14,21 +14,25 @@ import { RequestBuilder } from '../../request-builder'; export interface Reload$Params { + +/** + * Id of the operation + */ guid: string; } -export function reload(http: HttpClient, rootUrl: string, params: Reload$Params, context?: HttpContext): Observable> { +export function reload(http: HttpClient, rootUrl: string, params: Reload$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, reload.PATH, 'put'); if (params) { rb.path('guid', params.guid, {}); } return http.request( - rb.build({ responseType: 'text', accept: '*/*', context }) + rb.build({ responseType: 'json', accept: 'application/json', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; + return r as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/report-operation.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/report-operation.ts index 24c756e152..9de9e560e4 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/report-operation.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/report-operation.ts @@ -15,11 +15,19 @@ import { RequestBuilder } from '../../request-builder'; import { ReportModel } from '../../models/report-model'; export interface ReportOperation$Params { + +/** + * Id of the operation + */ guid: string; - body?: ReportModel + + /** + * Parameter object + */ + body: ReportModel } -export function reportOperation(http: HttpClient, rootUrl: string, params: ReportOperation$Params, context?: HttpContext): Observable> { +export function reportOperation(http: HttpClient, rootUrl: string, params: ReportOperation$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, reportOperation.PATH, 'post'); if (params) { rb.path('guid', params.guid, {}); @@ -27,11 +35,11 @@ export function reportOperation(http: HttpClient, rootUrl: string, params: Repor } return http.request( - rb.build({ responseType: 'text', accept: '*/*', context }) + rb.build({ responseType: 'json', accept: 'application/json', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; + return r as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/update-operation.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/update-operation.ts index ab175012d5..e5caff12f0 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/update-operation.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/update-operation.ts @@ -15,11 +15,19 @@ import { RequestBuilder } from '../../request-builder'; import { OperationUpdateModel } from '../../models/operation-update-model'; export interface UpdateOperation$Params { + +/** + * Id of the operation + */ guid: string; - body?: OperationUpdateModel + + /** + * Paramter object + */ + body: OperationUpdateModel } -export function updateOperation(http: HttpClient, rootUrl: string, params: UpdateOperation$Params, context?: HttpContext): Observable> { +export function updateOperation(http: HttpClient, rootUrl: string, params: UpdateOperation$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, updateOperation.PATH, 'put'); if (params) { rb.path('guid', params.guid, {}); @@ -27,11 +35,11 @@ export function updateOperation(http: HttpClient, rootUrl: string, params: Updat } return http.request( - rb.build({ responseType: 'text', accept: '*/*', context }) + rb.build({ responseType: 'json', accept: 'application/json', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; + return r as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/create-instance.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/create-instance.ts index 5fc22ebcbd..fd659d506e 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/create-instance.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/create-instance.ts @@ -15,8 +15,20 @@ import { RequestBuilder } from '../../request-builder'; import { ProductInstanceModel } from '../../models/product-instance-model'; export interface CreateInstance$Params { + +/** + * Product identifier + */ identifier?: string; + +/** + * Revision of the product + */ revision?: number; + +/** + * If save is false, the new instance won't be stored in the db + */ save?: boolean; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/duplicate.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/duplicate.ts index 03d16d4556..6054381be6 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/duplicate.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/duplicate.ts @@ -15,8 +15,16 @@ import { RequestBuilder } from '../../request-builder'; import { ProductModel } from '../../models/product-model'; export interface Duplicate$Params { + +/** + * Database id of the existing product type + */ id: number; - body?: string + + /** + * Product identifier of the new product + */ + body: string } export function duplicate(http: HttpClient, rootUrl: string, params: Duplicate$Params, context?: HttpContext): Observable> { diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-instance.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-instance.ts index a43f8580c9..9393db2250 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-instance.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-instance.ts @@ -15,6 +15,10 @@ import { RequestBuilder } from '../../request-builder'; import { ProductInstanceModel } from '../../models/product-instance-model'; export interface GetInstance$Params { + +/** + * Database id of the product instance + */ id: number; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-instances.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-instances.ts index 2e92ff0010..a65f03787c 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-instances.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-instances.ts @@ -15,6 +15,10 @@ import { RequestBuilder } from '../../request-builder'; import { ProductInstanceModel } from '../../models/product-instance-model'; export interface GetInstances$Params { + +/** + * A list of product instance ids + */ ids?: Array; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-recipe.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-recipe.ts index 1b548dc3d7..93fc3c3f7f 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-recipe.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-recipe.ts @@ -15,6 +15,10 @@ import { RequestBuilder } from '../../request-builder'; import { RecipeModel } from '../../models/recipe-model'; export interface GetRecipe$Params { + +/** + * Database id of the recipe + */ id: number; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-recipes.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-recipes.ts index 39ff33b1ee..997365ede2 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-recipes.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-recipes.ts @@ -15,7 +15,15 @@ import { RequestBuilder } from '../../request-builder'; import { RecipeModel } from '../../models/recipe-model'; export interface GetRecipes$Params { + +/** + * Database id + */ id: number; + +/** + * Recipe classification RecipeClassification + */ classification: number; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-type-by-id.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-type-by-id.ts index 81acac5b91..bc0d25efef 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-type-by-id.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-type-by-id.ts @@ -15,6 +15,10 @@ import { RequestBuilder } from '../../request-builder'; import { ProductModel } from '../../models/product-model'; export interface GetTypeById$Params { + +/** + * Database id + */ id: number; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-type-by-identity.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-type-by-identity.ts index c5cf4c06bf..b6899969cc 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-type-by-identity.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-type-by-identity.ts @@ -15,6 +15,10 @@ import { RequestBuilder } from '../../request-builder'; import { ProductModel } from '../../models/product-model'; export interface GetTypeByIdentity$Params { + +/** + * Optional. The id to look for + */ identity?: string; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-types.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-types.ts index 0ad1b0ba0e..4768f33018 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-types.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/get-types.ts @@ -16,10 +16,14 @@ import { ProductModel } from '../../models/product-model'; import { ProductQuery } from '../../models/product-query'; export interface GetTypes$Params { - body?: ProductQuery + + /** + * Query parameters + */ + body: ProductQuery } -export function getTypes(http: HttpClient, rootUrl: string, params?: GetTypes$Params, context?: HttpContext): Observable>> { +export function getTypes(http: HttpClient, rootUrl: string, params: GetTypes$Params, context?: HttpContext): Observable>> { const rb = new RequestBuilder(rootUrl, getTypes.PATH, 'post'); if (params) { rb.body(params.body, 'application/*+json'); diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/import.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/import.ts index 1179571565..c07aff507f 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/import.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/import.ts @@ -17,8 +17,16 @@ import { RequestBuilder } from '../../request-builder'; import { ProductModel } from '../../models/product-model'; export interface Import$Params { + +/** + * Name of the importer + */ importerName: string; - body?: Entry + + /** + * Parameters for the importer + */ + body: Entry } export function import$(http: HttpClient, rootUrl: string, params: Import$Params, context?: HttpContext): Observable>> { diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/save-instance.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/save-instance.ts index 6bfe1c0611..b34d338219 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/save-instance.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/save-instance.ts @@ -15,21 +15,25 @@ import { RequestBuilder } from '../../request-builder'; import { ProductInstanceModel } from '../../models/product-instance-model'; export interface SaveInstance$Params { - body?: ProductInstanceModel + + /** + * Model of the product instance + */ + body: ProductInstanceModel } -export function saveInstance(http: HttpClient, rootUrl: string, params?: SaveInstance$Params, context?: HttpContext): Observable> { +export function saveInstance(http: HttpClient, rootUrl: string, params: SaveInstance$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, saveInstance.PATH, 'put'); if (params) { rb.body(params.body, 'application/*+json'); } return http.request( - rb.build({ responseType: 'text', accept: '*/*', context }) + rb.build({ responseType: 'json', accept: 'application/json', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; + return r as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/save-recipe.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/save-recipe.ts index 29c0508df6..673574140a 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/save-recipe.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/save-recipe.ts @@ -15,10 +15,14 @@ import { RequestBuilder } from '../../request-builder'; import { RecipeModel } from '../../models/recipe-model'; export interface SaveRecipe$Params { - body?: RecipeModel + + /** + * Model of the recipe + */ + body: RecipeModel } -export function saveRecipe(http: HttpClient, rootUrl: string, params?: SaveRecipe$Params, context?: HttpContext): Observable> { +export function saveRecipe(http: HttpClient, rootUrl: string, params: SaveRecipe$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, saveRecipe.PATH, 'post'); if (params) { rb.body(params.body, 'application/*+json'); diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/save-type.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/save-type.ts index 23a5ae9acf..ece68ebd2b 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/save-type.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/save-type.ts @@ -15,10 +15,14 @@ import { RequestBuilder } from '../../request-builder'; import { ProductModel } from '../../models/product-model'; export interface SaveType$Params { - body?: ProductModel + + /** + * Model of the new product + */ + body: ProductModel } -export function saveType(http: HttpClient, rootUrl: string, params?: SaveType$Params, context?: HttpContext): Observable> { +export function saveType(http: HttpClient, rootUrl: string, params: SaveType$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, saveType.PATH, 'post'); if (params) { rb.body(params.body, 'application/*+json'); diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/update-recipe.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/update-recipe.ts index 0bcf4a4f03..d7d74f15b4 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/update-recipe.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/update-recipe.ts @@ -15,8 +15,16 @@ import { RequestBuilder } from '../../request-builder'; import { RecipeModel } from '../../models/recipe-model'; export interface UpdateRecipe$Params { + +/** + * Database id of the recipe + */ id: number; - body?: RecipeModel + + /** + * Updated recipe model + */ + body: RecipeModel } export function updateRecipe(http: HttpClient, rootUrl: string, params: UpdateRecipe$Params, context?: HttpContext): Observable> { diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/update-type.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/update-type.ts index 49ecadf3c3..07f453da20 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/update-type.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/update-type.ts @@ -15,8 +15,16 @@ import { RequestBuilder } from '../../request-builder'; import { ProductModel } from '../../models/product-model'; export interface UpdateType$Params { + +/** + * Database id of the product type + */ id: number; - body?: ProductModel + + /** + * New product model + */ + body: ProductModel } export function updateType(http: HttpClient, rootUrl: string, params: UpdateType$Params, context?: HttpContext): Observable> { diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/workplan/delete-workplan.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/workplan/delete-workplan.ts index 794b5f00cf..7ba84b3a5f 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/workplan/delete-workplan.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/workplan/delete-workplan.ts @@ -17,18 +17,18 @@ export interface DeleteWorkplan$Params { id: number; } -export function deleteWorkplan(http: HttpClient, rootUrl: string, params: DeleteWorkplan$Params, context?: HttpContext): Observable> { +export function deleteWorkplan(http: HttpClient, rootUrl: string, params: DeleteWorkplan$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, deleteWorkplan.PATH, 'delete'); if (params) { rb.path('id', params.id, {}); } return http.request( - rb.build({ responseType: 'text', accept: '*/*', context }) + rb.build({ responseType: 'json', accept: 'application/json', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; + return r as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/workplan/save-workplan.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/workplan/save-workplan.ts index a64b48bfa8..63c4ae7182 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/workplan/save-workplan.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/workplan/save-workplan.ts @@ -15,10 +15,10 @@ import { RequestBuilder } from '../../request-builder'; import { WorkplanModel } from '../../models/workplan-model'; export interface SaveWorkplan$Params { - body?: WorkplanModel + body: WorkplanModel } -export function saveWorkplan(http: HttpClient, rootUrl: string, params?: SaveWorkplan$Params, context?: HttpContext): Observable> { +export function saveWorkplan(http: HttpClient, rootUrl: string, params: SaveWorkplan$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, saveWorkplan.PATH, 'post'); if (params) { rb.body(params.body, 'application/*+json'); diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/workplan/update-workplan.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/workplan/update-workplan.ts index 8ab8498aa2..1ef5eea031 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/workplan/update-workplan.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/workplan/update-workplan.ts @@ -16,7 +16,7 @@ import { WorkplanModel } from '../../models/workplan-model'; export interface UpdateWorkplan$Params { id: string; - body?: WorkplanModel + body: WorkplanModel } export function updateWorkplan(http: HttpClient, rootUrl: string, params: UpdateWorkplan$Params, context?: HttpContext): Observable> { diff --git a/src/Moryx.Orders.Web/app/src/app/api/models.ts b/src/Moryx.Orders.Web/app/src/app/api/models.ts index 022b14bd13..bb313b0b1d 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models.ts @@ -12,51 +12,49 @@ export type { AssignableOperator } from './models/assignable-operator'; export type { AttendableResourceModel } from './models/attendable-resource-model'; export type { BeginContext } from './models/begin-context'; export type { BeginModel } from './models/begin-model'; -export { ConfirmationType } from './models/confirmation-type'; +export type { ConfirmationType } from './models/confirmation-type'; export type { DocumentModel } from './models/document-model'; +export type { EntityTagHeaderValue } from './models/entity-tag-header-value'; export type { ExtendedOperatorModel } from './models/extended-operator-model'; +export type { FileStreamResult } from './models/file-stream-result'; export type { ICapabilities } from './models/i-capabilities'; export type { IOperatorAssignable } from './models/i-operator-assignable'; -export { LogLevel } from './models/log-level'; +export type { LogLevel } from './models/log-level'; export type { MoryxExceptionResponse } from './models/moryx-exception-response'; export type { OperationAdvicedModel } from './models/operation-adviced-model'; -export type { OperationChangedModel } from './models/operation-changed-model'; export type { OperationCreationContextModel } from './models/operation-creation-context-model'; export type { OperationLogMessageModel } from './models/operation-log-message-model'; export type { OperationModel } from './models/operation-model'; export type { OperationRecipeModel } from './models/operation-recipe-model'; export type { OperationReportedModel } from './models/operation-reported-model'; export type { OperationStartedModel } from './models/operation-started-model'; -export { OperationStateClassification } from './models/operation-state-classification'; +export type { OperationStateClassification } from './models/operation-state-classification'; export type { OperationUpdateModel } from './models/operation-update-model'; export type { OperatorModel } from './models/operator-model'; -export { PartClassification } from './models/part-classification'; -export type { PartConnector } from './models/part-connector'; -export type { PartCreationContext } from './models/part-creation-context'; -export type { PartModel } from './models/part-model'; +export type { PartClassification } from './models/part-classification'; export type { ProblemDetails } from './models/problem-details'; export type { ProductCustomization } from './models/product-customization'; -export type { ProductDefinitionModel } from './models/product-definition-model'; -export type { ProductImporter } from './models/product-importer'; export type { ProductInstanceModel } from './models/product-instance-model'; -export { ProductInstanceState } from './models/product-instance-state'; +export type { ProductInstanceState } from './models/product-instance-state'; export type { ProductModel } from './models/product-model'; export type { ProductPartModel } from './models/product-part-model'; export type { ProductQuery } from './models/product-query'; -export { ProductState } from './models/product-state'; -export type { PropertyFilter } from './models/property-filter'; -export { PropertyFilterOperator } from './models/property-filter-operator'; -export { RecipeClassificationModel } from './models/recipe-classification-model'; -export type { RecipeDefinitionModel } from './models/recipe-definition-model'; -export { RecipeFilter } from './models/recipe-filter'; +export type { ProductState } from './models/product-state'; +export type { RecipeClassificationModel } from './models/recipe-classification-model'; +export type { RecipeFilter } from './models/recipe-filter'; export type { RecipeModel } from './models/recipe-model'; -export { RecipeState } from './models/recipe-state'; +export type { RecipeState } from './models/recipe-state'; export type { ReportContext } from './models/report-context'; export type { ReportModel } from './models/report-model'; -export type { RestrictionDescription } from './models/restriction-description'; -export { RestrictionSeverity } from './models/restriction-severity'; -export { RevisionFilter } from './models/revision-filter'; -export { Selector } from './models/selector'; -export { StagingIndicator } from './models/staging-indicator'; +export type { RevisionFilter } from './models/revision-filter'; +export type { Selector } from './models/selector'; +export type { SseItemBase } from './models/sse-item-base'; +export type { SseItemOfOperationAdvicedModel } from './models/sse-item-of-operation-adviced-model'; +export type { SseItemOfOperationModel } from './models/sse-item-of-operation-model'; +export type { SseItemOfOperationReportedModel } from './models/sse-item-of-operation-reported-model'; +export type { SseItemOfOperationStartedModel } from './models/sse-item-of-operation-started-model'; +export type { StagingIndicator } from './models/staging-indicator'; +export type { Stream } from './models/stream'; +export type { StringSegment } from './models/string-segment'; export type { WorkplanModel } from './models/workplan-model'; -export { WorkplanState } from './models/workplan-state'; +export type { WorkplanState } from './models/workplan-state'; diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/advice-context.ts b/src/Moryx.Orders.Web/app/src/app/api/models/advice-context.ts index 440600fc1c..b73e163fea 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/advice-context.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/advice-context.ts @@ -6,6 +6,14 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ + +/** + * Context for a new advice with all necessary information + */ export interface AdviceContext { + + /** + * Amount which are already adviced + */ advicedAmount?: number; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/advice-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/advice-model.ts index 8269d6eeb9..56bc5767d1 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/advice-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/advice-model.ts @@ -8,6 +8,6 @@ export interface AdviceModel { amount?: number; - partId?: number | null; - toteBoxNumber?: string | null; + partId?: (number | null); + toteBoxNumber?: (string | null); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/assignable-operator.ts b/src/Moryx.Orders.Web/app/src/app/api/models/assignable-operator.ts index e1aed15ff5..9a5912aa06 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/assignable-operator.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/assignable-operator.ts @@ -8,10 +8,10 @@ import { IOperatorAssignable } from '../models/i-operator-assignable'; export interface AssignableOperator { - assignedResources?: Array | null; - firstName?: string | null; - identifier?: string | null; - lastName?: string | null; - pseudonym?: string | null; + assignedResources?: Array; + firstName?: (string | null); + identifier: string; + lastName?: (string | null); + pseudonym?: (string | null); signedIn?: boolean; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/attendable-resource-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/attendable-resource-model.ts index 63a223b492..a9cf91c008 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/attendable-resource-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/attendable-resource-model.ts @@ -7,7 +7,7 @@ /* Code generated by ng-openapi-gen DO NOT EDIT. */ export interface AttendableResourceModel { - id?: number | null; - name?: string | null; - requiredSkills?: Array | null; + id?: (number | null); + name?: (string | null); + requiredSkills?: (Array | null); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/begin-context.ts b/src/Moryx.Orders.Web/app/src/app/api/models/begin-context.ts index 3929dd2e88..54938a9a7c 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/begin-context.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/begin-context.ts @@ -7,13 +7,49 @@ /* Code generated by ng-openapi-gen DO NOT EDIT. */ import { RestrictionDescription } from '../models/restriction-description'; + +/** + * Context information to begin an operation production + */ export interface BeginContext { + + /** + * Indicator if a begin is possible + */ canBegin?: boolean; + + /** + * Indicator if an adjustment of the operation is possible + */ canReduce?: boolean; + + /** + * Provides the minimum value that can be set for the target amount when adjusting the operation. + */ minimalTargetAmount?: number; + + /** + * Current target amount of the operation + */ partialAmount?: number; + + /** + * Residual amount of the operation + */ residualAmount?: number; - restrictions?: Array | null; + + /** + * Reasons why a begin is not possible + */ + restrictions?: (Array | null); + + /** + * Current failure count of the operation + */ scrapCount?: number; + + /** + * Current success count of the operation + */ successCount?: number; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/begin-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/begin-model.ts index 490f614755..3518a7a8c4 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/begin-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/begin-model.ts @@ -8,5 +8,5 @@ export interface BeginModel { amount?: number; - userId?: string | null; + userId?: (string | null); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/confirmation-type.ts b/src/Moryx.Orders.Web/app/src/app/api/models/confirmation-type.ts index 4361c1026f..a71aa9d361 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/confirmation-type.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/confirmation-type.ts @@ -6,7 +6,9 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export enum ConfirmationType { - Partial = 'Partial', - Final = 'Final' -} + +/** + * Confirmation type while reporting amounts of an operation + */ +export type ConfirmationType = 'Partial' | 'Final'; + diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/document-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/document-model.ts index 2b691cc1cc..63b90688c5 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/document-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/document-model.ts @@ -7,11 +7,11 @@ /* Code generated by ng-openapi-gen DO NOT EDIT. */ export interface DocumentModel { - contentType?: string | null; - description?: string | null; - identifier?: string | null; - number?: string | null; + contentType?: (string | null); + description?: (string | null); + identifier?: (string | null); + number?: (string | null); revision?: number; - source?: string | null; - type?: string | null; + source?: (string | null); + type?: (string | null); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/recipe-definition-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/entity-tag-header-value.ts similarity index 56% rename from src/Moryx.Orders.Web/app/src/app/api/models/recipe-definition-model.ts rename to src/Moryx.Orders.Web/app/src/app/api/models/entity-tag-header-value.ts index bd6efd645a..9759259a5f 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/recipe-definition-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/entity-tag-header-value.ts @@ -6,8 +6,8 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export interface RecipeDefinitionModel { - displayName?: string | null; - hasWorkplans?: boolean; - name?: string | null; +import { StringSegment } from '../models/string-segment'; +export interface EntityTagHeaderValue { + isWeak?: boolean; + tag?: StringSegment; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/extended-operator-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/extended-operator-model.ts index 5ac87445d8..efb1f20c99 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/extended-operator-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/extended-operator-model.ts @@ -8,9 +8,9 @@ import { AttendableResourceModel } from '../models/attendable-resource-model'; export interface ExtendedOperatorModel { - assignedResources?: Array | null; - firstName?: string | null; - identifier?: string | null; - lastName?: string | null; - pseudonym?: string | null; + assignedResources?: (Array | null); + firstName?: (string | null); + identifier?: (string | null); + lastName?: (string | null); + pseudonym?: (string | null); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/file-stream-result.ts b/src/Moryx.Orders.Web/app/src/app/api/models/file-stream-result.ts new file mode 100644 index 0000000000..d9111ab0f9 --- /dev/null +++ b/src/Moryx.Orders.Web/app/src/app/api/models/file-stream-result.ts @@ -0,0 +1,18 @@ +/* + * Copyright (c) 2026 Phoenix Contact GmbH & Co. KG + * Licensed under the Apache License, Version 2.0 +*/ + +/* eslint-disable */ +/* Code generated by ng-openapi-gen DO NOT EDIT. */ + +import { EntityTagHeaderValue } from '../models/entity-tag-header-value'; +import { Stream } from '../models/stream'; +export interface FileStreamResult { + contentType?: (string | null); + enableRangeProcessing?: boolean; + entityTag?: (null | EntityTagHeaderValue); + fileDownloadName?: (string | null); + fileStream?: Stream; + lastModified?: (string | null); +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/i-capabilities.ts b/src/Moryx.Orders.Web/app/src/app/api/models/i-capabilities.ts index c53081c774..b9d5eb1508 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/i-capabilities.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/i-capabilities.ts @@ -6,6 +6,14 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ + +/** + * Common capabilities interface + */ export interface ICapabilities { + + /** + * Flag if the capabilities of this instance are implemented by sub instances + */ isCombined?: boolean; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/i-operator-assignable.ts b/src/Moryx.Orders.Web/app/src/app/api/models/i-operator-assignable.ts index c109276a51..8aeb04c0a3 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/i-operator-assignable.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/i-operator-assignable.ts @@ -8,8 +8,20 @@ import { ICapabilities } from '../models/i-capabilities'; export interface IOperatorAssignable { + + /** + * The resource's capabilities + */ capabilities?: ICapabilities; + + /** + * Id of the resource + */ id?: number; - name?: string | null; + + /** + * Name of this resource instance + */ + name?: (string | null); requiredSkills?: ICapabilities; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/log-level.ts b/src/Moryx.Orders.Web/app/src/app/api/models/log-level.ts index c45c1ba145..92cce0b909 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/log-level.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/log-level.ts @@ -6,12 +6,5 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export enum LogLevel { - Trace = 'Trace', - Debug = 'Debug', - Information = 'Information', - Warning = 'Warning', - Error = 'Error', - Critical = 'Critical', - None = 'None' -} +export type LogLevel = 'Trace' | 'Debug' | 'Information' | 'Warning' | 'Error' | 'Critical' | 'None'; + diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/moryx-exception-response.ts b/src/Moryx.Orders.Web/app/src/app/api/models/moryx-exception-response.ts index f832a18a40..7d28696d8e 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/moryx-exception-response.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/moryx-exception-response.ts @@ -7,6 +7,6 @@ /* Code generated by ng-openapi-gen DO NOT EDIT. */ export interface MoryxExceptionResponse { - exception?: string | null; - title?: string | null; + exception?: (string | null); + title?: (string | null); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/operation-changed-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/operation-changed-model.ts deleted file mode 100644 index 993ff8e488..0000000000 --- a/src/Moryx.Orders.Web/app/src/app/api/models/operation-changed-model.ts +++ /dev/null @@ -1,16 +0,0 @@ -/* - * Copyright (c) 2026 Phoenix Contact GmbH & Co. KG - * Licensed under the Apache License, Version 2.0 -*/ - -/* eslint-disable */ -/* Code generated by ng-openapi-gen DO NOT EDIT. */ - -import { OperationAdvicedModel } from '../models/operation-adviced-model'; -import { OperationReportedModel } from '../models/operation-reported-model'; -import { OperationStartedModel } from '../models/operation-started-model'; -export interface OperationChangedModel { - advicedModel?: OperationAdvicedModel; - reportedModel?: OperationReportedModel; - startedModel?: OperationStartedModel; -} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/operation-creation-context-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/operation-creation-context-model.ts index 4c3180de1f..ff667e489d 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/operation-creation-context-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/operation-creation-context-model.ts @@ -10,21 +10,89 @@ import { Entry } from '@moryx/ngx-web-framework/entry-editor'; import { PartCreationContext } from '../models/part-creation-context'; export interface OperationCreationContextModel { - materialParameters?: Array | null; - name?: string | null; - operationNumber?: string | null; - orderNumber?: string | null; + + /** + * Additional operation depending parameters for the production + */ + materialParameters?: (Array | null); + + /** + * Operation name + */ + name?: (string | null); + + /** + * The number of this operation + */ + operationNumber?: (string | null); + + /** + * The number of the order this operation belongs to + */ + orderNumber?: (string | null); + + /** + * Total amount planned for over delivery + */ overDeliveryAmount?: number; - parts?: Array | null; + + /** + * Part list of the product of this operation + */ + parts?: (Array | null); + + /** + * Expected end time + */ plannedEnd?: string; + + /** + * Expected start time + */ plannedStart?: string; - productIdentifier?: string | null; - productName?: string | null; + + /** + * Main product identifier + */ + productIdentifier?: (string | null); + + /** + * Name of the Product + */ + productName?: (string | null); + + /** + * Revision of the Product + */ productRevision?: number; + + /** + * Id of the preselected recipe + */ recipePreselection?: number; + + /** + * Target cycle time for the production of the depending product + */ targetCycleTime?: number; - targetStock?: string | null; + + /** + * Target stock for produced parts + */ + targetStock?: (string | null); + + /** + * The amount to produce + */ totalAmount?: number; + + /** + * Total amount planned for under delivery + */ underDeliveryAmount?: number; - unit?: string | null; + + /** + * Unit of product + */ + unit?: (string | null); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/operation-log-message-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/operation-log-message-model.ts index baa1d1468f..734765a4ae 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/operation-log-message-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/operation-log-message-model.ts @@ -8,8 +8,8 @@ import { LogLevel } from '../models/log-level'; export interface OperationLogMessageModel { - exception?: string | null; + exception?: (string | null); logLevel?: LogLevel; - message?: string | null; + message?: (string | null); timeStamp?: string; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/operation-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/operation-model.ts index 276f5b0b07..484cc410a3 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/operation-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/operation-model.ts @@ -9,6 +9,10 @@ import { Entry } from '@moryx/ngx-web-framework/entry-editor'; /* Code generated by ng-openapi-gen DO NOT EDIT. */ import { OperationStateClassification } from '../models/operation-state-classification'; + +/** + * OrderOperation-DTO to be used with the endpoints + */ export interface OperationModel { canAdvice?: boolean; canAssign?: boolean; @@ -16,7 +20,7 @@ export interface OperationModel { canInterrupt?: boolean; canReport?: boolean; classification?: OperationStateClassification; - end?: string | null; + end?: (string | null); hasDocuments?: boolean; hasPartList?: boolean; identifier?: string; @@ -25,35 +29,35 @@ export interface OperationModel { isAssigning?: boolean; isCreated?: boolean; isFailed?: boolean; - jobIds?: Array | null; - name?: string | null; - number?: string | null; + jobIds?: (Array | null); + name?: (string | null); + number?: (string | null); operationSource?: Entry; - order?: string | null; + order?: (string | null); overDeliveryAmount?: number; pendingCount?: number; plannedEnd?: string; plannedStart?: string; productId?: number; - productIdentifier?: string | null; - productName?: string | null; + productIdentifier?: (string | null); + productName?: (string | null); productRevision?: number; progressPending?: number; progressRunning?: number; progressScrap?: number; progressSuccess?: number; - recipeIds?: Array | null; - recipeName?: string | null; + recipeIds?: (Array | null); + recipeName?: (string | null); reportedFailureCount?: number; reportedSuccessCount?: number; runningCount?: number; scrapCount?: number; sortOrder?: number; - start?: string | null; - stateDisplayName?: string | null; + start?: (string | null); + stateDisplayName?: (string | null); successCount?: number; targetCycleTime?: number; totalAmount?: number; underDeliveryAmount?: number; - unit?: string | null; + unit?: (string | null); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/operation-recipe-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/operation-recipe-model.ts index 44ae78181f..b9988ccc90 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/operation-recipe-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/operation-recipe-model.ts @@ -8,5 +8,5 @@ export interface OperationRecipeModel { id?: number; - name?: string | null; + name?: (string | null); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/operation-started-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/operation-started-model.ts index c7582a047b..d0a2146d72 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/operation-started-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/operation-started-model.ts @@ -9,5 +9,5 @@ import { OperationModel } from '../models/operation-model'; export interface OperationStartedModel { operationModel?: OperationModel; - userId?: string | null; + userId?: (string | null); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/operation-state-classification.ts b/src/Moryx.Orders.Web/app/src/app/api/models/operation-state-classification.ts index d2cd09068a..51e599ba65 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/operation-state-classification.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/operation-state-classification.ts @@ -6,20 +6,13 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export enum OperationStateClassification { - Initial = 'Initial', - Assigning = 'Assigning', - Failed = 'Failed', - Aborted = 'Aborted', - Ready = 'Ready', - Running = 'Running', - Interrupting = 'Interrupting', - Interrupted = 'Interrupted', - Completed = 'Completed', - CanReload = 'CanReload', - CanBegin = 'CanBegin', - CanInterrupt = 'CanInterrupt', - CanReport = 'CanReport', - CanAdvice = 'CanAdvice', - IsAmountReached = 'IsAmountReached' -} + +/** + * Enum providing the classification of the internal state machine of the operation for an external representation + * The lowest 8 bits define the state of the operation. The following 16 bits contain flags for the executable + * actions on the operation and the trailing 8 bits overall classification information. + * Bit: 31 - 24 | 23 - 8 | 7 - 0 | + * Flag: Overall | Usage | State | + */ +export type OperationStateClassification = string; + diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/operation-update-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/operation-update-model.ts index 0b1fa46336..4a2c8733ea 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/operation-update-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/operation-update-model.ts @@ -7,12 +7,12 @@ /* Code generated by ng-openapi-gen DO NOT EDIT. */ export interface OperationUpdateModel { - overDeliveryAmount?: number | null; - plannedEnd?: string | null; - plannedStart?: string | null; - sortIndex?: number | null; - targetCycleTime?: number | null; - targetStock?: string | null; - totalAmount?: number | null; - underDeliveryAmount?: number | null; + overDeliveryAmount?: (number | null); + plannedEnd?: (string | null); + plannedStart?: (string | null); + sortIndex?: (number | null); + targetCycleTime?: (number | null); + targetStock?: (string | null); + totalAmount?: (number | null); + underDeliveryAmount?: (number | null); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/operator-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/operator-model.ts index ae95613618..f6fd606338 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/operator-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/operator-model.ts @@ -7,8 +7,8 @@ /* Code generated by ng-openapi-gen DO NOT EDIT. */ export interface OperatorModel { - firstName?: string | null; - identifier?: string | null; - lastName?: string | null; - pseudonym?: string | null; + firstName?: (string | null); + identifier?: (string | null); + lastName?: (string | null); + pseudonym?: (string | null); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/part-classification.ts b/src/Moryx.Orders.Web/app/src/app/api/models/part-classification.ts index bded17daa8..befe4dd752 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/part-classification.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/part-classification.ts @@ -6,11 +6,5 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export enum PartClassification { - Unknown = 'Unknown', - Material = 'Material', - InfoComponent = 'InfoComponent', - CarrierMaterial = 'CarrierMaterial', - ScrapMaterial = 'ScrapMaterial', - BranchMaterial = 'BranchMaterial' -} +export type PartClassification = 'Unknown' | 'Material' | 'InfoComponent' | 'CarrierMaterial' | 'ScrapMaterial' | 'BranchMaterial'; + diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/part-connector.ts b/src/Moryx.Orders.Web/app/src/app/api/models/part-connector.ts deleted file mode 100644 index 3da21ee81d..0000000000 --- a/src/Moryx.Orders.Web/app/src/app/api/models/part-connector.ts +++ /dev/null @@ -1,19 +0,0 @@ -/* - * Copyright (c) 2026 Phoenix Contact GmbH & Co. KG - * Licensed under the Apache License, Version 2.0 -*/ - -/* eslint-disable */ -import { Entry } from '@moryx/ngx-web-framework/entry-editor'; - -/* Code generated by ng-openapi-gen DO NOT EDIT. */ - -import { PartModel } from '../models/part-model'; -export interface PartConnector { - displayName?: string | null; - isCollection?: boolean; - name?: string | null; - parts?: Array | null; - propertyTemplates?: Entry; - type?: string | null; -} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/part-creation-context.ts b/src/Moryx.Orders.Web/app/src/app/api/models/part-creation-context.ts deleted file mode 100644 index c53e25b8cb..0000000000 --- a/src/Moryx.Orders.Web/app/src/app/api/models/part-creation-context.ts +++ /dev/null @@ -1,18 +0,0 @@ -/* - * Copyright (c) 2026 Phoenix Contact GmbH & Co. KG - * Licensed under the Apache License, Version 2.0 -*/ - -/* eslint-disable */ -/* Code generated by ng-openapi-gen DO NOT EDIT. */ - -import { PartClassification } from '../models/part-classification'; -import { StagingIndicator } from '../models/staging-indicator'; -export interface PartCreationContext { - classification?: PartClassification; - name?: string | null; - number?: string | null; - quantity?: number; - stagingIndicator?: StagingIndicator; - unit?: string | null; -} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/part-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/part-model.ts deleted file mode 100644 index 7f4d698d83..0000000000 --- a/src/Moryx.Orders.Web/app/src/app/api/models/part-model.ts +++ /dev/null @@ -1,16 +0,0 @@ -/* - * Copyright (c) 2026 Phoenix Contact GmbH & Co. KG - * Licensed under the Apache License, Version 2.0 -*/ - -/* eslint-disable */ -import { Entry } from '@moryx/ngx-web-framework/entry-editor'; - -/* Code generated by ng-openapi-gen DO NOT EDIT. */ - -import { ProductModel } from '../models/product-model'; -export interface PartModel { - id?: number; - product?: ProductModel; - properties?: Entry; -} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/problem-details.ts b/src/Moryx.Orders.Web/app/src/app/api/models/problem-details.ts index a683af8312..ac43e51160 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/problem-details.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/problem-details.ts @@ -7,11 +7,9 @@ /* Code generated by ng-openapi-gen DO NOT EDIT. */ export interface ProblemDetails { - detail?: string | null; - instance?: string | null; - status?: number | null; - title?: string | null; - type?: string | null; - - [key: string]: any | number | null | string | null | undefined; + detail?: (string | null); + instance?: (string | null); + status?: (number | null); + title?: (string | null); + type?: (string | null); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/product-customization.ts b/src/Moryx.Orders.Web/app/src/app/api/models/product-customization.ts index f76c1c0ea5..86127257de 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/product-customization.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/product-customization.ts @@ -10,7 +10,7 @@ import { ProductDefinitionModel } from '../models/product-definition-model'; import { ProductImporter } from '../models/product-importer'; import { RecipeDefinitionModel } from '../models/recipe-definition-model'; export interface ProductCustomization { - importers?: Array | null; - productTypes?: Array | null; - recipeTypes?: Array | null; + importers?: (Array | null); + productTypes?: (Array | null); + recipeTypes?: (Array | null); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/product-definition-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/product-definition-model.ts deleted file mode 100644 index 852889caef..0000000000 --- a/src/Moryx.Orders.Web/app/src/app/api/models/product-definition-model.ts +++ /dev/null @@ -1,16 +0,0 @@ -/* - * Copyright (c) 2026 Phoenix Contact GmbH & Co. KG - * Licensed under the Apache License, Version 2.0 -*/ - -/* eslint-disable */ -import { Entry } from '@moryx/ngx-web-framework/entry-editor'; - -/* Code generated by ng-openapi-gen DO NOT EDIT. */ - -export interface ProductDefinitionModel { - baseDefinition?: string | null; - displayName?: string | null; - name?: string | null; - properties?: Entry; -} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/product-instance-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/product-instance-model.ts index d4e86da467..6b29871365 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/product-instance-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/product-instance-model.ts @@ -12,6 +12,14 @@ import { ProductInstanceState } from '../models/product-instance-state'; export interface ProductInstanceModel { id?: number; properties?: Entry; + + /** + * The current state of the instance + */ state?: ProductInstanceState; - type?: string | null; + + /** + * The name of the product type of this instance + */ + type?: (string | null); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/product-instance-state.ts b/src/Moryx.Orders.Web/app/src/app/api/models/product-instance-state.ts index 1b30c9cee5..be9bce94c6 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/product-instance-state.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/product-instance-state.ts @@ -6,10 +6,10 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export enum ProductInstanceState { - Unset = 'Unset', - InProduction = 'InProduction', - Paused = 'Paused', - Success = 'Success', - Failure = 'Failure' -} + +/** + * The state of an ProductInstance. + * This will not occupy more than 4 Bits. Other enums can be added by bit-shifting + */ +export type ProductInstanceState = string; + diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/product-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/product-model.ts index dcfa7076ae..941fd5f220 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/product-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/product-model.ts @@ -13,12 +13,12 @@ import { ProductState } from '../models/product-state'; import { RecipeModel } from '../models/recipe-model'; export interface ProductModel { id?: number; - identifier?: string | null; - name?: string | null; - parts?: Array | null; + identifier?: (string | null); + name?: (string | null); + parts?: (Array | null); properties?: Entry; - recipes?: Array | null; + recipes?: (Array | null); revision?: number; state?: ProductState; - type?: string | null; + type?: (string | null); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/product-part-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/product-part-model.ts index 36d168c617..da518dcc87 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/product-part-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/product-part-model.ts @@ -11,9 +11,9 @@ import { StagingIndicator } from '../models/staging-indicator'; export interface ProductPartModel { classification?: PartClassification; id?: number; - identifier?: string | null; - name?: string | null; + identifier?: (string | null); + name?: (string | null); quantity?: number; stagingIndicator?: StagingIndicator; - unit?: string | null; + unit?: (string | null); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/product-query.ts b/src/Moryx.Orders.Web/app/src/app/api/models/product-query.ts index f5b73d5829..e7e1adbecb 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/product-query.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/product-query.ts @@ -11,17 +11,67 @@ import { PropertyFilter } from '../models/property-filter'; import { RecipeFilter } from '../models/recipe-filter'; import { RevisionFilter } from '../models/revision-filter'; import { Selector } from '../models/selector'; + +/** + * Filter to fetch products from the product management + */ export interface ProductQuery { + + /** + * When filtering by type exclude derived types and only return specific matches + */ excludeDerivedTypes?: boolean; - identifier?: string | null; + + /** + * Material identifiers + */ + identifier?: (string | null); + + /** + * Flag if deleted products should be included in the query + */ includeDeleted?: boolean; + + /** + * If set to true, product queries return fully populated product types. + * Otherwise only the basic type information is returned. + */ loadFullTypeInformation?: boolean; - name?: string | null; - propertyFilters?: Array | null; + + /** + * Material identifiers + */ + name?: (string | null); + + /** + * List of property filters + */ + propertyFilters?: (Array | null); + + /** + * Optional recipe filter + */ recipeFilter?: RecipeFilter; - requiredState?: ProductState; + requiredState?: (null | ProductState); + + /** + * Optional specific revision if RevisionFilter ProductQuery.RevisionFilter is set to + * RevisionFilter.Specific + */ revision?: number; + + /** + * Revisions to filter + */ revisionFilter?: RevisionFilter; + + /** + * Selector + */ selector?: Selector; - typeName?: string | null; + + /** + * Product types to filter by + */ + typeName?: (string | null); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/product-state.ts b/src/Moryx.Orders.Web/app/src/app/api/models/product-state.ts index 9a5ffdcd86..aa2bee7a1c 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/product-state.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/product-state.ts @@ -6,9 +6,9 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export enum ProductState { - Created = 'Created', - Released = 'Released', - Deprecated = 'Deprecated', - Generated = 'Generated' -} + +/** + * Current state of a product + */ +export type ProductState = string; + diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/property-filter.ts b/src/Moryx.Orders.Web/app/src/app/api/models/property-filter.ts deleted file mode 100644 index 40713e567f..0000000000 --- a/src/Moryx.Orders.Web/app/src/app/api/models/property-filter.ts +++ /dev/null @@ -1,15 +0,0 @@ -/* - * Copyright (c) 2026 Phoenix Contact GmbH & Co. KG - * Licensed under the Apache License, Version 2.0 -*/ - -/* eslint-disable */ -import { Entry } from '@moryx/ngx-web-framework/entry-editor'; - -/* Code generated by ng-openapi-gen DO NOT EDIT. */ - -import { PropertyFilterOperator } from '../models/property-filter-operator'; -export interface PropertyFilter { - entry?: Entry; - operator?: PropertyFilterOperator; -} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/recipe-classification-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/recipe-classification-model.ts index 63533c4fae..935bb831cf 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/recipe-classification-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/recipe-classification-model.ts @@ -6,10 +6,9 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export enum RecipeClassificationModel { - Unset = 'Unset', - Default = 'Default', - Alternative = 'Alternative', - Intermediate = 'Intermediate', - Part = 'Part' -} + +/** + * Webservice compatible recipe classification enum + */ +export type RecipeClassificationModel = 'Unset' | 'Default' | 'Alternative' | 'Intermediate' | 'Part'; + diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/recipe-filter.ts b/src/Moryx.Orders.Web/app/src/app/api/models/recipe-filter.ts index b24de3f941..f9b61c913b 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/recipe-filter.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/recipe-filter.ts @@ -6,8 +6,9 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export enum RecipeFilter { - Unset = 'Unset', - WithRecipe = 'WithRecipe', - WithoutRecipes = 'WithoutRecipes' -} + +/** + * Different options regarding the recipes of the product + */ +export type RecipeFilter = 'Unset' | 'WithRecipe' | 'WithoutRecipes'; + diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/recipe-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/recipe-model.ts index 0c33b3346a..664e8260b9 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/recipe-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/recipe-model.ts @@ -11,14 +11,54 @@ import { Entry } from '@moryx/ngx-web-framework/entry-editor'; import { RecipeClassificationModel } from '../models/recipe-classification-model'; import { RecipeState } from '../models/recipe-state'; import { WorkplanModel } from '../models/workplan-model'; + +/** + * DTO representation of a recipe + */ export interface RecipeModel { + + /** + * Classification of the recipe + */ classification?: RecipeClassificationModel; + + /** + * Id of the recipe + */ id?: number; + + /** + * Whether this Recipe is a clone or not + */ isClone?: boolean; - name?: string | null; + + /** + * Name of the recipe + */ + name?: (string | null); + + /** + * Properties of the recipe + */ properties?: Entry; + + /** + * Revision of the recipe + */ revision?: number; + + /** + * This recipe's state + */ state?: RecipeState; - type?: string | null; + + /** + * Type of the recipe + */ + type?: (string | null); + + /** + * A model of the currently referenced workplan + */ workplanModel?: WorkplanModel; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/recipe-state.ts b/src/Moryx.Orders.Web/app/src/app/api/models/recipe-state.ts index 079adcaba1..492127244e 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/recipe-state.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/recipe-state.ts @@ -6,8 +6,9 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export enum RecipeState { - New = 'New', - Released = 'Released', - Revoked = 'Revoked' -} + +/** + * A Recipe's state + */ +export type RecipeState = 'New' | 'Released' | 'Revoked'; + diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/report-context.ts b/src/Moryx.Orders.Web/app/src/app/api/models/report-context.ts index c1e24004e7..7d92dcff81 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/report-context.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/report-context.ts @@ -7,14 +7,54 @@ /* Code generated by ng-openapi-gen DO NOT EDIT. */ import { RestrictionDescription } from '../models/restriction-description'; + +/** + * Report which is not processed. + */ export interface ReportContext { + + /** + * If `true` the operation can be reported finally + */ canFinal?: boolean; + + /** + * If `true` the operation can be reported partially + */ canPartial?: boolean; + + /** + * Currently reported failure count + */ reportedFailure?: number; + + /** + * Currently reported success count + */ reportedSuccess?: number; - restrictions?: Array | null; + + /** + * Reasons why a report is not possible + */ + restrictions?: (Array | null); + + /** + * Current failure count of the operation + */ scrapCount?: number; + + /** + * Current success count of the operation + */ successCount?: number; + + /** + * Value of unreported failure parts + */ unreportedFailure?: number; + + /** + * Value of unreported success parts + */ unreportedSuccess?: number; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/report-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/report-model.ts index 6b6970ddc0..db30f323d1 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/report-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/report-model.ts @@ -8,9 +8,9 @@ import { ConfirmationType } from '../models/confirmation-type'; export interface ReportModel { - comment?: string | null; + comment?: (string | null); confirmationType?: ConfirmationType; failureCount?: number; successCount?: number; - userIdentifier?: string | null; + userIdentifier?: (string | null); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/restriction-description.ts b/src/Moryx.Orders.Web/app/src/app/api/models/restriction-description.ts deleted file mode 100644 index bac17c3827..0000000000 --- a/src/Moryx.Orders.Web/app/src/app/api/models/restriction-description.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* - * Copyright (c) 2026 Phoenix Contact GmbH & Co. KG - * Licensed under the Apache License, Version 2.0 -*/ - -/* eslint-disable */ -/* Code generated by ng-openapi-gen DO NOT EDIT. */ - -import { RestrictionSeverity } from '../models/restriction-severity'; -export interface RestrictionDescription { - severity?: RestrictionSeverity; - text?: string | null; -} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/revision-filter.ts b/src/Moryx.Orders.Web/app/src/app/api/models/revision-filter.ts index 72974e513d..74ad39525f 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/revision-filter.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/revision-filter.ts @@ -6,8 +6,9 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export enum RevisionFilter { - All = 'All', - Latest = 'Latest', - Specific = 'Specific' -} + +/** + * Filter for revisions + */ +export type RevisionFilter = 'All' | 'Latest' | 'Specific'; + diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/selector.ts b/src/Moryx.Orders.Web/app/src/app/api/models/selector.ts index aa40edc551..abfe19ee88 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/selector.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/selector.ts @@ -6,8 +6,9 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export enum Selector { - Direct = 'Direct', - Parent = 'Parent', - Parts = 'Parts' -} + +/** + * Determine which objects to select for the query + */ +export type Selector = 'Direct' | 'Parent' | 'Parts'; + diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/property-filter-operator.ts b/src/Moryx.Orders.Web/app/src/app/api/models/sse-item-base.ts similarity index 62% rename from src/Moryx.Orders.Web/app/src/app/api/models/property-filter-operator.ts rename to src/Moryx.Orders.Web/app/src/app/api/models/sse-item-base.ts index 284c76cb60..8398125ce7 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/property-filter-operator.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/sse-item-base.ts @@ -6,8 +6,8 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export enum PropertyFilterOperator { - Equals = 'Equals', - GreaterThen = 'GreaterThen', - LessThen = 'LessThen' +export interface SseItemBase { + eventId?: string; + reconnectInterval?: string; + type?: string; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/sse-item-of-operation-adviced-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/sse-item-of-operation-adviced-model.ts new file mode 100644 index 0000000000..cf25ac823b --- /dev/null +++ b/src/Moryx.Orders.Web/app/src/app/api/models/sse-item-of-operation-adviced-model.ts @@ -0,0 +1,14 @@ +/* + * Copyright (c) 2026 Phoenix Contact GmbH & Co. KG + * Licensed under the Apache License, Version 2.0 +*/ + +/* eslint-disable */ +/* Code generated by ng-openapi-gen DO NOT EDIT. */ + +import { OperationAdvicedModel } from '../models/operation-adviced-model'; +import { SseItemBase } from '../models/sse-item-base'; +export type SseItemOfOperationAdvicedModel = SseItemBase & { +'data'?: OperationAdvicedModel; +}; + diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/sse-item-of-operation-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/sse-item-of-operation-model.ts new file mode 100644 index 0000000000..d4f731f01d --- /dev/null +++ b/src/Moryx.Orders.Web/app/src/app/api/models/sse-item-of-operation-model.ts @@ -0,0 +1,14 @@ +/* + * Copyright (c) 2026 Phoenix Contact GmbH & Co. KG + * Licensed under the Apache License, Version 2.0 +*/ + +/* eslint-disable */ +/* Code generated by ng-openapi-gen DO NOT EDIT. */ + +import { OperationModel } from '../models/operation-model'; +import { SseItemBase } from '../models/sse-item-base'; +export type SseItemOfOperationModel = SseItemBase & { +'data'?: OperationModel; +}; + diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/sse-item-of-operation-reported-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/sse-item-of-operation-reported-model.ts new file mode 100644 index 0000000000..067e3a161a --- /dev/null +++ b/src/Moryx.Orders.Web/app/src/app/api/models/sse-item-of-operation-reported-model.ts @@ -0,0 +1,14 @@ +/* + * Copyright (c) 2026 Phoenix Contact GmbH & Co. KG + * Licensed under the Apache License, Version 2.0 +*/ + +/* eslint-disable */ +/* Code generated by ng-openapi-gen DO NOT EDIT. */ + +import { OperationReportedModel } from '../models/operation-reported-model'; +import { SseItemBase } from '../models/sse-item-base'; +export type SseItemOfOperationReportedModel = SseItemBase & { +'data'?: OperationReportedModel; +}; + diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/sse-item-of-operation-started-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/sse-item-of-operation-started-model.ts new file mode 100644 index 0000000000..45b3e8ddad --- /dev/null +++ b/src/Moryx.Orders.Web/app/src/app/api/models/sse-item-of-operation-started-model.ts @@ -0,0 +1,14 @@ +/* + * Copyright (c) 2026 Phoenix Contact GmbH & Co. KG + * Licensed under the Apache License, Version 2.0 +*/ + +/* eslint-disable */ +/* Code generated by ng-openapi-gen DO NOT EDIT. */ + +import { OperationStartedModel } from '../models/operation-started-model'; +import { SseItemBase } from '../models/sse-item-base'; +export type SseItemOfOperationStartedModel = SseItemBase & { +'data'?: OperationStartedModel; +}; + diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/staging-indicator.ts b/src/Moryx.Orders.Web/app/src/app/api/models/staging-indicator.ts index 45971d31f3..cafdf070b6 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/staging-indicator.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/staging-indicator.ts @@ -6,11 +6,10 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export enum StagingIndicator { - NotRelevant = 'NotRelevant', - PickPart = 'PickPart', - CrateOrKanbanPart = 'CrateOrKanbanPart', - ReleaseOrderPart = 'ReleaseOrderPart', - ManualStaging = 'ManualStaging', - EwmStaging = 'EwmStaging' -} + +/** + * The material staging indicator defines the method of how needed materials can be supplied for production with the assistance of the Warehouse Management system. + * As with the location coordinates(warehouse number, storage type, and storage bin), the system files this indicator in the control cycle. + */ +export type StagingIndicator = 'NotRelevant' | 'PickPart' | 'CrateOrKanbanPart' | 'ReleaseOrderPart' | 'ManualStaging' | 'EwmStaging'; + diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/restriction-severity.ts b/src/Moryx.Orders.Web/app/src/app/api/models/stream.ts similarity index 66% rename from src/Moryx.Orders.Web/app/src/app/api/models/restriction-severity.ts rename to src/Moryx.Orders.Web/app/src/app/api/models/stream.ts index 3078673bd5..8d81fb481e 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/restriction-severity.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/stream.ts @@ -6,8 +6,5 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export enum RestrictionSeverity { - Info = 'Info', - Warning = 'Warning', - Error = 'Error' -} +export type Stream = Blob; + diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/product-importer.ts b/src/Moryx.Orders.Web/app/src/app/api/models/string-segment.ts similarity index 55% rename from src/Moryx.Orders.Web/app/src/app/api/models/product-importer.ts rename to src/Moryx.Orders.Web/app/src/app/api/models/string-segment.ts index 48cc0d93fc..5622aa84a7 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/product-importer.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/string-segment.ts @@ -4,11 +4,12 @@ */ /* eslint-disable */ -import { Entry } from '@moryx/ngx-web-framework/entry-editor'; - /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export interface ProductImporter { - name?: string | null; - parameters?: Entry; +export interface StringSegment { + buffer?: (string | null); + hasValue?: boolean; + length?: number; + offset?: number; + value?: (string | null); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/workplan-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/workplan-model.ts index 7c7e68df51..1c1986efd3 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/workplan-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/workplan-model.ts @@ -9,7 +9,7 @@ import { WorkplanState } from '../models/workplan-state'; export interface WorkplanModel { id?: number; - name?: string | null; + name?: (string | null); state?: WorkplanState; version?: number; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/workplan-state.ts b/src/Moryx.Orders.Web/app/src/app/api/models/workplan-state.ts index 3a00d745df..6d32c812eb 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/workplan-state.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/workplan-state.ts @@ -6,8 +6,9 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export enum WorkplanState { - New = 'New', - Released = 'Released', - Revoked = 'Revoked' -} + +/** + * A workplan state + */ +export type WorkplanState = 'New' | 'Released' | 'Revoked'; + diff --git a/src/Moryx.Orders.Web/app/src/app/api/services/operator-management.service.ts b/src/Moryx.Orders.Web/app/src/app/api/services/operator-management.service.ts index 6ca63dbb97..670d4d86cf 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/services/operator-management.service.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/services/operator-management.service.ts @@ -82,7 +82,7 @@ export class OperatorManagementService extends BaseService { * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - add$Response(params?: Add$Params, context?: HttpContext): Promise> { + add$Response(params: Add$Params, context?: HttpContext): Promise> { const obs = add(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } @@ -93,7 +93,7 @@ export class OperatorManagementService extends BaseService { * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - add(params?: Add$Params, context?: HttpContext): Promise { + add(params: Add$Params, context?: HttpContext): Promise { const resp = this.add$Response(params, context); return resp.then((r: StrictHttpResponse): string => r.body); } @@ -107,7 +107,7 @@ export class OperatorManagementService extends BaseService { * * This method doesn't expect any request body. */ - deleteOperator$Response(params?: DeleteOperator$Params, context?: HttpContext): Promise> { + deleteOperator$Response(params?: DeleteOperator$Params, context?: HttpContext): Promise> { const obs = deleteOperator(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } @@ -118,9 +118,9 @@ export class OperatorManagementService extends BaseService { * * This method doesn't expect any request body. */ - deleteOperator(params?: DeleteOperator$Params, context?: HttpContext): Promise { + deleteOperator(params?: DeleteOperator$Params, context?: HttpContext): Promise { const resp = this.deleteOperator$Response(params, context); - return resp.then((r: StrictHttpResponse): void => r.body); + return resp.then((r: StrictHttpResponse): any => r.body); } /** Path part for operation `get()` */ @@ -282,7 +282,7 @@ export class OperatorManagementService extends BaseService { * * This method doesn't expect any request body. */ - signIn$Response(params?: SignIn$Params, context?: HttpContext): Promise> { + signIn$Response(params?: SignIn$Params, context?: HttpContext): Promise> { const obs = signIn(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } @@ -293,9 +293,9 @@ export class OperatorManagementService extends BaseService { * * This method doesn't expect any request body. */ - signIn(params?: SignIn$Params, context?: HttpContext): Promise { + signIn(params?: SignIn$Params, context?: HttpContext): Promise { const resp = this.signIn$Response(params, context); - return resp.then((r: StrictHttpResponse): void => r.body); + return resp.then((r: StrictHttpResponse): any => r.body); } /** Path part for operation `signOut()` */ @@ -307,7 +307,7 @@ export class OperatorManagementService extends BaseService { * * This method doesn't expect any request body. */ - signOut$Response(params?: SignOut$Params, context?: HttpContext): Promise> { + signOut$Response(params?: SignOut$Params, context?: HttpContext): Promise> { const obs = signOut(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } @@ -318,9 +318,9 @@ export class OperatorManagementService extends BaseService { * * This method doesn't expect any request body. */ - signOut(params?: SignOut$Params, context?: HttpContext): Promise { + signOut(params?: SignOut$Params, context?: HttpContext): Promise { const resp = this.signOut$Response(params, context); - return resp.then((r: StrictHttpResponse): void => r.body); + return resp.then((r: StrictHttpResponse): any => r.body); } /** Path part for operation `stream()` */ @@ -332,7 +332,7 @@ export class OperatorManagementService extends BaseService { * * This method doesn't expect any request body. */ - stream$Response(params?: Stream$Params, context?: HttpContext): Promise> { + stream$Response(params?: Stream$Params, context?: HttpContext): Promise> { const obs = stream(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } @@ -343,9 +343,9 @@ export class OperatorManagementService extends BaseService { * * This method doesn't expect any request body. */ - stream(params?: Stream$Params, context?: HttpContext): Promise { + stream(params?: Stream$Params, context?: HttpContext): Promise { const resp = this.stream$Response(params, context); - return resp.then((r: StrictHttpResponse): void => r.body); + return resp.then((r: StrictHttpResponse): any => r.body); } } diff --git a/src/Moryx.Orders.Web/app/src/app/api/services/order-management.service.ts b/src/Moryx.Orders.Web/app/src/app/api/services/order-management.service.ts index fadd7e50d3..6838b36c8e 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/services/order-management.service.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/services/order-management.service.ts @@ -25,6 +25,7 @@ import { BeginContext } from '../models/begin-context'; import { beginOperation } from '../fn/order-management/begin-operation'; import { BeginOperation$Params } from '../fn/order-management/begin-operation'; import { DocumentModel } from '../models/document-model'; +import { FileStreamResult } from '../models/file-stream-result'; import { getAdviceContext } from '../fn/order-management/get-advice-context'; import { GetAdviceContext$Params } from '../fn/order-management/get-advice-context'; import { getAssignableRecipes } from '../fn/order-management/get-assignable-recipes'; @@ -49,7 +50,6 @@ import { getReportContext } from '../fn/order-management/get-report-context'; import { GetReportContext$Params } from '../fn/order-management/get-report-context'; import { interruptOperation } from '../fn/order-management/interrupt-operation'; import { InterruptOperation$Params } from '../fn/order-management/interrupt-operation'; -import { OperationChangedModel } from '../models/operation-changed-model'; import { OperationLogMessageModel } from '../models/operation-log-message-model'; import { OperationModel } from '../models/operation-model'; import { OperationRecipeModel } from '../models/operation-recipe-model'; @@ -61,6 +61,10 @@ import { Reload$Params } from '../fn/order-management/reload'; import { ReportContext } from '../models/report-context'; import { reportOperation } from '../fn/order-management/report-operation'; import { ReportOperation$Params } from '../fn/order-management/report-operation'; +import { SseItemOfOperationAdvicedModel } from '../models/sse-item-of-operation-adviced-model'; +import { SseItemOfOperationModel } from '../models/sse-item-of-operation-model'; +import { SseItemOfOperationReportedModel } from '../models/sse-item-of-operation-reported-model'; +import { SseItemOfOperationStartedModel } from '../models/sse-item-of-operation-started-model'; import { updateOperation } from '../fn/order-management/update-operation'; import { UpdateOperation$Params } from '../fn/order-management/update-operation'; @@ -74,6 +78,11 @@ export class OrderManagementService extends BaseService { static readonly GetOperationsPath = '/api/moryx/orders'; /** + * Retrieve all current operations that match the given filter parameters. + * Already completed or aborted Operations won't be included. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `getOperations()` instead. * @@ -85,6 +94,11 @@ export class OrderManagementService extends BaseService { } /** + * Retrieve all current operations that match the given filter parameters. + * Already completed or aborted Operations won't be included. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `getOperations$Response()` instead. * @@ -99,23 +113,31 @@ export class OrderManagementService extends BaseService { static readonly AddOperationPath = '/api/moryx/orders'; /** + * Add an operation to the order stock. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `addOperation()` instead. * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - addOperation$Response(params?: AddOperation$Params, context?: HttpContext): Promise> { + addOperation$Response(params: AddOperation$Params, context?: HttpContext): Promise> { const obs = addOperation(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } /** + * Add an operation to the order stock. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `addOperation$Response()` instead. * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - addOperation(params?: AddOperation$Params, context?: HttpContext): Promise { + addOperation(params: AddOperation$Params, context?: HttpContext): Promise { const resp = this.addOperation$Response(params, context); return resp.then((r: StrictHttpResponse): OperationModel => r.body); } @@ -124,31 +146,44 @@ export class OrderManagementService extends BaseService { static readonly OperationStreamPath = '/api/moryx/orders/stream'; /** + * Stream that allow subscribing to operation changes. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `operationStream()` instead. * * This method doesn't expect any request body. */ - operationStream$Response(params?: OperationStream$Params, context?: HttpContext): Promise> { + operationStream$Response(params?: OperationStream$Params, context?: HttpContext): Promise> { const obs = operationStream(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } /** + * Stream that allow subscribing to operation changes. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `operationStream$Response()` instead. * * This method doesn't expect any request body. */ - operationStream(params?: OperationStream$Params, context?: HttpContext): Promise { + operationStream(params?: OperationStream$Params, context?: HttpContext): Promise<(SseItemOfOperationStartedModel | SseItemOfOperationModel | SseItemOfOperationReportedModel | SseItemOfOperationReportedModel | SseItemOfOperationReportedModel | SseItemOfOperationAdvicedModel | SseItemOfOperationModel)> { const resp = this.operationStream$Response(params, context); - return resp.then((r: StrictHttpResponse): OperationChangedModel => r.body); + return resp.then((r: StrictHttpResponse<(SseItemOfOperationStartedModel | SseItemOfOperationModel | SseItemOfOperationReportedModel | SseItemOfOperationReportedModel | SseItemOfOperationReportedModel | SseItemOfOperationAdvicedModel | SseItemOfOperationModel)>): (SseItemOfOperationStartedModel | SseItemOfOperationModel | SseItemOfOperationReportedModel | SseItemOfOperationReportedModel | SseItemOfOperationReportedModel | SseItemOfOperationAdvicedModel | SseItemOfOperationModel) => r.body); } /** Path part for operation `getOperation()` */ static readonly GetOperationPath = '/api/moryx/orders/{guid}'; /** + * Retrieves an operationmodel using the unique id of the operation + * (Can load completed operations from storage). + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `getOperation()` instead. * @@ -160,6 +195,11 @@ export class OrderManagementService extends BaseService { } /** + * Retrieves an operationmodel using the unique id of the operation + * (Can load completed operations from storage). + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `getOperation$Response()` instead. * @@ -174,6 +214,10 @@ export class OrderManagementService extends BaseService { static readonly GetDocumentsPath = '/api/moryx/orders/{guid}/documents'; /** + * Retrieve the documents attached to operation with the given id. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `getDocuments()` instead. * @@ -185,6 +229,10 @@ export class OrderManagementService extends BaseService { } /** + * Retrieve the documents attached to operation with the given id. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `getDocuments$Response()` instead. * @@ -199,31 +247,43 @@ export class OrderManagementService extends BaseService { static readonly GetDocumentStreamPath = '/api/moryx/orders/{guid}/document/{identifier}/stream'; /** + * Retrieves the content of the document specified using the operation id and the identifier of the document. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `getDocumentStream()` instead. * * This method doesn't expect any request body. */ - getDocumentStream$Response(params: GetDocumentStream$Params, context?: HttpContext): Promise> { + getDocumentStream$Response(params: GetDocumentStream$Params, context?: HttpContext): Promise> { const obs = getDocumentStream(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } /** + * Retrieves the content of the document specified using the operation id and the identifier of the document. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `getDocumentStream$Response()` instead. * * This method doesn't expect any request body. */ - getDocumentStream(params: GetDocumentStream$Params, context?: HttpContext): Promise { + getDocumentStream(params: GetDocumentStream$Params, context?: HttpContext): Promise { const resp = this.getDocumentStream$Response(params, context); - return resp.then((r: StrictHttpResponse): Blob => r.body); + return resp.then((r: StrictHttpResponse): FileStreamResult => r.body); } /** Path part for operation `getProductParts()` */ static readonly GetProductPartsPath = '/api/moryx/orders/{guid}/productparts'; /** + * Retrieve a list of product parts attached to the given operation. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `getProductParts()` instead. * @@ -235,6 +295,10 @@ export class OrderManagementService extends BaseService { } /** + * Retrieve a list of product parts attached to the given operation. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `getProductParts$Response()` instead. * @@ -249,6 +313,10 @@ export class OrderManagementService extends BaseService { static readonly GetBeginContextPath = '/api/moryx/orders/{guid}/begin'; /** + * Retrieves the begin context for the given operation. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `getBeginContext()` instead. * @@ -260,6 +328,10 @@ export class OrderManagementService extends BaseService { } /** + * Retrieves the begin context for the given operation. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `getBeginContext$Response()` instead. * @@ -274,31 +346,43 @@ export class OrderManagementService extends BaseService { static readonly BeginOperationPath = '/api/moryx/orders/{guid}/begin'; /** + * Begin producing the operation using the given parameters. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `beginOperation()` instead. * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - beginOperation$Response(params: BeginOperation$Params, context?: HttpContext): Promise> { + beginOperation$Response(params: BeginOperation$Params, context?: HttpContext): Promise> { const obs = beginOperation(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } /** + * Begin producing the operation using the given parameters. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `beginOperation$Response()` instead. * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - beginOperation(params: BeginOperation$Params, context?: HttpContext): Promise { + beginOperation(params: BeginOperation$Params, context?: HttpContext): Promise { const resp = this.beginOperation$Response(params, context); - return resp.then((r: StrictHttpResponse): void => r.body); + return resp.then((r: StrictHttpResponse): any => r.body); } /** Path part for operation `getReportContext()` */ static readonly GetReportContextPath = '/api/moryx/orders/{guid}/report'; /** + * Retrieves a report context for the given operation. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `getReportContext()` instead. * @@ -310,6 +394,10 @@ export class OrderManagementService extends BaseService { } /** + * Retrieves a report context for the given operation. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `getReportContext$Response()` instead. * @@ -324,31 +412,43 @@ export class OrderManagementService extends BaseService { static readonly ReportOperationPath = '/api/moryx/orders/{guid}/report'; /** + * Report produced amounts of a given operation. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `reportOperation()` instead. * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - reportOperation$Response(params: ReportOperation$Params, context?: HttpContext): Promise> { + reportOperation$Response(params: ReportOperation$Params, context?: HttpContext): Promise> { const obs = reportOperation(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } /** + * Report produced amounts of a given operation. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `reportOperation$Response()` instead. * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - reportOperation(params: ReportOperation$Params, context?: HttpContext): Promise { + reportOperation(params: ReportOperation$Params, context?: HttpContext): Promise { const resp = this.reportOperation$Response(params, context); - return resp.then((r: StrictHttpResponse): void => r.body); + return resp.then((r: StrictHttpResponse): any => r.body); } /** Path part for operation `getInterruptContext()` */ static readonly GetInterruptContextPath = '/api/moryx/orders/{guid}/interrupt'; /** + * Retrieves a interrupt context for the given operation. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `getInterruptContext()` instead. * @@ -360,6 +460,10 @@ export class OrderManagementService extends BaseService { } /** + * Retrieves a interrupt context for the given operation. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `getInterruptContext$Response()` instead. * @@ -374,31 +478,43 @@ export class OrderManagementService extends BaseService { static readonly InterruptOperationPath = '/api/moryx/orders/{guid}/interrupt'; /** + * Interrupt the given operation. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `interruptOperation()` instead. * * This method doesn't expect any request body. */ - interruptOperation$Response(params: InterruptOperation$Params, context?: HttpContext): Promise> { + interruptOperation$Response(params: InterruptOperation$Params, context?: HttpContext): Promise> { const obs = interruptOperation(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } /** + * Interrupt the given operation. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `interruptOperation$Response()` instead. * * This method doesn't expect any request body. */ - interruptOperation(params: InterruptOperation$Params, context?: HttpContext): Promise { + interruptOperation(params: InterruptOperation$Params, context?: HttpContext): Promise { const resp = this.interruptOperation$Response(params, context); - return resp.then((r: StrictHttpResponse): void => r.body); + return resp.then((r: StrictHttpResponse): any => r.body); } /** Path part for operation `getAdviceContext()` */ static readonly GetAdviceContextPath = '/api/moryx/orders/{guid}/advice'; /** + * Retrieves a advice context for the given operation. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `getAdviceContext()` instead. * @@ -410,6 +526,10 @@ export class OrderManagementService extends BaseService { } /** + * Retrieves a advice context for the given operation. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `getAdviceContext$Response()` instead. * @@ -424,31 +544,43 @@ export class OrderManagementService extends BaseService { static readonly AdviceOperationPath = '/api/moryx/orders/{guid}/advice'; /** + * Advice operation. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `adviceOperation()` instead. * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - adviceOperation$Response(params: AdviceOperation$Params, context?: HttpContext): Promise> { + adviceOperation$Response(params: AdviceOperation$Params, context?: HttpContext): Promise> { const obs = adviceOperation(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } /** + * Advice operation. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `adviceOperation$Response()` instead. * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - adviceOperation(params: AdviceOperation$Params, context?: HttpContext): Promise { + adviceOperation(params: AdviceOperation$Params, context?: HttpContext): Promise { const resp = this.adviceOperation$Response(params, context); - return resp.then((r: StrictHttpResponse): void => r.body); + return resp.then((r: StrictHttpResponse): any => r.body); } /** Path part for operation `getLogs()` */ static readonly GetLogsPath = '/api/moryx/orders/{guid}/logs'; /** + * Retrieves logs written during the creation of the operation. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `getLogs()` instead. * @@ -460,6 +592,10 @@ export class OrderManagementService extends BaseService { } /** + * Retrieves logs written during the creation of the operation. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `getLogs$Response()` instead. * @@ -474,6 +610,10 @@ export class OrderManagementService extends BaseService { static readonly GetAssignableRecipesPath = '/api/moryx/orders/recipes'; /** + * Get's the list of recipes available to produce the given product. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `getAssignableRecipes()` instead. * @@ -485,6 +625,10 @@ export class OrderManagementService extends BaseService { } /** + * Get's the list of recipes available to produce the given product. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `getAssignableRecipes$Response()` instead. * @@ -499,75 +643,99 @@ export class OrderManagementService extends BaseService { static readonly AbortOperationPath = '/api/moryx/orders/{guid}/abort'; /** + * Abort the specified operation (Remove it before being started). + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `abortOperation()` instead. * * This method doesn't expect any request body. */ - abortOperation$Response(params: AbortOperation$Params, context?: HttpContext): Promise> { + abortOperation$Response(params: AbortOperation$Params, context?: HttpContext): Promise> { const obs = abortOperation(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } /** + * Abort the specified operation (Remove it before being started). + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `abortOperation$Response()` instead. * * This method doesn't expect any request body. */ - abortOperation(params: AbortOperation$Params, context?: HttpContext): Promise { + abortOperation(params: AbortOperation$Params, context?: HttpContext): Promise { const resp = this.abortOperation$Response(params, context); - return resp.then((r: StrictHttpResponse): void => r.body); + return resp.then((r: StrictHttpResponse): any => r.body); } /** Path part for operation `updateOperation()` */ static readonly UpdateOperationPath = '/api/moryx/orders/{guid}/update'; /** + * Update the operation. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `updateOperation()` instead. * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - updateOperation$Response(params: UpdateOperation$Params, context?: HttpContext): Promise> { + updateOperation$Response(params: UpdateOperation$Params, context?: HttpContext): Promise> { const obs = updateOperation(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } /** + * Update the operation. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `updateOperation$Response()` instead. * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - updateOperation(params: UpdateOperation$Params, context?: HttpContext): Promise { + updateOperation(params: UpdateOperation$Params, context?: HttpContext): Promise { const resp = this.updateOperation$Response(params, context); - return resp.then((r: StrictHttpResponse): void => r.body); + return resp.then((r: StrictHttpResponse): any => r.body); } /** Path part for operation `reload()` */ static readonly ReloadPath = '/api/moryx/orders/{guid}/reload'; /** + * Reload the operation, rerunning the order assignment steps. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `reload()` instead. * * This method doesn't expect any request body. */ - reload$Response(params: Reload$Params, context?: HttpContext): Promise> { + reload$Response(params: Reload$Params, context?: HttpContext): Promise> { const obs = reload(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } /** + * Reload the operation, rerunning the order assignment steps. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `reload$Response()` instead. * * This method doesn't expect any request body. */ - reload(params: Reload$Params, context?: HttpContext): Promise { + reload(params: Reload$Params, context?: HttpContext): Promise { const resp = this.reload$Response(params, context); - return resp.then((r: StrictHttpResponse): void => r.body); + return resp.then((r: StrictHttpResponse): any => r.body); } } diff --git a/src/Moryx.Orders.Web/app/src/app/api/services/product-management.service.ts b/src/Moryx.Orders.Web/app/src/app/api/services/product-management.service.ts index 1041eed36b..10815bc46a 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/services/product-management.service.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/services/product-management.service.ts @@ -65,6 +65,10 @@ export class ProductManagementService extends BaseService { static readonly GetProductCustomizationPath = '/api/moryx/products/configuration'; /** + * Loads dataset of existing products, recipes and importers for the UI. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `getProductCustomization()` instead. * @@ -76,6 +80,10 @@ export class ProductManagementService extends BaseService { } /** + * Loads dataset of existing products, recipes and importers for the UI. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `getProductCustomization$Response()` instead. * @@ -90,6 +98,10 @@ export class ProductManagementService extends BaseService { static readonly ImportPath = '/api/moryx/products/importers/{importerName}'; /** + * Run the product importer with the given parameters. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `import()` instead. * @@ -101,6 +113,10 @@ export class ProductManagementService extends BaseService { } /** + * Run the product importer with the given parameters. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `import$Response()` instead. * @@ -115,6 +131,10 @@ export class ProductManagementService extends BaseService { static readonly GetTypeByIdentityPath = '/api/moryx/products/types'; /** + * Retrieves all product types, if no identity is specified. Otherwise the model identified by that id is returned. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `getTypeByIdentity()` instead. * @@ -126,6 +146,10 @@ export class ProductManagementService extends BaseService { } /** + * Retrieves all product types, if no identity is specified. Otherwise the model identified by that id is returned. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `getTypeByIdentity$Response()` instead. * @@ -140,23 +164,31 @@ export class ProductManagementService extends BaseService { static readonly SaveTypePath = '/api/moryx/products/types'; /** + * Store the product type in the database. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `saveType()` instead. * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - saveType$Response(params?: SaveType$Params, context?: HttpContext): Promise> { + saveType$Response(params: SaveType$Params, context?: HttpContext): Promise> { const obs = saveType(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } /** + * Store the product type in the database. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `saveType$Response()` instead. * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - saveType(params?: SaveType$Params, context?: HttpContext): Promise { + saveType(params: SaveType$Params, context?: HttpContext): Promise { const resp = this.saveType$Response(params, context); return resp.then((r: StrictHttpResponse): number => r.body); } @@ -165,23 +197,31 @@ export class ProductManagementService extends BaseService { static readonly GetTypesPath = '/api/moryx/products/types/query'; /** + * Query the product type database. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `getTypes()` instead. * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - getTypes$Response(params?: GetTypes$Params, context?: HttpContext): Promise>> { + getTypes$Response(params: GetTypes$Params, context?: HttpContext): Promise>> { const obs = getTypes(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } /** + * Query the product type database. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `getTypes$Response()` instead. * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - getTypes(params?: GetTypes$Params, context?: HttpContext): Promise> { + getTypes(params: GetTypes$Params, context?: HttpContext): Promise> { const resp = this.getTypes$Response(params, context); return resp.then((r: StrictHttpResponse>): Array => r.body); } @@ -190,6 +230,10 @@ export class ProductManagementService extends BaseService { static readonly GetTypeByIdPath = '/api/moryx/products/types/{id}'; /** + * Get's a product type using the database id. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `getTypeById()` instead. * @@ -201,6 +245,10 @@ export class ProductManagementService extends BaseService { } /** + * Get's a product type using the database id. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `getTypeById$Response()` instead. * @@ -215,6 +263,10 @@ export class ProductManagementService extends BaseService { static readonly UpdateTypePath = '/api/moryx/products/types/{id}'; /** + * Updates the existing product type. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `updateType()` instead. * @@ -226,6 +278,10 @@ export class ProductManagementService extends BaseService { } /** + * Updates the existing product type. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `updateType$Response()` instead. * @@ -240,6 +296,10 @@ export class ProductManagementService extends BaseService { static readonly DuplicatePath = '/api/moryx/products/types/{id}'; /** + * Create a clone of the product type identified with the id with the new identitiy. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `duplicate()` instead. * @@ -251,6 +311,10 @@ export class ProductManagementService extends BaseService { } /** + * Create a clone of the product type identified with the id with the new identitiy. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `duplicate$Response()` instead. * @@ -265,6 +329,10 @@ export class ProductManagementService extends BaseService { static readonly DeleteTypePath = '/api/moryx/products/types/{id}'; /** + * Deletes the product type with the given id. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `deleteType()` instead. * @@ -276,6 +344,10 @@ export class ProductManagementService extends BaseService { } /** + * Deletes the product type with the given id. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `deleteType$Response()` instead. * @@ -290,6 +362,10 @@ export class ProductManagementService extends BaseService { static readonly GetRecipesPath = '/api/moryx/products/types/{id}/recipes/{classification}'; /** + * Loads the recipe attached to the product type with the id. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `getRecipes()` instead. * @@ -301,6 +377,10 @@ export class ProductManagementService extends BaseService { } /** + * Loads the recipe attached to the product type with the id. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `getRecipes$Response()` instead. * @@ -315,6 +395,10 @@ export class ProductManagementService extends BaseService { static readonly GetInstancePath = '/api/moryx/products/instances/{id}'; /** + * Get's the product instance with the given id. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `getInstance()` instead. * @@ -326,6 +410,10 @@ export class ProductManagementService extends BaseService { } /** + * Get's the product instance with the given id. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `getInstance$Response()` instead. * @@ -340,6 +428,10 @@ export class ProductManagementService extends BaseService { static readonly GetInstancesPath = '/api/moryx/products/instances'; /** + * Loads multiple product instances at once. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `getInstances()` instead. * @@ -351,6 +443,10 @@ export class ProductManagementService extends BaseService { } /** + * Loads multiple product instances at once. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `getInstances$Response()` instead. * @@ -365,31 +461,43 @@ export class ProductManagementService extends BaseService { static readonly SaveInstancePath = '/api/moryx/products/instances'; /** + * Save the instance in the product db. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `saveInstance()` instead. * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - saveInstance$Response(params?: SaveInstance$Params, context?: HttpContext): Promise> { + saveInstance$Response(params: SaveInstance$Params, context?: HttpContext): Promise> { const obs = saveInstance(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } /** + * Save the instance in the product db. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `saveInstance$Response()` instead. * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - saveInstance(params?: SaveInstance$Params, context?: HttpContext): Promise { + saveInstance(params: SaveInstance$Params, context?: HttpContext): Promise { const resp = this.saveInstance$Response(params, context); - return resp.then((r: StrictHttpResponse): void => r.body); + return resp.then((r: StrictHttpResponse): any => r.body); } /** Path part for operation `createInstance()` */ static readonly CreateInstancePath = '/api/moryx/products/instances'; /** + * Create a new product instace of the product type identified via the identifier and revision. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `createInstance()` instead. * @@ -401,6 +509,10 @@ export class ProductManagementService extends BaseService { } /** + * Create a new product instace of the product type identified via the identifier and revision. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `createInstance$Response()` instead. * @@ -415,6 +527,10 @@ export class ProductManagementService extends BaseService { static readonly GetRecipePath = '/api/moryx/products/recipes/{id}'; /** + * Get's a recipe by it's db id. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `getRecipe()` instead. * @@ -426,6 +542,10 @@ export class ProductManagementService extends BaseService { } /** + * Get's a recipe by it's db id. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `getRecipe$Response()` instead. * @@ -440,6 +560,10 @@ export class ProductManagementService extends BaseService { static readonly UpdateRecipePath = '/api/moryx/products/recipes/{id}'; /** + * Updates the existing recipes. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `updateRecipe()` instead. * @@ -451,6 +575,10 @@ export class ProductManagementService extends BaseService { } /** + * Updates the existing recipes. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `updateRecipe$Response()` instead. * @@ -465,23 +593,31 @@ export class ProductManagementService extends BaseService { static readonly SaveRecipePath = '/api/moryx/products/recipes'; /** + * Saves a new recipe in the database. + * + * + * * This method provides access to the full `HttpResponse`, allowing access to response headers. * To access only the response body, use `saveRecipe()` instead. * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - saveRecipe$Response(params?: SaveRecipe$Params, context?: HttpContext): Promise> { + saveRecipe$Response(params: SaveRecipe$Params, context?: HttpContext): Promise> { const obs = saveRecipe(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } /** + * Saves a new recipe in the database. + * + * + * * This method provides access only to the response body. * To access the full response (for headers, for example), `saveRecipe$Response()` instead. * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - saveRecipe(params?: SaveRecipe$Params, context?: HttpContext): Promise { + saveRecipe(params: SaveRecipe$Params, context?: HttpContext): Promise { const resp = this.saveRecipe$Response(params, context); return resp.then((r: StrictHttpResponse): number => r.body); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/services/workplan.service.ts b/src/Moryx.Orders.Web/app/src/app/api/services/workplan.service.ts index 66c4bf2229..c78a8d2f26 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/services/workplan.service.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/services/workplan.service.ts @@ -68,7 +68,7 @@ export class WorkplanService extends BaseService { * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - saveWorkplan$Response(params?: SaveWorkplan$Params, context?: HttpContext): Promise> { + saveWorkplan$Response(params: SaveWorkplan$Params, context?: HttpContext): Promise> { const obs = saveWorkplan(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } @@ -79,7 +79,7 @@ export class WorkplanService extends BaseService { * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - saveWorkplan(params?: SaveWorkplan$Params, context?: HttpContext): Promise { + saveWorkplan(params: SaveWorkplan$Params, context?: HttpContext): Promise { const resp = this.saveWorkplan$Response(params, context); return resp.then((r: StrictHttpResponse): void => r.body); } @@ -168,7 +168,7 @@ export class WorkplanService extends BaseService { * * This method doesn't expect any request body. */ - deleteWorkplan$Response(params: DeleteWorkplan$Params, context?: HttpContext): Promise> { + deleteWorkplan$Response(params: DeleteWorkplan$Params, context?: HttpContext): Promise> { const obs = deleteWorkplan(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } @@ -179,9 +179,9 @@ export class WorkplanService extends BaseService { * * This method doesn't expect any request body. */ - deleteWorkplan(params: DeleteWorkplan$Params, context?: HttpContext): Promise { + deleteWorkplan(params: DeleteWorkplan$Params, context?: HttpContext): Promise { const resp = this.deleteWorkplan$Response(params, context); - return resp.then((r: StrictHttpResponse): void => r.body); + return resp.then((r: StrictHttpResponse): any => r.body); } } From 0e383697b927b7bc9ad1660af395e0b65ff4d514 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Niggemann?= Date: Fri, 6 Nov 2026 10:36:45 +0100 Subject: [PATCH 09/16] Applied review suggestions: * Move schema generation output to /schemas and generate yaml at build time * Cleanup Program.cs by removing unused code and moving complexity to Moryx.AspNetCore.OpenApi Notes: * The current yaml at buildtime is a workaround. Microsoft is aiming to allow yaml at buildtime in the future * I verified that ng-openapi-gen produces exactly the sameoutput with the yaml spec --- .gitignore | 1 + schemas/framework-api.yaml | 8133 ++++++++++ .../OpenApiExtensions.cs | 81 + .../OpenApiOptionsExtension.cs | 20 - src/Moryx.Orders.Web/app/openapi-gen.json | 2 +- src/StartProject.Asp/Program.cs | 32 +- src/StartProject.Asp/StartProject.Asp.csproj | 5 +- src/StartProject.Asp/StartProject.Asp.json | 12762 ---------------- 8 files changed, 8225 insertions(+), 12811 deletions(-) create mode 100644 schemas/framework-api.yaml create mode 100644 src/Moryx.AspNetCore.OpenApi/OpenApiExtensions.cs delete mode 100644 src/Moryx.AspNetCore.OpenApi/OpenApiOptionsExtension.cs delete mode 100644 src/StartProject.Asp/StartProject.Asp.json diff --git a/.gitignore b/.gitignore index f39c4a0761..fb1aa6212e 100644 --- a/.gitignore +++ b/.gitignore @@ -166,3 +166,4 @@ orleans.codegen.cs .claude/settings.local.json CLAUDE.md AGENTS.md +/schemas/framework-api.json diff --git a/schemas/framework-api.yaml b/schemas/framework-api.yaml new file mode 100644 index 0000000000..218664abb5 --- /dev/null +++ b/schemas/framework-api.yaml @@ -0,0 +1,8133 @@ +openapi: '3.1.1' +info: + title: StartProject.Asp | v1 + version: 1.0.0 +paths: + /common/time: + get: + tags: + - Common + operationId: GetServerTime + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ServerTimeResponse' + /common/info/application: + get: + tags: + - Common + operationId: GetApplicationInfo + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationInformationResponse' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /common/info/system: + get: + tags: + - Common + operationId: GetHostInfo + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/HostInformationResponse' + /databases: + get: + tags: + - Database + operationId: GetAll + responses: + '200': + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/DatabasesResponse' + application/json: + schema: + $ref: '#/components/schemas/DatabasesResponse' + text/json: + schema: + $ref: '#/components/schemas/DatabasesResponse' + delete: + tags: + - Database + operationId: EraseAll + responses: + '200': + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/InvocationResponse' + application/json: + schema: + $ref: '#/components/schemas/InvocationResponse' + text/json: + schema: + $ref: '#/components/schemas/InvocationResponse' + '/databases/{targetModel}': + get: + tags: + - Database + operationId: GetModel + parameters: + - name: targetModel + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/DataModel' + application/json: + schema: + $ref: '#/components/schemas/DataModel' + text/json: + schema: + $ref: '#/components/schemas/DataModel' + delete: + tags: + - Database + operationId: EraseDatabase + parameters: + - name: targetModel + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DatabaseConfigModel' + text/json: + schema: + $ref: '#/components/schemas/DatabaseConfigModel' + application/*+json: + schema: + $ref: '#/components/schemas/DatabaseConfigModel' + required: true + responses: + '200': + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/InvocationResponse' + application/json: + schema: + $ref: '#/components/schemas/InvocationResponse' + text/json: + schema: + $ref: '#/components/schemas/InvocationResponse' + '/databases/{targetModel}/config': + post: + tags: + - Database + operationId: SetDatabaseConfig + parameters: + - name: targetModel + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DatabaseConfigModel' + text/json: + schema: + $ref: '#/components/schemas/DatabaseConfigModel' + application/*+json: + schema: + $ref: '#/components/schemas/DatabaseConfigModel' + required: true + responses: + '200': + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/DataModel' + application/json: + schema: + $ref: '#/components/schemas/DataModel' + text/json: + schema: + $ref: '#/components/schemas/DataModel' + '/databases/{targetModel}/config/test': + post: + tags: + - Database + operationId: TestDatabaseConfig + parameters: + - name: targetModel + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DatabaseConfigModel' + text/json: + schema: + $ref: '#/components/schemas/DatabaseConfigModel' + application/*+json: + schema: + $ref: '#/components/schemas/DatabaseConfigModel' + required: true + responses: + '200': + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/TestConnectionResponse' + application/json: + schema: + $ref: '#/components/schemas/TestConnectionResponse' + text/json: + schema: + $ref: '#/components/schemas/TestConnectionResponse' + /databases/createall: + post: + tags: + - Database + operationId: CreateAll + responses: + '200': + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/InvocationResponse' + application/json: + schema: + $ref: '#/components/schemas/InvocationResponse' + text/json: + schema: + $ref: '#/components/schemas/InvocationResponse' + '/databases/{targetModel}/create': + post: + tags: + - Database + operationId: CreateDatabase + parameters: + - name: targetModel + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DatabaseConfigModel' + text/json: + schema: + $ref: '#/components/schemas/DatabaseConfigModel' + application/*+json: + schema: + $ref: '#/components/schemas/DatabaseConfigModel' + required: true + responses: + '200': + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/InvocationResponse' + application/json: + schema: + $ref: '#/components/schemas/InvocationResponse' + text/json: + schema: + $ref: '#/components/schemas/InvocationResponse' + '/databases/{targetModel}/migrate': + post: + tags: + - Database + operationId: MigrateDatabaseModel + parameters: + - name: targetModel + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DatabaseConfigModel' + text/json: + schema: + $ref: '#/components/schemas/DatabaseConfigModel' + application/*+json: + schema: + $ref: '#/components/schemas/DatabaseConfigModel' + required: true + responses: + '200': + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/DatabaseMigrationSummary' + application/json: + schema: + $ref: '#/components/schemas/DatabaseMigrationSummary' + text/json: + schema: + $ref: '#/components/schemas/DatabaseMigrationSummary' + '/databases/{targetModel}/setup': + post: + tags: + - Database + operationId: ExecuteSetup + parameters: + - name: targetModel + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExecuteSetupRequest' + text/json: + schema: + $ref: '#/components/schemas/ExecuteSetupRequest' + application/*+json: + schema: + $ref: '#/components/schemas/ExecuteSetupRequest' + required: true + responses: + '200': + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/InvocationResponse' + application/json: + schema: + $ref: '#/components/schemas/InvocationResponse' + text/json: + schema: + $ref: '#/components/schemas/InvocationResponse' + /api/moryx/factory-monitor/state: + get: + tags: + - FactoryMonitor + operationId: InitialFactoryState + responses: + '200': + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/FactoryStateModel' + application/json: + schema: + $ref: '#/components/schemas/FactoryStateModel' + text/json: + schema: + $ref: '#/components/schemas/FactoryStateModel' + /api/moryx/factory-monitor/cells: + get: + tags: + - FactoryMonitor + operationId: AllCells + responses: + '200': + description: OK + content: + text/plain: + schema: + type: array + items: + $ref: '#/components/schemas/VisualizableItemModel' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VisualizableItemModel' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/VisualizableItemModel' + '/api/moryx/factory-monitor/factory-content/{factoryId}': + get: + tags: + - FactoryMonitor + operationId: FactoryContent + parameters: + - name: factoryId + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + text/plain: + schema: + type: array + items: + $ref: '#/components/schemas/VisualizableItemModel' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VisualizableItemModel' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/VisualizableItemModel' + '/api/moryx/factory-monitor/navigation/{factoryId}': + get: + tags: + - FactoryMonitor + operationId: GetNavigation + parameters: + - name: factoryId + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/FactoryModel' + application/json: + schema: + $ref: '#/components/schemas/FactoryModel' + text/json: + schema: + $ref: '#/components/schemas/FactoryModel' + /api/moryx/factory-monitor/state-stream: + get: + tags: + - FactoryMonitor + operationId: FactoryStatesStream + responses: + '200': + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/OrderChangedModel' + application/json: + schema: + $ref: '#/components/schemas/OrderChangedModel' + text/json: + schema: + $ref: '#/components/schemas/OrderChangedModel' + /api/moryx/factory-monitor/move-cell: + post: + tags: + - FactoryMonitor + operationId: MoveCell + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CellLocationModel' + text/json: + schema: + $ref: '#/components/schemas/CellLocationModel' + application/*+json: + schema: + $ref: '#/components/schemas/CellLocationModel' + required: true + responses: + '200': + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/CellLocationModel' + application/json: + schema: + $ref: '#/components/schemas/CellLocationModel' + text/json: + schema: + $ref: '#/components/schemas/CellLocationModel' + /api/moryx/factory-monitor/background: + post: + tags: + - FactoryMonitor + operationId: ChangeBackground + parameters: + - name: resourceId + in: query + schema: + type: integer + format: int64 + - name: url + in: query + schema: + type: string + responses: + '200': + description: OK + '404': + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '422': + description: Unprocessable Entity + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/api/moryx/factory-monitor/cell-properties/{identifier}': + get: + tags: + - FactoryMonitor + operationId: GetCellPropertiesSettings + parameters: + - name: identifier + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + text/plain: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/CellPropertySettings' + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/CellPropertySettings' + text/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/CellPropertySettings' + '404': + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /api/moryx/factory-monitor/traceroute: + post: + tags: + - FactoryMonitor + operationId: TraceRoute + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TransportRouteModel' + text/json: + schema: + $ref: '#/components/schemas/TransportRouteModel' + application/*+json: + schema: + $ref: '#/components/schemas/TransportRouteModel' + required: true + responses: + '200': + description: OK + '/api/moryx/factory-monitor/cell-settings/{id}': + put: + tags: + - FactoryMonitor + operationId: CellSettings + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CellSettingsModel' + text/json: + schema: + $ref: '#/components/schemas/CellSettingsModel' + application/*+json: + schema: + $ref: '#/components/schemas/CellSettingsModel' + required: true + responses: + '200': + description: OK + /api/moryx/factory-monitor/routes: + post: + tags: + - FactoryMonitor + operationId: GetRoutes + responses: + '200': + description: OK + content: + text/plain: + schema: + type: array + items: + $ref: '#/components/schemas/TransportRouteModel' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TransportRouteModel' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/TransportRouteModel' + '/api/moryx/jobs/{jobId}': + get: + tags: + - JobManagement + operationId: GetJob + parameters: + - name: jobId + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/JobModel' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /api/moryx/jobs: + get: + tags: + - JobManagement + operationId: GetAll + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/JobModel' + '/api/moryx/jobs/{jobId}/complete': + post: + tags: + - JobManagement + operationId: Complete + parameters: + - name: jobId + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: { } + '/api/moryx/jobs/{jobId}/abort': + post: + tags: + - JobManagement + operationId: Abort + parameters: + - name: jobId + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: { } + /api/moryx/jobs/stream: + get: + tags: + - JobManagement + operationId: ProgressStream + responses: + '200': + description: OK + content: + application/json: { } + /api/moryx/media: + get: + tags: + - MediaServer + operationId: GetAll + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContentDescriptorModel' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/api/moryx/media/{guid}': + get: + tags: + - MediaServer + operationId: Get + parameters: + - name: guid + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ContentDescriptorModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + delete: + tags: + - MediaServer + operationId: RemoveContent + parameters: + - name: guid + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + '400': + description: Bad Request + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/api/moryx/media/{guid}/{variantName}': + get: + tags: + - MediaServer + operationId: GetVariant + parameters: + - name: guid + in: path + required: true + schema: + type: string + - name: variantName + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/VariantDescriptor' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + delete: + tags: + - MediaServer + operationId: RemoveVariant + parameters: + - name: guid + in: path + required: true + schema: + type: string + - name: variantName + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + '400': + description: Bad Request + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/api/moryx/media/{guid}/{variantName}/stream': + get: + tags: + - MediaServer + operationId: GetVariantStream + parameters: + - name: guid + in: path + required: true + schema: + type: string + - name: variantName + in: path + required: true + schema: + type: string + - name: preview + in: query + schema: + type: boolean + default: false + responses: + '400': + description: Bad Request + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '200': + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/FileStreamResult' + application/json: + schema: + $ref: '#/components/schemas/FileStreamResult' + text/json: + schema: + $ref: '#/components/schemas/FileStreamResult' + /api/moryx/media/master: + post: + tags: + - MediaServer + operationId: AddMaster + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + formFile: + $ref: '#/components/schemas/IFormFile' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + type: string + format: uuid + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/api/moryx/media/{contentId}/{variantName}': + post: + tags: + - MediaServer + operationId: AddVariant + parameters: + - name: contentId + in: path + required: true + schema: + type: string + - name: variantName + in: path + required: true + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + formFile: + $ref: '#/components/schemas/IFormFile' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + type: string + format: uuid + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /modules/dependencies: + get: + tags: + - Modules + operationId: GetDependencyEvaluation + responses: + '200': + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/DependencyEvaluation' + application/json: + schema: + $ref: '#/components/schemas/DependencyEvaluation' + text/json: + schema: + $ref: '#/components/schemas/DependencyEvaluation' + /modules: + get: + tags: + - Modules + operationId: GetAll + responses: + '200': + description: OK + content: + text/plain: + schema: + type: array + items: + $ref: '#/components/schemas/ServerModuleModel' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ServerModuleModel' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/ServerModuleModel' + '/modules/{moduleName}/healthstate': + get: + tags: + - Modules + operationId: HealthState + parameters: + - name: moduleName + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/ServerModuleState' + application/json: + schema: + $ref: '#/components/schemas/ServerModuleState' + text/json: + schema: + $ref: '#/components/schemas/ServerModuleState' + '404': + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/modules/{moduleName}/notifications': + get: + tags: + - Modules + operationId: Notifications + parameters: + - name: moduleName + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + text/plain: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleNotificationModel' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleNotificationModel' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleNotificationModel' + '404': + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/modules/{moduleName}/start': + post: + tags: + - Modules + operationId: Start + parameters: + - name: moduleName + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + '404': + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/modules/{moduleName}/stop': + post: + tags: + - Modules + operationId: Stop + parameters: + - name: moduleName + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + '404': + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/modules/{moduleName}/reincarnate': + post: + tags: + - Modules + operationId: Reincarnate + parameters: + - name: moduleName + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + '404': + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/modules/{moduleName}': + post: + tags: + - Modules + operationId: Update + parameters: + - name: moduleName + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServerModuleModel' + text/json: + schema: + $ref: '#/components/schemas/ServerModuleModel' + application/*+json: + schema: + $ref: '#/components/schemas/ServerModuleModel' + required: true + responses: + '200': + description: OK + '400': + description: Bad Request + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/modules/{moduleName}/confirm': + post: + tags: + - Modules + operationId: ConfirmWarning + parameters: + - name: moduleName + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + '404': + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/modules/{moduleName}/config': + get: + tags: + - Modules + operationId: GetConfig + parameters: + - name: moduleName + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/Config' + application/json: + schema: + $ref: '#/components/schemas/Config' + text/json: + schema: + $ref: '#/components/schemas/Config' + '404': + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '500': + description: Internal Server Error + post: + tags: + - Modules + operationId: SetConfig + parameters: + - name: moduleName + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SaveConfigRequest' + text/json: + schema: + $ref: '#/components/schemas/SaveConfigRequest' + application/*+json: + schema: + $ref: '#/components/schemas/SaveConfigRequest' + required: true + responses: + '200': + description: OK + '400': + description: Bad Request + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '500': + description: Internal Server Error + '/modules/{moduleName}/console': + get: + tags: + - Modules + operationId: GetMethods + parameters: + - name: moduleName + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + text/plain: + schema: + type: array + items: + $ref: '#/components/schemas/MethodEntry' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MethodEntry' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/MethodEntry' + '404': + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + post: + tags: + - Modules + operationId: InvokeMethod + parameters: + - name: moduleName + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MethodEntry' + text/json: + schema: + $ref: '#/components/schemas/MethodEntry' + application/*+json: + schema: + $ref: '#/components/schemas/MethodEntry' + required: true + responses: + '200': + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/Entry' + application/json: + schema: + $ref: '#/components/schemas/Entry' + text/json: + schema: + $ref: '#/components/schemas/Entry' + '400': + description: Bad Request + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/ProblemDetails' + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '500': + description: Internal Server Error + /api/moryx/notifications: + get: + tags: + - NotificationPublisher + operationId: GetAll + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationModel' + '/api/moryx/notifications/{guid}': + get: + tags: + - NotificationPublisher + operationId: Get + parameters: + - name: guid + in: path + required: true + schema: + type: string + format: uuid + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationModel' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + /api/moryx/notifications/stream: + get: + tags: + - NotificationPublisher + operationId: NotificationStream + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationModel' + '/api/moryx/notifications/{guid}/acknowledge': + post: + tags: + - NotificationPublisher + operationId: Acknowledge + parameters: + - name: guid + in: path + required: true + schema: + type: string + format: uuid + responses: + '200': + description: OK + content: + application/json: { } + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + /api/moryx/operators: + post: + tags: + - OperatorManagement + operationId: Add + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OperatorModel' + text/json: + schema: + $ref: '#/components/schemas/OperatorModel' + application/*+json: + schema: + $ref: '#/components/schemas/OperatorModel' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + type: string + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + delete: + tags: + - OperatorManagement + operationId: DeleteOperator + parameters: + - name: operatorIdentifier + in: query + schema: + type: string + responses: + '204': + description: No Content + content: + application/json: { } + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + get: + tags: + - OperatorManagement + operationId: GetAll + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AssignableOperator' + '/api/moryx/operators/{identifier}': + put: + tags: + - OperatorManagement + operationId: Update + parameters: + - name: identifier + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OperatorModel' + text/json: + schema: + $ref: '#/components/schemas/OperatorModel' + application/*+json: + schema: + $ref: '#/components/schemas/OperatorModel' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + type: string + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + get: + tags: + - OperatorManagement + operationId: Get + parameters: + - name: identifier + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ExtendedOperatorModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/api/moryx/operators/get-operators-by-resource/{resourceId}': + get: + tags: + - OperatorManagement + operationId: GetOperatorsByResource + parameters: + - name: resourceId + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ExtendedOperatorModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/api/moryx/operators/resources/{operatorIdentifier}': + get: + tags: + - OperatorManagement + operationId: GetResources + parameters: + - name: operatorIdentifier + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AttendableResourceModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /api/moryx/operators/resources: + get: + tags: + - OperatorManagement + operationId: GetResources + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AttendableResourceModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /api/moryx/operators/default: + get: + tags: + - OperatorManagement + operationId: GetDefaultOperator + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ExtendedOperatorModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /api/moryx/operators/signin: + put: + tags: + - OperatorManagement + operationId: SignIn + parameters: + - name: operatorIdentifier + in: query + schema: + type: string + - name: resourceId + in: query + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: { } + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /api/moryx/operators/signout: + put: + tags: + - OperatorManagement + operationId: SignOut + parameters: + - name: operatorIdentifier + in: query + schema: + type: string + - name: resourceId + in: query + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: { } + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /api/moryx/operators/stream: + get: + tags: + - OperatorManagement + operationId: Stream + responses: + '200': + description: OK + content: + application/json: { } + /api/moryx/orders: + get: + tags: + - OrderManagement + summary: "Retrieve all current operations that match the given filter parameters.\r\nAlready completed or aborted Operations won't be included." + operationId: GetOperations + parameters: + - name: orderNumber + in: query + description: Optional. If specified only operations that belong to this order will be returned + schema: + type: string + - name: operationNumber + in: query + description: Optional. If specified only operations with this operation number will be returned + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/OperationModel' + post: + tags: + - OrderManagement + summary: Add an operation to the order stock + operationId: AddOperation + parameters: + - name: sourceId + in: query + description: Identifier of the application adding the operation + schema: + type: string + requestBody: + description: Description of the operation + content: + application/json: + schema: + $ref: '#/components/schemas/OperationCreationContextModel' + text/json: + schema: + $ref: '#/components/schemas/OperationCreationContextModel' + application/*+json: + schema: + $ref: '#/components/schemas/OperationCreationContextModel' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/OperationModel' + '400': + description: Bad Request + content: + application/json: + schema: + type: string + /api/moryx/orders/stream: + get: + tags: + - OrderManagement + summary: Stream that allow subscribing to operation changes. + operationId: OperationStream + responses: + '200': + description: OK + content: + text/event-stream: + schema: + oneOf: + - description: 'Published with type ''Start'': Published when operation has been started' + $ref: '#/components/schemas/SseItemOfOperationStartedModel' + - description: Published with type 'Progress' + $ref: '#/components/schemas/SseItemOfOperationModel' + - description: Published with type 'Completed' + $ref: '#/components/schemas/SseItemOfOperationReportedModel' + - description: Published with type 'Interrupted' + $ref: '#/components/schemas/SseItemOfOperationReportedModel' + - description: Published with type 'Report' + $ref: '#/components/schemas/SseItemOfOperationReportedModel' + - description: Published with type 'Advice' + $ref: '#/components/schemas/SseItemOfOperationAdvicedModel' + - description: Published with type 'Update' + $ref: '#/components/schemas/SseItemOfOperationModel' + discriminator: + propertyName: type + mapping: + Start: '#/components/schemas/SseItemOfOperationStartedModel' + Progress: '#/components/schemas/SseItemOfOperationModel' + Completed: '#/components/schemas/SseItemOfOperationReportedModel' + Interrupted: '#/components/schemas/SseItemOfOperationReportedModel' + Report: '#/components/schemas/SseItemOfOperationReportedModel' + Advice: '#/components/schemas/SseItemOfOperationAdvicedModel' + Update: '#/components/schemas/SseItemOfOperationModel' + '/api/moryx/orders/{guid}': + get: + tags: + - OrderManagement + summary: "Retrieves an operationmodel using the unique id of the operation\r\n(Can load completed operations from storage)" + operationId: GetOperation + parameters: + - name: guid + in: path + description: '' + required: true + schema: + type: string + format: uuid + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/OperationModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + '/api/moryx/orders/{guid}/documents': + get: + tags: + - OrderManagement + summary: Retrieve the documents attached to operation with the given id + operationId: GetDocuments + parameters: + - name: guid + in: path + description: Id of the operation + required: true + schema: + type: string + format: uuid + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DocumentModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + '/api/moryx/orders/{guid}/document/{identifier}/stream': + get: + tags: + - OrderManagement + summary: Retrieves the content of the document specified using the operation id and the identifier of the document + operationId: GetDocumentStream + parameters: + - name: guid + in: path + description: Id of the operation + required: true + schema: + type: string + format: uuid + - name: identifier + in: path + description: Identifier of the document + required: true + schema: + type: string + responses: + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/FileStreamResult' + '/api/moryx/orders/{guid}/productparts': + get: + tags: + - OrderManagement + summary: Retrieve a list of product parts attached to the given operation + operationId: GetProductParts + parameters: + - name: guid + in: path + description: If of the operation + required: true + schema: + type: string + format: uuid + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProductPartModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + '/api/moryx/orders/{guid}/begin': + get: + tags: + - OrderManagement + summary: Retrieves the begin context for the given operation + operationId: GetBeginContext + parameters: + - name: guid + in: path + description: Id of the operation + required: true + schema: + type: string + format: uuid + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/BeginContext' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + post: + tags: + - OrderManagement + summary: Begin producing the operation using the given parameters + operationId: BeginOperation + parameters: + - name: guid + in: path + description: Id of the operation + required: true + schema: + type: string + format: uuid + requestBody: + description: Begin parameters + content: + application/json: + schema: + $ref: '#/components/schemas/BeginModel' + text/json: + schema: + $ref: '#/components/schemas/BeginModel' + application/*+json: + schema: + $ref: '#/components/schemas/BeginModel' + required: true + responses: + '200': + description: OK + content: + application/json: { } + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + '/api/moryx/orders/{guid}/report': + get: + tags: + - OrderManagement + summary: Retrieves a report context for the given operation + operationId: GetReportContext + parameters: + - name: guid + in: path + description: Id of the operation + required: true + schema: + type: string + format: uuid + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ReportContext' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + post: + tags: + - OrderManagement + summary: Report produced amounts of a given operation + operationId: ReportOperation + parameters: + - name: guid + in: path + description: Id of the operation + required: true + schema: + type: string + format: uuid + requestBody: + description: Parameter object + content: + application/json: + schema: + $ref: '#/components/schemas/ReportModel' + text/json: + schema: + $ref: '#/components/schemas/ReportModel' + application/*+json: + schema: + $ref: '#/components/schemas/ReportModel' + required: true + responses: + '200': + description: OK + content: + application/json: { } + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + '/api/moryx/orders/{guid}/interrupt': + get: + tags: + - OrderManagement + summary: Retrieves a interrupt context for the given operation + operationId: GetInterruptContext + parameters: + - name: guid + in: path + description: Id of the operation + required: true + schema: + type: string + format: uuid + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ReportContext' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + post: + tags: + - OrderManagement + summary: Interrupt the given operation + operationId: InterruptOperation + parameters: + - name: guid + in: path + description: Id of the operation + required: true + schema: + type: string + format: uuid + - name: userIdentifier + in: query + description: Identifier of the user requesting the interrupt (Optional depending on configuration) + schema: + type: string + responses: + '200': + description: OK + content: + application/json: { } + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + '/api/moryx/orders/{guid}/advice': + get: + tags: + - OrderManagement + summary: Retrieves a advice context for the given operation + operationId: GetAdviceContext + parameters: + - name: guid + in: path + description: Id of the operation + required: true + schema: + type: string + format: uuid + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdviceContext' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + post: + tags: + - OrderManagement + summary: Advice operation + operationId: AdviceOperation + parameters: + - name: guid + in: path + description: Id of the operation + required: true + schema: + type: string + format: uuid + requestBody: + description: Parameter object + content: + application/json: + schema: + $ref: '#/components/schemas/AdviceModel' + text/json: + schema: + $ref: '#/components/schemas/AdviceModel' + application/*+json: + schema: + $ref: '#/components/schemas/AdviceModel' + required: true + responses: + '200': + description: OK + content: + application/json: { } + '400': + description: Bad Request + content: + application/json: + schema: + type: string + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + '/api/moryx/orders/{guid}/logs': + get: + tags: + - OrderManagement + summary: Retrieves logs written during the creation of the operation + operationId: GetLogs + parameters: + - name: guid + in: path + description: Id of the operation + required: true + schema: + type: string + format: uuid + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/OperationLogMessageModel' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + /api/moryx/orders/recipes: + get: + tags: + - OrderManagement + summary: Get's the list of recipes available to produce the given product + operationId: GetAssignableRecipes + parameters: + - name: identifier + in: query + description: Product identifier + schema: + type: string + - name: revision + in: query + description: Product revision + schema: + type: integer + format: int16 + responses: + '200': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/OperationRecipeModel' + '/api/moryx/orders/{guid}/abort': + post: + tags: + - OrderManagement + summary: Abort the specified operation (Remove it before being started) + operationId: AbortOperation + parameters: + - name: guid + in: path + description: Id of the operation + required: true + schema: + type: string + format: uuid + responses: + '200': + description: OK + content: + application/json: { } + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + '/api/moryx/orders/{guid}/update': + put: + tags: + - OrderManagement + summary: Update the operation + operationId: UpdateOperation + parameters: + - name: guid + in: path + description: Id of the operation + required: true + schema: + type: string + format: uuid + requestBody: + description: Paramter object + content: + application/json: + schema: + $ref: '#/components/schemas/OperationUpdateModel' + text/json: + schema: + $ref: '#/components/schemas/OperationUpdateModel' + application/*+json: + schema: + $ref: '#/components/schemas/OperationUpdateModel' + required: true + responses: + '200': + description: OK + content: + application/json: { } + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + '/api/moryx/orders/{guid}/reload': + put: + tags: + - OrderManagement + summary: 'Reload the operation, rerunning the order assignment steps' + operationId: Reload + parameters: + - name: guid + in: path + description: Id of the operation + required: true + schema: + type: string + format: uuid + responses: + '200': + description: OK + content: + application/json: { } + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + /api/moryx/processes/job: + get: + tags: + - ProcessEngine + operationId: GetRunningProcessesOfJob + parameters: + - name: jobId + in: query + schema: + type: integer + format: int64 + - name: allProcesses + in: query + schema: + type: boolean + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/JobProcessModel' + /api/moryx/processes/running: + get: + tags: + - ProcessEngine + operationId: GetRunningProcesses + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/JobProcessModel' + '/api/moryx/processes/instance/{productInstanceId}': + get: + tags: + - ProcessEngine + operationId: GetProcesses + parameters: + - name: productInstanceId + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/JobProcessModel' + '404': + description: Not Found + content: + application/json: + schema: + type: string + '/api/moryx/processes/running/{id}': + get: + tags: + - ProcessEngine + operationId: GetProcess + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/JobProcessModel' + '404': + description: Not Found + content: + application/json: + schema: + type: string + '/api/moryx/processes/running/{id}/activities': + get: + tags: + - ProcessEngine + operationId: GetActivities + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProcessActivityModel' + '404': + description: Not Found + content: + application/json: + schema: + type: string + '/api/moryx/processes/running/{id}/targets': + get: + tags: + - ProcessEngine + operationId: GetTargets + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ActivityResourceModel' + '404': + description: Not Found + content: + application/json: + schema: + type: string + '/api/moryx/processes/running/{id}/targets/{activityId}': + get: + tags: + - ProcessEngine + operationId: GetTargets + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + - name: activityId + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ActivityResourceModel' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + /api/moryx/processes/stream/processes: + get: + tags: + - ProcessEngine + operationId: ProcessUpdatesStream + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/JobProcessModel' + /api/moryx/processes/stream/activities: + get: + tags: + - ProcessEngine + operationId: ActivitiesUpdatesStream + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ProcessActivityModel' + /api/moryx/processes/holders/groups: + get: + tags: + - ProcessEngine + operationId: GetGroups + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ApiResponseOfProcessHolderGroupModel[]' + /api/moryx/processes/holders/stream: + get: + tags: + - ProcessEngine + operationId: GroupStream + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ProcessHolderGroupModel' + '/api/moryx/processes/holders/groups/{id}/reset': + post: + tags: + - ProcessEngine + operationId: ResetGroup + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '200': + description: OK + content: + application/json: { } + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/api/moryx/processes/holders/positions/{id}/reset': + post: + tags: + - ProcessEngine + operationId: ResetPosition + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '200': + description: OK + content: + application/json: { } + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /api/moryx/products/configuration: + get: + tags: + - ProductManagement + summary: 'Loads dataset of existing products, recipes and importers for the UI' + operationId: GetProductCustomization + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ProductCustomization' + '/api/moryx/products/importers/{importerName}': + post: + tags: + - ProductManagement + summary: Run the product importer with the given parameters + operationId: Import + parameters: + - name: importerName + in: path + description: Name of the importer + required: true + schema: + type: string + requestBody: + description: Parameters for the importer + content: + application/json: + schema: + $ref: '#/components/schemas/Entry' + text/json: + schema: + $ref: '#/components/schemas/Entry' + application/*+json: + schema: + $ref: '#/components/schemas/Entry' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProductModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /api/moryx/products/types: + post: + tags: + - ProductManagement + summary: Store the product type in the database + operationId: SaveType + requestBody: + description: Model of the new product + content: + application/json: + schema: + $ref: '#/components/schemas/ProductModel' + text/json: + schema: + $ref: '#/components/schemas/ProductModel' + application/*+json: + schema: + $ref: '#/components/schemas/ProductModel' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + type: integer + format: int64 + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + get: + tags: + - ProductManagement + summary: 'Retrieves all product types, if no identity is specified. Otherwise the model identified by that id is returned' + operationId: GetTypeByIdentity + parameters: + - name: identity + in: query + description: Optional. The id to look for + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProductModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /api/moryx/products/types/query: + post: + tags: + - ProductManagement + summary: Query the product type database + operationId: GetTypes + requestBody: + description: Query parameters + content: + application/json: + schema: + $ref: '#/components/schemas/ProductQuery' + text/json: + schema: + $ref: '#/components/schemas/ProductQuery' + application/*+json: + schema: + $ref: '#/components/schemas/ProductQuery' + required: true + responses: + '200': + description: The products models matching the query + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProductModel' + '/api/moryx/products/types/{id}': + get: + tags: + - ProductManagement + summary: Get's a product type using the database id + operationId: GetTypeById + parameters: + - name: id + in: path + description: Database id + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ProductModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + delete: + tags: + - ProductManagement + summary: Deletes the product type with the given id + operationId: DeleteType + parameters: + - name: id + in: path + description: '' + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + type: boolean + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + put: + tags: + - ProductManagement + summary: Updates the existing product type + operationId: UpdateType + parameters: + - name: id + in: path + description: Database id of the product type + required: true + schema: + type: integer + format: int64 + requestBody: + description: New product model + content: + application/json: + schema: + $ref: '#/components/schemas/ProductModel' + text/json: + schema: + $ref: '#/components/schemas/ProductModel' + application/*+json: + schema: + $ref: '#/components/schemas/ProductModel' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + type: integer + format: int64 + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + post: + tags: + - ProductManagement + summary: Create a clone of the product type identified with the id with the new identitiy + operationId: Duplicate + parameters: + - name: id + in: path + description: Database id of the existing product type + required: true + schema: + type: integer + format: int64 + requestBody: + description: Product identifier of the new product + content: + application/json: + schema: + type: string + text/json: + schema: + type: string + application/*+json: + schema: + type: string + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ProductModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/api/moryx/products/types/{id}/recipes/{classification}': + get: + tags: + - ProductManagement + summary: Loads the recipe attached to the product type with the id + operationId: GetRecipes + parameters: + - name: id + in: path + description: Database id + required: true + schema: + type: integer + format: int64 + - name: classification + in: path + description: Recipe classification RecipeClassification + required: true + schema: + type: integer + format: int32 + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RecipeModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/api/moryx/products/instances/{id}': + get: + tags: + - ProductManagement + summary: Get's the product instance with the given id + operationId: GetInstance + parameters: + - name: id + in: path + description: Database id of the product instance + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ProductInstanceModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /api/moryx/products/instances: + get: + tags: + - ProductManagement + summary: Loads multiple product instances at once + operationId: GetInstances + parameters: + - name: ids + in: query + description: A list of product instance ids + schema: + type: array + items: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProductInstanceModel' + post: + tags: + - ProductManagement + summary: Create a new product instace of the product type identified via the identifier and revision + operationId: CreateInstance + parameters: + - name: identifier + in: query + description: Product identifier + schema: + type: string + - name: revision + in: query + description: Revision of the product + schema: + type: integer + format: int16 + - name: save + in: query + description: 'If save is false, the new instance won''t be stored in the db' + schema: + type: boolean + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ProductInstanceModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + put: + tags: + - ProductManagement + summary: Save the instance in the product db + operationId: SaveInstance + requestBody: + description: Model of the product instance + content: + application/json: + schema: + $ref: '#/components/schemas/ProductInstanceModel' + text/json: + schema: + $ref: '#/components/schemas/ProductInstanceModel' + application/*+json: + schema: + $ref: '#/components/schemas/ProductInstanceModel' + required: true + responses: + '200': + description: OK + content: + application/json: { } + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/api/moryx/products/recipes/{id}': + get: + tags: + - ProductManagement + summary: Get's a recipe by it's db id + operationId: GetRecipe + parameters: + - name: id + in: path + description: Database id of the recipe + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/RecipeModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + put: + tags: + - ProductManagement + summary: Updates the existing recipes + operationId: UpdateRecipe + parameters: + - name: id + in: path + description: Database id of the recipe + required: true + schema: + type: integer + format: int64 + requestBody: + description: Updated recipe model + content: + application/json: + schema: + $ref: '#/components/schemas/RecipeModel' + text/json: + schema: + $ref: '#/components/schemas/RecipeModel' + application/*+json: + schema: + $ref: '#/components/schemas/RecipeModel' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + type: integer + format: int64 + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /api/moryx/products/recipes: + post: + tags: + - ProductManagement + summary: Saves a new recipe in the database + operationId: SaveRecipe + requestBody: + description: Model of the recipe + content: + application/json: + schema: + $ref: '#/components/schemas/RecipeModel' + text/json: + schema: + $ref: '#/components/schemas/RecipeModel' + application/*+json: + schema: + $ref: '#/components/schemas/RecipeModel' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + type: integer + format: int64 + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/api/moryx/products/recipe/construct/{recipeType}': + get: + tags: + - ProductManagement + operationId: CreateRecipe + parameters: + - name: recipeType + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/RecipeModel' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /api/moryx/resources/types: + get: + tags: + - ResourceModification + operationId: GetTypeTree + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceTypeModel' + '417': + description: Expectation Failed + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /api/moryx/resources: + get: + tags: + - ResourceModification + operationId: GetDetailsBatch + parameters: + - name: ids + in: query + schema: + type: array + items: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ResourceModel' + '417': + description: Expectation Failed + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + post: + tags: + - ResourceModification + operationId: Save + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceModel' + text/json: + schema: + $ref: '#/components/schemas/ResourceModel' + application/*+json: + schema: + $ref: '#/components/schemas/ResourceModel' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceModel' + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '500': + description: Internal Server Error + content: + application/json: { } + /api/moryx/resources/query: + post: + tags: + - ResourceModification + operationId: GetResources + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceQuery' + text/json: + schema: + $ref: '#/components/schemas/ResourceQuery' + application/*+json: + schema: + $ref: '#/components/schemas/ResourceQuery' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ResourceModel' + '417': + description: Expectation Failed + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/api/moryx/resources/{id}': + get: + tags: + - ResourceModification + operationId: GetDetails + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceModel' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '417': + description: Expectation Failed + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + put: + tags: + - ResourceModification + operationId: Update + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceModel' + text/json: + schema: + $ref: '#/components/schemas/ResourceModel' + application/*+json: + schema: + $ref: '#/components/schemas/ResourceModel' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '500': + description: Internal Server Error + content: + application/json: { } + delete: + tags: + - ResourceModification + operationId: Remove + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: { } + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '417': + description: Expectation Failed + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/api/moryx/resources/{id}/invoke/{method}': + post: + tags: + - ResourceModification + operationId: InvokeMethod + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + - name: method + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Entry' + text/json: + schema: + $ref: '#/components/schemas/Entry' + application/*+json: + schema: + $ref: '#/components/schemas/Entry' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Entry' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '417': + description: Expectation Failed + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/api/moryx/resources/types/{type}': + post: + tags: + - ResourceModification + operationId: ConstructWithParameters + parameters: + - name: type + in: path + required: true + schema: + type: string + - name: method + in: query + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Entry' + text/json: + schema: + $ref: '#/components/schemas/Entry' + application/*+json: + schema: + $ref: '#/components/schemas/Entry' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceModel' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '417': + description: Expectation Failed + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /api/moryx/shifts: + get: + tags: + - ShiftManagement + operationId: GetShifts + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ShiftModel' + post: + tags: + - ShiftManagement + operationId: CreateShift + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShiftCreationContextModel' + text/json: + schema: + $ref: '#/components/schemas/ShiftCreationContextModel' + application/*+json: + schema: + $ref: '#/components/schemas/ShiftCreationContextModel' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ShiftModel' + put: + tags: + - ShiftManagement + operationId: UpdateShift + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShiftModel' + text/json: + schema: + $ref: '#/components/schemas/ShiftModel' + application/*+json: + schema: + $ref: '#/components/schemas/ShiftModel' + required: true + responses: + '200': + description: OK + content: + application/json: { } + /api/moryx/shifts/filter: + get: + tags: + - ShiftManagement + operationId: GetShifts + parameters: + - name: earliestDate + in: query + schema: + type: string + format: date + - name: latestDate + in: query + schema: + type: string + format: date + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ShiftModel' + '/api/moryx/shifts/{id}': + delete: + tags: + - ShiftManagement + operationId: DeleteShift + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: { } + /api/moryx/shifts/types: + get: + tags: + - ShiftManagement + operationId: GetShiftTypes + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ShiftTypeModel' + post: + tags: + - ShiftManagement + operationId: CreateShiftType + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShiftTypeCreationContextModel' + text/json: + schema: + $ref: '#/components/schemas/ShiftTypeCreationContextModel' + application/*+json: + schema: + $ref: '#/components/schemas/ShiftTypeCreationContextModel' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ShiftTypeModel' + put: + tags: + - ShiftManagement + operationId: UpdateShiftType + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShiftTypeModel' + text/json: + schema: + $ref: '#/components/schemas/ShiftTypeModel' + application/*+json: + schema: + $ref: '#/components/schemas/ShiftTypeModel' + required: true + responses: + '200': + description: OK + content: + application/json: { } + '/api/moryx/shifts/types/{id}': + delete: + tags: + - ShiftManagement + operationId: DeleteShiftType + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: { } + /api/moryx/shifts/assignements: + get: + tags: + - ShiftManagement + operationId: GetShiftAssignements + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ShiftAssignementModel' + post: + tags: + - ShiftManagement + operationId: CreateShiftAssignement + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShiftAssignementCreationContextModel' + text/json: + schema: + $ref: '#/components/schemas/ShiftAssignementCreationContextModel' + application/*+json: + schema: + $ref: '#/components/schemas/ShiftAssignementCreationContextModel' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ShiftAssignementModel' + put: + tags: + - ShiftManagement + operationId: UpdateShiftAssignement + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShiftAssignementModel' + text/json: + schema: + $ref: '#/components/schemas/ShiftAssignementModel' + application/*+json: + schema: + $ref: '#/components/schemas/ShiftAssignementModel' + required: true + responses: + '200': + description: OK + content: + application/json: { } + /api/moryx/shifts/assignements/filter: + get: + tags: + - ShiftManagement + operationId: GetShiftAssignements + parameters: + - name: earliestDate + in: query + schema: + type: string + format: date + - name: latestDate + in: query + schema: + type: string + format: date + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ShiftAssignementModel' + '/api/moryx/shifts/assignements/{id}': + delete: + tags: + - ShiftManagement + operationId: DeleteShiftAssignement + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: { } + /api/moryx/skills/types: + get: + tags: + - SkillManagement + operationId: GetTypes + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SkillTypeModel' + '400': + description: Bad Request + content: + application/json: + schema: + type: string + post: + tags: + - SkillManagement + operationId: Create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SkillTypeCreationContextModel' + text/json: + schema: + $ref: '#/components/schemas/SkillTypeCreationContextModel' + application/*+json: + schema: + $ref: '#/components/schemas/SkillTypeCreationContextModel' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/SkillTypeModel' + '400': + description: Bad Request + content: + application/json: + schema: + type: string + put: + tags: + - SkillManagement + operationId: Update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SkillTypeModel' + text/json: + schema: + $ref: '#/components/schemas/SkillTypeModel' + application/*+json: + schema: + $ref: '#/components/schemas/SkillTypeModel' + required: true + responses: + '204': + description: No Content + content: + application/json: { } + '400': + description: Bad Request + content: + application/json: + schema: + type: string + '404': + description: Not Found + content: + application/json: + schema: + type: string + '/api/moryx/skills/types/{id}': + get: + tags: + - SkillManagement + operationId: GetType + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/SkillTypeModel' + '400': + description: Bad Request + content: + application/json: + schema: + type: string + '404': + description: Not Found + content: + application/json: + schema: + type: string + delete: + tags: + - SkillManagement + operationId: DeleteType + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + responses: + '204': + description: No Content + content: + application/json: { } + '400': + description: Bad Request + content: + application/json: + schema: + type: string + '404': + description: Not Found + content: + application/json: + schema: + type: string + /api/moryx/skills/types/prototype: + get: + tags: + - SkillManagement + operationId: GetTypePrototype + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/SkillTypeModel' + '400': + description: Bad Request + content: + application/json: + schema: + type: string + /api/moryx/skills: + get: + tags: + - SkillManagement + operationId: GetSkills + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SkillModel' + '400': + description: Bad Request + content: + application/json: + schema: + type: string + post: + tags: + - SkillManagement + operationId: Create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SkillCreationContextModel' + text/json: + schema: + $ref: '#/components/schemas/SkillCreationContextModel' + application/*+json: + schema: + $ref: '#/components/schemas/SkillCreationContextModel' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/SkillModel' + '400': + description: Bad Request + content: + application/json: + schema: + type: string + '404': + description: Not Found + content: + application/json: + schema: + type: string + '/api/moryx/skills/{id}': + get: + tags: + - SkillManagement + operationId: GetSkill + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/SkillModel' + '400': + description: Bad Request + content: + application/json: + schema: + type: string + '404': + description: Not Found + content: + application/json: + schema: + type: string + delete: + tags: + - SkillManagement + operationId: DeleteSkill + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + responses: + '204': + description: No Content + content: + application/json: { } + '400': + description: Bad Request + content: + application/json: + schema: + type: string + '404': + description: Not Found + content: + application/json: + schema: + type: string + '/foo/{value}': + get: + tags: + - Test + operationId: GetFoo + parameters: + - name: value + in: path + required: true + schema: + type: integer + format: int32 + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Foo' + /api/moryx/instructions/stream: + get: + tags: + - VisualInstructions + operationId: InstructionStream + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InstructionModel' + '400': + description: Bad Request + content: + application/json: + schema: + type: string + '/api/moryx/instructions/{identifier}': + get: + tags: + - VisualInstructions + operationId: GetAll + parameters: + - name: identifier + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InstructionModel' + '400': + description: Bad Request + content: + application/json: + schema: + type: string + post: + tags: + - VisualInstructions + operationId: AddInstruction + parameters: + - name: identifier + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstructionModel' + text/json: + schema: + $ref: '#/components/schemas/InstructionModel' + application/*+json: + schema: + $ref: '#/components/schemas/InstructionModel' + required: true + responses: + '200': + description: OK + content: + application/json: { } + delete: + tags: + - VisualInstructions + operationId: ClearInstruction + parameters: + - name: identifier + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstructionModel' + text/json: + schema: + $ref: '#/components/schemas/InstructionModel' + application/*+json: + schema: + $ref: '#/components/schemas/InstructionModel' + required: true + responses: + '200': + description: OK + content: + application/json: { } + '/api/moryx/instructions/{identifier}/response': + put: + tags: + - VisualInstructions + operationId: CompleteInstruction + parameters: + - name: identifier + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstructionResponseModel' + text/json: + schema: + $ref: '#/components/schemas/InstructionResponseModel' + application/*+json: + schema: + $ref: '#/components/schemas/InstructionResponseModel' + required: true + responses: + '200': + description: OK + content: + application/json: { } + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /api/moryx/instructions/instructors: + get: + tags: + - VisualInstructions + operationId: GetInstructors + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + type: string + /api/moryx/workplans: + get: + tags: + - Workplan + operationId: GetAllWorkplans + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WorkplanModel' + post: + tags: + - Workplan + operationId: SaveWorkplan + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkplanModel' + text/json: + schema: + $ref: '#/components/schemas/WorkplanModel' + application/*+json: + schema: + $ref: '#/components/schemas/WorkplanModel' + required: true + responses: + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/api/moryx/workplans/{id}/versions': + get: + tags: + - Workplan + operationId: GetVersions + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WorkplanModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '/api/moryx/workplans/{id}': + get: + tags: + - Workplan + operationId: GetWorkplan + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/WorkplanModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + delete: + tags: + - Workplan + operationId: DeleteWorkplan + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: { } + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + put: + tags: + - Workplan + operationId: UpdateWorkplan + parameters: + - name: id + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkplanModel' + text/json: + schema: + $ref: '#/components/schemas/WorkplanModel' + application/*+json: + schema: + $ref: '#/components/schemas/WorkplanModel' + required: true + responses: + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /api/moryx/workplans/steps: + get: + tags: + - WorkplanEditing + operationId: AvailableSteps + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WorkplanStepRecipe' + /api/moryx/workplans/sessions: + post: + tags: + - WorkplanEditing + operationId: EditWorkplan + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OpenSessionRequest' + text/json: + schema: + $ref: '#/components/schemas/OpenSessionRequest' + application/*+json: + schema: + $ref: '#/components/schemas/OpenSessionRequest' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/WorkplanSessionModel' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + '/api/moryx/workplans/sessions/{sessionId}': + get: + tags: + - WorkplanEditing + operationId: OpenSession + parameters: + - name: sessionId + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/WorkplanSessionModel' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + put: + tags: + - WorkplanEditing + operationId: UpdateSession + parameters: + - name: sessionId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkplanSessionModel' + text/json: + schema: + $ref: '#/components/schemas/WorkplanSessionModel' + application/*+json: + schema: + $ref: '#/components/schemas/WorkplanSessionModel' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/WorkplanSessionModel' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + delete: + tags: + - WorkplanEditing + operationId: CloseSession + parameters: + - name: sessionId + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: { } + '/api/moryx/workplans/sessions/{sessionId}/autolayout': + get: + tags: + - WorkplanEditing + operationId: AutoLayout + parameters: + - name: sessionId + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/WorkplanSessionModel' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + '/api/moryx/workplans/sessions/{sessionId}/save': + post: + tags: + - WorkplanEditing + operationId: SaveSession + parameters: + - name: sessionId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkplanSessionModel' + text/json: + schema: + $ref: '#/components/schemas/WorkplanSessionModel' + application/*+json: + schema: + $ref: '#/components/schemas/WorkplanSessionModel' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/WorkplanSessionModel' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + '/api/moryx/workplans/sessions/{sessionId}/validate': + get: + tags: + - WorkplanEditing + operationId: ValidateSession + parameters: + - name: sessionId + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationResultModel' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + '/api/moryx/workplans/sessions/{sessionId}/nodes': + post: + tags: + - WorkplanEditing + operationId: AddStep + parameters: + - name: sessionId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkplanStepRecipe' + text/json: + schema: + $ref: '#/components/schemas/WorkplanStepRecipe' + application/*+json: + schema: + $ref: '#/components/schemas/WorkplanStepRecipe' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/WorkplanNodeModel' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + '/api/moryx/workplans/sessions/{sessionId}/nodes/{nodeId}': + put: + tags: + - WorkplanEditing + operationId: UpdateStep + parameters: + - name: sessionId + in: path + required: true + schema: + type: string + - name: nodeId + in: path + required: true + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkplanNodeModel' + text/json: + schema: + $ref: '#/components/schemas/WorkplanNodeModel' + application/*+json: + schema: + $ref: '#/components/schemas/WorkplanNodeModel' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/WorkplanNodeModel' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + delete: + tags: + - WorkplanEditing + operationId: RemoveNode + parameters: + - name: sessionId + in: path + required: true + schema: + type: string + - name: nodeId + in: path + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/WorkplanSessionModel' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + '/api/moryx/workplans/sessions/{sessionId}/nodes/{targetNodeId}/{targetIndex}': + post: + tags: + - WorkplanEditing + operationId: ConnectStep + parameters: + - name: sessionId + in: path + required: true + schema: + type: string + - name: targetNodeId + in: path + required: true + schema: + type: integer + format: int64 + - name: targetIndex + in: path + required: true + schema: + type: integer + format: int32 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeConnector' + text/json: + schema: + $ref: '#/components/schemas/NodeConnector' + application/*+json: + schema: + $ref: '#/components/schemas/NodeConnector' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/WorkplanSessionModel' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' + delete: + tags: + - WorkplanEditing + operationId: DisconnectStep + parameters: + - name: sessionId + in: path + required: true + schema: + type: string + - name: targetNodeId + in: path + required: true + schema: + type: integer + format: int64 + - name: targetIndex + in: path + required: true + schema: + type: integer + format: int32 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeConnector' + text/json: + schema: + $ref: '#/components/schemas/NodeConnector' + application/*+json: + schema: + $ref: '#/components/schemas/NodeConnector' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/WorkplanSessionModel' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/MoryxExceptionResponse' +components: + schemas: + ActivityChangedModel: + type: object + properties: + id: + type: integer + format: int64 + resourceId: + type: integer + format: int64 + classification: + $ref: '#/components/schemas/ActivityClassification' + orderReferenceModel: + $ref: '#/components/schemas/OrderReferenceModel' + ActivityClassification: + type: string + description: "Defines different classifications of activities. A resource will define accepted classifications\r\nin the published ReadyToWork. An activity declares its classification which is compared\r\nto the accepted classification within the kernel. While a ReadyToWork can accept multiple\r\nclassifications (by combining flags), an activity has only one classification." + ActivityResourceModel: + type: object + properties: + id: + type: integer + format: int64 + name: + type: + - 'null' + - string + AdviceContext: + type: object + properties: + advicedAmount: + type: integer + description: Amount which are already adviced + format: int32 + description: Context for a new advice with all necessary information + AdviceModel: + type: object + properties: + toteBoxNumber: + type: + - 'null' + - string + amount: + type: integer + format: int32 + partId: + type: + - 'null' + - integer + format: int64 + ApiError: + required: + - errorCode + - message + type: object + properties: + errorCode: + type: + - 'null' + - string + message: + type: + - 'null' + - string + exception: + $ref: '#/components/schemas/Exception' + 'ApiResponseOfProcessHolderGroupModel[]': + type: object + properties: + data: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/ProcessHolderGroupModel' + errors: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/ApiError' + succeeded: + type: boolean + timestamp: + type: string + format: date-time + ApplicationInformationResponse: + type: object + properties: + assemblyProduct: + type: + - 'null' + - string + assemblyVersion: + type: + - 'null' + - string + assemblyInformationalVersion: + type: + - 'null' + - string + assemblyDescription: + type: + - 'null' + - string + assemblyCompanyName: + type: + - 'null' + - string + assemblyTitle: + type: + - 'null' + - string + assemblyConfiguration: + type: + - 'null' + - string + targetFramework: + type: + - 'null' + - string + assemblyCopyright: + type: + - 'null' + - string + assemblyTrademark: + type: + - 'null' + - string + AssemblyModel: + type: object + properties: + name: + type: + - 'null' + - string + version: + type: + - 'null' + - string + fileVersion: + type: + - 'null' + - string + informationalVersion: + type: + - 'null' + - string + AssignableOperator: + required: + - identifier + type: object + properties: + signedIn: + type: boolean + assignedResources: + type: array + items: + $ref: '#/components/schemas/IOperatorAssignable' + identifier: + type: string + firstName: + type: + - 'null' + - string + lastName: + type: + - 'null' + - string + pseudonym: + type: + - 'null' + - string + AssignedDays: + type: string + AttendableResourceModel: + type: object + properties: + id: + type: + - 'null' + - integer + format: int64 + name: + type: + - 'null' + - string + requiredSkills: + type: + - 'null' + - array + items: + type: string + BeginContext: + type: object + properties: + residualAmount: + type: integer + description: Residual amount of the operation + format: int32 + partialAmount: + type: integer + description: Current target amount of the operation + format: int32 + minimalTargetAmount: + type: integer + description: Provides the minimum value that can be set for the target amount when adjusting the operation. + format: int32 + canBegin: + type: boolean + description: Indicator if a begin is possible + canReduce: + type: boolean + description: Indicator if an adjustment of the operation is possible + restrictions: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/RestrictionDescription' + description: Reasons why a begin is not possible + successCount: + type: integer + description: Current success count of the operation + format: int32 + scrapCount: + type: integer + description: Current failure count of the operation + format: int32 + description: Context information to begin an operation production + BeginModel: + type: object + properties: + amount: + type: integer + format: int32 + userId: + type: + - 'null' + - string + Category: + enum: + - ProcessHolderGroup + - ParentResource + CellLocationModel: + type: object + properties: + id: + type: integer + format: int64 + positionX: + type: number + format: double + positionY: + type: number + format: double + CellPropertySettings: + type: object + properties: + valueUnit: + type: + - 'null' + - string + iconName: + type: + - 'null' + - string + isDisplayed: + type: boolean + currentValue: { } + displayName: + type: + - 'null' + - string + CellSettingsModel: + type: object + properties: + image: + type: + - 'null' + - string + icon: + type: + - 'null' + - string + CellState: + enum: + - Idle + - Requested + - Running + - NotReadyToWork + CellStateChangedModel: + type: object + properties: + id: + type: integer + format: int64 + state: + $ref: '#/components/schemas/CellState' + Config: + type: object + properties: + root: + $ref: '#/components/schemas/Entry' + ConfigUpdateMode: + enum: + - OnlySave + - SaveAndReincarnate + - UpdateLiveAndSave + ConfirmationType: + enum: + - Partial + - Final + description: Confirmation type while reporting amounts of an operation + ContentDescriptorModel: + type: object + properties: + id: + type: string + format: uuid + name: + type: + - 'null' + - string + variants: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/VariantDescriptor' + master: + $ref: '#/components/schemas/VariantDescriptor' + DatabaseConfigModel: + type: object + properties: + configuratorType: + type: + - 'null' + - string + connectionString: + type: + - 'null' + - string + properties: + $ref: '#/components/schemas/Entry' + DatabaseMigrationSummary: + type: object + properties: + result: + description: Flag that any updates were performed + $ref: '#/components/schemas/MigrationResult' + errors: + type: + - 'null' + - array + items: + type: string + description: 'Reason, in case an error occured during migration' + executedMigrations: + type: + - 'null' + - array + items: + type: string + description: All updates that were executed + description: Result object created from running a database update + DatabasesResponse: + type: object + properties: + databases: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/DataModel' + configurators: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/ModelConfiguratorModel' + DataModel: + type: object + properties: + targetModel: + type: + - 'null' + - string + config: + $ref: '#/components/schemas/DatabaseConfigModel' + possibleConfigurators: + type: + - 'null' + - array + items: + type: string + setups: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/SetupModel' + availableMigrations: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/DbMigrationsModel' + appliedMigrations: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/DbMigrationsModel' + DataType: + enum: + - Custom + - DateTime + - Date + - Time + - Duration + - PhoneNumber + - Currency + - Text + - Html + - MultilineText + - EmailAddress + - Password + - Url + - ImageUrl + - CreditCard + - PostalCode + - Upload + DbMigrationsModel: + type: object + properties: + name: + type: + - 'null' + - string + DependencyEvaluation: + type: object + properties: + rootModules: + type: integer + format: int32 + maxDepth: + type: integer + format: int32 + maxDependencies: + type: integer + format: int32 + maxDependends: + type: integer + format: int32 + DocumentModel: + type: object + properties: + identifier: + type: + - 'null' + - string + number: + type: + - 'null' + - string + revision: + type: integer + format: int16 + type: + type: + - 'null' + - string + description: + type: + - 'null' + - string + contentType: + type: + - 'null' + - string + source: + type: + - 'null' + - string + EntityTagHeaderValue: + type: object + properties: + tag: + $ref: '#/components/schemas/StringSegment' + isWeak: + type: boolean + Entry: + type: object + properties: + displayName: + type: + - 'null' + - string + description: Name of the item - property name or list item name + identifier: + type: + - 'null' + - string + description: Unique identifier - property name or item index + description: + type: + - 'null' + - string + description: Description of the entry + value: + description: Value of the entry + $ref: '#/components/schemas/EntryValue' + validation: + description: Validation information + $ref: '#/components/schemas/EntryValidation' + subEntries: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/Entry' + description: Subentries of this entry - properties or list items + prototypes: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/Entry' + description: Prototypes that can be used to create subentries + description: Model class representing a single property of a config class + EntryPossible: + type: object + properties: + key: + type: + - 'null' + - string + description: Invariant key of the possible value. + displayName: + type: + - 'null' + - string + description: Display name of the possible value. + description: + type: + - 'null' + - string + description: Description of the possible value. + description: Possible value for an entry. + EntryUnitType: + enum: + - None + - Password + - FilePath + - DirectoryPath + - Flags + - Base64 + description: Enum describes the unit type of a entry + EntryValidation: + type: object + properties: + dataType: + description: Logical data types that may appear + $ref: '#/components/schemas/DataType' + minimum: + type: number + description: Minimum value or minimal length of strings + format: double + maximum: + type: number + description: Maximum value or maximal length of strings + format: double + regex: + type: + - 'null' + - string + description: Regex pattern for this entry + isRequired: + type: boolean + description: Indicated if the field is required and should not be empty + description: All validation rules of an entry + EntryValue: + type: object + properties: + type: + description: Type of this entry + $ref: '#/components/schemas/EntryValueType' + unitType: + description: Unit type of this entry + $ref: '#/components/schemas/EntryUnitType' + current: + type: + - 'null' + - string + description: Current value of this entry + default: + type: + - 'null' + - string + description: Default value of this entry + possible: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/EntryPossible' + description: Possible values for this entry + isReadOnly: + type: boolean + description: Indicates wether the field is read only + description: Value of an config entry + EntryValueType: + enum: + - Byte + - Boolean + - Int16 + - UInt16 + - Int32 + - UInt32 + - Int64 + - UInt64 + - Single + - Double + - String + - Enum + - Class + - Collection + - Exception + - Stream + - Struct + - DateTime + - Date + - Time + - TimeSpan + description: Possible value types + Exception: + type: object + properties: + targetSite: + $ref: '#/components/schemas/MethodBase' + message: + type: + - 'null' + - string + data: + type: + - 'null' + - object + innerException: + $ref: '#/components/schemas/Exception' + helpLink: + type: + - 'null' + - string + source: + type: + - 'null' + - string + hResult: + type: integer + format: int32 + stackTrace: + type: + - 'null' + - string + ExecuteSetupRequest: + type: object + properties: + config: + $ref: '#/components/schemas/DatabaseConfigModel' + setup: + $ref: '#/components/schemas/SetupModel' + ExtendedOperatorModel: + type: object + properties: + assignedResources: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/AttendableResourceModel' + identifier: + type: + - 'null' + - string + firstName: + type: + - 'null' + - string + lastName: + type: + - 'null' + - string + pseudonym: + type: + - 'null' + - string + FactoryModel: + type: object + properties: + parentId: + type: integer + format: int64 + id: + type: integer + format: int64 + backgroundURL: + type: + - 'null' + - string + title: + type: + - 'null' + - string + FactoryStateModel: + type: object + properties: + backgroundURL: + type: + - 'null' + - string + hasManufacturingFactory: + type: boolean + orderModels: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/OrderModel' + activityChangedModels: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/ActivityChangedModel' + cellStateChangedModels: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/CellStateChangedModel' + resourceChangedModels: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/ResourceChangedModel' + id: + type: integer + format: int64 + location: + $ref: '#/components/schemas/CellLocationModel' + iconName: + type: + - 'null' + - string + isACell: + type: boolean + FailureBehaviour: + type: string + description: 'Enum flags: Notify - Reincarnate' + FileStreamResult: + type: object + properties: + fileStream: + $ref: '#/components/schemas/Stream' + contentType: + type: + - 'null' + - string + fileDownloadName: + type: + - 'null' + - string + lastModified: + type: + - 'null' + - string + format: date-time + entityTag: + oneOf: + - type: 'null' + - $ref: '#/components/schemas/EntityTagHeaderValue' + enableRangeProcessing: + type: boolean + Foo: + type: object + properties: + value: + type: integer + format: int32 + HostInformationResponse: + type: object + properties: + machineName: + type: + - 'null' + - string + osInformation: + type: + - 'null' + - string + upTime: + type: integer + format: int64 + ICapabilities: + type: object + properties: + isCombined: + type: boolean + description: Flag if the capabilities of this instance are implemented by sub instances + description: Common capabilities interface + IFormFile: + type: string + format: binary + InstructionContentType: + enum: + - Unknown + - Text + - Media + InstructionItemModel: + type: object + properties: + contentType: + $ref: '#/components/schemas/InstructionContentType' + content: + type: + - 'null' + - string + preview: + type: + - 'null' + - string + InstructionModel: + type: object + properties: + id: + type: integer + format: int64 + sender: + type: + - 'null' + - string + type: + $ref: '#/components/schemas/InstructionType' + items: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/InstructionItemModel' + inputs: + $ref: '#/components/schemas/Entry' + results: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/InstructionResultModel' + InstructionResponseModel: + type: object + properties: + id: + type: integer + format: int64 + inputs: + $ref: '#/components/schemas/Entry' + result: + type: + - 'null' + - string + selectedResult: + $ref: '#/components/schemas/InstructionResultModel' + InstructionResultModel: + type: object + properties: + key: + type: + - 'null' + - string + displayValue: + type: + - 'null' + - string + InstructionType: + enum: + - Display + - Execute + InternalOperationClassification: + enum: + - Initial + - Assigning + - Failed + - Aborted + - Ready + - Running + - Interrupting + - Interrupted + - Completed + - AmountReached + InvocationResponse: + type: object + properties: + success: + type: boolean + exceptionType: + type: + - 'null' + - string + errorMessage: + type: + - 'null' + - string + IOperatorAssignable: + type: object + properties: + requiredSkills: + $ref: '#/components/schemas/ICapabilities' + id: + type: integer + description: Id of the resource + format: int64 + name: + type: + - 'null' + - string + description: Name of this resource instance + capabilities: + description: The resource's capabilities + $ref: '#/components/schemas/ICapabilities' + JobModel: + type: object + properties: + id: + type: integer + format: int64 + recipeId: + type: integer + format: int64 + state: + type: + - 'null' + - string + displayState: + type: + - 'null' + - string + workplan: + type: + - 'null' + - string + canComplete: + type: boolean + canAbort: + type: boolean + isWaiting: + type: boolean + isRunning: + type: boolean + productionJob: + $ref: '#/components/schemas/ProductionJobModel' + setupJob: + $ref: '#/components/schemas/SetupJobModel' + JobProcessModel: + type: object + properties: + id: + type: integer + format: int64 + recipeId: + type: integer + format: int64 + state: + $ref: '#/components/schemas/ProcessProgress' + rework: + type: boolean + started: + type: string + format: date-time + completed: + type: string + format: date-time + activities: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/ProcessActivityModel' + isRunning: + type: boolean + LogLevel: + enum: + - Trace + - Debug + - Information + - Warning + - Error + - Critical + - None + MethodBase: { } + MethodEntry: + type: object + properties: + name: + type: + - 'null' + - string + description: Name of the method + isConstructor: + type: boolean + description: Flag if this structure represents a server side constructor + displayName: + type: + - 'null' + - string + description: Display name for the button + description: + type: + - 'null' + - string + description: Description of the method + parameters: + description: Arguments of the + $ref: '#/components/schemas/Entry' + isAsync: + type: boolean + description: True if the method is awaitable by Task + description: Model that represents a public method on an object callable from the UI + MigrationResult: + enum: + - Migrated + - NoMigrationsAvailable + - Error + description: Result enum for executing database migrations + ModelConfiguratorModel: + type: object + properties: + name: + type: + - 'null' + - string + configuratorType: + type: + - 'null' + - string + connectionStringKeys: + type: + - 'null' + - object + additionalProperties: + type: string + connectionStringPrototype: + type: + - 'null' + - string + configPrototype: + $ref: '#/components/schemas/Entry' + ModuleNotificationModel: + type: object + properties: + timestamp: + type: string + format: date-time + exception: + $ref: '#/components/schemas/SerializableException' + message: + type: + - 'null' + - string + severity: + $ref: '#/components/schemas/Severity' + ModuleStartBehaviour: + enum: + - Auto + - Manual + - OnDependency + description: Start behaviour + MoryxExceptionResponse: + type: object + properties: + title: + type: + - 'null' + - string + exception: + type: + - 'null' + - string + NodeConnectionPoint: + type: object + properties: + index: + type: integer + format: int32 + name: + type: + - 'null' + - string + connections: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/NodeConnector' + NodeConnector: + type: object + properties: + nodeId: + type: integer + format: int64 + index: + type: integer + format: int32 + NotificationModel: + type: object + properties: + identifier: + type: string + format: uuid + type: + type: + - 'null' + - string + title: + type: + - 'null' + - string + message: + type: + - 'null' + - string + severity: + $ref: '#/components/schemas/Severity' + created: + type: string + format: date-time + acknowledged: + type: + - 'null' + - string + format: date-time + isAcknowledgable: + type: boolean + properties: + $ref: '#/components/schemas/Entry' + sender: + type: + - 'null' + - string + source: + type: + - 'null' + - string + OpenSessionRequest: + type: object + properties: + workplanId: + type: integer + format: int64 + duplicate: + type: boolean + OperationAdvicedModel: + type: object + properties: + advice: + $ref: '#/components/schemas/AdviceModel' + operationModel: + $ref: '#/components/schemas/OperationModel' + OperationCreationContextModel: + type: object + properties: + totalAmount: + type: integer + description: The amount to produce + format: int32 + name: + type: + - 'null' + - string + description: Operation name + orderNumber: + type: + - 'null' + - string + description: The number of the order this operation belongs to + operationNumber: + type: + - 'null' + - string + description: The number of this operation + productIdentifier: + type: + - 'null' + - string + description: Main product identifier + productRevision: + type: integer + description: Revision of the Product + format: int16 + productName: + type: + - 'null' + - string + description: Name of the Product + recipePreselection: + type: integer + description: Id of the preselected recipe + format: int64 + overDeliveryAmount: + type: integer + description: Total amount planned for over delivery + format: int32 + underDeliveryAmount: + type: integer + description: Total amount planned for under delivery + format: int32 + plannedStart: + type: string + description: Expected start time + format: date-time + plannedEnd: + type: string + description: Expected end time + format: date-time + targetCycleTime: + type: number + description: Target cycle time for the production of the depending product + format: double + unit: + type: + - 'null' + - string + description: Unit of product + targetStock: + type: + - 'null' + - string + description: Target stock for produced parts + parts: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/PartCreationContext' + description: Part list of the product of this operation + materialParameters: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/Entry' + description: Additional operation depending parameters for the production + OperationLogMessageModel: + type: object + properties: + logLevel: + $ref: '#/components/schemas/LogLevel' + message: + type: + - 'null' + - string + exception: + type: + - 'null' + - string + timeStamp: + type: string + format: date-time + OperationModel: + type: object + properties: + identifier: + type: string + format: uuid + totalAmount: + type: integer + format: int32 + number: + type: + - 'null' + - string + name: + type: + - 'null' + - string + overDeliveryAmount: + type: integer + format: int32 + underDeliveryAmount: + type: integer + format: int32 + plannedStart: + type: string + format: date-time + plannedEnd: + type: string + format: date-time + start: + type: + - 'null' + - string + format: date-time + end: + type: + - 'null' + - string + format: date-time + targetCycleTime: + type: number + format: double + unit: + type: + - 'null' + - string + sortOrder: + type: integer + format: int32 + order: + type: + - 'null' + - string + classification: + $ref: '#/components/schemas/OperationStateClassification' + stateDisplayName: + type: + - 'null' + - string + productId: + type: integer + format: int64 + productIdentifier: + type: + - 'null' + - string + productRevision: + type: integer + format: int16 + productName: + type: + - 'null' + - string + recipeName: + type: + - 'null' + - string + recipeIds: + type: + - 'null' + - array + items: + type: integer + format: int64 + jobIds: + type: + - 'null' + - array + items: + type: integer + format: int64 + reportedSuccessCount: + type: integer + format: int32 + reportedFailureCount: + type: integer + format: int32 + canAssign: + type: boolean + canBegin: + type: boolean + canInterrupt: + type: boolean + canReport: + type: boolean + canAdvice: + type: boolean + isCreated: + type: boolean + isFailed: + type: boolean + isAssigning: + type: boolean + isAborted: + type: boolean + isAmountReached: + type: boolean + runningCount: + type: integer + format: int32 + successCount: + type: integer + format: int32 + scrapCount: + type: integer + format: int32 + pendingCount: + type: integer + format: int32 + progressRunning: + type: integer + format: int32 + progressSuccess: + type: integer + format: int32 + progressScrap: + type: integer + format: int32 + progressPending: + type: integer + format: int32 + hasDocuments: + type: boolean + hasPartList: + type: boolean + operationSource: + $ref: '#/components/schemas/Entry' + description: OrderOperation-DTO to be used with the endpoints + OperationRecipeModel: + type: object + properties: + id: + type: integer + format: int64 + name: + type: + - 'null' + - string + OperationReportedModel: + type: object + properties: + report: + $ref: '#/components/schemas/ReportModel' + operationModel: + $ref: '#/components/schemas/OperationModel' + OperationStartedModel: + type: object + properties: + userId: + type: + - 'null' + - string + operationModel: + $ref: '#/components/schemas/OperationModel' + OperationStateClassification: + type: string + description: "Enum providing the classification of the internal state machine of the operation for an external representation\r\nThe lowest 8 bits define the state of the operation. The following 16 bits contain flags for the executable\r\nactions on the operation and the trailing 8 bits overall classification information.\r\nBit: 31 - 24 | 23 - 8 | 7 - 0 |\r\nFlag: Overall | Usage | State |" + OperationUpdateModel: + type: object + properties: + sortIndex: + type: + - 'null' + - integer + format: int32 + plannedStart: + type: + - 'null' + - string + format: date-time + plannedEnd: + type: + - 'null' + - string + format: date-time + totalAmount: + type: + - 'null' + - integer + format: int32 + overDeliveryAmount: + type: + - 'null' + - integer + format: int32 + underDeliveryAmount: + type: + - 'null' + - integer + format: int32 + targetCycleTime: + type: + - 'null' + - number + format: double + targetStock: + type: + - 'null' + - string + OperatorModel: + type: object + properties: + identifier: + type: + - 'null' + - string + firstName: + type: + - 'null' + - string + lastName: + type: + - 'null' + - string + pseudonym: + type: + - 'null' + - string + OrderChangedModel: + type: object + properties: + order: + type: + - 'null' + - string + operation: + type: + - 'null' + - string + state: + $ref: '#/components/schemas/InternalOperationClassification' + OrderModel: + type: object + properties: + color: + type: + - 'null' + - string + order: + type: + - 'null' + - string + operation: + type: + - 'null' + - string + state: + $ref: '#/components/schemas/InternalOperationClassification' + OrderReferenceModel: + type: object + properties: + order: + type: + - 'null' + - string + operation: + type: + - 'null' + - string + PartClassification: + enum: + - Unknown + - Material + - InfoComponent + - CarrierMaterial + - ScrapMaterial + - BranchMaterial + PartConnector: + type: object + properties: + name: + type: + - 'null' + - string + displayName: + type: + - 'null' + - string + type: + type: + - 'null' + - string + isCollection: + type: boolean + parts: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/PartModel' + propertyTemplates: + $ref: '#/components/schemas/Entry' + PartCreationContext: + type: object + properties: + name: + type: + - 'null' + - string + description: Name of the part like the product name + number: + type: + - 'null' + - string + description: Identifier of this part + quantity: + type: number + description: Quantity of this part which are necessary to produce one product + format: double + unit: + type: + - 'null' + - string + description: Unit of the quantity + stagingIndicator: + description: Staging indicator + $ref: '#/components/schemas/StagingIndicator' + classification: + description: Classification of this part + $ref: '#/components/schemas/PartClassification' + description: Information about a part of the product which should be produced for an operation + PartModel: + type: object + properties: + id: + type: integer + format: int64 + properties: + $ref: '#/components/schemas/Entry' + product: + $ref: '#/components/schemas/ProductModel' + Position: + type: object + properties: + positionX: + type: number + format: double + positionY: + type: number + format: double + PreviewDescriptor: + type: object + properties: + state: + description: Current state of the preview + $ref: '#/components/schemas/PreviewState' + fileHash: + type: + - 'null' + - string + extension: + type: + - 'null' + - string + mimeType: + type: + - 'null' + - string + size: + type: integer + format: int64 + description: Descriptor for an preview + PreviewState: + enum: + - Creating + - Created + - Failed + - Unsupported + - Removed + description: State of the preview + ProblemDetails: + type: object + properties: + type: + type: + - 'null' + - string + title: + type: + - 'null' + - string + status: + type: + - 'null' + - integer + format: int32 + detail: + type: + - 'null' + - string + instance: + type: + - 'null' + - string + ProcessActivityModel: + type: object + properties: + id: + type: integer + format: int64 + resource: + $ref: '#/components/schemas/ActivityResourceModel' + type: + type: + - 'null' + - string + state: + type: + - 'null' + - string + classification: + $ref: '#/components/schemas/ActivityClassification' + requiredCapabilities: + type: + - 'null' + - string + possibleResources: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/ActivityResourceModel' + result: + type: + - 'null' + - integer + format: int64 + resultName: + type: + - 'null' + - string + instanceId: + type: + - 'null' + - integer + format: int64 + tracing: + $ref: '#/components/schemas/TracingModel' + isCompleted: + type: boolean + ProcessHolderGroupModel: + type: object + properties: + id: + type: integer + format: int64 + name: + type: + - 'null' + - string + isEmpty: + type: boolean + positions: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/ProcessHolderPositionModel' + visualization: + $ref: '#/components/schemas/VisualizationModel' + ProcessHolderPositionModel: + type: object + properties: + id: + type: integer + format: int64 + groupId: + type: integer + format: int64 + name: + type: + - 'null' + - string + position: + type: integer + format: int32 + activity: + type: + - 'null' + - string + order: + type: + - 'null' + - string + process: + type: + - 'null' + - string + isEmpty: + type: boolean + ProcessProgress: + enum: + - Ready + - Running + - Interrupted + - Completed + description: Enum representing the progress of a process within the kernel + ProductCustomization: + type: object + properties: + productTypes: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/ProductDefinitionModel' + recipeTypes: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/RecipeDefinitionModel' + importers: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/ProductImporter' + ProductDefinitionModel: + type: object + properties: + name: + type: + - 'null' + - string + displayName: + type: + - 'null' + - string + baseDefinition: + type: + - 'null' + - string + properties: + $ref: '#/components/schemas/Entry' + ProductImporter: + type: object + properties: + name: + type: + - 'null' + - string + parameters: + $ref: '#/components/schemas/Entry' + ProductInstanceModel: + type: object + properties: + id: + type: integer + format: int64 + type: + type: + - 'null' + - string + description: The name of the product type of this instance + state: + description: The current state of the instance + $ref: '#/components/schemas/ProductInstanceState' + properties: + $ref: '#/components/schemas/Entry' + ProductInstanceState: + type: string + description: "The state of an ProductInstance.\r\nThis will not occupy more than 4 Bits. Other enums can be added by bit-shifting" + ProductionJobModel: + type: object + properties: + productIdentity: + type: + - 'null' + - string + amount: + type: integer + format: int32 + successCount: + type: integer + format: int32 + failureCount: + type: integer + format: int32 + runningCount: + type: integer + format: int32 + reworkedCount: + type: integer + format: int32 + ProductModel: + type: object + properties: + id: + type: integer + format: int64 + name: + type: + - 'null' + - string + state: + $ref: '#/components/schemas/ProductState' + identifier: + type: + - 'null' + - string + revision: + type: integer + format: int16 + type: + type: + - 'null' + - string + properties: + $ref: '#/components/schemas/Entry' + parts: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/PartConnector' + recipes: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/RecipeModel' + ProductPartModel: + type: object + properties: + id: + type: integer + format: int64 + name: + type: + - 'null' + - string + identifier: + type: + - 'null' + - string + quantity: + type: number + format: double + unit: + type: + - 'null' + - string + stagingIndicator: + $ref: '#/components/schemas/StagingIndicator' + classification: + $ref: '#/components/schemas/PartClassification' + ProductQuery: + type: object + properties: + includeDeleted: + type: boolean + description: Flag if deleted products should be included in the query + typeName: + type: + - 'null' + - string + description: Product types to filter by + excludeDerivedTypes: + type: boolean + description: When filtering by type exclude derived types and only return specific matches + identifier: + type: + - 'null' + - string + description: Material identifiers + requiredState: + oneOf: + - type: 'null' + - description: State of the product + $ref: '#/components/schemas/ProductState' + revisionFilter: + description: Revisions to filter + $ref: '#/components/schemas/RevisionFilter' + name: + type: + - 'null' + - string + description: Material identifiers + revision: + type: integer + description: "Optional specific revision if RevisionFilter ProductQuery.RevisionFilter is set to\r\nRevisionFilter.Specific" + format: int16 + recipeFilter: + description: Optional recipe filter + $ref: '#/components/schemas/RecipeFilter' + selector: + description: Selector + $ref: '#/components/schemas/Selector' + propertyFilters: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/PropertyFilter' + description: List of property filters + loadFullTypeInformation: + type: boolean + description: "If set to true, product queries return fully populated product types.\r\nOtherwise only the basic type information is returned." + description: Filter to fetch products from the product management + ProductState: + type: string + description: Current state of a product + PropertyFilter: + type: object + properties: + entry: + description: Entry to filter + $ref: '#/components/schemas/Entry' + operator: + description: Operator for the filter expression + $ref: '#/components/schemas/PropertyFilterOperator' + description: Property filter wrapper for the filtered entry + PropertyFilterOperator: + enum: + - Equals + - GreaterThen + - LessThen + description: Property filter operator expression + RecipeClassificationModel: + enum: + - Unset + - Default + - Alternative + - Intermediate + - Part + description: Webservice compatible recipe classification enum + RecipeDefinitionModel: + type: object + properties: + name: + type: + - 'null' + - string + displayName: + type: + - 'null' + - string + hasWorkplans: + type: boolean + RecipeFilter: + enum: + - Unset + - WithRecipe + - WithoutRecipes + description: Different options regarding the recipes of the product + RecipeModel: + type: object + properties: + id: + type: integer + description: Id of the recipe + format: int64 + name: + type: + - 'null' + - string + description: Name of the recipe + state: + description: This recipe's state + $ref: '#/components/schemas/RecipeState' + revision: + type: integer + description: Revision of the recipe + format: int32 + type: + type: + - 'null' + - string + description: Type of the recipe + properties: + description: Properties of the recipe + $ref: '#/components/schemas/Entry' + workplanModel: + description: A model of the currently referenced workplan + $ref: '#/components/schemas/WorkplanModel' + classification: + description: Classification of the recipe + $ref: '#/components/schemas/RecipeClassificationModel' + isClone: + type: boolean + description: Whether this Recipe is a clone or not + description: DTO representation of a recipe + RecipeState: + enum: + - New + - Released + - Revoked + description: A Recipe's state + ReferenceFilter: + type: object + properties: + name: + type: + - 'null' + - string + description: Name of the reference + relationType: + description: Resource relation type + $ref: '#/components/schemas/ResourceRelationType' + role: + description: Role of the reference + $ref: '#/components/schemas/ResourceReferenceRole' + valueConstraint: + description: Filter criteria for the reference property + $ref: '#/components/schemas/ReferenceValue' + description: Filter criteria for required or requested references + ReferenceTypeModel: + type: object + properties: + name: + type: + - 'null' + - string + description: 'Name of the reference, usually name of the property' + isCollection: + type: boolean + description: Flag if this reference is a collection + displayName: + type: + - 'null' + - string + description: Display name of the reference + description: + type: + - 'null' + - string + description: Description of this reference + isRequired: + type: boolean + description: Reference is required and must be set + supportedTypes: + type: + - 'null' + - array + items: + type: string + description: Types that can be assigned to this reference + role: + description: Role of the referenced resource in the relationship + $ref: '#/components/schemas/ResourceReferenceRole' + relationType: + description: Type of resource relation + $ref: '#/components/schemas/ResourceRelationType' + description: Type model for a reference property on a resource type + ReferenceValue: + enum: + - Irrelevant + - NullOrEmpty + - NotEmpty + description: Enum to classify the current value of the reference property + ReportContext: + type: object + properties: + canPartial: + type: boolean + description: If `true` the operation can be reported partially + canFinal: + type: boolean + description: If `true` the operation can be reported finally + reportedSuccess: + type: integer + description: Currently reported success count + format: int32 + reportedFailure: + type: integer + description: Currently reported failure count + format: int32 + unreportedSuccess: + type: integer + description: Value of unreported success parts + format: int32 + unreportedFailure: + type: integer + description: Value of unreported failure parts + format: int32 + restrictions: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/RestrictionDescription' + description: Reasons why a report is not possible + successCount: + type: integer + description: Current success count of the operation + format: int32 + scrapCount: + type: integer + description: Current failure count of the operation + format: int32 + description: Report which is not processed. + ReportModel: + type: object + properties: + confirmationType: + $ref: '#/components/schemas/ConfirmationType' + comment: + type: + - 'null' + - string + successCount: + type: integer + format: int32 + failureCount: + type: integer + format: int32 + userIdentifier: + type: + - 'null' + - string + ResourceChangedModel: + type: object + properties: + cellName: + type: + - 'null' + - string + cellIconName: + type: + - 'null' + - string + cellImageURL: + type: + - 'null' + - string + id: + type: integer + format: int64 + cellLocation: + $ref: '#/components/schemas/CellLocationModel' + cellPropertySettings: + type: + - 'null' + - object + additionalProperties: + $ref: '#/components/schemas/CellPropertySettings' + factoryId: + type: integer + format: int64 + location: + $ref: '#/components/schemas/CellLocationModel' + iconName: + type: + - 'null' + - string + isACell: + type: boolean + ResourceModel: + type: object + properties: + id: + type: integer + description: Id of the resource. + format: int64 + referenceId: + type: integer + description: Reference id in case of recursion in the returned model + format: int64 + name: + type: + - 'null' + - string + description: Name of the resource. + description: + type: + - 'null' + - string + description: Description of the resource + type: + type: + - 'null' + - string + description: Resource type model reference + partiallyLoaded: + type: boolean + description: "Indicates that this model does not represent the full\r\nresource but only its key properties" + properties: + description: A list of configs of the resource. + $ref: '#/components/schemas/Entry' + methods: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/MethodEntry' + description: User callable methods for instances of this type + references: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/ResourceReferenceModel' + description: 'References of this resource, including children' + description: Base model used by details view and tree + ResourceQuery: + type: object + properties: + types: + type: + - 'null' + - array + items: + type: string + description: Type constraints to filter instances + referenceCondition: + description: Reference condition to filter instances + $ref: '#/components/schemas/ReferenceFilter' + referenceRecursion: + type: boolean + description: Flag if included references should be processed recursively + includedReferences: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/ReferenceFilter' + description: References that should be included in the response + description: Filter object to fetch resources from the server + ResourceReferenceModel: + type: object + properties: + name: + type: + - 'null' + - string + description: 'Name of the reference, usually name of the property' + targets: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/ResourceModel' + description: Targets of this reference + description: DTO that represents the reference of one resource with another + ResourceReferenceRole: + enum: + - Target + - Source + description: Role of a resource in a relation decorated with the ResourceReferenceAttribute + ResourceRelationType: + type: string + description: "Enum representing the relation between two entities and definition of their life cycle coupling.\r\nThe lowest 3 bits define the UML association type. The other 29 bits are for free use\r\nBit: 31 - 3 | 2 | 1 | 0\r\nFlag: Type | Usage | Composition | Aggregation\r\nUsage: Pick a number and bitshift it by 3 and add the UML type, e.g. 42 => (42 << 3) + 1" + ResourceTypeModel: + type: object + properties: + name: + type: + - 'null' + - string + description: The name of the resource type. + displayName: + type: + - 'null' + - string + description: Display name of this resource type + creatable: + type: boolean + description: Flag that this type is registered and can be instantiated + description: + type: + - 'null' + - string + description: Description of this resource type + constructors: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/MethodEntry' + description: Resource constructors used to build new instances + references: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/ReferenceTypeModel' + description: Reference properties of this type + baseType: + type: + - 'null' + - string + description: Back reference to the base type + derivedTypes: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/ResourceTypeModel' + description: Types derived from this type + description: Type item for the tree + RestrictionDescription: + required: + - text + - severity + type: object + properties: + text: + type: + - 'null' + - string + description: Description of the result + severity: + description: Severity of the result + $ref: '#/components/schemas/RestrictionSeverity' + description: Description of the result of a performed rule + RestrictionSeverity: + enum: + - Info + - Warning + - Error + description: Severity of a rule result + RevisionFilter: + enum: + - All + - Latest + - Specific + description: Filter for revisions + SaveConfigRequest: + type: object + properties: + config: + $ref: '#/components/schemas/Config' + updateMode: + $ref: '#/components/schemas/ConfigUpdateMode' + Selector: + enum: + - Direct + - Parent + - Parts + description: Determine which objects to select for the query + SerializableException: + type: object + properties: + exceptionTypeName: + type: + - 'null' + - string + message: + type: + - 'null' + - string + stackTrace: + type: + - 'null' + - string + innerException: + $ref: '#/components/schemas/SerializableException' + ServerModuleModel: + type: object + properties: + name: + type: + - 'null' + - string + healthState: + $ref: '#/components/schemas/ServerModuleState' + startBehaviour: + $ref: '#/components/schemas/ModuleStartBehaviour' + failureBehaviour: + $ref: '#/components/schemas/FailureBehaviour' + dependencies: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/ServerModuleModel' + notifications: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/ModuleNotificationModel' + assembly: + $ref: '#/components/schemas/AssemblyModel' + ServerModuleState: + enum: + - Stopped + - Ready + - Initializing + - Starting + - Failure + - Missing + - Running + - Stopping + description: Different health states a server module can have + ServerTimeResponse: + type: object + properties: + serverTime: + type: + - 'null' + - string + SetupJobClassification: + enum: + - None + - Prepare + - Cleanup + - Manual + SetupJobModel: + type: object + properties: + classification: + $ref: '#/components/schemas/SetupJobClassification' + targetRecipeId: + type: integer + format: int64 + steps: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/SetupStepModel' + SetupModel: + type: object + properties: + fullname: + type: + - 'null' + - string + sortOrder: + type: integer + format: int32 + name: + type: + - 'null' + - string + description: + type: + - 'null' + - string + supportedFileRegex: + type: + - 'null' + - string + setupData: + type: + - 'null' + - string + SetupStepModel: + type: object + properties: + name: + type: + - 'null' + - string + state: + $ref: '#/components/schemas/StepState' + Severity: + enum: + - Info + - Warning + - Error + - Fatal + description: Different levels to differentiate the severity of a message + ShiftAssignementCreationContextModel: + type: object + properties: + resourceId: + type: integer + format: int64 + shiftId: + type: integer + format: int64 + operatorIdentifier: + type: + - 'null' + - string + note: + type: + - 'null' + - string + priority: + type: integer + format: int32 + assignedDays: + $ref: '#/components/schemas/AssignedDays' + ShiftAssignementModel: + type: object + properties: + id: + type: integer + format: int64 + resourceId: + type: integer + format: int64 + operatorIdentifier: + type: + - 'null' + - string + shiftId: + type: integer + format: int64 + note: + type: + - 'null' + - string + priority: + type: integer + format: int32 + assignedDays: + $ref: '#/components/schemas/AssignedDays' + ShiftCreationContextModel: + type: object + properties: + typeId: + type: integer + format: int64 + date: + type: string + format: date + ShiftModel: + type: object + properties: + id: + type: integer + format: int64 + typeId: + type: integer + format: int64 + date: + type: string + format: date + ShiftTypeCreationContextModel: + type: object + properties: + name: + type: + - 'null' + - string + startTime: + type: string + format: time + endtime: + type: string + format: time + periode: + type: integer + format: uint8 + ShiftTypeModel: + type: object + properties: + id: + type: integer + format: int64 + name: + type: + - 'null' + - string + startTime: + type: string + format: time + endtime: + type: string + format: time + periode: + type: integer + format: uint8 + SkillCreationContextModel: + type: object + properties: + obtainedOn: + type: string + format: date + typeId: + type: integer + format: int64 + operatorIdentifier: + type: + - 'null' + - string + SkillModel: + type: object + properties: + id: + type: integer + format: int64 + obtainedOn: + type: string + format: date + expiresOn: + type: string + format: date + typeId: + type: integer + format: int64 + operatorIdentifier: + type: + - 'null' + - string + isExpired: + type: boolean + SkillTypeCreationContextModel: + type: object + properties: + name: + type: + - 'null' + - string + duration: + pattern: '^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$' + type: string + capabilities: + oneOf: + - type: 'null' + - $ref: '#/components/schemas/Entry' + SkillTypeModel: + type: object + properties: + id: + type: integer + format: int64 + name: + type: + - 'null' + - string + duration: + pattern: '^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$' + type: string + capabilities: + oneOf: + - type: 'null' + - $ref: '#/components/schemas/Entry' + SseItemBase: + type: object + properties: + type: + type: string + eventId: + type: string + reconnectInterval: + pattern: '^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$' + type: string + SseItemOfOperationAdvicedModel: + allOf: + - $ref: '#/components/schemas/SseItemBase' + properties: + data: + $ref: '#/components/schemas/OperationAdvicedModel' + SseItemOfOperationModel: + allOf: + - $ref: '#/components/schemas/SseItemBase' + properties: + data: + $ref: '#/components/schemas/OperationModel' + SseItemOfOperationReportedModel: + allOf: + - $ref: '#/components/schemas/SseItemBase' + properties: + data: + $ref: '#/components/schemas/OperationReportedModel' + SseItemOfOperationStartedModel: + allOf: + - $ref: '#/components/schemas/SseItemBase' + properties: + data: + $ref: '#/components/schemas/OperationStartedModel' + StagingIndicator: + enum: + - NotRelevant + - PickPart + - CrateOrKanbanPart + - ReleaseOrderPart + - ManualStaging + - EwmStaging + description: "The material staging indicator defines the method of how needed materials can be supplied for production with the assistance of the Warehouse Management system.\r\nAs with the location coordinates(warehouse number, storage type, and storage bin), the system files this indicator in the control cycle." + StepState: + enum: + - Initial + - Running + - Completed + Stream: + type: string + format: binary + StringSegment: + type: object + properties: + buffer: + type: + - 'null' + - string + offset: + type: integer + format: int32 + length: + type: integer + format: int32 + value: + type: + - 'null' + - string + hasValue: + type: boolean + TestConnectionResponse: + type: object + properties: + result: + $ref: '#/components/schemas/TestConnectionResult' + TestConnectionResult: + enum: + - ConfigurationError + - ConnectionError + - ConnectionOkDbDoesNotExist + - PendingMigrations + - Success + description: Result enum for function TestConnection + TracingModel: + type: object + properties: + type: + type: + - 'null' + - string + text: + type: + - 'null' + - string + started: + type: + - 'null' + - string + format: date-time + completed: + type: + - 'null' + - string + format: date-time + errorCode: + type: integer + format: int32 + properties: + $ref: '#/components/schemas/Entry' + TransportRouteModel: + type: object + properties: + idCellOfOrigin: + type: integer + format: int64 + idCellOfDestination: + type: integer + format: int64 + paths: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/Position' + ValidationErrorModel: + type: object + properties: + error: + type: + - 'null' + - string + position: + type: integer + format: int64 + ValidationResultModel: + type: object + properties: + success: + type: boolean + errors: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/ValidationErrorModel' + VariantDescriptor: + type: object + properties: + name: + type: + - 'null' + - string + description: Name of the variant + creationDate: + type: string + description: Date of the creation + format: date-time + preview: + description: Preview information for this variant + $ref: '#/components/schemas/PreviewDescriptor' + fileHash: + type: + - 'null' + - string + extension: + type: + - 'null' + - string + mimeType: + type: + - 'null' + - string + size: + type: integer + format: int64 + description: Descriptor for an variant + VisualizableItemModel: + type: object + properties: + id: + type: integer + format: int64 + location: + $ref: '#/components/schemas/CellLocationModel' + iconName: + type: + - 'null' + - string + isACell: + type: boolean + VisualizationModel: + type: object + properties: + icon: + type: + - 'null' + - string + category: + $ref: '#/components/schemas/Category' + WorkplanModel: + type: object + properties: + id: + type: integer + format: int64 + name: + type: + - 'null' + - string + version: + type: integer + format: int32 + state: + $ref: '#/components/schemas/WorkplanState' + WorkplanNodeClassification: + enum: + - Input + - Output + - Execution + - ControlFlow + - Subworkplan + WorkplanNodeModel: + type: object + properties: + id: + type: integer + format: int64 + type: + type: + - 'null' + - string + name: + type: + - 'null' + - string + displayName: + type: + - 'null' + - string + positionTop: + type: integer + format: int32 + positionLeft: + type: integer + format: int32 + classification: + $ref: '#/components/schemas/WorkplanNodeClassification' + inputs: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/NodeConnectionPoint' + outputs: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/NodeConnectionPoint' + properties: + $ref: '#/components/schemas/Entry' + subworkplanId: + type: integer + format: int64 + WorkplanSessionModel: + type: object + properties: + sessionToken: + type: + - 'null' + - string + workplanId: + type: integer + format: int64 + name: + type: + - 'null' + - string + version: + type: integer + format: int32 + state: + $ref: '#/components/schemas/WorkplanState' + nodes: + type: + - 'null' + - array + items: + $ref: '#/components/schemas/WorkplanNodeModel' + WorkplanState: + enum: + - New + - Released + - Revoked + description: A workplan state + WorkplanStepRecipe: + type: object + properties: + type: + type: + - 'null' + - string + name: + type: + - 'null' + - string + description: + type: + - 'null' + - string + positionTop: + type: integer + format: int32 + positionLeft: + type: integer + format: int32 + classification: + $ref: '#/components/schemas/WorkplanNodeClassification' + constructor: + $ref: '#/components/schemas/MethodEntry' + subworkplanId: + type: integer + format: int64 +tags: + - name: Common + - name: Database + - name: FactoryMonitor + - name: JobManagement + - name: MediaServer + - name: Modules + - name: NotificationPublisher + - name: OperatorManagement + - name: OrderManagement + - name: ProcessEngine + - name: ProductManagement + - name: ResourceModification + - name: ShiftManagement + - name: SkillManagement + - name: Test + - name: VisualInstructions + - name: Workplan + - name: WorkplanEditing \ No newline at end of file diff --git a/src/Moryx.AspNetCore.OpenApi/OpenApiExtensions.cs b/src/Moryx.AspNetCore.OpenApi/OpenApiExtensions.cs new file mode 100644 index 0000000000..3857512b52 --- /dev/null +++ b/src/Moryx.AspNetCore.OpenApi/OpenApiExtensions.cs @@ -0,0 +1,81 @@ +// Copyright (c) 2026 Phoenix Contact GmbH & Co. KG +// Licensed under the Apache License, Version 2.0 + +using System.Reflection; +using Microsoft.AspNetCore.OpenApi; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Hosting; +using Microsoft.OpenApi; + +namespace Moryx.AspNetCore.OpenApi; + +public static class OpenApiExtensions +{ + extension(OpenApiOptions options) + { + public OpenApiOptions ConfigureMoryxTransformers() + { + options.AddDocumentTransformer(); + options.AddOperationTransformer(); + options.AddOperationTransformer(); + return options; + } + } + extension(IHostEnvironment env) + { + /// + /// Extension to make it fit in with IsDevelopment, IsProduction that are common in asp.net core + /// + /// + public bool IsOpenApiBuildTime() + { + if (string.Compare(env.EnvironmentName, "OpenApiBuildTime", StringComparison.OrdinalIgnoreCase) == 0) + { + return true; + } + // If the environment name is not set, fallback to detecting the entry point + // Taken from https://github.com/dotnet/AspNetCore.Docs/blob/2c37585a425dd64e91015e60146031859ff52865/aspnetcore/fundamentals/openapi/samples/9.x/AspireApp1/AspireApp1.Web/Program.cs#L5 + // according to https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/fundamentals/openapi/aspnetcore-openapi.md#customize-runtime-behavior-during-build-time-document-generation + return Assembly.GetEntryAssembly()?.GetName().Name == "GetDocument.Insider"; + + } + } + extension(IServiceProvider services) + { + /// + /// Writes an openapi yaml spec for the specified document key + /// to the output location identified by path and file name. + /// + /// Filename of the generated spec with extension i.e. 'framework-api.yaml' + /// Folder in which to place the spec. Can be infered from the command line args if it's running as part of the Microsoft.Extensions.ApiDescription.Server + /// The document to generate the spec of. Defaults to the standard 'v1' document of the OpenApi integration + public async Task WriteYamlOpenApiSpec(string fileName, string path = null, string documentKey = "v1") + { + if (path == null) + { + var args = Environment.GetCommandLineArgs(); + var outputKey = args.IndexOf("--output"); + if (outputKey >= 0 && args.Length > outputKey + 1) + { + path = args[outputKey + 1]; + } + else + { + path = Directory.GetCurrentDirectory(); + } + + } + var provider = services.GetRequiredKeyedService(documentKey); + var document = await provider.GetOpenApiDocumentAsync(); + + Directory.CreateDirectory(path); + var filePath = Path.Combine(path, fileName); + using var textWriter = File.CreateText(filePath); + var writer = new OpenApiYamlWriter(textWriter); + + document.SerializeAsV31(writer); + await writer.FlushAsync(); + await textWriter.FlushAsync(); + } + } +} diff --git a/src/Moryx.AspNetCore.OpenApi/OpenApiOptionsExtension.cs b/src/Moryx.AspNetCore.OpenApi/OpenApiOptionsExtension.cs deleted file mode 100644 index ea68756789..0000000000 --- a/src/Moryx.AspNetCore.OpenApi/OpenApiOptionsExtension.cs +++ /dev/null @@ -1,20 +0,0 @@ -// Copyright (c) 2026 Phoenix Contact GmbH & Co. KG -// Licensed under the Apache License, Version 2.0 - -using Microsoft.AspNetCore.OpenApi; - -namespace Moryx.AspNetCore.OpenApi; - -public static class OpenApiOptionsExtension -{ - extension(OpenApiOptions options) - { - public OpenApiOptions ConfigureMoryxTransformers() - { - options.AddDocumentTransformer(); - options.AddOperationTransformer(); - options.AddOperationTransformer(); - return options; - } - } -} \ No newline at end of file diff --git a/src/Moryx.Orders.Web/app/openapi-gen.json b/src/Moryx.Orders.Web/app/openapi-gen.json index fcbe2c54ff..1953e67dc0 100644 --- a/src/Moryx.Orders.Web/app/openapi-gen.json +++ b/src/Moryx.Orders.Web/app/openapi-gen.json @@ -1,6 +1,6 @@ { "$schema": "node_modules/ng-openapi-gen/ng-openapi-gen-schema.json", - "input": "../../StartProject.Asp/StartProject.Asp.json", + "input": "../../../schemas/framework-api.json", "output": "src/app/api", "ignoreUnusedModels": true, "includeTags": [ diff --git a/src/StartProject.Asp/Program.cs b/src/StartProject.Asp/Program.cs index 9b4010300b..28a25bae19 100644 --- a/src/StartProject.Asp/Program.cs +++ b/src/StartProject.Asp/Program.cs @@ -2,11 +2,9 @@ // Licensed under the Apache License, Version 2.0 using System.Globalization; -using System.Reflection; using System.Text.Json.Serialization; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Localization; -using Microsoft.AspNetCore.OpenApi; using Microsoft.OpenApi; using Moryx.AspNetCore.OpenApi; using Moryx.Launcher; @@ -63,9 +61,7 @@ builder.Services.AddOpenApi(static options => { - options.OpenApiVersion = OpenApiSpecVersion.OpenApi3_1; // OpenApi3_2 is only available with .net 11 - //options.AddOperationTransformer(); options.ConfigureMoryxTransformers(); } ); @@ -94,26 +90,12 @@ { app.UseDeveloperExceptionPage(); - app.MapOpenApi(); - // Map open api spec as yaml to, if someone requires it - app.MapGet("/openapi/v1.yaml", - async ([FromKeyedServices("v1")] IOpenApiDocumentProvider provider) => - { - var document = await provider.GetOpenApiDocumentAsync(); - - using var stringWriter = new StringWriter(); - var writer = new OpenApiYamlWriter(stringWriter); - - document.SerializeAsV31(writer); - - return Results.Text( - stringWriter.ToString(), - "application/yaml"); - }); - app.UseSwaggerUI(options => - options.SwaggerEndpoint("/openapi/v1.json", "v1") + app.MapOpenApi("/openapi/{documentName}.yaml"); + app.MapOpenApi("/openapi/{documentName}.json"); + app.UseSwaggerUI(options => options.SwaggerEndpoint("/openapi/v1.yaml", "v1") ); } + app.UseRequestLocalization(); app.UseStaticFiles(); app.UseHttpsRedirection(); @@ -129,11 +111,9 @@ app.MapControllers().WithMetadata(new AllowAnonymousAttribute()); app.MapRazorPages(); -// Don't start moryx modules for openapi build time code generation -// Taken from https://github.com/dotnet/AspNetCore.Docs/blob/2c37585a425dd64e91015e60146031859ff52865/aspnetcore/fundamentals/openapi/samples/9.x/AspireApp1/AspireApp1.Web/Program.cs#L5 -// according to https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/fundamentals/openapi/aspnetcore-openapi.md#customize-runtime-behavior-during-build-time-document-generation -if (Assembly.GetEntryAssembly()?.GetName().Name == "GetDocument.Insider") +if (app.Environment.IsOpenApiBuildTime()) { + await app.Services.WriteYamlOpenApiSpec("framework-api.yaml"); await app.RunAsync(); return; } diff --git a/src/StartProject.Asp/StartProject.Asp.csproj b/src/StartProject.Asp/StartProject.Asp.csproj index 942f1a1144..d4bdac6d44 100644 --- a/src/StartProject.Asp/StartProject.Asp.csproj +++ b/src/StartProject.Asp/StartProject.Asp.csproj @@ -20,8 +20,9 @@ true - $(MSBuildProjectDirectory) - --openapi-version OpenApi3_1 + $(MSBuildProjectDirectory)/../../schemas + --openapi-version OpenApi3_1 --file-name framework-api + OpenApiBuildTime diff --git a/src/StartProject.Asp/StartProject.Asp.json b/src/StartProject.Asp/StartProject.Asp.json deleted file mode 100644 index 4017eafec6..0000000000 --- a/src/StartProject.Asp/StartProject.Asp.json +++ /dev/null @@ -1,12762 +0,0 @@ -{ - "openapi": "3.1.1", - "info": { - "title": "StartProject.Asp | v1", - "version": "1.0.0" - }, - "paths": { - "/common/time": { - "get": { - "tags": [ - "Common" - ], - "operationId": "GetServerTime", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServerTimeResponse" - } - } - } - } - } - } - }, - "/common/info/application": { - "get": { - "tags": [ - "Common" - ], - "operationId": "GetApplicationInfo", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApplicationInformationResponse" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/common/info/system": { - "get": { - "tags": [ - "Common" - ], - "operationId": "GetHostInfo", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HostInformationResponse" - } - } - } - } - } - } - }, - "/databases": { - "get": { - "tags": [ - "Database" - ], - "operationId": "GetAll", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/DatabasesResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DatabasesResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/DatabasesResponse" - } - } - } - } - } - }, - "delete": { - "tags": [ - "Database" - ], - "operationId": "EraseAll", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/InvocationResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/InvocationResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InvocationResponse" - } - } - } - } - } - } - }, - "/databases/{targetModel}": { - "get": { - "tags": [ - "Database" - ], - "operationId": "GetModel", - "parameters": [ - { - "name": "targetModel", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/DataModel" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DataModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/DataModel" - } - } - } - } - } - }, - "delete": { - "tags": [ - "Database" - ], - "operationId": "EraseDatabase", - "parameters": [ - { - "name": "targetModel", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DatabaseConfigModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/DatabaseConfigModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/DatabaseConfigModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/InvocationResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/InvocationResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InvocationResponse" - } - } - } - } - } - } - }, - "/databases/{targetModel}/config": { - "post": { - "tags": [ - "Database" - ], - "operationId": "SetDatabaseConfig", - "parameters": [ - { - "name": "targetModel", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DatabaseConfigModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/DatabaseConfigModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/DatabaseConfigModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/DataModel" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DataModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/DataModel" - } - } - } - } - } - } - }, - "/databases/{targetModel}/config/test": { - "post": { - "tags": [ - "Database" - ], - "operationId": "TestDatabaseConfig", - "parameters": [ - { - "name": "targetModel", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DatabaseConfigModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/DatabaseConfigModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/DatabaseConfigModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/TestConnectionResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestConnectionResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/TestConnectionResponse" - } - } - } - } - } - } - }, - "/databases/createall": { - "post": { - "tags": [ - "Database" - ], - "operationId": "CreateAll", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/InvocationResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/InvocationResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InvocationResponse" - } - } - } - } - } - } - }, - "/databases/{targetModel}/create": { - "post": { - "tags": [ - "Database" - ], - "operationId": "CreateDatabase", - "parameters": [ - { - "name": "targetModel", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DatabaseConfigModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/DatabaseConfigModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/DatabaseConfigModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/InvocationResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/InvocationResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InvocationResponse" - } - } - } - } - } - } - }, - "/databases/{targetModel}/migrate": { - "post": { - "tags": [ - "Database" - ], - "operationId": "MigrateDatabaseModel", - "parameters": [ - { - "name": "targetModel", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DatabaseConfigModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/DatabaseConfigModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/DatabaseConfigModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/DatabaseMigrationSummary" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DatabaseMigrationSummary" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/DatabaseMigrationSummary" - } - } - } - } - } - } - }, - "/databases/{targetModel}/setup": { - "post": { - "tags": [ - "Database" - ], - "operationId": "ExecuteSetup", - "parameters": [ - { - "name": "targetModel", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExecuteSetupRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ExecuteSetupRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ExecuteSetupRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/InvocationResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/InvocationResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InvocationResponse" - } - } - } - } - } - } - }, - "/api/moryx/factory-monitor/state": { - "get": { - "tags": [ - "FactoryMonitor" - ], - "operationId": "InitialFactoryState", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/FactoryStateModel" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/FactoryStateModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/FactoryStateModel" - } - } - } - } - } - } - }, - "/api/moryx/factory-monitor/cells": { - "get": { - "tags": [ - "FactoryMonitor" - ], - "operationId": "AllCells", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VisualizableItemModel" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VisualizableItemModel" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VisualizableItemModel" - } - } - } - } - } - } - } - }, - "/api/moryx/factory-monitor/factory-content/{factoryId}": { - "get": { - "tags": [ - "FactoryMonitor" - ], - "operationId": "FactoryContent", - "parameters": [ - { - "name": "factoryId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VisualizableItemModel" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VisualizableItemModel" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VisualizableItemModel" - } - } - } - } - } - } - } - }, - "/api/moryx/factory-monitor/navigation/{factoryId}": { - "get": { - "tags": [ - "FactoryMonitor" - ], - "operationId": "GetNavigation", - "parameters": [ - { - "name": "factoryId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/FactoryModel" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/FactoryModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/FactoryModel" - } - } - } - } - } - } - }, - "/api/moryx/factory-monitor/state-stream": { - "get": { - "tags": [ - "FactoryMonitor" - ], - "operationId": "FactoryStatesStream", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/OrderChangedModel" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderChangedModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/OrderChangedModel" - } - } - } - } - } - } - }, - "/api/moryx/factory-monitor/move-cell": { - "post": { - "tags": [ - "FactoryMonitor" - ], - "operationId": "MoveCell", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CellLocationModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/CellLocationModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/CellLocationModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/CellLocationModel" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CellLocationModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/CellLocationModel" - } - } - } - } - } - } - }, - "/api/moryx/factory-monitor/background": { - "post": { - "tags": [ - "FactoryMonitor" - ], - "operationId": "ChangeBackground", - "parameters": [ - { - "name": "resourceId", - "in": "query", - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "url", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK" - }, - "404": { - "description": "Not Found", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "422": { - "description": "Unprocessable Entity", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/factory-monitor/cell-properties/{identifier}": { - "get": { - "tags": [ - "FactoryMonitor" - ], - "operationId": "GetCellPropertiesSettings", - "parameters": [ - { - "name": "identifier", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/CellPropertySettings" - } - } - }, - "application/json": { - "schema": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/CellPropertySettings" - } - } - }, - "text/json": { - "schema": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/CellPropertySettings" - } - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/factory-monitor/traceroute": { - "post": { - "tags": [ - "FactoryMonitor" - ], - "operationId": "TraceRoute", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TransportRouteModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/TransportRouteModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/TransportRouteModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/moryx/factory-monitor/cell-settings/{id}": { - "put": { - "tags": [ - "FactoryMonitor" - ], - "operationId": "CellSettings", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CellSettingsModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/CellSettingsModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/CellSettingsModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/moryx/factory-monitor/routes": { - "post": { - "tags": [ - "FactoryMonitor" - ], - "operationId": "GetRoutes", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TransportRouteModel" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TransportRouteModel" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TransportRouteModel" - } - } - } - } - } - } - } - }, - "/api/moryx/jobs/{jobId}": { - "get": { - "tags": [ - "JobManagement" - ], - "operationId": "GetJob", - "parameters": [ - { - "name": "jobId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JobModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/jobs": { - "get": { - "tags": [ - "JobManagement" - ], - "operationId": "GetAll", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/JobModel" - } - } - } - } - } - } - } - }, - "/api/moryx/jobs/{jobId}/complete": { - "post": { - "tags": [ - "JobManagement" - ], - "operationId": "Complete", - "parameters": [ - { - "name": "jobId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - } - } - } - }, - "/api/moryx/jobs/{jobId}/abort": { - "post": { - "tags": [ - "JobManagement" - ], - "operationId": "Abort", - "parameters": [ - { - "name": "jobId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - } - } - } - }, - "/api/moryx/jobs/stream": { - "get": { - "tags": [ - "JobManagement" - ], - "operationId": "ProgressStream", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - } - } - } - }, - "/api/moryx/media": { - "get": { - "tags": [ - "MediaServer" - ], - "operationId": "GetAll", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ContentDescriptorModel" - } - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/media/{guid}": { - "get": { - "tags": [ - "MediaServer" - ], - "operationId": "Get", - "parameters": [ - { - "name": "guid", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ContentDescriptorModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "delete": { - "tags": [ - "MediaServer" - ], - "operationId": "RemoveContent", - "parameters": [ - { - "name": "guid", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK" - }, - "400": { - "description": "Bad Request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/media/{guid}/{variantName}": { - "get": { - "tags": [ - "MediaServer" - ], - "operationId": "GetVariant", - "parameters": [ - { - "name": "guid", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "variantName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VariantDescriptor" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "delete": { - "tags": [ - "MediaServer" - ], - "operationId": "RemoveVariant", - "parameters": [ - { - "name": "guid", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "variantName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK" - }, - "400": { - "description": "Bad Request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/media/{guid}/{variantName}/stream": { - "get": { - "tags": [ - "MediaServer" - ], - "operationId": "GetVariantStream", - "parameters": [ - { - "name": "guid", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "variantName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "preview", - "in": "query", - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "400": { - "description": "Bad Request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/FileStreamResult" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileStreamResult" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/FileStreamResult" - } - } - } - } - } - } - }, - "/api/moryx/media/master": { - "post": { - "tags": [ - "MediaServer" - ], - "operationId": "AddMaster", - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "formFile": { - "$ref": "#/components/schemas/IFormFile" - } - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "format": "uuid" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/media/{contentId}/{variantName}": { - "post": { - "tags": [ - "MediaServer" - ], - "operationId": "AddVariant", - "parameters": [ - { - "name": "contentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "variantName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "formFile": { - "$ref": "#/components/schemas/IFormFile" - } - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "format": "uuid" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/modules/dependencies": { - "get": { - "tags": [ - "Modules" - ], - "operationId": "GetDependencyEvaluation", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/DependencyEvaluation" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DependencyEvaluation" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/DependencyEvaluation" - } - } - } - } - } - } - }, - "/modules": { - "get": { - "tags": [ - "Modules" - ], - "operationId": "GetAll", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ServerModuleModel" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ServerModuleModel" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ServerModuleModel" - } - } - } - } - } - } - } - }, - "/modules/{moduleName}/healthstate": { - "get": { - "tags": [ - "Modules" - ], - "operationId": "HealthState", - "parameters": [ - { - "name": "moduleName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ServerModuleState" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServerModuleState" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ServerModuleState" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/modules/{moduleName}/notifications": { - "get": { - "tags": [ - "Modules" - ], - "operationId": "Notifications", - "parameters": [ - { - "name": "moduleName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ModuleNotificationModel" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ModuleNotificationModel" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ModuleNotificationModel" - } - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/modules/{moduleName}/start": { - "post": { - "tags": [ - "Modules" - ], - "operationId": "Start", - "parameters": [ - { - "name": "moduleName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK" - }, - "404": { - "description": "Not Found", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/modules/{moduleName}/stop": { - "post": { - "tags": [ - "Modules" - ], - "operationId": "Stop", - "parameters": [ - { - "name": "moduleName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK" - }, - "404": { - "description": "Not Found", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/modules/{moduleName}/reincarnate": { - "post": { - "tags": [ - "Modules" - ], - "operationId": "Reincarnate", - "parameters": [ - { - "name": "moduleName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK" - }, - "404": { - "description": "Not Found", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/modules/{moduleName}": { - "post": { - "tags": [ - "Modules" - ], - "operationId": "Update", - "parameters": [ - { - "name": "moduleName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServerModuleModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ServerModuleModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ServerModuleModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK" - }, - "400": { - "description": "Bad Request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/modules/{moduleName}/confirm": { - "post": { - "tags": [ - "Modules" - ], - "operationId": "ConfirmWarning", - "parameters": [ - { - "name": "moduleName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK" - }, - "404": { - "description": "Not Found", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/modules/{moduleName}/config": { - "get": { - "tags": [ - "Modules" - ], - "operationId": "GetConfig", - "parameters": [ - { - "name": "moduleName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/Config" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Config" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/Config" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "500": { - "description": "Internal Server Error" - } - } - }, - "post": { - "tags": [ - "Modules" - ], - "operationId": "SetConfig", - "parameters": [ - { - "name": "moduleName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SaveConfigRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/SaveConfigRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/SaveConfigRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK" - }, - "400": { - "description": "Bad Request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "500": { - "description": "Internal Server Error" - } - } - } - }, - "/modules/{moduleName}/console": { - "get": { - "tags": [ - "Modules" - ], - "operationId": "GetMethods", - "parameters": [ - { - "name": "moduleName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MethodEntry" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MethodEntry" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MethodEntry" - } - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "post": { - "tags": [ - "Modules" - ], - "operationId": "InvokeMethod", - "parameters": [ - { - "name": "moduleName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MethodEntry" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/MethodEntry" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/MethodEntry" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/Entry" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Entry" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/Entry" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "500": { - "description": "Internal Server Error" - } - } - } - }, - "/api/moryx/notifications": { - "get": { - "tags": [ - "NotificationPublisher" - ], - "operationId": "GetAll", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NotificationModel" - } - } - } - } - } - } - } - }, - "/api/moryx/notifications/{guid}": { - "get": { - "tags": [ - "NotificationPublisher" - ], - "operationId": "Get", - "parameters": [ - { - "name": "guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - }, - "/api/moryx/notifications/stream": { - "get": { - "tags": [ - "NotificationPublisher" - ], - "operationId": "NotificationStream", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NotificationModel" - } - } - } - } - } - } - } - }, - "/api/moryx/notifications/{guid}/acknowledge": { - "post": { - "tags": [ - "NotificationPublisher" - ], - "operationId": "Acknowledge", - "parameters": [ - { - "name": "guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - }, - "/api/moryx/operators": { - "post": { - "tags": [ - "OperatorManagement" - ], - "operationId": "Add", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OperatorModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/OperatorModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/OperatorModel" - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "delete": { - "tags": [ - "OperatorManagement" - ], - "operationId": "DeleteOperator", - "parameters": [ - { - "name": "operatorIdentifier", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "No Content", - "content": { - "application/json": { } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "get": { - "tags": [ - "OperatorManagement" - ], - "operationId": "GetAll", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AssignableOperator" - } - } - } - } - } - } - } - }, - "/api/moryx/operators/{identifier}": { - "put": { - "tags": [ - "OperatorManagement" - ], - "operationId": "Update", - "parameters": [ - { - "name": "identifier", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OperatorModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/OperatorModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/OperatorModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "get": { - "tags": [ - "OperatorManagement" - ], - "operationId": "Get", - "parameters": [ - { - "name": "identifier", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExtendedOperatorModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/operators/get-operators-by-resource/{resourceId}": { - "get": { - "tags": [ - "OperatorManagement" - ], - "operationId": "GetOperatorsByResource", - "parameters": [ - { - "name": "resourceId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ExtendedOperatorModel" - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/operators/resources/{operatorIdentifier}": { - "get": { - "tags": [ - "OperatorManagement" - ], - "operationId": "GetResources", - "parameters": [ - { - "name": "operatorIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttendableResourceModel" - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/operators/resources": { - "get": { - "tags": [ - "OperatorManagement" - ], - "operationId": "GetResources", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttendableResourceModel" - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/operators/default": { - "get": { - "tags": [ - "OperatorManagement" - ], - "operationId": "GetDefaultOperator", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExtendedOperatorModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/operators/signin": { - "put": { - "tags": [ - "OperatorManagement" - ], - "operationId": "SignIn", - "parameters": [ - { - "name": "operatorIdentifier", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "resourceId", - "in": "query", - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/operators/signout": { - "put": { - "tags": [ - "OperatorManagement" - ], - "operationId": "SignOut", - "parameters": [ - { - "name": "operatorIdentifier", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "resourceId", - "in": "query", - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/operators/stream": { - "get": { - "tags": [ - "OperatorManagement" - ], - "operationId": "Stream", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - } - } - } - }, - "/api/moryx/orders": { - "get": { - "tags": [ - "OrderManagement" - ], - "summary": "Retrieve all current operations that match the given filter parameters.\r\nAlready completed or aborted Operations won't be included.", - "operationId": "GetOperations", - "parameters": [ - { - "name": "orderNumber", - "in": "query", - "description": "Optional. If specified only operations that belong to this order will be returned", - "schema": { - "type": "string" - } - }, - { - "name": "operationNumber", - "in": "query", - "description": "Optional. If specified only operations with this operation number will be returned", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OperationModel" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "OrderManagement" - ], - "summary": "Add an operation to the order stock", - "operationId": "AddOperation", - "parameters": [ - { - "name": "sourceId", - "in": "query", - "description": "Identifier of the application adding the operation", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Description of the operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OperationCreationContextModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/OperationCreationContextModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/OperationCreationContextModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OperationModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - } - } - }, - "/api/moryx/orders/stream": { - "get": { - "tags": [ - "OrderManagement" - ], - "summary": "Stream that allow subscribing to operation changes.", - "operationId": "OperationStream", - "responses": { - "200": { - "description": "OK", - "content": { - "text/event-stream": { - "schema": { - "oneOf": [ - { - "description": "Published with type 'Start': Published when operation has been started", - "$ref": "#/components/schemas/SseItemOfOperationStartedModel" - }, - { - "description": "Published with type 'Progress'", - "$ref": "#/components/schemas/SseItemOfOperationModel" - }, - { - "description": "Published with type 'Completed'", - "$ref": "#/components/schemas/SseItemOfOperationReportedModel" - }, - { - "description": "Published with type 'Interrupted'", - "$ref": "#/components/schemas/SseItemOfOperationReportedModel" - }, - { - "description": "Published with type 'Report'", - "$ref": "#/components/schemas/SseItemOfOperationReportedModel" - }, - { - "description": "Published with type 'Advice'", - "$ref": "#/components/schemas/SseItemOfOperationAdvicedModel" - }, - { - "description": "Published with type 'Update'", - "$ref": "#/components/schemas/SseItemOfOperationModel" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "Start": "#/components/schemas/SseItemOfOperationStartedModel", - "Progress": "#/components/schemas/SseItemOfOperationModel", - "Completed": "#/components/schemas/SseItemOfOperationReportedModel", - "Interrupted": "#/components/schemas/SseItemOfOperationReportedModel", - "Report": "#/components/schemas/SseItemOfOperationReportedModel", - "Advice": "#/components/schemas/SseItemOfOperationAdvicedModel", - "Update": "#/components/schemas/SseItemOfOperationModel" - } - } - } - } - } - } - } - } - }, - "/api/moryx/orders/{guid}": { - "get": { - "tags": [ - "OrderManagement" - ], - "summary": "Retrieves an operationmodel using the unique id of the operation\r\n(Can load completed operations from storage)", - "operationId": "GetOperation", - "parameters": [ - { - "name": "guid", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OperationModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - }, - "/api/moryx/orders/{guid}/documents": { - "get": { - "tags": [ - "OrderManagement" - ], - "summary": "Retrieve the documents attached to operation with the given id", - "operationId": "GetDocuments", - "parameters": [ - { - "name": "guid", - "in": "path", - "description": "Id of the operation", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentModel" - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - }, - "/api/moryx/orders/{guid}/document/{identifier}/stream": { - "get": { - "tags": [ - "OrderManagement" - ], - "summary": "Retrieves the content of the document specified using the operation id and the identifier of the document", - "operationId": "GetDocumentStream", - "parameters": [ - { - "name": "guid", - "in": "path", - "description": "Id of the operation", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "identifier", - "in": "path", - "description": "Identifier of the document", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - }, - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileStreamResult" - } - } - } - } - } - } - }, - "/api/moryx/orders/{guid}/productparts": { - "get": { - "tags": [ - "OrderManagement" - ], - "summary": "Retrieve a list of product parts attached to the given operation", - "operationId": "GetProductParts", - "parameters": [ - { - "name": "guid", - "in": "path", - "description": "If of the operation", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductPartModel" - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - }, - "/api/moryx/orders/{guid}/begin": { - "get": { - "tags": [ - "OrderManagement" - ], - "summary": "Retrieves the begin context for the given operation", - "operationId": "GetBeginContext", - "parameters": [ - { - "name": "guid", - "in": "path", - "description": "Id of the operation", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BeginContext" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - }, - "post": { - "tags": [ - "OrderManagement" - ], - "summary": "Begin producing the operation using the given parameters", - "operationId": "BeginOperation", - "parameters": [ - { - "name": "guid", - "in": "path", - "description": "Id of the operation", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "description": "Begin parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BeginModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/BeginModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/BeginModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - }, - "/api/moryx/orders/{guid}/report": { - "get": { - "tags": [ - "OrderManagement" - ], - "summary": "Retrieves a report context for the given operation", - "operationId": "GetReportContext", - "parameters": [ - { - "name": "guid", - "in": "path", - "description": "Id of the operation", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportContext" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - }, - "post": { - "tags": [ - "OrderManagement" - ], - "summary": "Report produced amounts of a given operation", - "operationId": "ReportOperation", - "parameters": [ - { - "name": "guid", - "in": "path", - "description": "Id of the operation", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "description": "Parameter object", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ReportModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ReportModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - }, - "/api/moryx/orders/{guid}/interrupt": { - "get": { - "tags": [ - "OrderManagement" - ], - "summary": "Retrieves a interrupt context for the given operation", - "operationId": "GetInterruptContext", - "parameters": [ - { - "name": "guid", - "in": "path", - "description": "Id of the operation", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportContext" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - }, - "post": { - "tags": [ - "OrderManagement" - ], - "summary": "Interrupt the given operation", - "operationId": "InterruptOperation", - "parameters": [ - { - "name": "guid", - "in": "path", - "description": "Id of the operation", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "userIdentifier", - "in": "query", - "description": "Identifier of the user requesting the interrupt (Optional depending on configuration)", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - }, - "/api/moryx/orders/{guid}/advice": { - "get": { - "tags": [ - "OrderManagement" - ], - "summary": "Retrieves a advice context for the given operation", - "operationId": "GetAdviceContext", - "parameters": [ - { - "name": "guid", - "in": "path", - "description": "Id of the operation", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AdviceContext" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - }, - "post": { - "tags": [ - "OrderManagement" - ], - "summary": "Advice operation", - "operationId": "AdviceOperation", - "parameters": [ - { - "name": "guid", - "in": "path", - "description": "Id of the operation", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "description": "Parameter object", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AdviceModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/AdviceModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/AdviceModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - }, - "/api/moryx/orders/{guid}/logs": { - "get": { - "tags": [ - "OrderManagement" - ], - "summary": "Retrieves logs written during the creation of the operation", - "operationId": "GetLogs", - "parameters": [ - { - "name": "guid", - "in": "path", - "description": "Id of the operation", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OperationLogMessageModel" - } - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - }, - "/api/moryx/orders/recipes": { - "get": { - "tags": [ - "OrderManagement" - ], - "summary": "Get's the list of recipes available to produce the given product", - "operationId": "GetAssignableRecipes", - "parameters": [ - { - "name": "identifier", - "in": "query", - "description": "Product identifier", - "schema": { - "type": "string" - } - }, - { - "name": "revision", - "in": "query", - "description": "Product revision", - "schema": { - "type": "integer", - "format": "int16" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OperationRecipeModel" - } - } - } - } - } - } - } - }, - "/api/moryx/orders/{guid}/abort": { - "post": { - "tags": [ - "OrderManagement" - ], - "summary": "Abort the specified operation (Remove it before being started)", - "operationId": "AbortOperation", - "parameters": [ - { - "name": "guid", - "in": "path", - "description": "Id of the operation", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - }, - "/api/moryx/orders/{guid}/update": { - "put": { - "tags": [ - "OrderManagement" - ], - "summary": "Update the operation", - "operationId": "UpdateOperation", - "parameters": [ - { - "name": "guid", - "in": "path", - "description": "Id of the operation", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "description": "Paramter object", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OperationUpdateModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/OperationUpdateModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/OperationUpdateModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - }, - "/api/moryx/orders/{guid}/reload": { - "put": { - "tags": [ - "OrderManagement" - ], - "summary": "Reload the operation, rerunning the order assignment steps", - "operationId": "Reload", - "parameters": [ - { - "name": "guid", - "in": "path", - "description": "Id of the operation", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - }, - "/api/moryx/processes/job": { - "get": { - "tags": [ - "ProcessEngine" - ], - "operationId": "GetRunningProcessesOfJob", - "parameters": [ - { - "name": "jobId", - "in": "query", - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "allProcesses", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/JobProcessModel" - } - } - } - } - } - } - } - }, - "/api/moryx/processes/running": { - "get": { - "tags": [ - "ProcessEngine" - ], - "operationId": "GetRunningProcesses", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/JobProcessModel" - } - } - } - } - } - } - } - }, - "/api/moryx/processes/instance/{productInstanceId}": { - "get": { - "tags": [ - "ProcessEngine" - ], - "operationId": "GetProcesses", - "parameters": [ - { - "name": "productInstanceId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/JobProcessModel" - } - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - } - } - }, - "/api/moryx/processes/running/{id}": { - "get": { - "tags": [ - "ProcessEngine" - ], - "operationId": "GetProcess", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JobProcessModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - } - } - }, - "/api/moryx/processes/running/{id}/activities": { - "get": { - "tags": [ - "ProcessEngine" - ], - "operationId": "GetActivities", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProcessActivityModel" - } - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - } - } - }, - "/api/moryx/processes/running/{id}/targets": { - "get": { - "tags": [ - "ProcessEngine" - ], - "operationId": "GetTargets", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ActivityResourceModel" - } - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - } - } - }, - "/api/moryx/processes/running/{id}/targets/{activityId}": { - "get": { - "tags": [ - "ProcessEngine" - ], - "operationId": "GetTargets", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "activityId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ActivityResourceModel" - } - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - }, - "/api/moryx/processes/stream/processes": { - "get": { - "tags": [ - "ProcessEngine" - ], - "operationId": "ProcessUpdatesStream", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JobProcessModel" - } - } - } - } - } - } - }, - "/api/moryx/processes/stream/activities": { - "get": { - "tags": [ - "ProcessEngine" - ], - "operationId": "ActivitiesUpdatesStream", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProcessActivityModel" - } - } - } - } - } - } - }, - "/api/moryx/processes/holders/groups": { - "get": { - "tags": [ - "ProcessEngine" - ], - "operationId": "GetGroups", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiResponseOfProcessHolderGroupModel[]" - } - } - } - } - } - } - }, - "/api/moryx/processes/holders/stream": { - "get": { - "tags": [ - "ProcessEngine" - ], - "operationId": "GroupStream", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProcessHolderGroupModel" - } - } - } - } - } - } - }, - "/api/moryx/processes/holders/groups/{id}/reset": { - "post": { - "tags": [ - "ProcessEngine" - ], - "operationId": "ResetGroup", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/processes/holders/positions/{id}/reset": { - "post": { - "tags": [ - "ProcessEngine" - ], - "operationId": "ResetPosition", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/products/configuration": { - "get": { - "tags": [ - "ProductManagement" - ], - "summary": "Loads dataset of existing products, recipes and importers for the UI", - "operationId": "GetProductCustomization", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductCustomization" - } - } - } - } - } - } - }, - "/api/moryx/products/importers/{importerName}": { - "post": { - "tags": [ - "ProductManagement" - ], - "summary": "Run the product importer with the given parameters", - "operationId": "Import", - "parameters": [ - { - "name": "importerName", - "in": "path", - "description": "Name of the importer", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Parameters for the importer", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Entry" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/Entry" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/Entry" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductModel" - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/products/types": { - "post": { - "tags": [ - "ProductManagement" - ], - "summary": "Store the product type in the database", - "operationId": "SaveType", - "requestBody": { - "description": "Model of the new product", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProductModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ProductModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "integer", - "format": "int64" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "get": { - "tags": [ - "ProductManagement" - ], - "summary": "Retrieves all product types, if no identity is specified. Otherwise the model identified by that id is returned", - "operationId": "GetTypeByIdentity", - "parameters": [ - { - "name": "identity", - "in": "query", - "description": "Optional. The id to look for", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductModel" - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/products/types/query": { - "post": { - "tags": [ - "ProductManagement" - ], - "summary": "Query the product type database", - "operationId": "GetTypes", - "requestBody": { - "description": "Query parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductQuery" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProductQuery" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ProductQuery" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "The products models matching the query", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductModel" - } - } - } - } - } - } - } - }, - "/api/moryx/products/types/{id}": { - "get": { - "tags": [ - "ProductManagement" - ], - "summary": "Get's a product type using the database id", - "operationId": "GetTypeById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Database id", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "delete": { - "tags": [ - "ProductManagement" - ], - "summary": "Deletes the product type with the given id", - "operationId": "DeleteType", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "put": { - "tags": [ - "ProductManagement" - ], - "summary": "Updates the existing product type", - "operationId": "UpdateType", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Database id of the product type", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "requestBody": { - "description": "New product model", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProductModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ProductModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "integer", - "format": "int64" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "post": { - "tags": [ - "ProductManagement" - ], - "summary": "Create a clone of the product type identified with the id with the new identitiy", - "operationId": "Duplicate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Database id of the existing product type", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "requestBody": { - "description": "Product identifier of the new product", - "content": { - "application/json": { - "schema": { - "type": "string" - } - }, - "text/json": { - "schema": { - "type": "string" - } - }, - "application/*+json": { - "schema": { - "type": "string" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/products/types/{id}/recipes/{classification}": { - "get": { - "tags": [ - "ProductManagement" - ], - "summary": "Loads the recipe attached to the product type with the id", - "operationId": "GetRecipes", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Database id", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "classification", - "in": "path", - "description": "Recipe classification RecipeClassification", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RecipeModel" - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/products/instances/{id}": { - "get": { - "tags": [ - "ProductManagement" - ], - "summary": "Get's the product instance with the given id", - "operationId": "GetInstance", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Database id of the product instance", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductInstanceModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/products/instances": { - "get": { - "tags": [ - "ProductManagement" - ], - "summary": "Loads multiple product instances at once", - "operationId": "GetInstances", - "parameters": [ - { - "name": "ids", - "in": "query", - "description": "A list of product instance ids", - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "int64" - } - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductInstanceModel" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ProductManagement" - ], - "summary": "Create a new product instace of the product type identified via the identifier and revision", - "operationId": "CreateInstance", - "parameters": [ - { - "name": "identifier", - "in": "query", - "description": "Product identifier", - "schema": { - "type": "string" - } - }, - { - "name": "revision", - "in": "query", - "description": "Revision of the product", - "schema": { - "type": "integer", - "format": "int16" - } - }, - { - "name": "save", - "in": "query", - "description": "If save is false, the new instance won't be stored in the db", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductInstanceModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "put": { - "tags": [ - "ProductManagement" - ], - "summary": "Save the instance in the product db", - "operationId": "SaveInstance", - "requestBody": { - "description": "Model of the product instance", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductInstanceModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProductInstanceModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ProductInstanceModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/products/recipes/{id}": { - "get": { - "tags": [ - "ProductManagement" - ], - "summary": "Get's a recipe by it's db id", - "operationId": "GetRecipe", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Database id of the recipe", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RecipeModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "put": { - "tags": [ - "ProductManagement" - ], - "summary": "Updates the existing recipes", - "operationId": "UpdateRecipe", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Database id of the recipe", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "requestBody": { - "description": "Updated recipe model", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RecipeModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/RecipeModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/RecipeModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "integer", - "format": "int64" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/products/recipes": { - "post": { - "tags": [ - "ProductManagement" - ], - "summary": "Saves a new recipe in the database", - "operationId": "SaveRecipe", - "requestBody": { - "description": "Model of the recipe", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RecipeModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/RecipeModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/RecipeModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "integer", - "format": "int64" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/products/recipe/construct/{recipeType}": { - "get": { - "tags": [ - "ProductManagement" - ], - "operationId": "CreateRecipe", - "parameters": [ - { - "name": "recipeType", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RecipeModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/resources/types": { - "get": { - "tags": [ - "ResourceModification" - ], - "operationId": "GetTypeTree", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ResourceTypeModel" - } - } - } - }, - "417": { - "description": "Expectation Failed", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/resources": { - "get": { - "tags": [ - "ResourceModification" - ], - "operationId": "GetDetailsBatch", - "parameters": [ - { - "name": "ids", - "in": "query", - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "int64" - } - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ResourceModel" - } - } - } - } - }, - "417": { - "description": "Expectation Failed", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "post": { - "tags": [ - "ResourceModification" - ], - "operationId": "Save", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ResourceModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ResourceModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ResourceModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ResourceModel" - } - } - } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { } - } - } - } - } - }, - "/api/moryx/resources/query": { - "post": { - "tags": [ - "ResourceModification" - ], - "operationId": "GetResources", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ResourceQuery" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ResourceQuery" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ResourceQuery" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ResourceModel" - } - } - } - } - }, - "417": { - "description": "Expectation Failed", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/resources/{id}": { - "get": { - "tags": [ - "ResourceModification" - ], - "operationId": "GetDetails", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ResourceModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "417": { - "description": "Expectation Failed", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "put": { - "tags": [ - "ResourceModification" - ], - "operationId": "Update", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ResourceModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ResourceModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ResourceModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ResourceModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { } - } - } - } - }, - "delete": { - "tags": [ - "ResourceModification" - ], - "operationId": "Remove", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "417": { - "description": "Expectation Failed", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/resources/{id}/invoke/{method}": { - "post": { - "tags": [ - "ResourceModification" - ], - "operationId": "InvokeMethod", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "method", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Entry" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/Entry" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/Entry" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Entry" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "417": { - "description": "Expectation Failed", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/resources/types/{type}": { - "post": { - "tags": [ - "ResourceModification" - ], - "operationId": "ConstructWithParameters", - "parameters": [ - { - "name": "type", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "method", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Entry" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/Entry" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/Entry" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ResourceModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "417": { - "description": "Expectation Failed", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/shifts": { - "get": { - "tags": [ - "ShiftManagement" - ], - "operationId": "GetShifts", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShiftModel" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ShiftManagement" - ], - "operationId": "CreateShift", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ShiftCreationContextModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ShiftCreationContextModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ShiftCreationContextModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ShiftModel" - } - } - } - } - } - }, - "put": { - "tags": [ - "ShiftManagement" - ], - "operationId": "UpdateShift", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ShiftModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ShiftModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ShiftModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - } - } - } - }, - "/api/moryx/shifts/filter": { - "get": { - "tags": [ - "ShiftManagement" - ], - "operationId": "GetShifts", - "parameters": [ - { - "name": "earliestDate", - "in": "query", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "latestDate", - "in": "query", - "schema": { - "type": "string", - "format": "date" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShiftModel" - } - } - } - } - } - } - } - }, - "/api/moryx/shifts/{id}": { - "delete": { - "tags": [ - "ShiftManagement" - ], - "operationId": "DeleteShift", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - } - } - } - }, - "/api/moryx/shifts/types": { - "get": { - "tags": [ - "ShiftManagement" - ], - "operationId": "GetShiftTypes", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShiftTypeModel" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ShiftManagement" - ], - "operationId": "CreateShiftType", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ShiftTypeCreationContextModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ShiftTypeCreationContextModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ShiftTypeCreationContextModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ShiftTypeModel" - } - } - } - } - } - }, - "put": { - "tags": [ - "ShiftManagement" - ], - "operationId": "UpdateShiftType", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ShiftTypeModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ShiftTypeModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ShiftTypeModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - } - } - } - }, - "/api/moryx/shifts/types/{id}": { - "delete": { - "tags": [ - "ShiftManagement" - ], - "operationId": "DeleteShiftType", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - } - } - } - }, - "/api/moryx/shifts/assignements": { - "get": { - "tags": [ - "ShiftManagement" - ], - "operationId": "GetShiftAssignements", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShiftAssignementModel" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ShiftManagement" - ], - "operationId": "CreateShiftAssignement", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ShiftAssignementCreationContextModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ShiftAssignementCreationContextModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ShiftAssignementCreationContextModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ShiftAssignementModel" - } - } - } - } - } - }, - "put": { - "tags": [ - "ShiftManagement" - ], - "operationId": "UpdateShiftAssignement", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ShiftAssignementModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ShiftAssignementModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ShiftAssignementModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - } - } - } - }, - "/api/moryx/shifts/assignements/filter": { - "get": { - "tags": [ - "ShiftManagement" - ], - "operationId": "GetShiftAssignements", - "parameters": [ - { - "name": "earliestDate", - "in": "query", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "latestDate", - "in": "query", - "schema": { - "type": "string", - "format": "date" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShiftAssignementModel" - } - } - } - } - } - } - } - }, - "/api/moryx/shifts/assignements/{id}": { - "delete": { - "tags": [ - "ShiftManagement" - ], - "operationId": "DeleteShiftAssignement", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - } - } - } - }, - "/api/moryx/skills/types": { - "get": { - "tags": [ - "SkillManagement" - ], - "operationId": "GetTypes", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SkillTypeModel" - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - } - }, - "post": { - "tags": [ - "SkillManagement" - ], - "operationId": "Create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SkillTypeCreationContextModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/SkillTypeCreationContextModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/SkillTypeCreationContextModel" - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SkillTypeModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - } - }, - "put": { - "tags": [ - "SkillManagement" - ], - "operationId": "Update", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SkillTypeModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/SkillTypeModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/SkillTypeModel" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "No Content", - "content": { - "application/json": { } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - } - } - }, - "/api/moryx/skills/types/{id}": { - "get": { - "tags": [ - "SkillManagement" - ], - "operationId": "GetType", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SkillTypeModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - } - }, - "delete": { - "tags": [ - "SkillManagement" - ], - "operationId": "DeleteType", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "204": { - "description": "No Content", - "content": { - "application/json": { } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - } - } - }, - "/api/moryx/skills/types/prototype": { - "get": { - "tags": [ - "SkillManagement" - ], - "operationId": "GetTypePrototype", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SkillTypeModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - } - } - }, - "/api/moryx/skills": { - "get": { - "tags": [ - "SkillManagement" - ], - "operationId": "GetSkills", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SkillModel" - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - } - }, - "post": { - "tags": [ - "SkillManagement" - ], - "operationId": "Create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SkillCreationContextModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/SkillCreationContextModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/SkillCreationContextModel" - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SkillModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - } - } - }, - "/api/moryx/skills/{id}": { - "get": { - "tags": [ - "SkillManagement" - ], - "operationId": "GetSkill", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SkillModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - } - }, - "delete": { - "tags": [ - "SkillManagement" - ], - "operationId": "DeleteSkill", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "204": { - "description": "No Content", - "content": { - "application/json": { } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - } - } - }, - "/foo/{value}": { - "get": { - "tags": [ - "Test" - ], - "operationId": "GetFoo", - "parameters": [ - { - "name": "value", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Foo" - } - } - } - } - } - } - }, - "/api/moryx/instructions/stream": { - "get": { - "tags": [ - "VisualInstructions" - ], - "operationId": "InstructionStream", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InstructionModel" - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - } - } - }, - "/api/moryx/instructions/{identifier}": { - "get": { - "tags": [ - "VisualInstructions" - ], - "operationId": "GetAll", - "parameters": [ - { - "name": "identifier", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InstructionModel" - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - } - }, - "post": { - "tags": [ - "VisualInstructions" - ], - "operationId": "AddInstruction", - "parameters": [ - { - "name": "identifier", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InstructionModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InstructionModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/InstructionModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - } - } - }, - "delete": { - "tags": [ - "VisualInstructions" - ], - "operationId": "ClearInstruction", - "parameters": [ - { - "name": "identifier", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InstructionModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InstructionModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/InstructionModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - } - } - } - }, - "/api/moryx/instructions/{identifier}/response": { - "put": { - "tags": [ - "VisualInstructions" - ], - "operationId": "CompleteInstruction", - "parameters": [ - { - "name": "identifier", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InstructionResponseModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InstructionResponseModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/InstructionResponseModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/instructions/instructors": { - "get": { - "tags": [ - "VisualInstructions" - ], - "operationId": "GetInstructors", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "/api/moryx/workplans": { - "get": { - "tags": [ - "Workplan" - ], - "operationId": "GetAllWorkplans", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WorkplanModel" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "Workplan" - ], - "operationId": "SaveWorkplan", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/WorkplanModel" - } - } - }, - "required": true - }, - "responses": { - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/workplans/{id}/versions": { - "get": { - "tags": [ - "Workplan" - ], - "operationId": "GetVersions", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WorkplanModel" - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/workplans/{id}": { - "get": { - "tags": [ - "Workplan" - ], - "operationId": "GetWorkplan", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "delete": { - "tags": [ - "Workplan" - ], - "operationId": "DeleteWorkplan", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "put": { - "tags": [ - "Workplan" - ], - "operationId": "UpdateWorkplan", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/WorkplanModel" - } - } - }, - "required": true - }, - "responses": { - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/moryx/workplans/steps": { - "get": { - "tags": [ - "WorkplanEditing" - ], - "operationId": "AvailableSteps", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WorkplanStepRecipe" - } - } - } - } - } - } - } - }, - "/api/moryx/workplans/sessions": { - "post": { - "tags": [ - "WorkplanEditing" - ], - "operationId": "EditWorkplan", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OpenSessionRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/OpenSessionRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/OpenSessionRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanSessionModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - }, - "/api/moryx/workplans/sessions/{sessionId}": { - "get": { - "tags": [ - "WorkplanEditing" - ], - "operationId": "OpenSession", - "parameters": [ - { - "name": "sessionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanSessionModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - }, - "put": { - "tags": [ - "WorkplanEditing" - ], - "operationId": "UpdateSession", - "parameters": [ - { - "name": "sessionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanSessionModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanSessionModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/WorkplanSessionModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanSessionModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - }, - "delete": { - "tags": [ - "WorkplanEditing" - ], - "operationId": "CloseSession", - "parameters": [ - { - "name": "sessionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { } - } - } - } - } - }, - "/api/moryx/workplans/sessions/{sessionId}/autolayout": { - "get": { - "tags": [ - "WorkplanEditing" - ], - "operationId": "AutoLayout", - "parameters": [ - { - "name": "sessionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanSessionModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - }, - "/api/moryx/workplans/sessions/{sessionId}/save": { - "post": { - "tags": [ - "WorkplanEditing" - ], - "operationId": "SaveSession", - "parameters": [ - { - "name": "sessionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanSessionModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanSessionModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/WorkplanSessionModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanSessionModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - }, - "/api/moryx/workplans/sessions/{sessionId}/validate": { - "get": { - "tags": [ - "WorkplanEditing" - ], - "operationId": "ValidateSession", - "parameters": [ - { - "name": "sessionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationResultModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - }, - "/api/moryx/workplans/sessions/{sessionId}/nodes": { - "post": { - "tags": [ - "WorkplanEditing" - ], - "operationId": "AddStep", - "parameters": [ - { - "name": "sessionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanStepRecipe" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanStepRecipe" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/WorkplanStepRecipe" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanNodeModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - }, - "/api/moryx/workplans/sessions/{sessionId}/nodes/{nodeId}": { - "put": { - "tags": [ - "WorkplanEditing" - ], - "operationId": "UpdateStep", - "parameters": [ - { - "name": "sessionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "nodeId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanNodeModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanNodeModel" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/WorkplanNodeModel" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanNodeModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - }, - "delete": { - "tags": [ - "WorkplanEditing" - ], - "operationId": "RemoveNode", - "parameters": [ - { - "name": "sessionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "nodeId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanSessionModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - }, - "/api/moryx/workplans/sessions/{sessionId}/nodes/{targetNodeId}/{targetIndex}": { - "post": { - "tags": [ - "WorkplanEditing" - ], - "operationId": "ConnectStep", - "parameters": [ - { - "name": "sessionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "targetNodeId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "targetIndex", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NodeConnector" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/NodeConnector" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/NodeConnector" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanSessionModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - }, - "delete": { - "tags": [ - "WorkplanEditing" - ], - "operationId": "DisconnectStep", - "parameters": [ - { - "name": "sessionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "targetNodeId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "targetIndex", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NodeConnector" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/NodeConnector" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/NodeConnector" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkplanSessionModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoryxExceptionResponse" - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "ActivityChangedModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "resourceId": { - "type": "integer", - "format": "int64" - }, - "classification": { - "$ref": "#/components/schemas/ActivityClassification" - }, - "orderReferenceModel": { - "$ref": "#/components/schemas/OrderReferenceModel" - } - } - }, - "ActivityClassification": { - "type": "string", - "description": "Defines different classifications of activities. A resource will define accepted classifications\r\nin the published ReadyToWork. An activity declares its classification which is compared\r\nto the accepted classification within the kernel. While a ReadyToWork can accept multiple\r\nclassifications (by combining flags), an activity has only one classification." - }, - "ActivityResourceModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": [ - "null", - "string" - ] - } - } - }, - "AdviceContext": { - "type": "object", - "properties": { - "advicedAmount": { - "type": "integer", - "description": "Amount which are already adviced", - "format": "int32" - } - }, - "description": "Context for a new advice with all necessary information" - }, - "AdviceModel": { - "type": "object", - "properties": { - "toteBoxNumber": { - "type": [ - "null", - "string" - ] - }, - "amount": { - "type": "integer", - "format": "int32" - }, - "partId": { - "type": [ - "null", - "integer" - ], - "format": "int64" - } - } - }, - "ApiError": { - "required": [ - "errorCode", - "message" - ], - "type": "object", - "properties": { - "errorCode": { - "type": [ - "null", - "string" - ] - }, - "message": { - "type": [ - "null", - "string" - ] - }, - "exception": { - "$ref": "#/components/schemas/Exception" - } - } - }, - "ApiResponseOfProcessHolderGroupModel[]": { - "type": "object", - "properties": { - "data": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/ProcessHolderGroupModel" - } - }, - "errors": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/ApiError" - } - }, - "succeeded": { - "type": "boolean" - }, - "timestamp": { - "type": "string", - "format": "date-time" - } - } - }, - "ApplicationInformationResponse": { - "type": "object", - "properties": { - "assemblyProduct": { - "type": [ - "null", - "string" - ] - }, - "assemblyVersion": { - "type": [ - "null", - "string" - ] - }, - "assemblyInformationalVersion": { - "type": [ - "null", - "string" - ] - }, - "assemblyDescription": { - "type": [ - "null", - "string" - ] - }, - "assemblyCompanyName": { - "type": [ - "null", - "string" - ] - }, - "assemblyTitle": { - "type": [ - "null", - "string" - ] - }, - "assemblyConfiguration": { - "type": [ - "null", - "string" - ] - }, - "targetFramework": { - "type": [ - "null", - "string" - ] - }, - "assemblyCopyright": { - "type": [ - "null", - "string" - ] - }, - "assemblyTrademark": { - "type": [ - "null", - "string" - ] - } - } - }, - "AssemblyModel": { - "type": "object", - "properties": { - "name": { - "type": [ - "null", - "string" - ] - }, - "version": { - "type": [ - "null", - "string" - ] - }, - "fileVersion": { - "type": [ - "null", - "string" - ] - }, - "informationalVersion": { - "type": [ - "null", - "string" - ] - } - } - }, - "AssignableOperator": { - "required": [ - "identifier" - ], - "type": "object", - "properties": { - "signedIn": { - "type": "boolean" - }, - "assignedResources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IOperatorAssignable" - } - }, - "identifier": { - "type": "string" - }, - "firstName": { - "type": [ - "null", - "string" - ] - }, - "lastName": { - "type": [ - "null", - "string" - ] - }, - "pseudonym": { - "type": [ - "null", - "string" - ] - } - } - }, - "AssignedDays": { - "type": "string" - }, - "AttendableResourceModel": { - "type": "object", - "properties": { - "id": { - "type": [ - "null", - "integer" - ], - "format": "int64" - }, - "name": { - "type": [ - "null", - "string" - ] - }, - "requiredSkills": { - "type": [ - "null", - "array" - ], - "items": { - "type": "string" - } - } - } - }, - "BeginContext": { - "type": "object", - "properties": { - "residualAmount": { - "type": "integer", - "description": "Residual amount of the operation", - "format": "int32" - }, - "partialAmount": { - "type": "integer", - "description": "Current target amount of the operation", - "format": "int32" - }, - "minimalTargetAmount": { - "type": "integer", - "description": "Provides the minimum value that can be set for the target amount when adjusting the operation.", - "format": "int32" - }, - "canBegin": { - "type": "boolean", - "description": "Indicator if a begin is possible" - }, - "canReduce": { - "type": "boolean", - "description": "Indicator if an adjustment of the operation is possible" - }, - "restrictions": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/RestrictionDescription" - }, - "description": "Reasons why a begin is not possible" - }, - "successCount": { - "type": "integer", - "description": "Current success count of the operation", - "format": "int32" - }, - "scrapCount": { - "type": "integer", - "description": "Current failure count of the operation", - "format": "int32" - } - }, - "description": "Context information to begin an operation production" - }, - "BeginModel": { - "type": "object", - "properties": { - "amount": { - "type": "integer", - "format": "int32" - }, - "userId": { - "type": [ - "null", - "string" - ] - } - } - }, - "Category": { - "enum": [ - "ProcessHolderGroup", - "ParentResource" - ] - }, - "CellLocationModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "positionX": { - "type": "number", - "format": "double" - }, - "positionY": { - "type": "number", - "format": "double" - } - } - }, - "CellPropertySettings": { - "type": "object", - "properties": { - "valueUnit": { - "type": [ - "null", - "string" - ] - }, - "iconName": { - "type": [ - "null", - "string" - ] - }, - "isDisplayed": { - "type": "boolean" - }, - "currentValue": { }, - "displayName": { - "type": [ - "null", - "string" - ] - } - } - }, - "CellSettingsModel": { - "type": "object", - "properties": { - "image": { - "type": [ - "null", - "string" - ] - }, - "icon": { - "type": [ - "null", - "string" - ] - } - } - }, - "CellState": { - "enum": [ - "Idle", - "Requested", - "Running", - "NotReadyToWork" - ] - }, - "CellStateChangedModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "state": { - "$ref": "#/components/schemas/CellState" - } - } - }, - "Config": { - "type": "object", - "properties": { - "root": { - "$ref": "#/components/schemas/Entry" - } - } - }, - "ConfigUpdateMode": { - "enum": [ - "OnlySave", - "SaveAndReincarnate", - "UpdateLiveAndSave" - ] - }, - "ConfirmationType": { - "enum": [ - "Partial", - "Final" - ], - "description": "Confirmation type while reporting amounts of an operation" - }, - "ContentDescriptorModel": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "name": { - "type": [ - "null", - "string" - ] - }, - "variants": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/VariantDescriptor" - } - }, - "master": { - "$ref": "#/components/schemas/VariantDescriptor" - } - } - }, - "DatabaseConfigModel": { - "type": "object", - "properties": { - "configuratorType": { - "type": [ - "null", - "string" - ] - }, - "connectionString": { - "type": [ - "null", - "string" - ] - }, - "properties": { - "$ref": "#/components/schemas/Entry" - } - } - }, - "DatabaseMigrationSummary": { - "type": "object", - "properties": { - "result": { - "description": "Flag that any updates were performed", - "$ref": "#/components/schemas/MigrationResult" - }, - "errors": { - "type": [ - "null", - "array" - ], - "items": { - "type": "string" - }, - "description": "Reason, in case an error occured during migration" - }, - "executedMigrations": { - "type": [ - "null", - "array" - ], - "items": { - "type": "string" - }, - "description": "All updates that were executed" - } - }, - "description": "Result object created from running a database update" - }, - "DatabasesResponse": { - "type": "object", - "properties": { - "databases": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/DataModel" - } - }, - "configurators": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/ModelConfiguratorModel" - } - } - } - }, - "DataModel": { - "type": "object", - "properties": { - "targetModel": { - "type": [ - "null", - "string" - ] - }, - "config": { - "$ref": "#/components/schemas/DatabaseConfigModel" - }, - "possibleConfigurators": { - "type": [ - "null", - "array" - ], - "items": { - "type": "string" - } - }, - "setups": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/SetupModel" - } - }, - "availableMigrations": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/DbMigrationsModel" - } - }, - "appliedMigrations": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/DbMigrationsModel" - } - } - } - }, - "DataType": { - "enum": [ - "Custom", - "DateTime", - "Date", - "Time", - "Duration", - "PhoneNumber", - "Currency", - "Text", - "Html", - "MultilineText", - "EmailAddress", - "Password", - "Url", - "ImageUrl", - "CreditCard", - "PostalCode", - "Upload" - ] - }, - "DbMigrationsModel": { - "type": "object", - "properties": { - "name": { - "type": [ - "null", - "string" - ] - } - } - }, - "DependencyEvaluation": { - "type": "object", - "properties": { - "rootModules": { - "type": "integer", - "format": "int32" - }, - "maxDepth": { - "type": "integer", - "format": "int32" - }, - "maxDependencies": { - "type": "integer", - "format": "int32" - }, - "maxDependends": { - "type": "integer", - "format": "int32" - } - } - }, - "DocumentModel": { - "type": "object", - "properties": { - "identifier": { - "type": [ - "null", - "string" - ] - }, - "number": { - "type": [ - "null", - "string" - ] - }, - "revision": { - "type": "integer", - "format": "int16" - }, - "type": { - "type": [ - "null", - "string" - ] - }, - "description": { - "type": [ - "null", - "string" - ] - }, - "contentType": { - "type": [ - "null", - "string" - ] - }, - "source": { - "type": [ - "null", - "string" - ] - } - } - }, - "EntityTagHeaderValue": { - "type": "object", - "properties": { - "tag": { - "$ref": "#/components/schemas/StringSegment" - }, - "isWeak": { - "type": "boolean" - } - } - }, - "Entry": { - "type": "object", - "properties": { - "displayName": { - "type": [ - "null", - "string" - ], - "description": "Name of the item - property name or list item name" - }, - "identifier": { - "type": [ - "null", - "string" - ], - "description": "Unique identifier - property name or item index" - }, - "description": { - "type": [ - "null", - "string" - ], - "description": "Description of the entry" - }, - "value": { - "description": "Value of the entry", - "$ref": "#/components/schemas/EntryValue" - }, - "validation": { - "description": "Validation information", - "$ref": "#/components/schemas/EntryValidation" - }, - "subEntries": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/Entry" - }, - "description": "Subentries of this entry - properties or list items" - }, - "prototypes": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/Entry" - }, - "description": "Prototypes that can be used to create subentries" - } - }, - "description": "Model class representing a single property of a config class" - }, - "EntryPossible": { - "type": "object", - "properties": { - "key": { - "type": [ - "null", - "string" - ], - "description": "Invariant key of the possible value." - }, - "displayName": { - "type": [ - "null", - "string" - ], - "description": "Display name of the possible value." - }, - "description": { - "type": [ - "null", - "string" - ], - "description": "Description of the possible value." - } - }, - "description": "Possible value for an entry." - }, - "EntryUnitType": { - "enum": [ - "None", - "Password", - "FilePath", - "DirectoryPath", - "Flags", - "Base64" - ], - "description": "Enum describes the unit type of a entry" - }, - "EntryValidation": { - "type": "object", - "properties": { - "dataType": { - "description": "Logical data types that may appear", - "$ref": "#/components/schemas/DataType" - }, - "minimum": { - "type": "number", - "description": "Minimum value or minimal length of strings", - "format": "double" - }, - "maximum": { - "type": "number", - "description": "Maximum value or maximal length of strings", - "format": "double" - }, - "regex": { - "type": [ - "null", - "string" - ], - "description": "Regex pattern for this entry" - }, - "isRequired": { - "type": "boolean", - "description": "Indicated if the field is required and should not be empty" - } - }, - "description": "All validation rules of an entry" - }, - "EntryValue": { - "type": "object", - "properties": { - "type": { - "description": "Type of this entry", - "$ref": "#/components/schemas/EntryValueType" - }, - "unitType": { - "description": "Unit type of this entry", - "$ref": "#/components/schemas/EntryUnitType" - }, - "current": { - "type": [ - "null", - "string" - ], - "description": "Current value of this entry" - }, - "default": { - "type": [ - "null", - "string" - ], - "description": "Default value of this entry" - }, - "possible": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/EntryPossible" - }, - "description": "Possible values for this entry" - }, - "isReadOnly": { - "type": "boolean", - "description": "Indicates wether the field is read only" - } - }, - "description": "Value of an config entry" - }, - "EntryValueType": { - "enum": [ - "Byte", - "Boolean", - "Int16", - "UInt16", - "Int32", - "UInt32", - "Int64", - "UInt64", - "Single", - "Double", - "String", - "Enum", - "Class", - "Collection", - "Exception", - "Stream", - "Struct", - "DateTime", - "Date", - "Time", - "TimeSpan" - ], - "description": "Possible value types" - }, - "Exception": { - "type": "object", - "properties": { - "targetSite": { - "$ref": "#/components/schemas/MethodBase" - }, - "message": { - "type": [ - "null", - "string" - ] - }, - "data": { - "type": [ - "null", - "object" - ] - }, - "innerException": { - "$ref": "#/components/schemas/Exception" - }, - "helpLink": { - "type": [ - "null", - "string" - ] - }, - "source": { - "type": [ - "null", - "string" - ] - }, - "hResult": { - "type": "integer", - "format": "int32" - }, - "stackTrace": { - "type": [ - "null", - "string" - ] - } - } - }, - "ExecuteSetupRequest": { - "type": "object", - "properties": { - "config": { - "$ref": "#/components/schemas/DatabaseConfigModel" - }, - "setup": { - "$ref": "#/components/schemas/SetupModel" - } - } - }, - "ExtendedOperatorModel": { - "type": "object", - "properties": { - "assignedResources": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/AttendableResourceModel" - } - }, - "identifier": { - "type": [ - "null", - "string" - ] - }, - "firstName": { - "type": [ - "null", - "string" - ] - }, - "lastName": { - "type": [ - "null", - "string" - ] - }, - "pseudonym": { - "type": [ - "null", - "string" - ] - } - } - }, - "FactoryModel": { - "type": "object", - "properties": { - "parentId": { - "type": "integer", - "format": "int64" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "backgroundURL": { - "type": [ - "null", - "string" - ] - }, - "title": { - "type": [ - "null", - "string" - ] - } - } - }, - "FactoryStateModel": { - "type": "object", - "properties": { - "backgroundURL": { - "type": [ - "null", - "string" - ] - }, - "hasManufacturingFactory": { - "type": "boolean" - }, - "orderModels": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/OrderModel" - } - }, - "activityChangedModels": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/ActivityChangedModel" - } - }, - "cellStateChangedModels": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/CellStateChangedModel" - } - }, - "resourceChangedModels": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/ResourceChangedModel" - } - }, - "id": { - "type": "integer", - "format": "int64" - }, - "location": { - "$ref": "#/components/schemas/CellLocationModel" - }, - "iconName": { - "type": [ - "null", - "string" - ] - }, - "isACell": { - "type": "boolean" - } - } - }, - "FailureBehaviour": { - "type": "string", - "description": "Enum flags: Notify - Reincarnate" - }, - "FileStreamResult": { - "type": "object", - "properties": { - "fileStream": { - "$ref": "#/components/schemas/Stream" - }, - "contentType": { - "type": [ - "null", - "string" - ] - }, - "fileDownloadName": { - "type": [ - "null", - "string" - ] - }, - "lastModified": { - "type": [ - "null", - "string" - ], - "format": "date-time" - }, - "entityTag": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/EntityTagHeaderValue" - } - ] - }, - "enableRangeProcessing": { - "type": "boolean" - } - } - }, - "Foo": { - "type": "object", - "properties": { - "value": { - "type": "integer", - "format": "int32" - } - } - }, - "HostInformationResponse": { - "type": "object", - "properties": { - "machineName": { - "type": [ - "null", - "string" - ] - }, - "osInformation": { - "type": [ - "null", - "string" - ] - }, - "upTime": { - "type": "integer", - "format": "int64" - } - } - }, - "ICapabilities": { - "type": "object", - "properties": { - "isCombined": { - "type": "boolean", - "description": "Flag if the capabilities of this instance are implemented by sub instances" - } - }, - "description": "Common capabilities interface" - }, - "IFormFile": { - "type": "string", - "format": "binary" - }, - "InstructionContentType": { - "enum": [ - "Unknown", - "Text", - "Media" - ] - }, - "InstructionItemModel": { - "type": "object", - "properties": { - "contentType": { - "$ref": "#/components/schemas/InstructionContentType" - }, - "content": { - "type": [ - "null", - "string" - ] - }, - "preview": { - "type": [ - "null", - "string" - ] - } - } - }, - "InstructionModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "sender": { - "type": [ - "null", - "string" - ] - }, - "type": { - "$ref": "#/components/schemas/InstructionType" - }, - "items": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/InstructionItemModel" - } - }, - "inputs": { - "$ref": "#/components/schemas/Entry" - }, - "results": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/InstructionResultModel" - } - } - } - }, - "InstructionResponseModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "inputs": { - "$ref": "#/components/schemas/Entry" - }, - "result": { - "type": [ - "null", - "string" - ] - }, - "selectedResult": { - "$ref": "#/components/schemas/InstructionResultModel" - } - } - }, - "InstructionResultModel": { - "type": "object", - "properties": { - "key": { - "type": [ - "null", - "string" - ] - }, - "displayValue": { - "type": [ - "null", - "string" - ] - } - } - }, - "InstructionType": { - "enum": [ - "Display", - "Execute" - ] - }, - "InternalOperationClassification": { - "enum": [ - "Initial", - "Assigning", - "Failed", - "Aborted", - "Ready", - "Running", - "Interrupting", - "Interrupted", - "Completed", - "AmountReached" - ] - }, - "InvocationResponse": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "exceptionType": { - "type": [ - "null", - "string" - ] - }, - "errorMessage": { - "type": [ - "null", - "string" - ] - } - } - }, - "IOperatorAssignable": { - "type": "object", - "properties": { - "requiredSkills": { - "$ref": "#/components/schemas/ICapabilities" - }, - "id": { - "type": "integer", - "description": "Id of the resource", - "format": "int64" - }, - "name": { - "type": [ - "null", - "string" - ], - "description": "Name of this resource instance" - }, - "capabilities": { - "description": "The resource's capabilities", - "$ref": "#/components/schemas/ICapabilities" - } - } - }, - "JobModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "recipeId": { - "type": "integer", - "format": "int64" - }, - "state": { - "type": [ - "null", - "string" - ] - }, - "displayState": { - "type": [ - "null", - "string" - ] - }, - "workplan": { - "type": [ - "null", - "string" - ] - }, - "canComplete": { - "type": "boolean" - }, - "canAbort": { - "type": "boolean" - }, - "isWaiting": { - "type": "boolean" - }, - "isRunning": { - "type": "boolean" - }, - "productionJob": { - "$ref": "#/components/schemas/ProductionJobModel" - }, - "setupJob": { - "$ref": "#/components/schemas/SetupJobModel" - } - } - }, - "JobProcessModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "recipeId": { - "type": "integer", - "format": "int64" - }, - "state": { - "$ref": "#/components/schemas/ProcessProgress" - }, - "rework": { - "type": "boolean" - }, - "started": { - "type": "string", - "format": "date-time" - }, - "completed": { - "type": "string", - "format": "date-time" - }, - "activities": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/ProcessActivityModel" - } - }, - "isRunning": { - "type": "boolean" - } - } - }, - "LogLevel": { - "enum": [ - "Trace", - "Debug", - "Information", - "Warning", - "Error", - "Critical", - "None" - ] - }, - "MethodBase": { }, - "MethodEntry": { - "type": "object", - "properties": { - "name": { - "type": [ - "null", - "string" - ], - "description": "Name of the method" - }, - "isConstructor": { - "type": "boolean", - "description": "Flag if this structure represents a server side constructor" - }, - "displayName": { - "type": [ - "null", - "string" - ], - "description": "Display name for the button" - }, - "description": { - "type": [ - "null", - "string" - ], - "description": "Description of the method" - }, - "parameters": { - "description": "Arguments of the", - "$ref": "#/components/schemas/Entry" - }, - "isAsync": { - "type": "boolean", - "description": "True if the method is awaitable by Task" - } - }, - "description": "Model that represents a public method on an object callable from the UI" - }, - "MigrationResult": { - "enum": [ - "Migrated", - "NoMigrationsAvailable", - "Error" - ], - "description": "Result enum for executing database migrations" - }, - "ModelConfiguratorModel": { - "type": "object", - "properties": { - "name": { - "type": [ - "null", - "string" - ] - }, - "configuratorType": { - "type": [ - "null", - "string" - ] - }, - "connectionStringKeys": { - "type": [ - "null", - "object" - ], - "additionalProperties": { - "type": "string" - } - }, - "connectionStringPrototype": { - "type": [ - "null", - "string" - ] - }, - "configPrototype": { - "$ref": "#/components/schemas/Entry" - } - } - }, - "ModuleNotificationModel": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time" - }, - "exception": { - "$ref": "#/components/schemas/SerializableException" - }, - "message": { - "type": [ - "null", - "string" - ] - }, - "severity": { - "$ref": "#/components/schemas/Severity" - } - } - }, - "ModuleStartBehaviour": { - "enum": [ - "Auto", - "Manual", - "OnDependency" - ], - "description": "Start behaviour" - }, - "MoryxExceptionResponse": { - "type": "object", - "properties": { - "title": { - "type": [ - "null", - "string" - ] - }, - "exception": { - "type": [ - "null", - "string" - ] - } - } - }, - "NodeConnectionPoint": { - "type": "object", - "properties": { - "index": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": [ - "null", - "string" - ] - }, - "connections": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/NodeConnector" - } - } - } - }, - "NodeConnector": { - "type": "object", - "properties": { - "nodeId": { - "type": "integer", - "format": "int64" - }, - "index": { - "type": "integer", - "format": "int32" - } - } - }, - "NotificationModel": { - "type": "object", - "properties": { - "identifier": { - "type": "string", - "format": "uuid" - }, - "type": { - "type": [ - "null", - "string" - ] - }, - "title": { - "type": [ - "null", - "string" - ] - }, - "message": { - "type": [ - "null", - "string" - ] - }, - "severity": { - "$ref": "#/components/schemas/Severity" - }, - "created": { - "type": "string", - "format": "date-time" - }, - "acknowledged": { - "type": [ - "null", - "string" - ], - "format": "date-time" - }, - "isAcknowledgable": { - "type": "boolean" - }, - "properties": { - "$ref": "#/components/schemas/Entry" - }, - "sender": { - "type": [ - "null", - "string" - ] - }, - "source": { - "type": [ - "null", - "string" - ] - } - } - }, - "OpenSessionRequest": { - "type": "object", - "properties": { - "workplanId": { - "type": "integer", - "format": "int64" - }, - "duplicate": { - "type": "boolean" - } - } - }, - "OperationAdvicedModel": { - "type": "object", - "properties": { - "advice": { - "$ref": "#/components/schemas/AdviceModel" - }, - "operationModel": { - "$ref": "#/components/schemas/OperationModel" - } - } - }, - "OperationCreationContextModel": { - "type": "object", - "properties": { - "totalAmount": { - "type": "integer", - "description": "The amount to produce", - "format": "int32" - }, - "name": { - "type": [ - "null", - "string" - ], - "description": "Operation name" - }, - "orderNumber": { - "type": [ - "null", - "string" - ], - "description": "The number of the order this operation belongs to" - }, - "operationNumber": { - "type": [ - "null", - "string" - ], - "description": "The number of this operation" - }, - "productIdentifier": { - "type": [ - "null", - "string" - ], - "description": "Main product identifier" - }, - "productRevision": { - "type": "integer", - "description": "Revision of the Product", - "format": "int16" - }, - "productName": { - "type": [ - "null", - "string" - ], - "description": "Name of the Product" - }, - "recipePreselection": { - "type": "integer", - "description": "Id of the preselected recipe", - "format": "int64" - }, - "overDeliveryAmount": { - "type": "integer", - "description": "Total amount planned for over delivery", - "format": "int32" - }, - "underDeliveryAmount": { - "type": "integer", - "description": "Total amount planned for under delivery", - "format": "int32" - }, - "plannedStart": { - "type": "string", - "description": "Expected start time", - "format": "date-time" - }, - "plannedEnd": { - "type": "string", - "description": "Expected end time", - "format": "date-time" - }, - "targetCycleTime": { - "type": "number", - "description": "Target cycle time for the production of the depending product", - "format": "double" - }, - "unit": { - "type": [ - "null", - "string" - ], - "description": "Unit of product" - }, - "targetStock": { - "type": [ - "null", - "string" - ], - "description": "Target stock for produced parts" - }, - "parts": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/PartCreationContext" - }, - "description": "Part list of the product of this operation" - }, - "materialParameters": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/Entry" - }, - "description": "Additional operation depending parameters for the production" - } - } - }, - "OperationLogMessageModel": { - "type": "object", - "properties": { - "logLevel": { - "$ref": "#/components/schemas/LogLevel" - }, - "message": { - "type": [ - "null", - "string" - ] - }, - "exception": { - "type": [ - "null", - "string" - ] - }, - "timeStamp": { - "type": "string", - "format": "date-time" - } - } - }, - "OperationModel": { - "type": "object", - "properties": { - "identifier": { - "type": "string", - "format": "uuid" - }, - "totalAmount": { - "type": "integer", - "format": "int32" - }, - "number": { - "type": [ - "null", - "string" - ] - }, - "name": { - "type": [ - "null", - "string" - ] - }, - "overDeliveryAmount": { - "type": "integer", - "format": "int32" - }, - "underDeliveryAmount": { - "type": "integer", - "format": "int32" - }, - "plannedStart": { - "type": "string", - "format": "date-time" - }, - "plannedEnd": { - "type": "string", - "format": "date-time" - }, - "start": { - "type": [ - "null", - "string" - ], - "format": "date-time" - }, - "end": { - "type": [ - "null", - "string" - ], - "format": "date-time" - }, - "targetCycleTime": { - "type": "number", - "format": "double" - }, - "unit": { - "type": [ - "null", - "string" - ] - }, - "sortOrder": { - "type": "integer", - "format": "int32" - }, - "order": { - "type": [ - "null", - "string" - ] - }, - "classification": { - "$ref": "#/components/schemas/OperationStateClassification" - }, - "stateDisplayName": { - "type": [ - "null", - "string" - ] - }, - "productId": { - "type": "integer", - "format": "int64" - }, - "productIdentifier": { - "type": [ - "null", - "string" - ] - }, - "productRevision": { - "type": "integer", - "format": "int16" - }, - "productName": { - "type": [ - "null", - "string" - ] - }, - "recipeName": { - "type": [ - "null", - "string" - ] - }, - "recipeIds": { - "type": [ - "null", - "array" - ], - "items": { - "type": "integer", - "format": "int64" - } - }, - "jobIds": { - "type": [ - "null", - "array" - ], - "items": { - "type": "integer", - "format": "int64" - } - }, - "reportedSuccessCount": { - "type": "integer", - "format": "int32" - }, - "reportedFailureCount": { - "type": "integer", - "format": "int32" - }, - "canAssign": { - "type": "boolean" - }, - "canBegin": { - "type": "boolean" - }, - "canInterrupt": { - "type": "boolean" - }, - "canReport": { - "type": "boolean" - }, - "canAdvice": { - "type": "boolean" - }, - "isCreated": { - "type": "boolean" - }, - "isFailed": { - "type": "boolean" - }, - "isAssigning": { - "type": "boolean" - }, - "isAborted": { - "type": "boolean" - }, - "isAmountReached": { - "type": "boolean" - }, - "runningCount": { - "type": "integer", - "format": "int32" - }, - "successCount": { - "type": "integer", - "format": "int32" - }, - "scrapCount": { - "type": "integer", - "format": "int32" - }, - "pendingCount": { - "type": "integer", - "format": "int32" - }, - "progressRunning": { - "type": "integer", - "format": "int32" - }, - "progressSuccess": { - "type": "integer", - "format": "int32" - }, - "progressScrap": { - "type": "integer", - "format": "int32" - }, - "progressPending": { - "type": "integer", - "format": "int32" - }, - "hasDocuments": { - "type": "boolean" - }, - "hasPartList": { - "type": "boolean" - }, - "operationSource": { - "$ref": "#/components/schemas/Entry" - } - }, - "description": "OrderOperation-DTO to be used with the endpoints" - }, - "OperationRecipeModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": [ - "null", - "string" - ] - } - } - }, - "OperationReportedModel": { - "type": "object", - "properties": { - "report": { - "$ref": "#/components/schemas/ReportModel" - }, - "operationModel": { - "$ref": "#/components/schemas/OperationModel" - } - } - }, - "OperationStartedModel": { - "type": "object", - "properties": { - "userId": { - "type": [ - "null", - "string" - ] - }, - "operationModel": { - "$ref": "#/components/schemas/OperationModel" - } - } - }, - "OperationStateClassification": { - "type": "string", - "description": "Enum providing the classification of the internal state machine of the operation for an external representation\r\nThe lowest 8 bits define the state of the operation. The following 16 bits contain flags for the executable\r\nactions on the operation and the trailing 8 bits overall classification information.\r\nBit: 31 - 24 | 23 - 8 | 7 - 0 |\r\nFlag: Overall | Usage | State |" - }, - "OperationUpdateModel": { - "type": "object", - "properties": { - "sortIndex": { - "type": [ - "null", - "integer" - ], - "format": "int32" - }, - "plannedStart": { - "type": [ - "null", - "string" - ], - "format": "date-time" - }, - "plannedEnd": { - "type": [ - "null", - "string" - ], - "format": "date-time" - }, - "totalAmount": { - "type": [ - "null", - "integer" - ], - "format": "int32" - }, - "overDeliveryAmount": { - "type": [ - "null", - "integer" - ], - "format": "int32" - }, - "underDeliveryAmount": { - "type": [ - "null", - "integer" - ], - "format": "int32" - }, - "targetCycleTime": { - "type": [ - "null", - "number" - ], - "format": "double" - }, - "targetStock": { - "type": [ - "null", - "string" - ] - } - } - }, - "OperatorModel": { - "type": "object", - "properties": { - "identifier": { - "type": [ - "null", - "string" - ] - }, - "firstName": { - "type": [ - "null", - "string" - ] - }, - "lastName": { - "type": [ - "null", - "string" - ] - }, - "pseudonym": { - "type": [ - "null", - "string" - ] - } - } - }, - "OrderChangedModel": { - "type": "object", - "properties": { - "order": { - "type": [ - "null", - "string" - ] - }, - "operation": { - "type": [ - "null", - "string" - ] - }, - "state": { - "$ref": "#/components/schemas/InternalOperationClassification" - } - } - }, - "OrderModel": { - "type": "object", - "properties": { - "color": { - "type": [ - "null", - "string" - ] - }, - "order": { - "type": [ - "null", - "string" - ] - }, - "operation": { - "type": [ - "null", - "string" - ] - }, - "state": { - "$ref": "#/components/schemas/InternalOperationClassification" - } - } - }, - "OrderReferenceModel": { - "type": "object", - "properties": { - "order": { - "type": [ - "null", - "string" - ] - }, - "operation": { - "type": [ - "null", - "string" - ] - } - } - }, - "PartClassification": { - "enum": [ - "Unknown", - "Material", - "InfoComponent", - "CarrierMaterial", - "ScrapMaterial", - "BranchMaterial" - ] - }, - "PartConnector": { - "type": "object", - "properties": { - "name": { - "type": [ - "null", - "string" - ] - }, - "displayName": { - "type": [ - "null", - "string" - ] - }, - "type": { - "type": [ - "null", - "string" - ] - }, - "isCollection": { - "type": "boolean" - }, - "parts": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/PartModel" - } - }, - "propertyTemplates": { - "$ref": "#/components/schemas/Entry" - } - } - }, - "PartCreationContext": { - "type": "object", - "properties": { - "name": { - "type": [ - "null", - "string" - ], - "description": "Name of the part like the product name" - }, - "number": { - "type": [ - "null", - "string" - ], - "description": "Identifier of this part" - }, - "quantity": { - "type": "number", - "description": "Quantity of this part which are necessary to produce one product", - "format": "double" - }, - "unit": { - "type": [ - "null", - "string" - ], - "description": "Unit of the quantity" - }, - "stagingIndicator": { - "description": "Staging indicator", - "$ref": "#/components/schemas/StagingIndicator" - }, - "classification": { - "description": "Classification of this part", - "$ref": "#/components/schemas/PartClassification" - } - }, - "description": "Information about a part of the product which should be produced for an operation" - }, - "PartModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "properties": { - "$ref": "#/components/schemas/Entry" - }, - "product": { - "$ref": "#/components/schemas/ProductModel" - } - } - }, - "Position": { - "type": "object", - "properties": { - "positionX": { - "type": "number", - "format": "double" - }, - "positionY": { - "type": "number", - "format": "double" - } - } - }, - "PreviewDescriptor": { - "type": "object", - "properties": { - "state": { - "description": "Current state of the preview", - "$ref": "#/components/schemas/PreviewState" - }, - "fileHash": { - "type": [ - "null", - "string" - ] - }, - "extension": { - "type": [ - "null", - "string" - ] - }, - "mimeType": { - "type": [ - "null", - "string" - ] - }, - "size": { - "type": "integer", - "format": "int64" - } - }, - "description": "Descriptor for an preview" - }, - "PreviewState": { - "enum": [ - "Creating", - "Created", - "Failed", - "Unsupported", - "Removed" - ], - "description": "State of the preview" - }, - "ProblemDetails": { - "type": "object", - "properties": { - "type": { - "type": [ - "null", - "string" - ] - }, - "title": { - "type": [ - "null", - "string" - ] - }, - "status": { - "type": [ - "null", - "integer" - ], - "format": "int32" - }, - "detail": { - "type": [ - "null", - "string" - ] - }, - "instance": { - "type": [ - "null", - "string" - ] - } - } - }, - "ProcessActivityModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "resource": { - "$ref": "#/components/schemas/ActivityResourceModel" - }, - "type": { - "type": [ - "null", - "string" - ] - }, - "state": { - "type": [ - "null", - "string" - ] - }, - "classification": { - "$ref": "#/components/schemas/ActivityClassification" - }, - "requiredCapabilities": { - "type": [ - "null", - "string" - ] - }, - "possibleResources": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/ActivityResourceModel" - } - }, - "result": { - "type": [ - "null", - "integer" - ], - "format": "int64" - }, - "resultName": { - "type": [ - "null", - "string" - ] - }, - "instanceId": { - "type": [ - "null", - "integer" - ], - "format": "int64" - }, - "tracing": { - "$ref": "#/components/schemas/TracingModel" - }, - "isCompleted": { - "type": "boolean" - } - } - }, - "ProcessHolderGroupModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": [ - "null", - "string" - ] - }, - "isEmpty": { - "type": "boolean" - }, - "positions": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/ProcessHolderPositionModel" - } - }, - "visualization": { - "$ref": "#/components/schemas/VisualizationModel" - } - } - }, - "ProcessHolderPositionModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "groupId": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": [ - "null", - "string" - ] - }, - "position": { - "type": "integer", - "format": "int32" - }, - "activity": { - "type": [ - "null", - "string" - ] - }, - "order": { - "type": [ - "null", - "string" - ] - }, - "process": { - "type": [ - "null", - "string" - ] - }, - "isEmpty": { - "type": "boolean" - } - } - }, - "ProcessProgress": { - "enum": [ - "Ready", - "Running", - "Interrupted", - "Completed" - ], - "description": "Enum representing the progress of a process within the kernel" - }, - "ProductCustomization": { - "type": "object", - "properties": { - "productTypes": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/ProductDefinitionModel" - } - }, - "recipeTypes": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/RecipeDefinitionModel" - } - }, - "importers": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/ProductImporter" - } - } - } - }, - "ProductDefinitionModel": { - "type": "object", - "properties": { - "name": { - "type": [ - "null", - "string" - ] - }, - "displayName": { - "type": [ - "null", - "string" - ] - }, - "baseDefinition": { - "type": [ - "null", - "string" - ] - }, - "properties": { - "$ref": "#/components/schemas/Entry" - } - } - }, - "ProductImporter": { - "type": "object", - "properties": { - "name": { - "type": [ - "null", - "string" - ] - }, - "parameters": { - "$ref": "#/components/schemas/Entry" - } - } - }, - "ProductInstanceModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "type": { - "type": [ - "null", - "string" - ], - "description": "The name of the product type of this instance" - }, - "state": { - "description": "The current state of the instance", - "$ref": "#/components/schemas/ProductInstanceState" - }, - "properties": { - "$ref": "#/components/schemas/Entry" - } - } - }, - "ProductInstanceState": { - "type": "string", - "description": "The state of an ProductInstance.\r\nThis will not occupy more than 4 Bits. Other enums can be added by bit-shifting" - }, - "ProductionJobModel": { - "type": "object", - "properties": { - "productIdentity": { - "type": [ - "null", - "string" - ] - }, - "amount": { - "type": "integer", - "format": "int32" - }, - "successCount": { - "type": "integer", - "format": "int32" - }, - "failureCount": { - "type": "integer", - "format": "int32" - }, - "runningCount": { - "type": "integer", - "format": "int32" - }, - "reworkedCount": { - "type": "integer", - "format": "int32" - } - } - }, - "ProductModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": [ - "null", - "string" - ] - }, - "state": { - "$ref": "#/components/schemas/ProductState" - }, - "identifier": { - "type": [ - "null", - "string" - ] - }, - "revision": { - "type": "integer", - "format": "int16" - }, - "type": { - "type": [ - "null", - "string" - ] - }, - "properties": { - "$ref": "#/components/schemas/Entry" - }, - "parts": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/PartConnector" - } - }, - "recipes": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/RecipeModel" - } - } - } - }, - "ProductPartModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": [ - "null", - "string" - ] - }, - "identifier": { - "type": [ - "null", - "string" - ] - }, - "quantity": { - "type": "number", - "format": "double" - }, - "unit": { - "type": [ - "null", - "string" - ] - }, - "stagingIndicator": { - "$ref": "#/components/schemas/StagingIndicator" - }, - "classification": { - "$ref": "#/components/schemas/PartClassification" - } - } - }, - "ProductQuery": { - "type": "object", - "properties": { - "includeDeleted": { - "type": "boolean", - "description": "Flag if deleted products should be included in the query" - }, - "typeName": { - "type": [ - "null", - "string" - ], - "description": "Product types to filter by" - }, - "excludeDerivedTypes": { - "type": "boolean", - "description": "When filtering by type exclude derived types and only return specific matches" - }, - "identifier": { - "type": [ - "null", - "string" - ], - "description": "Material identifiers" - }, - "requiredState": { - "oneOf": [ - { - "type": "null" - }, - { - "description": "State of the product", - "$ref": "#/components/schemas/ProductState" - } - ] - }, - "revisionFilter": { - "description": "Revisions to filter", - "$ref": "#/components/schemas/RevisionFilter" - }, - "name": { - "type": [ - "null", - "string" - ], - "description": "Material identifiers" - }, - "revision": { - "type": "integer", - "description": "Optional specific revision if RevisionFilter ProductQuery.RevisionFilter is set to\r\nRevisionFilter.Specific", - "format": "int16" - }, - "recipeFilter": { - "description": "Optional recipe filter", - "$ref": "#/components/schemas/RecipeFilter" - }, - "selector": { - "description": "Selector", - "$ref": "#/components/schemas/Selector" - }, - "propertyFilters": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/PropertyFilter" - }, - "description": "List of property filters" - }, - "loadFullTypeInformation": { - "type": "boolean", - "description": "If set to true, product queries return fully populated product types.\r\nOtherwise only the basic type information is returned." - } - }, - "description": "Filter to fetch products from the product management" - }, - "ProductState": { - "type": "string", - "description": "Current state of a product" - }, - "PropertyFilter": { - "type": "object", - "properties": { - "entry": { - "description": "Entry to filter", - "$ref": "#/components/schemas/Entry" - }, - "operator": { - "description": "Operator for the filter expression", - "$ref": "#/components/schemas/PropertyFilterOperator" - } - }, - "description": "Property filter wrapper for the filtered entry" - }, - "PropertyFilterOperator": { - "enum": [ - "Equals", - "GreaterThen", - "LessThen" - ], - "description": "Property filter operator expression" - }, - "RecipeClassificationModel": { - "enum": [ - "Unset", - "Default", - "Alternative", - "Intermediate", - "Part" - ], - "description": "Webservice compatible recipe classification enum" - }, - "RecipeDefinitionModel": { - "type": "object", - "properties": { - "name": { - "type": [ - "null", - "string" - ] - }, - "displayName": { - "type": [ - "null", - "string" - ] - }, - "hasWorkplans": { - "type": "boolean" - } - } - }, - "RecipeFilter": { - "enum": [ - "Unset", - "WithRecipe", - "WithoutRecipes" - ], - "description": "Different options regarding the recipes of the product" - }, - "RecipeModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Id of the recipe", - "format": "int64" - }, - "name": { - "type": [ - "null", - "string" - ], - "description": "Name of the recipe" - }, - "state": { - "description": "This recipe's state", - "$ref": "#/components/schemas/RecipeState" - }, - "revision": { - "type": "integer", - "description": "Revision of the recipe", - "format": "int32" - }, - "type": { - "type": [ - "null", - "string" - ], - "description": "Type of the recipe" - }, - "properties": { - "description": "Properties of the recipe", - "$ref": "#/components/schemas/Entry" - }, - "workplanModel": { - "description": "A model of the currently referenced workplan", - "$ref": "#/components/schemas/WorkplanModel" - }, - "classification": { - "description": "Classification of the recipe", - "$ref": "#/components/schemas/RecipeClassificationModel" - }, - "isClone": { - "type": "boolean", - "description": "Whether this Recipe is a clone or not" - } - }, - "description": "DTO representation of a recipe" - }, - "RecipeState": { - "enum": [ - "New", - "Released", - "Revoked" - ], - "description": "A Recipe's state" - }, - "ReferenceFilter": { - "type": "object", - "properties": { - "name": { - "type": [ - "null", - "string" - ], - "description": "Name of the reference" - }, - "relationType": { - "description": "Resource relation type", - "$ref": "#/components/schemas/ResourceRelationType" - }, - "role": { - "description": "Role of the reference", - "$ref": "#/components/schemas/ResourceReferenceRole" - }, - "valueConstraint": { - "description": "Filter criteria for the reference property", - "$ref": "#/components/schemas/ReferenceValue" - } - }, - "description": "Filter criteria for required or requested references" - }, - "ReferenceTypeModel": { - "type": "object", - "properties": { - "name": { - "type": [ - "null", - "string" - ], - "description": "Name of the reference, usually name of the property" - }, - "isCollection": { - "type": "boolean", - "description": "Flag if this reference is a collection" - }, - "displayName": { - "type": [ - "null", - "string" - ], - "description": "Display name of the reference" - }, - "description": { - "type": [ - "null", - "string" - ], - "description": "Description of this reference" - }, - "isRequired": { - "type": "boolean", - "description": "Reference is required and must be set" - }, - "supportedTypes": { - "type": [ - "null", - "array" - ], - "items": { - "type": "string" - }, - "description": "Types that can be assigned to this reference" - }, - "role": { - "description": "Role of the referenced resource in the relationship", - "$ref": "#/components/schemas/ResourceReferenceRole" - }, - "relationType": { - "description": "Type of resource relation", - "$ref": "#/components/schemas/ResourceRelationType" - } - }, - "description": "Type model for a reference property on a resource type" - }, - "ReferenceValue": { - "enum": [ - "Irrelevant", - "NullOrEmpty", - "NotEmpty" - ], - "description": "Enum to classify the current value of the reference property" - }, - "ReportContext": { - "type": "object", - "properties": { - "canPartial": { - "type": "boolean", - "description": "If `true` the operation can be reported partially" - }, - "canFinal": { - "type": "boolean", - "description": "If `true` the operation can be reported finally" - }, - "reportedSuccess": { - "type": "integer", - "description": "Currently reported success count", - "format": "int32" - }, - "reportedFailure": { - "type": "integer", - "description": "Currently reported failure count", - "format": "int32" - }, - "unreportedSuccess": { - "type": "integer", - "description": "Value of unreported success parts", - "format": "int32" - }, - "unreportedFailure": { - "type": "integer", - "description": "Value of unreported failure parts", - "format": "int32" - }, - "restrictions": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/RestrictionDescription" - }, - "description": "Reasons why a report is not possible" - }, - "successCount": { - "type": "integer", - "description": "Current success count of the operation", - "format": "int32" - }, - "scrapCount": { - "type": "integer", - "description": "Current failure count of the operation", - "format": "int32" - } - }, - "description": "Report which is not processed." - }, - "ReportModel": { - "type": "object", - "properties": { - "confirmationType": { - "$ref": "#/components/schemas/ConfirmationType" - }, - "comment": { - "type": [ - "null", - "string" - ] - }, - "successCount": { - "type": "integer", - "format": "int32" - }, - "failureCount": { - "type": "integer", - "format": "int32" - }, - "userIdentifier": { - "type": [ - "null", - "string" - ] - } - } - }, - "ResourceChangedModel": { - "type": "object", - "properties": { - "cellName": { - "type": [ - "null", - "string" - ] - }, - "cellIconName": { - "type": [ - "null", - "string" - ] - }, - "cellImageURL": { - "type": [ - "null", - "string" - ] - }, - "id": { - "type": "integer", - "format": "int64" - }, - "cellLocation": { - "$ref": "#/components/schemas/CellLocationModel" - }, - "cellPropertySettings": { - "type": [ - "null", - "object" - ], - "additionalProperties": { - "$ref": "#/components/schemas/CellPropertySettings" - } - }, - "factoryId": { - "type": "integer", - "format": "int64" - }, - "location": { - "$ref": "#/components/schemas/CellLocationModel" - }, - "iconName": { - "type": [ - "null", - "string" - ] - }, - "isACell": { - "type": "boolean" - } - } - }, - "ResourceModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Id of the resource.", - "format": "int64" - }, - "referenceId": { - "type": "integer", - "description": "Reference id in case of recursion in the returned model", - "format": "int64" - }, - "name": { - "type": [ - "null", - "string" - ], - "description": "Name of the resource." - }, - "description": { - "type": [ - "null", - "string" - ], - "description": "Description of the resource" - }, - "type": { - "type": [ - "null", - "string" - ], - "description": "Resource type model reference" - }, - "partiallyLoaded": { - "type": "boolean", - "description": "Indicates that this model does not represent the full\r\nresource but only its key properties" - }, - "properties": { - "description": "A list of configs of the resource.", - "$ref": "#/components/schemas/Entry" - }, - "methods": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/MethodEntry" - }, - "description": "User callable methods for instances of this type" - }, - "references": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/ResourceReferenceModel" - }, - "description": "References of this resource, including children" - } - }, - "description": "Base model used by details view and tree" - }, - "ResourceQuery": { - "type": "object", - "properties": { - "types": { - "type": [ - "null", - "array" - ], - "items": { - "type": "string" - }, - "description": "Type constraints to filter instances" - }, - "referenceCondition": { - "description": "Reference condition to filter instances", - "$ref": "#/components/schemas/ReferenceFilter" - }, - "referenceRecursion": { - "type": "boolean", - "description": "Flag if included references should be processed recursively" - }, - "includedReferences": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/ReferenceFilter" - }, - "description": "References that should be included in the response" - } - }, - "description": "Filter object to fetch resources from the server" - }, - "ResourceReferenceModel": { - "type": "object", - "properties": { - "name": { - "type": [ - "null", - "string" - ], - "description": "Name of the reference, usually name of the property" - }, - "targets": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/ResourceModel" - }, - "description": "Targets of this reference" - } - }, - "description": "DTO that represents the reference of one resource with another" - }, - "ResourceReferenceRole": { - "enum": [ - "Target", - "Source" - ], - "description": "Role of a resource in a relation decorated with the ResourceReferenceAttribute" - }, - "ResourceRelationType": { - "type": "string", - "description": "Enum representing the relation between two entities and definition of their life cycle coupling.\r\nThe lowest 3 bits define the UML association type. The other 29 bits are for free use\r\nBit: 31 - 3 | 2 | 1 | 0\r\nFlag: Type | Usage | Composition | Aggregation\r\nUsage: Pick a number and bitshift it by 3 and add the UML type, e.g. 42 => (42 << 3) + 1" - }, - "ResourceTypeModel": { - "type": "object", - "properties": { - "name": { - "type": [ - "null", - "string" - ], - "description": "The name of the resource type." - }, - "displayName": { - "type": [ - "null", - "string" - ], - "description": "Display name of this resource type" - }, - "creatable": { - "type": "boolean", - "description": "Flag that this type is registered and can be instantiated" - }, - "description": { - "type": [ - "null", - "string" - ], - "description": "Description of this resource type" - }, - "constructors": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/MethodEntry" - }, - "description": "Resource constructors used to build new instances" - }, - "references": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/ReferenceTypeModel" - }, - "description": "Reference properties of this type" - }, - "baseType": { - "type": [ - "null", - "string" - ], - "description": "Back reference to the base type" - }, - "derivedTypes": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/ResourceTypeModel" - }, - "description": "Types derived from this type" - } - }, - "description": "Type item for the tree" - }, - "RestrictionDescription": { - "required": [ - "text", - "severity" - ], - "type": "object", - "properties": { - "text": { - "type": [ - "null", - "string" - ], - "description": "Description of the result" - }, - "severity": { - "description": "Severity of the result", - "$ref": "#/components/schemas/RestrictionSeverity" - } - }, - "description": "Description of the result of a performed rule" - }, - "RestrictionSeverity": { - "enum": [ - "Info", - "Warning", - "Error" - ], - "description": "Severity of a rule result" - }, - "RevisionFilter": { - "enum": [ - "All", - "Latest", - "Specific" - ], - "description": "Filter for revisions" - }, - "SaveConfigRequest": { - "type": "object", - "properties": { - "config": { - "$ref": "#/components/schemas/Config" - }, - "updateMode": { - "$ref": "#/components/schemas/ConfigUpdateMode" - } - } - }, - "Selector": { - "enum": [ - "Direct", - "Parent", - "Parts" - ], - "description": "Determine which objects to select for the query" - }, - "SerializableException": { - "type": "object", - "properties": { - "exceptionTypeName": { - "type": [ - "null", - "string" - ] - }, - "message": { - "type": [ - "null", - "string" - ] - }, - "stackTrace": { - "type": [ - "null", - "string" - ] - }, - "innerException": { - "$ref": "#/components/schemas/SerializableException" - } - } - }, - "ServerModuleModel": { - "type": "object", - "properties": { - "name": { - "type": [ - "null", - "string" - ] - }, - "healthState": { - "$ref": "#/components/schemas/ServerModuleState" - }, - "startBehaviour": { - "$ref": "#/components/schemas/ModuleStartBehaviour" - }, - "failureBehaviour": { - "$ref": "#/components/schemas/FailureBehaviour" - }, - "dependencies": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/ServerModuleModel" - } - }, - "notifications": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/ModuleNotificationModel" - } - }, - "assembly": { - "$ref": "#/components/schemas/AssemblyModel" - } - } - }, - "ServerModuleState": { - "enum": [ - "Stopped", - "Ready", - "Initializing", - "Starting", - "Failure", - "Missing", - "Running", - "Stopping" - ], - "description": "Different health states a server module can have" - }, - "ServerTimeResponse": { - "type": "object", - "properties": { - "serverTime": { - "type": [ - "null", - "string" - ] - } - } - }, - "SetupJobClassification": { - "enum": [ - "None", - "Prepare", - "Cleanup", - "Manual" - ] - }, - "SetupJobModel": { - "type": "object", - "properties": { - "classification": { - "$ref": "#/components/schemas/SetupJobClassification" - }, - "targetRecipeId": { - "type": "integer", - "format": "int64" - }, - "steps": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/SetupStepModel" - } - } - } - }, - "SetupModel": { - "type": "object", - "properties": { - "fullname": { - "type": [ - "null", - "string" - ] - }, - "sortOrder": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": [ - "null", - "string" - ] - }, - "description": { - "type": [ - "null", - "string" - ] - }, - "supportedFileRegex": { - "type": [ - "null", - "string" - ] - }, - "setupData": { - "type": [ - "null", - "string" - ] - } - } - }, - "SetupStepModel": { - "type": "object", - "properties": { - "name": { - "type": [ - "null", - "string" - ] - }, - "state": { - "$ref": "#/components/schemas/StepState" - } - } - }, - "Severity": { - "enum": [ - "Info", - "Warning", - "Error", - "Fatal" - ], - "description": "Different levels to differentiate the severity of a message" - }, - "ShiftAssignementCreationContextModel": { - "type": "object", - "properties": { - "resourceId": { - "type": "integer", - "format": "int64" - }, - "shiftId": { - "type": "integer", - "format": "int64" - }, - "operatorIdentifier": { - "type": [ - "null", - "string" - ] - }, - "note": { - "type": [ - "null", - "string" - ] - }, - "priority": { - "type": "integer", - "format": "int32" - }, - "assignedDays": { - "$ref": "#/components/schemas/AssignedDays" - } - } - }, - "ShiftAssignementModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "resourceId": { - "type": "integer", - "format": "int64" - }, - "operatorIdentifier": { - "type": [ - "null", - "string" - ] - }, - "shiftId": { - "type": "integer", - "format": "int64" - }, - "note": { - "type": [ - "null", - "string" - ] - }, - "priority": { - "type": "integer", - "format": "int32" - }, - "assignedDays": { - "$ref": "#/components/schemas/AssignedDays" - } - } - }, - "ShiftCreationContextModel": { - "type": "object", - "properties": { - "typeId": { - "type": "integer", - "format": "int64" - }, - "date": { - "type": "string", - "format": "date" - } - } - }, - "ShiftModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "typeId": { - "type": "integer", - "format": "int64" - }, - "date": { - "type": "string", - "format": "date" - } - } - }, - "ShiftTypeCreationContextModel": { - "type": "object", - "properties": { - "name": { - "type": [ - "null", - "string" - ] - }, - "startTime": { - "type": "string", - "format": "time" - }, - "endtime": { - "type": "string", - "format": "time" - }, - "periode": { - "type": "integer", - "format": "uint8" - } - } - }, - "ShiftTypeModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": [ - "null", - "string" - ] - }, - "startTime": { - "type": "string", - "format": "time" - }, - "endtime": { - "type": "string", - "format": "time" - }, - "periode": { - "type": "integer", - "format": "uint8" - } - } - }, - "SkillCreationContextModel": { - "type": "object", - "properties": { - "obtainedOn": { - "type": "string", - "format": "date" - }, - "typeId": { - "type": "integer", - "format": "int64" - }, - "operatorIdentifier": { - "type": [ - "null", - "string" - ] - } - } - }, - "SkillModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "obtainedOn": { - "type": "string", - "format": "date" - }, - "expiresOn": { - "type": "string", - "format": "date" - }, - "typeId": { - "type": "integer", - "format": "int64" - }, - "operatorIdentifier": { - "type": [ - "null", - "string" - ] - }, - "isExpired": { - "type": "boolean" - } - } - }, - "SkillTypeCreationContextModel": { - "type": "object", - "properties": { - "name": { - "type": [ - "null", - "string" - ] - }, - "duration": { - "pattern": "^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$", - "type": "string" - }, - "capabilities": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/Entry" - } - ] - } - } - }, - "SkillTypeModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": [ - "null", - "string" - ] - }, - "duration": { - "pattern": "^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$", - "type": "string" - }, - "capabilities": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/Entry" - } - ] - } - } - }, - "SseItemBase": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "eventId": { - "type": "string" - }, - "reconnectInterval": { - "pattern": "^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$", - "type": "string" - } - } - }, - "SseItemOfOperationAdvicedModel": { - "allOf": [ - { - "$ref": "#/components/schemas/SseItemBase" - } - ], - "properties": { - "data": { - "$ref": "#/components/schemas/OperationAdvicedModel" - } - } - }, - "SseItemOfOperationModel": { - "allOf": [ - { - "$ref": "#/components/schemas/SseItemBase" - } - ], - "properties": { - "data": { - "$ref": "#/components/schemas/OperationModel" - } - } - }, - "SseItemOfOperationReportedModel": { - "allOf": [ - { - "$ref": "#/components/schemas/SseItemBase" - } - ], - "properties": { - "data": { - "$ref": "#/components/schemas/OperationReportedModel" - } - } - }, - "SseItemOfOperationStartedModel": { - "allOf": [ - { - "$ref": "#/components/schemas/SseItemBase" - } - ], - "properties": { - "data": { - "$ref": "#/components/schemas/OperationStartedModel" - } - } - }, - "StagingIndicator": { - "enum": [ - "NotRelevant", - "PickPart", - "CrateOrKanbanPart", - "ReleaseOrderPart", - "ManualStaging", - "EwmStaging" - ], - "description": "The material staging indicator defines the method of how needed materials can be supplied for production with the assistance of the Warehouse Management system.\r\nAs with the location coordinates(warehouse number, storage type, and storage bin), the system files this indicator in the control cycle." - }, - "StepState": { - "enum": [ - "Initial", - "Running", - "Completed" - ] - }, - "Stream": { - "type": "string", - "format": "binary" - }, - "StringSegment": { - "type": "object", - "properties": { - "buffer": { - "type": [ - "null", - "string" - ] - }, - "offset": { - "type": "integer", - "format": "int32" - }, - "length": { - "type": "integer", - "format": "int32" - }, - "value": { - "type": [ - "null", - "string" - ] - }, - "hasValue": { - "type": "boolean" - } - } - }, - "TestConnectionResponse": { - "type": "object", - "properties": { - "result": { - "$ref": "#/components/schemas/TestConnectionResult" - } - } - }, - "TestConnectionResult": { - "enum": [ - "ConfigurationError", - "ConnectionError", - "ConnectionOkDbDoesNotExist", - "PendingMigrations", - "Success" - ], - "description": "Result enum for function TestConnection" - }, - "TracingModel": { - "type": "object", - "properties": { - "type": { - "type": [ - "null", - "string" - ] - }, - "text": { - "type": [ - "null", - "string" - ] - }, - "started": { - "type": [ - "null", - "string" - ], - "format": "date-time" - }, - "completed": { - "type": [ - "null", - "string" - ], - "format": "date-time" - }, - "errorCode": { - "type": "integer", - "format": "int32" - }, - "properties": { - "$ref": "#/components/schemas/Entry" - } - } - }, - "TransportRouteModel": { - "type": "object", - "properties": { - "idCellOfOrigin": { - "type": "integer", - "format": "int64" - }, - "idCellOfDestination": { - "type": "integer", - "format": "int64" - }, - "paths": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/Position" - } - } - } - }, - "ValidationErrorModel": { - "type": "object", - "properties": { - "error": { - "type": [ - "null", - "string" - ] - }, - "position": { - "type": "integer", - "format": "int64" - } - } - }, - "ValidationResultModel": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "errors": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/ValidationErrorModel" - } - } - } - }, - "VariantDescriptor": { - "type": "object", - "properties": { - "name": { - "type": [ - "null", - "string" - ], - "description": "Name of the variant" - }, - "creationDate": { - "type": "string", - "description": "Date of the creation", - "format": "date-time" - }, - "preview": { - "description": "Preview information for this variant", - "$ref": "#/components/schemas/PreviewDescriptor" - }, - "fileHash": { - "type": [ - "null", - "string" - ] - }, - "extension": { - "type": [ - "null", - "string" - ] - }, - "mimeType": { - "type": [ - "null", - "string" - ] - }, - "size": { - "type": "integer", - "format": "int64" - } - }, - "description": "Descriptor for an variant" - }, - "VisualizableItemModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "location": { - "$ref": "#/components/schemas/CellLocationModel" - }, - "iconName": { - "type": [ - "null", - "string" - ] - }, - "isACell": { - "type": "boolean" - } - } - }, - "VisualizationModel": { - "type": "object", - "properties": { - "icon": { - "type": [ - "null", - "string" - ] - }, - "category": { - "$ref": "#/components/schemas/Category" - } - } - }, - "WorkplanModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": [ - "null", - "string" - ] - }, - "version": { - "type": "integer", - "format": "int32" - }, - "state": { - "$ref": "#/components/schemas/WorkplanState" - } - } - }, - "WorkplanNodeClassification": { - "enum": [ - "Input", - "Output", - "Execution", - "ControlFlow", - "Subworkplan" - ] - }, - "WorkplanNodeModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "type": { - "type": [ - "null", - "string" - ] - }, - "name": { - "type": [ - "null", - "string" - ] - }, - "displayName": { - "type": [ - "null", - "string" - ] - }, - "positionTop": { - "type": "integer", - "format": "int32" - }, - "positionLeft": { - "type": "integer", - "format": "int32" - }, - "classification": { - "$ref": "#/components/schemas/WorkplanNodeClassification" - }, - "inputs": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/NodeConnectionPoint" - } - }, - "outputs": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/NodeConnectionPoint" - } - }, - "properties": { - "$ref": "#/components/schemas/Entry" - }, - "subworkplanId": { - "type": "integer", - "format": "int64" - } - } - }, - "WorkplanSessionModel": { - "type": "object", - "properties": { - "sessionToken": { - "type": [ - "null", - "string" - ] - }, - "workplanId": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": [ - "null", - "string" - ] - }, - "version": { - "type": "integer", - "format": "int32" - }, - "state": { - "$ref": "#/components/schemas/WorkplanState" - }, - "nodes": { - "type": [ - "null", - "array" - ], - "items": { - "$ref": "#/components/schemas/WorkplanNodeModel" - } - } - } - }, - "WorkplanState": { - "enum": [ - "New", - "Released", - "Revoked" - ], - "description": "A workplan state" - }, - "WorkplanStepRecipe": { - "type": "object", - "properties": { - "type": { - "type": [ - "null", - "string" - ] - }, - "name": { - "type": [ - "null", - "string" - ] - }, - "description": { - "type": [ - "null", - "string" - ] - }, - "positionTop": { - "type": "integer", - "format": "int32" - }, - "positionLeft": { - "type": "integer", - "format": "int32" - }, - "classification": { - "$ref": "#/components/schemas/WorkplanNodeClassification" - }, - "constructor": { - "$ref": "#/components/schemas/MethodEntry" - }, - "subworkplanId": { - "type": "integer", - "format": "int64" - } - } - } - } - }, - "tags": [ - { - "name": "Common" - }, - { - "name": "Database" - }, - { - "name": "FactoryMonitor" - }, - { - "name": "JobManagement" - }, - { - "name": "MediaServer" - }, - { - "name": "Modules" - }, - { - "name": "NotificationPublisher" - }, - { - "name": "OperatorManagement" - }, - { - "name": "OrderManagement" - }, - { - "name": "ProcessEngine" - }, - { - "name": "ProductManagement" - }, - { - "name": "ResourceModification" - }, - { - "name": "ShiftManagement" - }, - { - "name": "SkillManagement" - }, - { - "name": "Test" - }, - { - "name": "VisualInstructions" - }, - { - "name": "Workplan" - }, - { - "name": "WorkplanEditing" - } - ] -} \ No newline at end of file From dfc66b3d9e5873f8e318a3e34cb2b28e71f07283 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Niggemann?= Date: Fri, 6 Nov 2026 10:37:29 +0100 Subject: [PATCH 10/16] Add launchsettings profile to make it easy to debug the build time behavior --- src/StartProject.Asp/Properties/launchSettings.json | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/StartProject.Asp/Properties/launchSettings.json b/src/StartProject.Asp/Properties/launchSettings.json index 615e1c1f91..508a2959b9 100644 --- a/src/StartProject.Asp/Properties/launchSettings.json +++ b/src/StartProject.Asp/Properties/launchSettings.json @@ -19,6 +19,16 @@ "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "PathBase" } + }, + "Debug ApiSpecGeneration": { + "commandName": "Project", + "commandLineArgs": "--output ..\\..\\schemas --openapi-version OpenApi3_1 --file-name framework-api", + "launchBrowser": true, + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "OpenApiBuildTime" + }, + "dotnetRunMessages": true, + "applicationUrl": "https://localhost:5001" } } } From fd0ac912a757aca942c76eacc6be634b4154f360 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Niggemann?= Date: Sun, 8 Nov 2026 23:44:30 +0100 Subject: [PATCH 11/16] Downgrade Openapi version to 3.0, because of compatibility problems in typescript codegen --- src/Moryx.AspNetCore.OpenApi/OpenApiExtensions.cs | 2 +- src/StartProject.Asp/Program.cs | 5 ++--- src/StartProject.Asp/Properties/launchSettings.json | 2 +- src/StartProject.Asp/StartProject.Asp.csproj | 2 +- 4 files changed, 5 insertions(+), 6 deletions(-) diff --git a/src/Moryx.AspNetCore.OpenApi/OpenApiExtensions.cs b/src/Moryx.AspNetCore.OpenApi/OpenApiExtensions.cs index 3857512b52..3ae593a3a4 100644 --- a/src/Moryx.AspNetCore.OpenApi/OpenApiExtensions.cs +++ b/src/Moryx.AspNetCore.OpenApi/OpenApiExtensions.cs @@ -73,7 +73,7 @@ public async Task WriteYamlOpenApiSpec(string fileName, string path = null, stri using var textWriter = File.CreateText(filePath); var writer = new OpenApiYamlWriter(textWriter); - document.SerializeAsV31(writer); + document.SerializeAsV3(writer); await writer.FlushAsync(); await textWriter.FlushAsync(); } diff --git a/src/StartProject.Asp/Program.cs b/src/StartProject.Asp/Program.cs index 28a25bae19..567fe9cd60 100644 --- a/src/StartProject.Asp/Program.cs +++ b/src/StartProject.Asp/Program.cs @@ -61,10 +61,9 @@ builder.Services.AddOpenApi(static options => { - options.OpenApiVersion = OpenApiSpecVersion.OpenApi3_1; // OpenApi3_2 is only available with .net 11 + options.OpenApiVersion = OpenApiSpecVersion.OpenApi3_0; // OpenApi3_2 is only available with .net 11 options.ConfigureMoryxTransformers(); -} -); +}); builder.Services.AddSingleton(); diff --git a/src/StartProject.Asp/Properties/launchSettings.json b/src/StartProject.Asp/Properties/launchSettings.json index 508a2959b9..90999651ca 100644 --- a/src/StartProject.Asp/Properties/launchSettings.json +++ b/src/StartProject.Asp/Properties/launchSettings.json @@ -22,7 +22,7 @@ }, "Debug ApiSpecGeneration": { "commandName": "Project", - "commandLineArgs": "--output ..\\..\\schemas --openapi-version OpenApi3_1 --file-name framework-api", + "commandLineArgs": "--output ..\\..\\schemas --openapi-version OpenApi3_0 --file-name framework-api", "launchBrowser": true, "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "OpenApiBuildTime" diff --git a/src/StartProject.Asp/StartProject.Asp.csproj b/src/StartProject.Asp/StartProject.Asp.csproj index d4bdac6d44..573303623d 100644 --- a/src/StartProject.Asp/StartProject.Asp.csproj +++ b/src/StartProject.Asp/StartProject.Asp.csproj @@ -21,7 +21,7 @@ true $(MSBuildProjectDirectory)/../../schemas - --openapi-version OpenApi3_1 --file-name framework-api + --openapi-version OpenApi3_0 --file-name framework-api OpenApiBuildTime From 36372a4f8be93f0c7b1247ef596e9b9b104442f0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Niggemann?= Date: Sun, 8 Nov 2026 23:47:04 +0100 Subject: [PATCH 12/16] Add more transformers to fixup the schema --- schemas/framework-api.yaml | 1781 +++++++---------- .../EnumSchemaTransformer.cs | 39 + .../FileStreamSchemaTransformer.cs | 40 + .../MoryxOpenApiDocumentTransformer.cs | 2 +- .../OpenApiExtensions.cs | 7 +- ...veEmptyResponseTypeOperationTransformer.cs | 29 + ... => SetOperationIdOperationTransformer.cs} | 2 +- ...nsformer.cs => SseOperationTransformer.cs} | 2 +- 8 files changed, 841 insertions(+), 1061 deletions(-) create mode 100644 src/Moryx.AspNetCore.OpenApi/EnumSchemaTransformer.cs create mode 100644 src/Moryx.AspNetCore.OpenApi/FileStreamSchemaTransformer.cs create mode 100644 src/Moryx.AspNetCore.OpenApi/RemoveEmptyResponseTypeOperationTransformer.cs rename src/Moryx.AspNetCore.OpenApi/{MoryxOperationIdOperationTransformer.cs => SetOperationIdOperationTransformer.cs} (89%) rename src/Moryx.AspNetCore.OpenApi/{MoryxSseOperationTransformer.cs => SseOperationTransformer.cs} (96%) diff --git a/schemas/framework-api.yaml b/schemas/framework-api.yaml index 218664abb5..fd4228804e 100644 --- a/schemas/framework-api.yaml +++ b/schemas/framework-api.yaml @@ -1,4 +1,4 @@ -openapi: '3.1.1' +openapi: 3.0.4 info: title: StartProject.Asp | v1 version: 1.0.0 @@ -692,8 +692,6 @@ paths: responses: '200': description: OK - content: - application/json: { } '/api/moryx/jobs/{jobId}/abort': post: tags: @@ -709,8 +707,6 @@ paths: responses: '200': description: OK - content: - application/json: { } /api/moryx/jobs/stream: get: tags: @@ -719,8 +715,6 @@ paths: responses: '200': description: OK - content: - application/json: { } /api/moryx/media: get: tags: @@ -1562,8 +1556,6 @@ paths: responses: '200': description: OK - content: - application/json: { } '404': description: Not Found content: @@ -1618,8 +1610,6 @@ paths: responses: '204': description: No Content - content: - application/json: { } '400': description: Bad Request content: @@ -1849,8 +1839,6 @@ paths: responses: '200': description: OK - content: - application/json: { } '400': description: Bad Request content: @@ -1881,8 +1869,6 @@ paths: responses: '200': description: OK - content: - application/json: { } '400': description: Bad Request content: @@ -1903,8 +1889,6 @@ paths: responses: '200': description: OK - content: - application/json: { } /api/moryx/orders: get: tags: @@ -1981,20 +1965,13 @@ paths: text/event-stream: schema: oneOf: - - description: 'Published with type ''Start'': Published when operation has been started' - $ref: '#/components/schemas/SseItemOfOperationStartedModel' - - description: Published with type 'Progress' - $ref: '#/components/schemas/SseItemOfOperationModel' - - description: Published with type 'Completed' - $ref: '#/components/schemas/SseItemOfOperationReportedModel' - - description: Published with type 'Interrupted' - $ref: '#/components/schemas/SseItemOfOperationReportedModel' - - description: Published with type 'Report' - $ref: '#/components/schemas/SseItemOfOperationReportedModel' - - description: Published with type 'Advice' - $ref: '#/components/schemas/SseItemOfOperationAdvicedModel' - - description: Published with type 'Update' - $ref: '#/components/schemas/SseItemOfOperationModel' + - $ref: '#/components/schemas/SseItemOfOperationStartedModel' + - $ref: '#/components/schemas/SseItemOfOperationModel' + - $ref: '#/components/schemas/SseItemOfOperationReportedModel' + - $ref: '#/components/schemas/SseItemOfOperationReportedModel' + - $ref: '#/components/schemas/SseItemOfOperationReportedModel' + - $ref: '#/components/schemas/SseItemOfOperationAdvicedModel' + - $ref: '#/components/schemas/SseItemOfOperationModel' discriminator: propertyName: type mapping: @@ -2209,8 +2186,6 @@ paths: responses: '200': description: OK - content: - application/json: { } '400': description: Bad Request content: @@ -2285,8 +2260,6 @@ paths: responses: '200': description: OK - content: - application/json: { } '400': description: Bad Request content: @@ -2353,8 +2326,6 @@ paths: responses: '200': description: OK - content: - application/json: { } '400': description: Bad Request content: @@ -2429,8 +2400,6 @@ paths: responses: '200': description: OK - content: - application/json: { } '400': description: Bad Request content: @@ -2516,8 +2485,6 @@ paths: responses: '200': description: OK - content: - application/json: { } '400': description: Bad Request content: @@ -2560,8 +2527,6 @@ paths: responses: '200': description: OK - content: - application/json: { } '400': description: Bad Request content: @@ -2591,8 +2556,6 @@ paths: responses: '200': description: OK - content: - application/json: { } '400': description: Bad Request content: @@ -2845,8 +2808,6 @@ paths: responses: '200': description: OK - content: - application/json: { } '404': description: Not Found content: @@ -2868,8 +2829,6 @@ paths: responses: '200': description: OK - content: - application/json: { } '404': description: Not Found content: @@ -3322,8 +3281,6 @@ paths: responses: '200': description: OK - content: - application/json: { } '400': description: Bad Request content: @@ -3555,8 +3512,6 @@ paths: $ref: '#/components/schemas/ProblemDetails' '500': description: Internal Server Error - content: - application/json: { } /api/moryx/resources/query: post: tags: @@ -3664,8 +3619,6 @@ paths: $ref: '#/components/schemas/ProblemDetails' '500': description: Internal Server Error - content: - application/json: { } delete: tags: - ResourceModification @@ -3680,8 +3633,6 @@ paths: responses: '200': description: OK - content: - application/json: { } '400': description: Bad Request content: @@ -3855,8 +3806,6 @@ paths: responses: '200': description: OK - content: - application/json: { } /api/moryx/shifts/filter: get: tags: @@ -3897,8 +3846,6 @@ paths: responses: '200': description: OK - content: - application/json: { } /api/moryx/shifts/types: get: tags: @@ -3955,8 +3902,6 @@ paths: responses: '200': description: OK - content: - application/json: { } '/api/moryx/shifts/types/{id}': delete: tags: @@ -3972,8 +3917,6 @@ paths: responses: '200': description: OK - content: - application/json: { } /api/moryx/shifts/assignements: get: tags: @@ -4030,8 +3973,6 @@ paths: responses: '200': description: OK - content: - application/json: { } /api/moryx/shifts/assignements/filter: get: tags: @@ -4072,8 +4013,6 @@ paths: responses: '200': description: OK - content: - application/json: { } /api/moryx/skills/types: get: tags: @@ -4142,8 +4081,6 @@ paths: responses: '204': description: No Content - content: - application/json: { } '400': description: Bad Request content: @@ -4201,8 +4138,6 @@ paths: responses: '204': description: No Content - content: - application/json: { } '400': description: Bad Request content: @@ -4333,8 +4268,6 @@ paths: responses: '204': description: No Content - content: - application/json: { } '400': description: Bad Request content: @@ -4437,8 +4370,6 @@ paths: responses: '200': description: OK - content: - application/json: { } delete: tags: - VisualInstructions @@ -4464,8 +4395,6 @@ paths: responses: '200': description: OK - content: - application/json: { } '/api/moryx/instructions/{identifier}/response': put: tags: @@ -4492,8 +4421,6 @@ paths: responses: '200': description: OK - content: - application/json: { } '404': description: Not Found content: @@ -4629,8 +4556,6 @@ paths: responses: '200': description: OK - content: - application/json: { } '404': description: Not Found content: @@ -4782,8 +4707,6 @@ paths: responses: '200': description: OK - content: - application/json: { } '/api/moryx/workplans/sessions/{sessionId}/autolayout': get: tags: @@ -5092,6 +5015,12 @@ components: orderReferenceModel: $ref: '#/components/schemas/OrderReferenceModel' ActivityClassification: + enum: + - Unknown + - Production + - Setup + - Maintenance + - Preparation type: string description: "Defines different classifications of activities. A resource will define accepted classifications\r\nin the published ReadyToWork. An activity declares its classification which is compared\r\nto the accepted classification within the kernel. While a ReadyToWork can accept multiple\r\nclassifications (by combining flags), an activity has only one classification." ActivityResourceModel: @@ -5101,9 +5030,8 @@ components: type: integer format: int64 name: - type: - - 'null' - - string + type: string + nullable: true AdviceContext: type: object properties: @@ -5116,17 +5044,15 @@ components: type: object properties: toteBoxNumber: - type: - - 'null' - - string + type: string + nullable: true amount: type: integer format: int32 partId: - type: - - 'null' - - integer + type: integer format: int64 + nullable: true ApiError: required: - errorCode @@ -5134,30 +5060,26 @@ components: type: object properties: errorCode: - type: - - 'null' - - string + type: string + nullable: true message: - type: - - 'null' - - string + type: string + nullable: true exception: $ref: '#/components/schemas/Exception' 'ApiResponseOfProcessHolderGroupModel[]': type: object properties: data: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/ProcessHolderGroupModel' + nullable: true errors: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/ApiError' + nullable: true succeeded: type: boolean timestamp: @@ -5167,64 +5089,50 @@ components: type: object properties: assemblyProduct: - type: - - 'null' - - string + type: string + nullable: true assemblyVersion: - type: - - 'null' - - string + type: string + nullable: true assemblyInformationalVersion: - type: - - 'null' - - string + type: string + nullable: true assemblyDescription: - type: - - 'null' - - string + type: string + nullable: true assemblyCompanyName: - type: - - 'null' - - string + type: string + nullable: true assemblyTitle: - type: - - 'null' - - string + type: string + nullable: true assemblyConfiguration: - type: - - 'null' - - string + type: string + nullable: true targetFramework: - type: - - 'null' - - string + type: string + nullable: true assemblyCopyright: - type: - - 'null' - - string + type: string + nullable: true assemblyTrademark: - type: - - 'null' - - string + type: string + nullable: true AssemblyModel: type: object properties: name: - type: - - 'null' - - string + type: string + nullable: true version: - type: - - 'null' - - string + type: string + nullable: true fileVersion: - type: - - 'null' - - string + type: string + nullable: true informationalVersion: - type: - - 'null' - - string + type: string + nullable: true AssignableOperator: required: - identifier @@ -5239,37 +5147,64 @@ components: identifier: type: string firstName: - type: - - 'null' - - string + type: string + nullable: true lastName: - type: - - 'null' - - string + type: string + nullable: true pseudonym: - type: - - 'null' - - string + type: string + nullable: true AssignedDays: + enum: + - All + - First + - Second + - Third + - Fourth + - Fifth + - Sixth + - Seventh + - Eighth + - Ninth + - Tenth + - Eleventh + - Twelfth + - Thirteenth + - Fourteenth + - Fifteenth + - Sixteenth + - Seventeenth + - Eighteenth + - Nineteenth + - Twentieth + - TwentyFirst + - TwentySecond + - TwentyThird + - TwentyFourth + - TwentyFifth + - TwentySixth + - TwentySeventh + - TwentyEighth + - TwentyNinth + - Thirtieth + - ThirtyFirst type: string AttendableResourceModel: type: object properties: id: - type: - - 'null' - - integer + type: integer format: int64 + nullable: true name: - type: - - 'null' - - string + type: string + nullable: true requiredSkills: - type: - - 'null' - - array + type: array items: type: string + nullable: true BeginContext: type: object properties: @@ -5292,12 +5227,11 @@ components: type: boolean description: Indicator if an adjustment of the operation is possible restrictions: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/RestrictionDescription' description: Reasons why a begin is not possible + nullable: true successCount: type: integer description: Current success count of the operation @@ -5314,13 +5248,13 @@ components: type: integer format: int32 userId: - type: - - 'null' - - string + type: string + nullable: true Category: enum: - ProcessHolderGroup - ParentResource + type: string CellLocationModel: type: object properties: @@ -5337,37 +5271,33 @@ components: type: object properties: valueUnit: - type: - - 'null' - - string + type: string + nullable: true iconName: - type: - - 'null' - - string + type: string + nullable: true isDisplayed: type: boolean currentValue: { } displayName: - type: - - 'null' - - string + type: string + nullable: true CellSettingsModel: type: object properties: image: - type: - - 'null' - - string + type: string + nullable: true icon: - type: - - 'null' - - string + type: string + nullable: true CellState: enum: - Idle - Requested - Running - NotReadyToWork + type: string CellStateChangedModel: type: object properties: @@ -5386,10 +5316,12 @@ components: - OnlySave - SaveAndReincarnate - UpdateLiveAndSave + type: string ConfirmationType: enum: - Partial - Final + type: string description: Confirmation type while reporting amounts of an operation ContentDescriptorModel: type: object @@ -5398,99 +5330,85 @@ components: type: string format: uuid name: - type: - - 'null' - - string + type: string + nullable: true variants: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/VariantDescriptor' + nullable: true master: $ref: '#/components/schemas/VariantDescriptor' DatabaseConfigModel: type: object properties: configuratorType: - type: - - 'null' - - string + type: string + nullable: true connectionString: - type: - - 'null' - - string + type: string + nullable: true properties: $ref: '#/components/schemas/Entry' DatabaseMigrationSummary: type: object properties: result: - description: Flag that any updates were performed $ref: '#/components/schemas/MigrationResult' errors: - type: - - 'null' - - array + type: array items: type: string description: 'Reason, in case an error occured during migration' + nullable: true executedMigrations: - type: - - 'null' - - array + type: array items: type: string description: All updates that were executed + nullable: true description: Result object created from running a database update DatabasesResponse: type: object properties: databases: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/DataModel' + nullable: true configurators: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/ModelConfiguratorModel' + nullable: true DataModel: type: object properties: targetModel: - type: - - 'null' - - string + type: string + nullable: true config: $ref: '#/components/schemas/DatabaseConfigModel' possibleConfigurators: - type: - - 'null' - - array + type: array items: type: string + nullable: true setups: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/SetupModel' + nullable: true availableMigrations: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/DbMigrationsModel' + nullable: true appliedMigrations: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/DbMigrationsModel' + nullable: true DataType: enum: - Custom @@ -5510,13 +5428,13 @@ components: - CreditCard - PostalCode - Upload + type: string DbMigrationsModel: type: object properties: name: - type: - - 'null' - - string + type: string + nullable: true DependencyEvaluation: type: object properties: @@ -5536,96 +5454,73 @@ components: type: object properties: identifier: - type: - - 'null' - - string + type: string + nullable: true number: - type: - - 'null' - - string + type: string + nullable: true revision: type: integer format: int16 type: - type: - - 'null' - - string + type: string + nullable: true description: - type: - - 'null' - - string + type: string + nullable: true contentType: - type: - - 'null' - - string + type: string + nullable: true source: - type: - - 'null' - - string - EntityTagHeaderValue: - type: object - properties: - tag: - $ref: '#/components/schemas/StringSegment' - isWeak: - type: boolean + type: string + nullable: true Entry: type: object properties: displayName: - type: - - 'null' - - string + type: string description: Name of the item - property name or list item name + nullable: true identifier: - type: - - 'null' - - string + type: string description: Unique identifier - property name or item index + nullable: true description: - type: - - 'null' - - string + type: string description: Description of the entry + nullable: true value: - description: Value of the entry $ref: '#/components/schemas/EntryValue' validation: - description: Validation information $ref: '#/components/schemas/EntryValidation' subEntries: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/Entry' description: Subentries of this entry - properties or list items + nullable: true prototypes: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/Entry' description: Prototypes that can be used to create subentries + nullable: true description: Model class representing a single property of a config class EntryPossible: type: object properties: key: - type: - - 'null' - - string + type: string description: Invariant key of the possible value. + nullable: true displayName: - type: - - 'null' - - string + type: string description: Display name of the possible value. + nullable: true description: - type: - - 'null' - - string + type: string description: Description of the possible value. + nullable: true description: Possible value for an entry. EntryUnitType: enum: @@ -5635,12 +5530,12 @@ components: - DirectoryPath - Flags - Base64 + type: string description: Enum describes the unit type of a entry EntryValidation: type: object properties: dataType: - description: Logical data types that may appear $ref: '#/components/schemas/DataType' minimum: type: number @@ -5651,10 +5546,9 @@ components: description: Maximum value or maximal length of strings format: double regex: - type: - - 'null' - - string + type: string description: Regex pattern for this entry + nullable: true isRequired: type: boolean description: Indicated if the field is required and should not be empty @@ -5663,28 +5557,23 @@ components: type: object properties: type: - description: Type of this entry $ref: '#/components/schemas/EntryValueType' unitType: - description: Unit type of this entry $ref: '#/components/schemas/EntryUnitType' current: - type: - - 'null' - - string + type: string description: Current value of this entry + nullable: true default: - type: - - 'null' - - string + type: string description: Default value of this entry + nullable: true possible: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/EntryPossible' description: Possible values for this entry + nullable: true isReadOnly: type: boolean description: Indicates wether the field is read only @@ -5712,6 +5601,7 @@ components: - Date - Time - TimeSpan + type: string description: Possible value types Exception: type: object @@ -5719,30 +5609,25 @@ components: targetSite: $ref: '#/components/schemas/MethodBase' message: - type: - - 'null' - - string + type: string + nullable: true data: - type: - - 'null' - - object + type: object + nullable: true innerException: $ref: '#/components/schemas/Exception' helpLink: - type: - - 'null' - - string + type: string + nullable: true source: - type: - - 'null' - - string + type: string + nullable: true hResult: type: integer format: int32 stackTrace: - type: - - 'null' - - string + type: string + nullable: true ExecuteSetupRequest: type: object properties: @@ -5754,27 +5639,22 @@ components: type: object properties: assignedResources: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/AttendableResourceModel' + nullable: true identifier: - type: - - 'null' - - string + type: string + nullable: true firstName: - type: - - 'null' - - string + type: string + nullable: true lastName: - type: - - 'null' - - string + type: string + nullable: true pseudonym: - type: - - 'null' - - string + type: string + nullable: true FactoryModel: type: object properties: @@ -5785,84 +5665,58 @@ components: type: integer format: int64 backgroundURL: - type: - - 'null' - - string + type: string + nullable: true title: - type: - - 'null' - - string + type: string + nullable: true FactoryStateModel: type: object properties: backgroundURL: - type: - - 'null' - - string + type: string + nullable: true hasManufacturingFactory: type: boolean orderModels: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/OrderModel' + nullable: true activityChangedModels: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/ActivityChangedModel' + nullable: true cellStateChangedModels: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/CellStateChangedModel' + nullable: true resourceChangedModels: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/ResourceChangedModel' + nullable: true id: type: integer format: int64 location: $ref: '#/components/schemas/CellLocationModel' iconName: - type: - - 'null' - - string + type: string + nullable: true isACell: type: boolean FailureBehaviour: + enum: + - Stop + - StopAndNotify type: string description: 'Enum flags: Notify - Reincarnate' FileStreamResult: - type: object - properties: - fileStream: - $ref: '#/components/schemas/Stream' - contentType: - type: - - 'null' - - string - fileDownloadName: - type: - - 'null' - - string - lastModified: - type: - - 'null' - - string - format: date-time - entityTag: - oneOf: - - type: 'null' - - $ref: '#/components/schemas/EntityTagHeaderValue' - enableRangeProcessing: - type: boolean + type: string + format: binary Foo: type: object properties: @@ -5873,13 +5727,11 @@ components: type: object properties: machineName: - type: - - 'null' - - string + type: string + nullable: true osInformation: - type: - - 'null' - - string + type: string + nullable: true upTime: type: integer format: int64 @@ -5898,19 +5750,18 @@ components: - Unknown - Text - Media + type: string InstructionItemModel: type: object properties: contentType: $ref: '#/components/schemas/InstructionContentType' content: - type: - - 'null' - - string + type: string + nullable: true preview: - type: - - 'null' - - string + type: string + nullable: true InstructionModel: type: object properties: @@ -5918,25 +5769,22 @@ components: type: integer format: int64 sender: - type: - - 'null' - - string + type: string + nullable: true type: $ref: '#/components/schemas/InstructionType' items: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/InstructionItemModel' + nullable: true inputs: $ref: '#/components/schemas/Entry' results: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/InstructionResultModel' + nullable: true InstructionResponseModel: type: object properties: @@ -5946,26 +5794,24 @@ components: inputs: $ref: '#/components/schemas/Entry' result: - type: - - 'null' - - string + type: string + nullable: true selectedResult: $ref: '#/components/schemas/InstructionResultModel' InstructionResultModel: type: object properties: key: - type: - - 'null' - - string + type: string + nullable: true displayValue: - type: - - 'null' - - string + type: string + nullable: true InstructionType: enum: - Display - Execute + type: string InternalOperationClassification: enum: - Initial @@ -5978,19 +5824,18 @@ components: - Interrupted - Completed - AmountReached + type: string InvocationResponse: type: object properties: success: type: boolean exceptionType: - type: - - 'null' - - string + type: string + nullable: true errorMessage: - type: - - 'null' - - string + type: string + nullable: true IOperatorAssignable: type: object properties: @@ -6001,12 +5846,10 @@ components: description: Id of the resource format: int64 name: - type: - - 'null' - - string + type: string description: Name of this resource instance + nullable: true capabilities: - description: The resource's capabilities $ref: '#/components/schemas/ICapabilities' JobModel: type: object @@ -6018,17 +5861,14 @@ components: type: integer format: int64 state: - type: - - 'null' - - string + type: string + nullable: true displayState: - type: - - 'null' - - string + type: string + nullable: true workplan: - type: - - 'null' - - string + type: string + nullable: true canComplete: type: boolean canAbort: @@ -6061,11 +5901,10 @@ components: type: string format: date-time activities: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/ProcessActivityModel' + nullable: true isRunning: type: boolean LogLevel: @@ -6077,30 +5916,27 @@ components: - Error - Critical - None + type: string MethodBase: { } MethodEntry: type: object properties: name: - type: - - 'null' - - string + type: string description: Name of the method + nullable: true isConstructor: type: boolean description: Flag if this structure represents a server side constructor displayName: - type: - - 'null' - - string + type: string description: Display name for the button + nullable: true description: - type: - - 'null' - - string + type: string description: Description of the method + nullable: true parameters: - description: Arguments of the $ref: '#/components/schemas/Entry' isAsync: type: boolean @@ -6111,28 +5947,25 @@ components: - Migrated - NoMigrationsAvailable - Error + type: string description: Result enum for executing database migrations ModelConfiguratorModel: type: object properties: name: - type: - - 'null' - - string + type: string + nullable: true configuratorType: - type: - - 'null' - - string + type: string + nullable: true connectionStringKeys: - type: - - 'null' - - object + type: object additionalProperties: type: string + nullable: true connectionStringPrototype: - type: - - 'null' - - string + type: string + nullable: true configPrototype: $ref: '#/components/schemas/Entry' ModuleNotificationModel: @@ -6144,9 +5977,8 @@ components: exception: $ref: '#/components/schemas/SerializableException' message: - type: - - 'null' - - string + type: string + nullable: true severity: $ref: '#/components/schemas/Severity' ModuleStartBehaviour: @@ -6154,18 +5986,17 @@ components: - Auto - Manual - OnDependency + type: string description: Start behaviour MoryxExceptionResponse: type: object properties: title: - type: - - 'null' - - string + type: string + nullable: true exception: - type: - - 'null' - - string + type: string + nullable: true NodeConnectionPoint: type: object properties: @@ -6173,15 +6004,13 @@ components: type: integer format: int32 name: - type: - - 'null' - - string + type: string + nullable: true connections: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/NodeConnector' + nullable: true NodeConnector: type: object properties: @@ -6198,39 +6027,33 @@ components: type: string format: uuid type: - type: - - 'null' - - string + type: string + nullable: true title: - type: - - 'null' - - string + type: string + nullable: true message: - type: - - 'null' - - string + type: string + nullable: true severity: $ref: '#/components/schemas/Severity' created: type: string format: date-time acknowledged: - type: - - 'null' - - string + type: string format: date-time + nullable: true isAcknowledgable: type: boolean properties: $ref: '#/components/schemas/Entry' sender: - type: - - 'null' - - string + type: string + nullable: true source: - type: - - 'null' - - string + type: string + nullable: true OpenSessionRequest: type: object properties: @@ -6254,34 +6077,29 @@ components: description: The amount to produce format: int32 name: - type: - - 'null' - - string + type: string description: Operation name + nullable: true orderNumber: - type: - - 'null' - - string + type: string description: The number of the order this operation belongs to + nullable: true operationNumber: - type: - - 'null' - - string + type: string description: The number of this operation + nullable: true productIdentifier: - type: - - 'null' - - string + type: string description: Main product identifier + nullable: true productRevision: type: integer description: Revision of the Product format: int16 productName: - type: - - 'null' - - string + type: string description: Name of the Product + nullable: true recipePreselection: type: integer description: Id of the preselected recipe @@ -6307,42 +6125,36 @@ components: description: Target cycle time for the production of the depending product format: double unit: - type: - - 'null' - - string + type: string description: Unit of product + nullable: true targetStock: - type: - - 'null' - - string + type: string description: Target stock for produced parts + nullable: true parts: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/PartCreationContext' description: Part list of the product of this operation + nullable: true materialParameters: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/Entry' description: Additional operation depending parameters for the production + nullable: true OperationLogMessageModel: type: object properties: logLevel: $ref: '#/components/schemas/LogLevel' message: - type: - - 'null' - - string + type: string + nullable: true exception: - type: - - 'null' - - string + type: string + nullable: true timeStamp: type: string format: date-time @@ -6356,13 +6168,11 @@ components: type: integer format: int32 number: - type: - - 'null' - - string + type: string + nullable: true name: - type: - - 'null' - - string + type: string + nullable: true overDeliveryAmount: type: integer format: int32 @@ -6376,67 +6186,57 @@ components: type: string format: date-time start: - type: - - 'null' - - string + type: string format: date-time + nullable: true end: - type: - - 'null' - - string + type: string format: date-time + nullable: true targetCycleTime: type: number format: double unit: - type: - - 'null' - - string + type: string + nullable: true sortOrder: type: integer format: int32 order: - type: - - 'null' - - string + type: string + nullable: true classification: $ref: '#/components/schemas/OperationStateClassification' stateDisplayName: - type: - - 'null' - - string + type: string + nullable: true productId: type: integer format: int64 productIdentifier: - type: - - 'null' - - string + type: string + nullable: true productRevision: type: integer format: int16 productName: - type: - - 'null' - - string + type: string + nullable: true recipeName: - type: - - 'null' - - string + type: string + nullable: true recipeIds: - type: - - 'null' - - array + type: array items: type: integer format: int64 + nullable: true jobIds: - type: - - 'null' - - array + type: array items: type: integer format: int64 + nullable: true reportedSuccessCount: type: integer format: int32 @@ -6501,9 +6301,8 @@ components: type: integer format: int64 name: - type: - - 'null' - - string + type: string + nullable: true OperationReportedModel: type: object properties: @@ -6515,116 +6314,112 @@ components: type: object properties: userId: - type: - - 'null' - - string + type: string + nullable: true operationModel: $ref: '#/components/schemas/OperationModel' OperationStateClassification: + enum: + - Initial + - Assigning + - Failed + - Aborted + - Ready + - Running + - Interrupting + - Interrupted + - Completed + - CanReload + - CanBegin + - CanInterrupt + - CanReport + - CanAdvice + - IsAmountReached type: string description: "Enum providing the classification of the internal state machine of the operation for an external representation\r\nThe lowest 8 bits define the state of the operation. The following 16 bits contain flags for the executable\r\nactions on the operation and the trailing 8 bits overall classification information.\r\nBit: 31 - 24 | 23 - 8 | 7 - 0 |\r\nFlag: Overall | Usage | State |" OperationUpdateModel: type: object properties: sortIndex: - type: - - 'null' - - integer + type: integer format: int32 + nullable: true plannedStart: - type: - - 'null' - - string + type: string format: date-time + nullable: true plannedEnd: - type: - - 'null' - - string + type: string format: date-time + nullable: true totalAmount: - type: - - 'null' - - integer + type: integer format: int32 + nullable: true overDeliveryAmount: - type: - - 'null' - - integer + type: integer format: int32 + nullable: true underDeliveryAmount: - type: - - 'null' - - integer + type: integer format: int32 + nullable: true targetCycleTime: - type: - - 'null' - - number + type: number format: double + nullable: true targetStock: - type: - - 'null' - - string + type: string + nullable: true OperatorModel: type: object properties: identifier: - type: - - 'null' - - string + type: string + nullable: true firstName: - type: - - 'null' - - string + type: string + nullable: true lastName: - type: - - 'null' - - string + type: string + nullable: true pseudonym: - type: - - 'null' - - string + type: string + nullable: true OrderChangedModel: type: object properties: order: - type: - - 'null' - - string + type: string + nullable: true operation: - type: - - 'null' - - string + type: string + nullable: true state: $ref: '#/components/schemas/InternalOperationClassification' OrderModel: type: object properties: color: - type: - - 'null' - - string + type: string + nullable: true order: - type: - - 'null' - - string + type: string + nullable: true operation: - type: - - 'null' - - string + type: string + nullable: true state: $ref: '#/components/schemas/InternalOperationClassification' OrderReferenceModel: type: object properties: order: - type: - - 'null' - - string + type: string + nullable: true operation: - type: - - 'null' - - string + type: string + nullable: true PartClassification: enum: - Unknown @@ -6633,58 +6428,50 @@ components: - CarrierMaterial - ScrapMaterial - BranchMaterial + type: string PartConnector: type: object properties: name: - type: - - 'null' - - string + type: string + nullable: true displayName: - type: - - 'null' - - string + type: string + nullable: true type: - type: - - 'null' - - string + type: string + nullable: true isCollection: type: boolean parts: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/PartModel' + nullable: true propertyTemplates: $ref: '#/components/schemas/Entry' PartCreationContext: type: object properties: name: - type: - - 'null' - - string + type: string description: Name of the part like the product name + nullable: true number: - type: - - 'null' - - string + type: string description: Identifier of this part + nullable: true quantity: type: number description: Quantity of this part which are necessary to produce one product format: double unit: - type: - - 'null' - - string + type: string description: Unit of the quantity + nullable: true stagingIndicator: - description: Staging indicator $ref: '#/components/schemas/StagingIndicator' classification: - description: Classification of this part $ref: '#/components/schemas/PartClassification' description: Information about a part of the product which should be produced for an operation PartModel: @@ -6710,20 +6497,16 @@ components: type: object properties: state: - description: Current state of the preview $ref: '#/components/schemas/PreviewState' fileHash: - type: - - 'null' - - string + type: string + nullable: true extension: - type: - - 'null' - - string + type: string + nullable: true mimeType: - type: - - 'null' - - string + type: string + nullable: true size: type: integer format: int64 @@ -6735,31 +6518,27 @@ components: - Failed - Unsupported - Removed + type: string description: State of the preview ProblemDetails: type: object properties: type: - type: - - 'null' - - string + type: string + nullable: true title: - type: - - 'null' - - string + type: string + nullable: true status: - type: - - 'null' - - integer + type: integer format: int32 + nullable: true detail: - type: - - 'null' - - string + type: string + nullable: true instance: - type: - - 'null' - - string + type: string + nullable: true ProcessActivityModel: type: object properties: @@ -6769,39 +6548,32 @@ components: resource: $ref: '#/components/schemas/ActivityResourceModel' type: - type: - - 'null' - - string + type: string + nullable: true state: - type: - - 'null' - - string + type: string + nullable: true classification: $ref: '#/components/schemas/ActivityClassification' requiredCapabilities: - type: - - 'null' - - string + type: string + nullable: true possibleResources: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/ActivityResourceModel' + nullable: true result: - type: - - 'null' - - integer + type: integer format: int64 + nullable: true resultName: - type: - - 'null' - - string + type: string + nullable: true instanceId: - type: - - 'null' - - integer + type: integer format: int64 + nullable: true tracing: $ref: '#/components/schemas/TracingModel' isCompleted: @@ -6813,17 +6585,15 @@ components: type: integer format: int64 name: - type: - - 'null' - - string + type: string + nullable: true isEmpty: type: boolean positions: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/ProcessHolderPositionModel' + nullable: true visualization: $ref: '#/components/schemas/VisualizationModel' ProcessHolderPositionModel: @@ -6836,24 +6606,20 @@ components: type: integer format: int64 name: - type: - - 'null' - - string + type: string + nullable: true position: type: integer format: int32 activity: - type: - - 'null' - - string + type: string + nullable: true order: - type: - - 'null' - - string + type: string + nullable: true process: - type: - - 'null' - - string + type: string + nullable: true isEmpty: type: boolean ProcessProgress: @@ -6862,52 +6628,46 @@ components: - Running - Interrupted - Completed + type: string description: Enum representing the progress of a process within the kernel ProductCustomization: type: object properties: productTypes: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/ProductDefinitionModel' + nullable: true recipeTypes: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/RecipeDefinitionModel' + nullable: true importers: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/ProductImporter' + nullable: true ProductDefinitionModel: type: object properties: name: - type: - - 'null' - - string + type: string + nullable: true displayName: - type: - - 'null' - - string + type: string + nullable: true baseDefinition: - type: - - 'null' - - string + type: string + nullable: true properties: $ref: '#/components/schemas/Entry' ProductImporter: type: object properties: name: - type: - - 'null' - - string + type: string + nullable: true parameters: $ref: '#/components/schemas/Entry' ProductInstanceModel: @@ -6917,25 +6677,28 @@ components: type: integer format: int64 type: - type: - - 'null' - - string + type: string description: The name of the product type of this instance + nullable: true state: - description: The current state of the instance $ref: '#/components/schemas/ProductInstanceState' properties: $ref: '#/components/schemas/Entry' ProductInstanceState: + enum: + - Unset + - InProduction + - Paused + - Success + - Failure type: string description: "The state of an ProductInstance.\r\nThis will not occupy more than 4 Bits. Other enums can be added by bit-shifting" ProductionJobModel: type: object properties: productIdentity: - type: - - 'null' - - string + type: string + nullable: true amount: type: integer format: int32 @@ -6958,36 +6721,31 @@ components: type: integer format: int64 name: - type: - - 'null' - - string + type: string + nullable: true state: $ref: '#/components/schemas/ProductState' identifier: - type: - - 'null' - - string + type: string + nullable: true revision: type: integer format: int16 type: - type: - - 'null' - - string + type: string + nullable: true properties: $ref: '#/components/schemas/Entry' parts: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/PartConnector' + nullable: true recipes: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/RecipeModel' + nullable: true ProductPartModel: type: object properties: @@ -6995,20 +6753,17 @@ components: type: integer format: int64 name: - type: - - 'null' - - string + type: string + nullable: true identifier: - type: - - 'null' - - string + type: string + nullable: true quantity: type: number format: double unit: - type: - - 'null' - - string + type: string + nullable: true stagingIndicator: $ref: '#/components/schemas/StagingIndicator' classification: @@ -7020,63 +6775,60 @@ components: type: boolean description: Flag if deleted products should be included in the query typeName: - type: - - 'null' - - string + type: string description: Product types to filter by + nullable: true excludeDerivedTypes: type: boolean description: When filtering by type exclude derived types and only return specific matches identifier: - type: - - 'null' - - string + type: string description: Material identifiers + nullable: true requiredState: oneOf: - - type: 'null' - - description: State of the product - $ref: '#/components/schemas/ProductState' + - enum: + - null + nullable: true + - $ref: '#/components/schemas/ProductState' revisionFilter: - description: Revisions to filter $ref: '#/components/schemas/RevisionFilter' name: - type: - - 'null' - - string + type: string description: Material identifiers + nullable: true revision: type: integer description: "Optional specific revision if RevisionFilter ProductQuery.RevisionFilter is set to\r\nRevisionFilter.Specific" format: int16 recipeFilter: - description: Optional recipe filter $ref: '#/components/schemas/RecipeFilter' selector: - description: Selector $ref: '#/components/schemas/Selector' propertyFilters: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/PropertyFilter' description: List of property filters + nullable: true loadFullTypeInformation: type: boolean description: "If set to true, product queries return fully populated product types.\r\nOtherwise only the basic type information is returned." description: Filter to fetch products from the product management ProductState: + enum: + - Created + - Released + - Deprecated + - Generated type: string description: Current state of a product PropertyFilter: type: object properties: entry: - description: Entry to filter $ref: '#/components/schemas/Entry' operator: - description: Operator for the filter expression $ref: '#/components/schemas/PropertyFilterOperator' description: Property filter wrapper for the filtered entry PropertyFilterOperator: @@ -7084,6 +6836,7 @@ components: - Equals - GreaterThen - LessThen + type: string description: Property filter operator expression RecipeClassificationModel: enum: @@ -7092,18 +6845,17 @@ components: - Alternative - Intermediate - Part + type: string description: Webservice compatible recipe classification enum RecipeDefinitionModel: type: object properties: name: - type: - - 'null' - - string + type: string + nullable: true displayName: - type: - - 'null' - - string + type: string + nullable: true hasWorkplans: type: boolean RecipeFilter: @@ -7111,6 +6863,7 @@ components: - Unset - WithRecipe - WithoutRecipes + type: string description: Different options regarding the recipes of the product RecipeModel: type: object @@ -7120,30 +6873,24 @@ components: description: Id of the recipe format: int64 name: - type: - - 'null' - - string + type: string description: Name of the recipe + nullable: true state: - description: This recipe's state $ref: '#/components/schemas/RecipeState' revision: type: integer description: Revision of the recipe format: int32 type: - type: - - 'null' - - string + type: string description: Type of the recipe + nullable: true properties: - description: Properties of the recipe $ref: '#/components/schemas/Entry' workplanModel: - description: A model of the currently referenced workplan $ref: '#/components/schemas/WorkplanModel' classification: - description: Classification of the recipe $ref: '#/components/schemas/RecipeClassificationModel' isClone: type: boolean @@ -7154,61 +6901,52 @@ components: - New - Released - Revoked + type: string description: A Recipe's state ReferenceFilter: type: object properties: name: - type: - - 'null' - - string + type: string description: Name of the reference + nullable: true relationType: - description: Resource relation type $ref: '#/components/schemas/ResourceRelationType' role: - description: Role of the reference $ref: '#/components/schemas/ResourceReferenceRole' valueConstraint: - description: Filter criteria for the reference property $ref: '#/components/schemas/ReferenceValue' description: Filter criteria for required or requested references ReferenceTypeModel: type: object properties: name: - type: - - 'null' - - string + type: string description: 'Name of the reference, usually name of the property' + nullable: true isCollection: type: boolean description: Flag if this reference is a collection displayName: - type: - - 'null' - - string + type: string description: Display name of the reference + nullable: true description: - type: - - 'null' - - string + type: string description: Description of this reference + nullable: true isRequired: type: boolean description: Reference is required and must be set supportedTypes: - type: - - 'null' - - array + type: array items: type: string description: Types that can be assigned to this reference + nullable: true role: - description: Role of the referenced resource in the relationship $ref: '#/components/schemas/ResourceReferenceRole' relationType: - description: Type of resource relation $ref: '#/components/schemas/ResourceRelationType' description: Type model for a reference property on a resource type ReferenceValue: @@ -7216,6 +6954,7 @@ components: - Irrelevant - NullOrEmpty - NotEmpty + type: string description: Enum to classify the current value of the reference property ReportContext: type: object @@ -7243,12 +6982,11 @@ components: description: Value of unreported failure parts format: int32 restrictions: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/RestrictionDescription' description: Reasons why a report is not possible + nullable: true successCount: type: integer description: Current success count of the operation @@ -7264,9 +7002,8 @@ components: confirmationType: $ref: '#/components/schemas/ConfirmationType' comment: - type: - - 'null' - - string + type: string + nullable: true successCount: type: integer format: int32 @@ -7274,44 +7011,38 @@ components: type: integer format: int32 userIdentifier: - type: - - 'null' - - string + type: string + nullable: true ResourceChangedModel: type: object properties: cellName: - type: - - 'null' - - string + type: string + nullable: true cellIconName: - type: - - 'null' - - string + type: string + nullable: true cellImageURL: - type: - - 'null' - - string + type: string + nullable: true id: type: integer format: int64 cellLocation: $ref: '#/components/schemas/CellLocationModel' cellPropertySettings: - type: - - 'null' - - object + type: object additionalProperties: $ref: '#/components/schemas/CellPropertySettings' + nullable: true factoryId: type: integer format: int64 location: $ref: '#/components/schemas/CellLocationModel' iconName: - type: - - 'null' - - string + type: string + nullable: true isACell: type: boolean ResourceModel: @@ -7326,136 +7057,133 @@ components: description: Reference id in case of recursion in the returned model format: int64 name: - type: - - 'null' - - string + type: string description: Name of the resource. + nullable: true description: - type: - - 'null' - - string + type: string description: Description of the resource + nullable: true type: - type: - - 'null' - - string + type: string description: Resource type model reference + nullable: true partiallyLoaded: type: boolean description: "Indicates that this model does not represent the full\r\nresource but only its key properties" properties: - description: A list of configs of the resource. $ref: '#/components/schemas/Entry' methods: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/MethodEntry' description: User callable methods for instances of this type + nullable: true references: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/ResourceReferenceModel' description: 'References of this resource, including children' + nullable: true description: Base model used by details view and tree ResourceQuery: type: object properties: types: - type: - - 'null' - - array + type: array items: type: string description: Type constraints to filter instances + nullable: true referenceCondition: - description: Reference condition to filter instances $ref: '#/components/schemas/ReferenceFilter' referenceRecursion: type: boolean description: Flag if included references should be processed recursively includedReferences: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/ReferenceFilter' description: References that should be included in the response + nullable: true description: Filter object to fetch resources from the server ResourceReferenceModel: type: object properties: name: - type: - - 'null' - - string + type: string description: 'Name of the reference, usually name of the property' + nullable: true targets: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/ResourceModel' description: Targets of this reference + nullable: true description: DTO that represents the reference of one resource with another ResourceReferenceRole: enum: - Target - Source + type: string description: Role of a resource in a relation decorated with the ResourceReferenceAttribute ResourceRelationType: + enum: + - Unset + - Aggregation + - Composition + - Usage + - ParentChild + - Driver + - TransportSystem + - TransportRoute + - CurrentExchangeablePart + - PossibleExchangeablePart + - Decorated + - Extension + - Custom type: string description: "Enum representing the relation between two entities and definition of their life cycle coupling.\r\nThe lowest 3 bits define the UML association type. The other 29 bits are for free use\r\nBit: 31 - 3 | 2 | 1 | 0\r\nFlag: Type | Usage | Composition | Aggregation\r\nUsage: Pick a number and bitshift it by 3 and add the UML type, e.g. 42 => (42 << 3) + 1" ResourceTypeModel: type: object properties: name: - type: - - 'null' - - string + type: string description: The name of the resource type. + nullable: true displayName: - type: - - 'null' - - string + type: string description: Display name of this resource type + nullable: true creatable: type: boolean description: Flag that this type is registered and can be instantiated description: - type: - - 'null' - - string + type: string description: Description of this resource type + nullable: true constructors: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/MethodEntry' description: Resource constructors used to build new instances + nullable: true references: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/ReferenceTypeModel' description: Reference properties of this type + nullable: true baseType: - type: - - 'null' - - string + type: string description: Back reference to the base type + nullable: true derivedTypes: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/ResourceTypeModel' description: Types derived from this type + nullable: true description: Type item for the tree RestrictionDescription: required: @@ -7464,12 +7192,10 @@ components: type: object properties: text: - type: - - 'null' - - string + type: string description: Description of the result + nullable: true severity: - description: Severity of the result $ref: '#/components/schemas/RestrictionSeverity' description: Description of the result of a performed rule RestrictionSeverity: @@ -7477,12 +7203,14 @@ components: - Info - Warning - Error + type: string description: Severity of a rule result RevisionFilter: enum: - All - Latest - Specific + type: string description: Filter for revisions SaveConfigRequest: type: object @@ -7496,31 +7224,28 @@ components: - Direct - Parent - Parts + type: string description: Determine which objects to select for the query SerializableException: type: object properties: exceptionTypeName: - type: - - 'null' - - string + type: string + nullable: true message: - type: - - 'null' - - string + type: string + nullable: true stackTrace: - type: - - 'null' - - string + type: string + nullable: true innerException: $ref: '#/components/schemas/SerializableException' ServerModuleModel: type: object properties: name: - type: - - 'null' - - string + type: string + nullable: true healthState: $ref: '#/components/schemas/ServerModuleState' startBehaviour: @@ -7528,17 +7253,15 @@ components: failureBehaviour: $ref: '#/components/schemas/FailureBehaviour' dependencies: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/ServerModuleModel' + nullable: true notifications: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/ModuleNotificationModel' + nullable: true assembly: $ref: '#/components/schemas/AssemblyModel' ServerModuleState: @@ -7551,20 +7274,21 @@ components: - Missing - Running - Stopping + type: string description: Different health states a server module can have ServerTimeResponse: type: object properties: serverTime: - type: - - 'null' - - string + type: string + nullable: true SetupJobClassification: enum: - None - Prepare - Cleanup - Manual + type: string SetupJobModel: type: object properties: @@ -7574,44 +7298,37 @@ components: type: integer format: int64 steps: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/SetupStepModel' + nullable: true SetupModel: type: object properties: fullname: - type: - - 'null' - - string + type: string + nullable: true sortOrder: type: integer format: int32 name: - type: - - 'null' - - string + type: string + nullable: true description: - type: - - 'null' - - string + type: string + nullable: true supportedFileRegex: - type: - - 'null' - - string + type: string + nullable: true setupData: - type: - - 'null' - - string + type: string + nullable: true SetupStepModel: type: object properties: name: - type: - - 'null' - - string + type: string + nullable: true state: $ref: '#/components/schemas/StepState' Severity: @@ -7620,6 +7337,7 @@ components: - Warning - Error - Fatal + type: string description: Different levels to differentiate the severity of a message ShiftAssignementCreationContextModel: type: object @@ -7631,13 +7349,11 @@ components: type: integer format: int64 operatorIdentifier: - type: - - 'null' - - string + type: string + nullable: true note: - type: - - 'null' - - string + type: string + nullable: true priority: type: integer format: int32 @@ -7653,16 +7369,14 @@ components: type: integer format: int64 operatorIdentifier: - type: - - 'null' - - string + type: string + nullable: true shiftId: type: integer format: int64 note: - type: - - 'null' - - string + type: string + nullable: true priority: type: integer format: int32 @@ -7693,9 +7407,8 @@ components: type: object properties: name: - type: - - 'null' - - string + type: string + nullable: true startTime: type: string format: time @@ -7712,9 +7425,8 @@ components: type: integer format: int64 name: - type: - - 'null' - - string + type: string + nullable: true startTime: type: string format: time @@ -7734,9 +7446,8 @@ components: type: integer format: int64 operatorIdentifier: - type: - - 'null' - - string + type: string + nullable: true SkillModel: type: object properties: @@ -7753,24 +7464,24 @@ components: type: integer format: int64 operatorIdentifier: - type: - - 'null' - - string + type: string + nullable: true isExpired: type: boolean SkillTypeCreationContextModel: type: object properties: name: - type: - - 'null' - - string + type: string + nullable: true duration: pattern: '^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$' type: string capabilities: oneOf: - - type: 'null' + - enum: + - null + nullable: true - $ref: '#/components/schemas/Entry' SkillTypeModel: type: object @@ -7779,15 +7490,16 @@ components: type: integer format: int64 name: - type: - - 'null' - - string + type: string + nullable: true duration: pattern: '^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$' type: string capabilities: oneOf: - - type: 'null' + - enum: + - null + nullable: true - $ref: '#/components/schemas/Entry' SseItemBase: type: object @@ -7831,34 +7543,14 @@ components: - ReleaseOrderPart - ManualStaging - EwmStaging + type: string description: "The material staging indicator defines the method of how needed materials can be supplied for production with the assistance of the Warehouse Management system.\r\nAs with the location coordinates(warehouse number, storage type, and storage bin), the system files this indicator in the control cycle." StepState: enum: - Initial - Running - Completed - Stream: type: string - format: binary - StringSegment: - type: object - properties: - buffer: - type: - - 'null' - - string - offset: - type: integer - format: int32 - length: - type: integer - format: int32 - value: - type: - - 'null' - - string - hasValue: - type: boolean TestConnectionResponse: type: object properties: @@ -7871,28 +7563,25 @@ components: - ConnectionOkDbDoesNotExist - PendingMigrations - Success + type: string description: Result enum for function TestConnection TracingModel: type: object properties: type: - type: - - 'null' - - string + type: string + nullable: true text: - type: - - 'null' - - string + type: string + nullable: true started: - type: - - 'null' - - string + type: string format: date-time + nullable: true completed: - type: - - 'null' - - string + type: string format: date-time + nullable: true errorCode: type: integer format: int32 @@ -7908,18 +7597,16 @@ components: type: integer format: int64 paths: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/Position' + nullable: true ValidationErrorModel: type: object properties: error: - type: - - 'null' - - string + type: string + nullable: true position: type: integer format: int64 @@ -7929,38 +7616,32 @@ components: success: type: boolean errors: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/ValidationErrorModel' + nullable: true VariantDescriptor: type: object properties: name: - type: - - 'null' - - string + type: string description: Name of the variant + nullable: true creationDate: type: string description: Date of the creation format: date-time preview: - description: Preview information for this variant $ref: '#/components/schemas/PreviewDescriptor' fileHash: - type: - - 'null' - - string + type: string + nullable: true extension: - type: - - 'null' - - string + type: string + nullable: true mimeType: - type: - - 'null' - - string + type: string + nullable: true size: type: integer format: int64 @@ -7974,18 +7655,16 @@ components: location: $ref: '#/components/schemas/CellLocationModel' iconName: - type: - - 'null' - - string + type: string + nullable: true isACell: type: boolean VisualizationModel: type: object properties: icon: - type: - - 'null' - - string + type: string + nullable: true category: $ref: '#/components/schemas/Category' WorkplanModel: @@ -7995,9 +7674,8 @@ components: type: integer format: int64 name: - type: - - 'null' - - string + type: string + nullable: true version: type: integer format: int32 @@ -8010,6 +7688,7 @@ components: - Execution - ControlFlow - Subworkplan + type: string WorkplanNodeModel: type: object properties: @@ -8017,17 +7696,14 @@ components: type: integer format: int64 type: - type: - - 'null' - - string + type: string + nullable: true name: - type: - - 'null' - - string + type: string + nullable: true displayName: - type: - - 'null' - - string + type: string + nullable: true positionTop: type: integer format: int32 @@ -8037,17 +7713,15 @@ components: classification: $ref: '#/components/schemas/WorkplanNodeClassification' inputs: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/NodeConnectionPoint' + nullable: true outputs: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/NodeConnectionPoint' + nullable: true properties: $ref: '#/components/schemas/Entry' subworkplanId: @@ -8057,48 +7731,43 @@ components: type: object properties: sessionToken: - type: - - 'null' - - string + type: string + nullable: true workplanId: type: integer format: int64 name: - type: - - 'null' - - string + type: string + nullable: true version: type: integer format: int32 state: $ref: '#/components/schemas/WorkplanState' nodes: - type: - - 'null' - - array + type: array items: $ref: '#/components/schemas/WorkplanNodeModel' + nullable: true WorkplanState: enum: - New - Released - Revoked + type: string description: A workplan state WorkplanStepRecipe: type: object properties: type: - type: - - 'null' - - string + type: string + nullable: true name: - type: - - 'null' - - string + type: string + nullable: true description: - type: - - 'null' - - string + type: string + nullable: true positionTop: type: integer format: int32 diff --git a/src/Moryx.AspNetCore.OpenApi/EnumSchemaTransformer.cs b/src/Moryx.AspNetCore.OpenApi/EnumSchemaTransformer.cs new file mode 100644 index 0000000000..07f9f0daa3 --- /dev/null +++ b/src/Moryx.AspNetCore.OpenApi/EnumSchemaTransformer.cs @@ -0,0 +1,39 @@ +// Copyright (c) 2026 Phoenix Contact GmbH & Co. KG +// Licensed under the Apache License, Version 2.0 + +using System.Reflection; +using System.Text.Json; +using System.Text.Json.Nodes; +using Microsoft.AspNetCore.OpenApi; +using Microsoft.OpenApi; + +namespace Moryx.AspNetCore.OpenApi; + +internal class EnumSchemaTransformer : IOpenApiSchemaTransformer +{ + public async Task TransformAsync(OpenApiSchema schema, OpenApiSchemaTransformerContext context, CancellationToken cancellationToken) + { + if (!context.JsonTypeInfo.Type.IsEnum) + { + return; + } + // Set enum values for flage nums, because otherwise the information about possible keys is completely lost in the spec + // It's not really correct, because technically other values than the pure enum cases are accepted + await SetEnumValuesForFlagEnums(schema, context, cancellationToken); + + // set schema.Type because ng-openapi-gen will create unions instead of enums if not set + if (schema.Type == null && schema.Enum.All(e => e.GetValueKind() == JsonValueKind.String)) + { + schema.Type = JsonSchemaType.String; + } + } + public async Task SetEnumValuesForFlagEnums(OpenApiSchema schema, OpenApiSchemaTransformerContext context, CancellationToken cancellationToken) + { + if (schema.Enum != null || context.JsonTypeInfo.Type.GetCustomAttributes() is null) + { + return; + } + schema.Enum = Enum.GetNames(context.JsonTypeInfo.Type) + .Select(t => JsonValue.Create(t)).ToArray(); + } +} diff --git a/src/Moryx.AspNetCore.OpenApi/FileStreamSchemaTransformer.cs b/src/Moryx.AspNetCore.OpenApi/FileStreamSchemaTransformer.cs new file mode 100644 index 0000000000..09f9fc69dd --- /dev/null +++ b/src/Moryx.AspNetCore.OpenApi/FileStreamSchemaTransformer.cs @@ -0,0 +1,40 @@ +// Copyright (c) 2026 Phoenix Contact GmbH & Co. KG +// Licensed under the Apache License, Version 2.0 + +using System.IO.Pipelines; +using Microsoft.AspNetCore.Http; +using Microsoft.AspNetCore.Http.HttpResults; +using Microsoft.AspNetCore.Mvc; +using Microsoft.AspNetCore.OpenApi; +using Microsoft.OpenApi; + +namespace Moryx.AspNetCore.OpenApi; + +internal class FileStreamSchemaTransformer : IOpenApiSchemaTransformer +{ + public async Task TransformAsync(OpenApiSchema schema, OpenApiSchemaTransformerContext context, CancellationToken cancellationToken) + { + var type = context.JsonTypeInfo.Type; + // Lightly adapted from https://github.com/dotnet/aspnetcore/blob/2e65b75b42210ac4e9f8314e0d6910ede3035dad/src/OpenApi/src/Services/Schemas/OpenApiSchemaService.cs#L62 + // Fix up schemas generated for IFormFile, IFormFileCollection, Stream, PipeReader, + // FileContentResult, FileStreamResult, FileContentHttpResult and FileStreamHttpResult + // that appear as properties within complex types. + if (type == typeof(IFormFile) || type == typeof(Stream) || type == typeof(PipeReader) + || type == typeof(FileContentResult) || type == typeof(FileStreamResult) + || type == typeof(FileContentHttpResult) || type == typeof(FileStreamHttpResult)) + { + schema.Type = JsonSchemaType.String; + schema.Properties = null; + schema.Format = "binary"; + } + else if (type == typeof(IFormFileCollection)) + { + schema.Type = JsonSchemaType.Array; + schema.Items = new OpenApiSchema + { + Type = JsonSchemaType.String, + Format = "binary", + }; + } + } +} diff --git a/src/Moryx.AspNetCore.OpenApi/MoryxOpenApiDocumentTransformer.cs b/src/Moryx.AspNetCore.OpenApi/MoryxOpenApiDocumentTransformer.cs index 4b989e3704..6eb77e7f63 100644 --- a/src/Moryx.AspNetCore.OpenApi/MoryxOpenApiDocumentTransformer.cs +++ b/src/Moryx.AspNetCore.OpenApi/MoryxOpenApiDocumentTransformer.cs @@ -65,6 +65,6 @@ private static void EnsureSseItemBaseExists(OpenApiDocument document) } } }; - document.AddComponent(MoryxSseOperationTransformer.SseItemBaseSchemaId, sseItemBaseSchema); + document.AddComponent(SseOperationTransformer.SseItemBaseSchemaId, sseItemBaseSchema); } } diff --git a/src/Moryx.AspNetCore.OpenApi/OpenApiExtensions.cs b/src/Moryx.AspNetCore.OpenApi/OpenApiExtensions.cs index 3ae593a3a4..ce067a2657 100644 --- a/src/Moryx.AspNetCore.OpenApi/OpenApiExtensions.cs +++ b/src/Moryx.AspNetCore.OpenApi/OpenApiExtensions.cs @@ -16,8 +16,11 @@ public static class OpenApiExtensions public OpenApiOptions ConfigureMoryxTransformers() { options.AddDocumentTransformer(); - options.AddOperationTransformer(); - options.AddOperationTransformer(); + options.AddOperationTransformer(); + options.AddOperationTransformer(); + options.AddOperationTransformer(); + options.AddSchemaTransformer(); + options.AddSchemaTransformer(); return options; } } diff --git a/src/Moryx.AspNetCore.OpenApi/RemoveEmptyResponseTypeOperationTransformer.cs b/src/Moryx.AspNetCore.OpenApi/RemoveEmptyResponseTypeOperationTransformer.cs new file mode 100644 index 0000000000..1fa95728e4 --- /dev/null +++ b/src/Moryx.AspNetCore.OpenApi/RemoveEmptyResponseTypeOperationTransformer.cs @@ -0,0 +1,29 @@ +// Copyright (c) 2026 Phoenix Contact GmbH & Co. KG +// Licensed under the Apache License, Version 2.0 + +using Microsoft.AspNetCore.OpenApi; +using Microsoft.OpenApi; + +namespace Moryx.AspNetCore.OpenApi; + +/// +/// Remove content types that don't have a defined response in the schema. +/// Necessary to keep the void results in generated client code. +/// +internal class RemoveEmptyResponseTypeOperationTransformer : IOpenApiOperationTransformer +{ + public async Task TransformAsync(OpenApiOperation operation, OpenApiOperationTransformerContext context, CancellationToken cancellationToken) + { + foreach (var (code, value) in operation.Responses) + { + var emptyTypes = value?.Content? + .Where(pair => + pair.Value.Schema == null).ToArray() + ?? []; + foreach (var empty in emptyTypes) + { + value.Content.Remove(empty.Key); + } + } + } +} diff --git a/src/Moryx.AspNetCore.OpenApi/MoryxOperationIdOperationTransformer.cs b/src/Moryx.AspNetCore.OpenApi/SetOperationIdOperationTransformer.cs similarity index 89% rename from src/Moryx.AspNetCore.OpenApi/MoryxOperationIdOperationTransformer.cs rename to src/Moryx.AspNetCore.OpenApi/SetOperationIdOperationTransformer.cs index 03b9ddebd2..640db0585d 100644 --- a/src/Moryx.AspNetCore.OpenApi/MoryxOperationIdOperationTransformer.cs +++ b/src/Moryx.AspNetCore.OpenApi/SetOperationIdOperationTransformer.cs @@ -7,7 +7,7 @@ namespace Moryx.AspNetCore.OpenApi; -internal class MoryxOperationIdOperationTransformer : IOpenApiOperationTransformer +internal class SetOperationIdOperationTransformer : IOpenApiOperationTransformer { public async Task TransformAsync(OpenApiOperation operation, OpenApiOperationTransformerContext context, CancellationToken cancellationToken) { diff --git a/src/Moryx.AspNetCore.OpenApi/MoryxSseOperationTransformer.cs b/src/Moryx.AspNetCore.OpenApi/SseOperationTransformer.cs similarity index 96% rename from src/Moryx.AspNetCore.OpenApi/MoryxSseOperationTransformer.cs rename to src/Moryx.AspNetCore.OpenApi/SseOperationTransformer.cs index 47e3dbda55..71bdbd95c4 100644 --- a/src/Moryx.AspNetCore.OpenApi/MoryxSseOperationTransformer.cs +++ b/src/Moryx.AspNetCore.OpenApi/SseOperationTransformer.cs @@ -11,7 +11,7 @@ using Microsoft.OpenApi; using Moryx.AspNetCore; -internal class MoryxSseOperationTransformer(IOptions openapiOptions) : IOpenApiOperationTransformer +internal class SseOperationTransformer(IOptions openapiOptions) : IOpenApiOperationTransformer { internal const string SseItemBaseSchemaId = "SseItemBase"; private const string EventStreamResponseType = "text/event-stream"; From 5ad74dde47855b82472ab9c2b09a6a8a6e8988fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Niggemann?= Date: Sun, 8 Nov 2026 23:51:02 +0100 Subject: [PATCH 13/16] Update generated typescript --- .../fn/operator-management/delete-operator.ts | 6 +-- .../app/api/fn/operator-management/sign-in.ts | 6 +-- .../api/fn/operator-management/sign-out.ts | 6 +-- .../app/api/fn/operator-management/stream.ts | 6 +-- .../fn/order-management/abort-operation.ts | 6 +-- .../fn/order-management/advice-operation.ts | 6 +-- .../fn/order-management/begin-operation.ts | 6 +-- .../order-management/get-document-stream.ts | 2 +- .../order-management/interrupt-operation.ts | 6 +-- .../src/app/api/fn/order-management/reload.ts | 6 +-- .../fn/order-management/report-operation.ts | 6 +-- .../fn/order-management/update-operation.ts | 6 +-- .../fn/product-management/save-instance.ts | 6 +-- .../app/api/fn/workplan/delete-workplan.ts | 6 +-- .../app/src/app/api/models.ts | 39 ++++++++++------- .../app/src/app/api/models/advice-model.ts | 4 +- .../src/app/api/models/assignable-operator.ts | 6 +-- .../api/models/attendable-resource-model.ts | 6 +-- .../app/src/app/api/models/begin-context.ts | 2 +- .../app/src/app/api/models/begin-model.ts | 2 +- .../src/app/api/models/confirmation-type.ts | 6 ++- .../app/src/app/api/models/document-model.ts | 12 +++--- .../app/api/models/extended-operator-model.ts | 10 ++--- .../src/app/api/models/file-stream-result.ts | 12 +----- .../app/api/models/i-operator-assignable.ts | 6 +-- .../app/src/app/api/models/log-level.ts | 11 ++++- .../api/models/moryx-exception-response.ts | 4 +- .../operation-creation-context-model.ts | 18 ++++---- .../api/models/operation-log-message-model.ts | 4 +- .../app/src/app/api/models/operation-model.ts | 24 +++++------ .../app/api/models/operation-recipe-model.ts | 2 +- .../app/api/models/operation-started-model.ts | 2 +- .../models/operation-state-classification.ts | 19 ++++++++- .../app/api/models/operation-update-model.ts | 16 +++---- .../app/src/app/api/models/operator-model.ts | 8 ++-- .../src/app/api/models/part-classification.ts | 10 ++++- .../app/src/app/api/models/part-connector.ts | 19 +++++++++ .../app/api/models/part-creation-context.ts | 38 +++++++++++++++++ .../app/src/app/api/models/part-model.ts | 16 +++++++ .../app/src/app/api/models/problem-details.ts | 10 ++--- .../app/api/models/product-customization.ts | 6 +-- .../api/models/product-definition-model.ts | 16 +++++++ ...{string-segment.ts => product-importer.ts} | 11 +++-- .../app/api/models/product-instance-model.ts | 6 +-- .../app/api/models/product-instance-state.ts | 9 +++- .../app/src/app/api/models/product-model.ts | 10 ++--- .../src/app/api/models/product-part-model.ts | 6 +-- .../app/src/app/api/models/product-query.ts | 22 +++------- .../app/src/app/api/models/product-state.ts | 8 +++- .../api/models/property-filter-operator.ts | 17 ++++++++ .../app/src/app/api/models/property-filter.ts | 19 +++++++++ .../api/models/recipe-classification-model.ts | 9 +++- .../{stream.ts => recipe-definition-model.ts} | 7 +++- .../app/src/app/api/models/recipe-filter.ts | 7 +++- .../app/src/app/api/models/recipe-model.ts | 20 +-------- .../app/src/app/api/models/recipe-state.ts | 7 +++- .../app/src/app/api/models/report-context.ts | 2 +- .../app/src/app/api/models/report-model.ts | 4 +- .../app/api/models/restriction-description.ts | 21 ++++++++++ ...eader-value.ts => restriction-severity.ts} | 12 ++++-- .../app/src/app/api/models/revision-filter.ts | 7 +++- .../app/src/app/api/models/selector.ts | 7 +++- .../src/app/api/models/staging-indicator.ts | 10 ++++- .../app/src/app/api/models/workplan-model.ts | 2 +- .../app/src/app/api/models/workplan-state.ts | 7 +++- .../services/operator-management.service.ts | 24 +++++------ .../api/services/order-management.service.ts | 42 +++++++++---------- .../services/product-management.service.ts | 6 +-- .../src/app/api/services/workplan.service.ts | 6 +-- 69 files changed, 448 insertions(+), 268 deletions(-) create mode 100644 src/Moryx.Orders.Web/app/src/app/api/models/part-connector.ts create mode 100644 src/Moryx.Orders.Web/app/src/app/api/models/part-creation-context.ts create mode 100644 src/Moryx.Orders.Web/app/src/app/api/models/part-model.ts create mode 100644 src/Moryx.Orders.Web/app/src/app/api/models/product-definition-model.ts rename src/Moryx.Orders.Web/app/src/app/api/models/{string-segment.ts => product-importer.ts} (55%) create mode 100644 src/Moryx.Orders.Web/app/src/app/api/models/property-filter-operator.ts create mode 100644 src/Moryx.Orders.Web/app/src/app/api/models/property-filter.ts rename src/Moryx.Orders.Web/app/src/app/api/models/{stream.ts => recipe-definition-model.ts} (59%) create mode 100644 src/Moryx.Orders.Web/app/src/app/api/models/restriction-description.ts rename src/Moryx.Orders.Web/app/src/app/api/models/{entity-tag-header-value.ts => restriction-severity.ts} (56%) diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/delete-operator.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/delete-operator.ts index 6eae0a6a79..4d97805ab4 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/delete-operator.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/delete-operator.ts @@ -17,18 +17,18 @@ export interface DeleteOperator$Params { operatorIdentifier?: string; } -export function deleteOperator(http: HttpClient, rootUrl: string, params?: DeleteOperator$Params, context?: HttpContext): Observable> { +export function deleteOperator(http: HttpClient, rootUrl: string, params?: DeleteOperator$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, deleteOperator.PATH, 'delete'); if (params) { rb.query('operatorIdentifier', params.operatorIdentifier, {}); } return http.request( - rb.build({ responseType: 'json', accept: 'application/json', context }) + rb.build({ responseType: 'text', accept: '*/*', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return r as StrictHttpResponse; + return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/sign-in.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/sign-in.ts index 60503dec35..bf084832ef 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/sign-in.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/sign-in.ts @@ -18,7 +18,7 @@ export interface SignIn$Params { resourceId?: number; } -export function signIn(http: HttpClient, rootUrl: string, params?: SignIn$Params, context?: HttpContext): Observable> { +export function signIn(http: HttpClient, rootUrl: string, params?: SignIn$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, signIn.PATH, 'put'); if (params) { rb.query('operatorIdentifier', params.operatorIdentifier, {}); @@ -26,11 +26,11 @@ export function signIn(http: HttpClient, rootUrl: string, params?: SignIn$Params } return http.request( - rb.build({ responseType: 'json', accept: 'application/json', context }) + rb.build({ responseType: 'text', accept: '*/*', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return r as StrictHttpResponse; + return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/sign-out.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/sign-out.ts index 6e6beda3ee..40563fa4f9 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/sign-out.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/sign-out.ts @@ -18,7 +18,7 @@ export interface SignOut$Params { resourceId?: number; } -export function signOut(http: HttpClient, rootUrl: string, params?: SignOut$Params, context?: HttpContext): Observable> { +export function signOut(http: HttpClient, rootUrl: string, params?: SignOut$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, signOut.PATH, 'put'); if (params) { rb.query('operatorIdentifier', params.operatorIdentifier, {}); @@ -26,11 +26,11 @@ export function signOut(http: HttpClient, rootUrl: string, params?: SignOut$Para } return http.request( - rb.build({ responseType: 'json', accept: 'application/json', context }) + rb.build({ responseType: 'text', accept: '*/*', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return r as StrictHttpResponse; + return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/stream.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/stream.ts index ddbaa26d94..e32d4de5dd 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/stream.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/operator-management/stream.ts @@ -16,17 +16,17 @@ import { RequestBuilder } from '../../request-builder'; export interface Stream$Params { } -export function stream(http: HttpClient, rootUrl: string, params?: Stream$Params, context?: HttpContext): Observable> { +export function stream(http: HttpClient, rootUrl: string, params?: Stream$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, stream.PATH, 'get'); if (params) { } return http.request( - rb.build({ responseType: 'json', accept: 'application/json', context }) + rb.build({ responseType: 'text', accept: '*/*', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return r as StrictHttpResponse; + return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/abort-operation.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/abort-operation.ts index 51402570fa..0cda69b6ac 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/abort-operation.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/abort-operation.ts @@ -21,18 +21,18 @@ export interface AbortOperation$Params { guid: string; } -export function abortOperation(http: HttpClient, rootUrl: string, params: AbortOperation$Params, context?: HttpContext): Observable> { +export function abortOperation(http: HttpClient, rootUrl: string, params: AbortOperation$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, abortOperation.PATH, 'post'); if (params) { rb.path('guid', params.guid, {}); } return http.request( - rb.build({ responseType: 'json', accept: 'application/json', context }) + rb.build({ responseType: 'text', accept: '*/*', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return r as StrictHttpResponse; + return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/advice-operation.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/advice-operation.ts index 07129a8d79..0b0e435aee 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/advice-operation.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/advice-operation.ts @@ -27,7 +27,7 @@ export interface AdviceOperation$Params { body: AdviceModel } -export function adviceOperation(http: HttpClient, rootUrl: string, params: AdviceOperation$Params, context?: HttpContext): Observable> { +export function adviceOperation(http: HttpClient, rootUrl: string, params: AdviceOperation$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, adviceOperation.PATH, 'post'); if (params) { rb.path('guid', params.guid, {}); @@ -35,11 +35,11 @@ export function adviceOperation(http: HttpClient, rootUrl: string, params: Advic } return http.request( - rb.build({ responseType: 'json', accept: 'application/json', context }) + rb.build({ responseType: 'text', accept: '*/*', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return r as StrictHttpResponse; + return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/begin-operation.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/begin-operation.ts index 13195a61b4..704242ebd1 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/begin-operation.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/begin-operation.ts @@ -27,7 +27,7 @@ export interface BeginOperation$Params { body: BeginModel } -export function beginOperation(http: HttpClient, rootUrl: string, params: BeginOperation$Params, context?: HttpContext): Observable> { +export function beginOperation(http: HttpClient, rootUrl: string, params: BeginOperation$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, beginOperation.PATH, 'post'); if (params) { rb.path('guid', params.guid, {}); @@ -35,11 +35,11 @@ export function beginOperation(http: HttpClient, rootUrl: string, params: BeginO } return http.request( - rb.build({ responseType: 'json', accept: 'application/json', context }) + rb.build({ responseType: 'text', accept: '*/*', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return r as StrictHttpResponse; + return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-document-stream.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-document-stream.ts index 12ae886b97..76f66a865f 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-document-stream.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/get-document-stream.ts @@ -35,7 +35,7 @@ export function getDocumentStream(http: HttpClient, rootUrl: string, params: Get } return http.request( - rb.build({ responseType: 'json', accept: 'application/json', context }) + rb.build({ responseType: 'blob', accept: 'application/json', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/interrupt-operation.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/interrupt-operation.ts index 81afae770b..1f7c0f3af4 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/interrupt-operation.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/interrupt-operation.ts @@ -26,7 +26,7 @@ export interface InterruptOperation$Params { userIdentifier?: string; } -export function interruptOperation(http: HttpClient, rootUrl: string, params: InterruptOperation$Params, context?: HttpContext): Observable> { +export function interruptOperation(http: HttpClient, rootUrl: string, params: InterruptOperation$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, interruptOperation.PATH, 'post'); if (params) { rb.path('guid', params.guid, {}); @@ -34,11 +34,11 @@ export function interruptOperation(http: HttpClient, rootUrl: string, params: In } return http.request( - rb.build({ responseType: 'json', accept: 'application/json', context }) + rb.build({ responseType: 'text', accept: '*/*', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return r as StrictHttpResponse; + return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/reload.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/reload.ts index 6412381552..d520305641 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/reload.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/reload.ts @@ -21,18 +21,18 @@ export interface Reload$Params { guid: string; } -export function reload(http: HttpClient, rootUrl: string, params: Reload$Params, context?: HttpContext): Observable> { +export function reload(http: HttpClient, rootUrl: string, params: Reload$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, reload.PATH, 'put'); if (params) { rb.path('guid', params.guid, {}); } return http.request( - rb.build({ responseType: 'json', accept: 'application/json', context }) + rb.build({ responseType: 'text', accept: '*/*', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return r as StrictHttpResponse; + return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/report-operation.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/report-operation.ts index 9de9e560e4..9e45f364ad 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/report-operation.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/report-operation.ts @@ -27,7 +27,7 @@ export interface ReportOperation$Params { body: ReportModel } -export function reportOperation(http: HttpClient, rootUrl: string, params: ReportOperation$Params, context?: HttpContext): Observable> { +export function reportOperation(http: HttpClient, rootUrl: string, params: ReportOperation$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, reportOperation.PATH, 'post'); if (params) { rb.path('guid', params.guid, {}); @@ -35,11 +35,11 @@ export function reportOperation(http: HttpClient, rootUrl: string, params: Repor } return http.request( - rb.build({ responseType: 'json', accept: 'application/json', context }) + rb.build({ responseType: 'text', accept: '*/*', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return r as StrictHttpResponse; + return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/update-operation.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/update-operation.ts index e5caff12f0..a286e727e6 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/update-operation.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/order-management/update-operation.ts @@ -27,7 +27,7 @@ export interface UpdateOperation$Params { body: OperationUpdateModel } -export function updateOperation(http: HttpClient, rootUrl: string, params: UpdateOperation$Params, context?: HttpContext): Observable> { +export function updateOperation(http: HttpClient, rootUrl: string, params: UpdateOperation$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, updateOperation.PATH, 'put'); if (params) { rb.path('guid', params.guid, {}); @@ -35,11 +35,11 @@ export function updateOperation(http: HttpClient, rootUrl: string, params: Updat } return http.request( - rb.build({ responseType: 'json', accept: 'application/json', context }) + rb.build({ responseType: 'text', accept: '*/*', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return r as StrictHttpResponse; + return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/save-instance.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/save-instance.ts index b34d338219..7e96f6f266 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/save-instance.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/product-management/save-instance.ts @@ -22,18 +22,18 @@ export interface SaveInstance$Params { body: ProductInstanceModel } -export function saveInstance(http: HttpClient, rootUrl: string, params: SaveInstance$Params, context?: HttpContext): Observable> { +export function saveInstance(http: HttpClient, rootUrl: string, params: SaveInstance$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, saveInstance.PATH, 'put'); if (params) { rb.body(params.body, 'application/*+json'); } return http.request( - rb.build({ responseType: 'json', accept: 'application/json', context }) + rb.build({ responseType: 'text', accept: '*/*', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return r as StrictHttpResponse; + return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/fn/workplan/delete-workplan.ts b/src/Moryx.Orders.Web/app/src/app/api/fn/workplan/delete-workplan.ts index 7ba84b3a5f..794b5f00cf 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/fn/workplan/delete-workplan.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/fn/workplan/delete-workplan.ts @@ -17,18 +17,18 @@ export interface DeleteWorkplan$Params { id: number; } -export function deleteWorkplan(http: HttpClient, rootUrl: string, params: DeleteWorkplan$Params, context?: HttpContext): Observable> { +export function deleteWorkplan(http: HttpClient, rootUrl: string, params: DeleteWorkplan$Params, context?: HttpContext): Observable> { const rb = new RequestBuilder(rootUrl, deleteWorkplan.PATH, 'delete'); if (params) { rb.path('id', params.id, {}); } return http.request( - rb.build({ responseType: 'json', accept: 'application/json', context }) + rb.build({ responseType: 'text', accept: '*/*', context }) ).pipe( filter((r: any): r is HttpResponse => r instanceof HttpResponse), map((r: HttpResponse) => { - return r as StrictHttpResponse; + return (r as HttpResponse).clone({ body: undefined }) as StrictHttpResponse; }) ); } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models.ts b/src/Moryx.Orders.Web/app/src/app/api/models.ts index bb313b0b1d..42f154f416 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models.ts @@ -12,14 +12,13 @@ export type { AssignableOperator } from './models/assignable-operator'; export type { AttendableResourceModel } from './models/attendable-resource-model'; export type { BeginContext } from './models/begin-context'; export type { BeginModel } from './models/begin-model'; -export type { ConfirmationType } from './models/confirmation-type'; +export { ConfirmationType } from './models/confirmation-type'; export type { DocumentModel } from './models/document-model'; -export type { EntityTagHeaderValue } from './models/entity-tag-header-value'; export type { ExtendedOperatorModel } from './models/extended-operator-model'; export type { FileStreamResult } from './models/file-stream-result'; export type { ICapabilities } from './models/i-capabilities'; export type { IOperatorAssignable } from './models/i-operator-assignable'; -export type { LogLevel } from './models/log-level'; +export { LogLevel } from './models/log-level'; export type { MoryxExceptionResponse } from './models/moryx-exception-response'; export type { OperationAdvicedModel } from './models/operation-adviced-model'; export type { OperationCreationContextModel } from './models/operation-creation-context-model'; @@ -28,33 +27,41 @@ export type { OperationModel } from './models/operation-model'; export type { OperationRecipeModel } from './models/operation-recipe-model'; export type { OperationReportedModel } from './models/operation-reported-model'; export type { OperationStartedModel } from './models/operation-started-model'; -export type { OperationStateClassification } from './models/operation-state-classification'; +export { OperationStateClassification } from './models/operation-state-classification'; export type { OperationUpdateModel } from './models/operation-update-model'; export type { OperatorModel } from './models/operator-model'; -export type { PartClassification } from './models/part-classification'; +export { PartClassification } from './models/part-classification'; +export type { PartConnector } from './models/part-connector'; +export type { PartCreationContext } from './models/part-creation-context'; +export type { PartModel } from './models/part-model'; export type { ProblemDetails } from './models/problem-details'; export type { ProductCustomization } from './models/product-customization'; +export type { ProductDefinitionModel } from './models/product-definition-model'; +export type { ProductImporter } from './models/product-importer'; export type { ProductInstanceModel } from './models/product-instance-model'; -export type { ProductInstanceState } from './models/product-instance-state'; +export { ProductInstanceState } from './models/product-instance-state'; export type { ProductModel } from './models/product-model'; export type { ProductPartModel } from './models/product-part-model'; export type { ProductQuery } from './models/product-query'; -export type { ProductState } from './models/product-state'; -export type { RecipeClassificationModel } from './models/recipe-classification-model'; -export type { RecipeFilter } from './models/recipe-filter'; +export { ProductState } from './models/product-state'; +export type { PropertyFilter } from './models/property-filter'; +export { PropertyFilterOperator } from './models/property-filter-operator'; +export { RecipeClassificationModel } from './models/recipe-classification-model'; +export type { RecipeDefinitionModel } from './models/recipe-definition-model'; +export { RecipeFilter } from './models/recipe-filter'; export type { RecipeModel } from './models/recipe-model'; -export type { RecipeState } from './models/recipe-state'; +export { RecipeState } from './models/recipe-state'; export type { ReportContext } from './models/report-context'; export type { ReportModel } from './models/report-model'; -export type { RevisionFilter } from './models/revision-filter'; -export type { Selector } from './models/selector'; +export type { RestrictionDescription } from './models/restriction-description'; +export { RestrictionSeverity } from './models/restriction-severity'; +export { RevisionFilter } from './models/revision-filter'; +export { Selector } from './models/selector'; export type { SseItemBase } from './models/sse-item-base'; export type { SseItemOfOperationAdvicedModel } from './models/sse-item-of-operation-adviced-model'; export type { SseItemOfOperationModel } from './models/sse-item-of-operation-model'; export type { SseItemOfOperationReportedModel } from './models/sse-item-of-operation-reported-model'; export type { SseItemOfOperationStartedModel } from './models/sse-item-of-operation-started-model'; -export type { StagingIndicator } from './models/staging-indicator'; -export type { Stream } from './models/stream'; -export type { StringSegment } from './models/string-segment'; +export { StagingIndicator } from './models/staging-indicator'; export type { WorkplanModel } from './models/workplan-model'; -export type { WorkplanState } from './models/workplan-state'; +export { WorkplanState } from './models/workplan-state'; diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/advice-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/advice-model.ts index 56bc5767d1..8269d6eeb9 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/advice-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/advice-model.ts @@ -8,6 +8,6 @@ export interface AdviceModel { amount?: number; - partId?: (number | null); - toteBoxNumber?: (string | null); + partId?: number | null; + toteBoxNumber?: string | null; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/assignable-operator.ts b/src/Moryx.Orders.Web/app/src/app/api/models/assignable-operator.ts index 9a5912aa06..a2400ac47c 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/assignable-operator.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/assignable-operator.ts @@ -9,9 +9,9 @@ import { IOperatorAssignable } from '../models/i-operator-assignable'; export interface AssignableOperator { assignedResources?: Array; - firstName?: (string | null); + firstName?: string | null; identifier: string; - lastName?: (string | null); - pseudonym?: (string | null); + lastName?: string | null; + pseudonym?: string | null; signedIn?: boolean; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/attendable-resource-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/attendable-resource-model.ts index a9cf91c008..63a223b492 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/attendable-resource-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/attendable-resource-model.ts @@ -7,7 +7,7 @@ /* Code generated by ng-openapi-gen DO NOT EDIT. */ export interface AttendableResourceModel { - id?: (number | null); - name?: (string | null); - requiredSkills?: (Array | null); + id?: number | null; + name?: string | null; + requiredSkills?: Array | null; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/begin-context.ts b/src/Moryx.Orders.Web/app/src/app/api/models/begin-context.ts index 54938a9a7c..fc96466de9 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/begin-context.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/begin-context.ts @@ -41,7 +41,7 @@ export interface BeginContext { /** * Reasons why a begin is not possible */ - restrictions?: (Array | null); + restrictions?: Array | null; /** * Current failure count of the operation diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/begin-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/begin-model.ts index 3518a7a8c4..490f614755 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/begin-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/begin-model.ts @@ -8,5 +8,5 @@ export interface BeginModel { amount?: number; - userId?: (string | null); + userId?: string | null; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/confirmation-type.ts b/src/Moryx.Orders.Web/app/src/app/api/models/confirmation-type.ts index a71aa9d361..c40d4490d9 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/confirmation-type.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/confirmation-type.ts @@ -10,5 +10,7 @@ /** * Confirmation type while reporting amounts of an operation */ -export type ConfirmationType = 'Partial' | 'Final'; - +export enum ConfirmationType { + Partial = 'Partial', + Final = 'Final' +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/document-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/document-model.ts index 63b90688c5..2b691cc1cc 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/document-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/document-model.ts @@ -7,11 +7,11 @@ /* Code generated by ng-openapi-gen DO NOT EDIT. */ export interface DocumentModel { - contentType?: (string | null); - description?: (string | null); - identifier?: (string | null); - number?: (string | null); + contentType?: string | null; + description?: string | null; + identifier?: string | null; + number?: string | null; revision?: number; - source?: (string | null); - type?: (string | null); + source?: string | null; + type?: string | null; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/extended-operator-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/extended-operator-model.ts index efb1f20c99..5ac87445d8 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/extended-operator-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/extended-operator-model.ts @@ -8,9 +8,9 @@ import { AttendableResourceModel } from '../models/attendable-resource-model'; export interface ExtendedOperatorModel { - assignedResources?: (Array | null); - firstName?: (string | null); - identifier?: (string | null); - lastName?: (string | null); - pseudonym?: (string | null); + assignedResources?: Array | null; + firstName?: string | null; + identifier?: string | null; + lastName?: string | null; + pseudonym?: string | null; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/file-stream-result.ts b/src/Moryx.Orders.Web/app/src/app/api/models/file-stream-result.ts index d9111ab0f9..851b37954d 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/file-stream-result.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/file-stream-result.ts @@ -6,13 +6,5 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -import { EntityTagHeaderValue } from '../models/entity-tag-header-value'; -import { Stream } from '../models/stream'; -export interface FileStreamResult { - contentType?: (string | null); - enableRangeProcessing?: boolean; - entityTag?: (null | EntityTagHeaderValue); - fileDownloadName?: (string | null); - fileStream?: Stream; - lastModified?: (string | null); -} +export type FileStreamResult = Blob; + diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/i-operator-assignable.ts b/src/Moryx.Orders.Web/app/src/app/api/models/i-operator-assignable.ts index 8aeb04c0a3..96f49dbec1 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/i-operator-assignable.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/i-operator-assignable.ts @@ -8,10 +8,6 @@ import { ICapabilities } from '../models/i-capabilities'; export interface IOperatorAssignable { - - /** - * The resource's capabilities - */ capabilities?: ICapabilities; /** @@ -22,6 +18,6 @@ export interface IOperatorAssignable { /** * Name of this resource instance */ - name?: (string | null); + name?: string | null; requiredSkills?: ICapabilities; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/log-level.ts b/src/Moryx.Orders.Web/app/src/app/api/models/log-level.ts index 92cce0b909..c45c1ba145 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/log-level.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/log-level.ts @@ -6,5 +6,12 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export type LogLevel = 'Trace' | 'Debug' | 'Information' | 'Warning' | 'Error' | 'Critical' | 'None'; - +export enum LogLevel { + Trace = 'Trace', + Debug = 'Debug', + Information = 'Information', + Warning = 'Warning', + Error = 'Error', + Critical = 'Critical', + None = 'None' +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/moryx-exception-response.ts b/src/Moryx.Orders.Web/app/src/app/api/models/moryx-exception-response.ts index 7d28696d8e..f832a18a40 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/moryx-exception-response.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/moryx-exception-response.ts @@ -7,6 +7,6 @@ /* Code generated by ng-openapi-gen DO NOT EDIT. */ export interface MoryxExceptionResponse { - exception?: (string | null); - title?: (string | null); + exception?: string | null; + title?: string | null; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/operation-creation-context-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/operation-creation-context-model.ts index ff667e489d..ccc5ccb498 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/operation-creation-context-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/operation-creation-context-model.ts @@ -14,22 +14,22 @@ export interface OperationCreationContextModel { /** * Additional operation depending parameters for the production */ - materialParameters?: (Array | null); + materialParameters?: Array | null; /** * Operation name */ - name?: (string | null); + name?: string | null; /** * The number of this operation */ - operationNumber?: (string | null); + operationNumber?: string | null; /** * The number of the order this operation belongs to */ - orderNumber?: (string | null); + orderNumber?: string | null; /** * Total amount planned for over delivery @@ -39,7 +39,7 @@ export interface OperationCreationContextModel { /** * Part list of the product of this operation */ - parts?: (Array | null); + parts?: Array | null; /** * Expected end time @@ -54,12 +54,12 @@ export interface OperationCreationContextModel { /** * Main product identifier */ - productIdentifier?: (string | null); + productIdentifier?: string | null; /** * Name of the Product */ - productName?: (string | null); + productName?: string | null; /** * Revision of the Product @@ -79,7 +79,7 @@ export interface OperationCreationContextModel { /** * Target stock for produced parts */ - targetStock?: (string | null); + targetStock?: string | null; /** * The amount to produce @@ -94,5 +94,5 @@ export interface OperationCreationContextModel { /** * Unit of product */ - unit?: (string | null); + unit?: string | null; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/operation-log-message-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/operation-log-message-model.ts index 734765a4ae..baa1d1468f 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/operation-log-message-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/operation-log-message-model.ts @@ -8,8 +8,8 @@ import { LogLevel } from '../models/log-level'; export interface OperationLogMessageModel { - exception?: (string | null); + exception?: string | null; logLevel?: LogLevel; - message?: (string | null); + message?: string | null; timeStamp?: string; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/operation-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/operation-model.ts index 484cc410a3..3a6e10b95c 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/operation-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/operation-model.ts @@ -20,7 +20,7 @@ export interface OperationModel { canInterrupt?: boolean; canReport?: boolean; classification?: OperationStateClassification; - end?: (string | null); + end?: string | null; hasDocuments?: boolean; hasPartList?: boolean; identifier?: string; @@ -29,35 +29,35 @@ export interface OperationModel { isAssigning?: boolean; isCreated?: boolean; isFailed?: boolean; - jobIds?: (Array | null); - name?: (string | null); - number?: (string | null); + jobIds?: Array | null; + name?: string | null; + number?: string | null; operationSource?: Entry; - order?: (string | null); + order?: string | null; overDeliveryAmount?: number; pendingCount?: number; plannedEnd?: string; plannedStart?: string; productId?: number; - productIdentifier?: (string | null); - productName?: (string | null); + productIdentifier?: string | null; + productName?: string | null; productRevision?: number; progressPending?: number; progressRunning?: number; progressScrap?: number; progressSuccess?: number; - recipeIds?: (Array | null); - recipeName?: (string | null); + recipeIds?: Array | null; + recipeName?: string | null; reportedFailureCount?: number; reportedSuccessCount?: number; runningCount?: number; scrapCount?: number; sortOrder?: number; - start?: (string | null); - stateDisplayName?: (string | null); + start?: string | null; + stateDisplayName?: string | null; successCount?: number; targetCycleTime?: number; totalAmount?: number; underDeliveryAmount?: number; - unit?: (string | null); + unit?: string | null; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/operation-recipe-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/operation-recipe-model.ts index b9988ccc90..44ae78181f 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/operation-recipe-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/operation-recipe-model.ts @@ -8,5 +8,5 @@ export interface OperationRecipeModel { id?: number; - name?: (string | null); + name?: string | null; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/operation-started-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/operation-started-model.ts index d0a2146d72..c7582a047b 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/operation-started-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/operation-started-model.ts @@ -9,5 +9,5 @@ import { OperationModel } from '../models/operation-model'; export interface OperationStartedModel { operationModel?: OperationModel; - userId?: (string | null); + userId?: string | null; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/operation-state-classification.ts b/src/Moryx.Orders.Web/app/src/app/api/models/operation-state-classification.ts index 51e599ba65..df9efc866a 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/operation-state-classification.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/operation-state-classification.ts @@ -14,5 +14,20 @@ * Bit: 31 - 24 | 23 - 8 | 7 - 0 | * Flag: Overall | Usage | State | */ -export type OperationStateClassification = string; - +export enum OperationStateClassification { + Initial = 'Initial', + Assigning = 'Assigning', + Failed = 'Failed', + Aborted = 'Aborted', + Ready = 'Ready', + Running = 'Running', + Interrupting = 'Interrupting', + Interrupted = 'Interrupted', + Completed = 'Completed', + CanReload = 'CanReload', + CanBegin = 'CanBegin', + CanInterrupt = 'CanInterrupt', + CanReport = 'CanReport', + CanAdvice = 'CanAdvice', + IsAmountReached = 'IsAmountReached' +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/operation-update-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/operation-update-model.ts index 4a2c8733ea..0b1fa46336 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/operation-update-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/operation-update-model.ts @@ -7,12 +7,12 @@ /* Code generated by ng-openapi-gen DO NOT EDIT. */ export interface OperationUpdateModel { - overDeliveryAmount?: (number | null); - plannedEnd?: (string | null); - plannedStart?: (string | null); - sortIndex?: (number | null); - targetCycleTime?: (number | null); - targetStock?: (string | null); - totalAmount?: (number | null); - underDeliveryAmount?: (number | null); + overDeliveryAmount?: number | null; + plannedEnd?: string | null; + plannedStart?: string | null; + sortIndex?: number | null; + targetCycleTime?: number | null; + targetStock?: string | null; + totalAmount?: number | null; + underDeliveryAmount?: number | null; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/operator-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/operator-model.ts index f6fd606338..ae95613618 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/operator-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/operator-model.ts @@ -7,8 +7,8 @@ /* Code generated by ng-openapi-gen DO NOT EDIT. */ export interface OperatorModel { - firstName?: (string | null); - identifier?: (string | null); - lastName?: (string | null); - pseudonym?: (string | null); + firstName?: string | null; + identifier?: string | null; + lastName?: string | null; + pseudonym?: string | null; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/part-classification.ts b/src/Moryx.Orders.Web/app/src/app/api/models/part-classification.ts index befe4dd752..bded17daa8 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/part-classification.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/part-classification.ts @@ -6,5 +6,11 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export type PartClassification = 'Unknown' | 'Material' | 'InfoComponent' | 'CarrierMaterial' | 'ScrapMaterial' | 'BranchMaterial'; - +export enum PartClassification { + Unknown = 'Unknown', + Material = 'Material', + InfoComponent = 'InfoComponent', + CarrierMaterial = 'CarrierMaterial', + ScrapMaterial = 'ScrapMaterial', + BranchMaterial = 'BranchMaterial' +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/part-connector.ts b/src/Moryx.Orders.Web/app/src/app/api/models/part-connector.ts new file mode 100644 index 0000000000..3da21ee81d --- /dev/null +++ b/src/Moryx.Orders.Web/app/src/app/api/models/part-connector.ts @@ -0,0 +1,19 @@ +/* + * Copyright (c) 2026 Phoenix Contact GmbH & Co. KG + * Licensed under the Apache License, Version 2.0 +*/ + +/* eslint-disable */ +import { Entry } from '@moryx/ngx-web-framework/entry-editor'; + +/* Code generated by ng-openapi-gen DO NOT EDIT. */ + +import { PartModel } from '../models/part-model'; +export interface PartConnector { + displayName?: string | null; + isCollection?: boolean; + name?: string | null; + parts?: Array | null; + propertyTemplates?: Entry; + type?: string | null; +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/part-creation-context.ts b/src/Moryx.Orders.Web/app/src/app/api/models/part-creation-context.ts new file mode 100644 index 0000000000..3e778e43d9 --- /dev/null +++ b/src/Moryx.Orders.Web/app/src/app/api/models/part-creation-context.ts @@ -0,0 +1,38 @@ +/* + * Copyright (c) 2026 Phoenix Contact GmbH & Co. KG + * Licensed under the Apache License, Version 2.0 +*/ + +/* eslint-disable */ +/* Code generated by ng-openapi-gen DO NOT EDIT. */ + +import { PartClassification } from '../models/part-classification'; +import { StagingIndicator } from '../models/staging-indicator'; + +/** + * Information about a part of the product which should be produced for an operation + */ +export interface PartCreationContext { + classification?: PartClassification; + + /** + * Name of the part like the product name + */ + name?: string | null; + + /** + * Identifier of this part + */ + number?: string | null; + + /** + * Quantity of this part which are necessary to produce one product + */ + quantity?: number; + stagingIndicator?: StagingIndicator; + + /** + * Unit of the quantity + */ + unit?: string | null; +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/part-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/part-model.ts new file mode 100644 index 0000000000..7f4d698d83 --- /dev/null +++ b/src/Moryx.Orders.Web/app/src/app/api/models/part-model.ts @@ -0,0 +1,16 @@ +/* + * Copyright (c) 2026 Phoenix Contact GmbH & Co. KG + * Licensed under the Apache License, Version 2.0 +*/ + +/* eslint-disable */ +import { Entry } from '@moryx/ngx-web-framework/entry-editor'; + +/* Code generated by ng-openapi-gen DO NOT EDIT. */ + +import { ProductModel } from '../models/product-model'; +export interface PartModel { + id?: number; + product?: ProductModel; + properties?: Entry; +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/problem-details.ts b/src/Moryx.Orders.Web/app/src/app/api/models/problem-details.ts index ac43e51160..e172b96854 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/problem-details.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/problem-details.ts @@ -7,9 +7,9 @@ /* Code generated by ng-openapi-gen DO NOT EDIT. */ export interface ProblemDetails { - detail?: (string | null); - instance?: (string | null); - status?: (number | null); - title?: (string | null); - type?: (string | null); + detail?: string | null; + instance?: string | null; + status?: number | null; + title?: string | null; + type?: string | null; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/product-customization.ts b/src/Moryx.Orders.Web/app/src/app/api/models/product-customization.ts index 86127257de..f76c1c0ea5 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/product-customization.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/product-customization.ts @@ -10,7 +10,7 @@ import { ProductDefinitionModel } from '../models/product-definition-model'; import { ProductImporter } from '../models/product-importer'; import { RecipeDefinitionModel } from '../models/recipe-definition-model'; export interface ProductCustomization { - importers?: (Array | null); - productTypes?: (Array | null); - recipeTypes?: (Array | null); + importers?: Array | null; + productTypes?: Array | null; + recipeTypes?: Array | null; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/product-definition-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/product-definition-model.ts new file mode 100644 index 0000000000..852889caef --- /dev/null +++ b/src/Moryx.Orders.Web/app/src/app/api/models/product-definition-model.ts @@ -0,0 +1,16 @@ +/* + * Copyright (c) 2026 Phoenix Contact GmbH & Co. KG + * Licensed under the Apache License, Version 2.0 +*/ + +/* eslint-disable */ +import { Entry } from '@moryx/ngx-web-framework/entry-editor'; + +/* Code generated by ng-openapi-gen DO NOT EDIT. */ + +export interface ProductDefinitionModel { + baseDefinition?: string | null; + displayName?: string | null; + name?: string | null; + properties?: Entry; +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/string-segment.ts b/src/Moryx.Orders.Web/app/src/app/api/models/product-importer.ts similarity index 55% rename from src/Moryx.Orders.Web/app/src/app/api/models/string-segment.ts rename to src/Moryx.Orders.Web/app/src/app/api/models/product-importer.ts index 5622aa84a7..48cc0d93fc 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/string-segment.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/product-importer.ts @@ -4,12 +4,11 @@ */ /* eslint-disable */ +import { Entry } from '@moryx/ngx-web-framework/entry-editor'; + /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export interface StringSegment { - buffer?: (string | null); - hasValue?: boolean; - length?: number; - offset?: number; - value?: (string | null); +export interface ProductImporter { + name?: string | null; + parameters?: Entry; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/product-instance-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/product-instance-model.ts index 6b29871365..0a85c9b569 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/product-instance-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/product-instance-model.ts @@ -12,14 +12,10 @@ import { ProductInstanceState } from '../models/product-instance-state'; export interface ProductInstanceModel { id?: number; properties?: Entry; - - /** - * The current state of the instance - */ state?: ProductInstanceState; /** * The name of the product type of this instance */ - type?: (string | null); + type?: string | null; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/product-instance-state.ts b/src/Moryx.Orders.Web/app/src/app/api/models/product-instance-state.ts index be9bce94c6..37566620a3 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/product-instance-state.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/product-instance-state.ts @@ -11,5 +11,10 @@ * The state of an ProductInstance. * This will not occupy more than 4 Bits. Other enums can be added by bit-shifting */ -export type ProductInstanceState = string; - +export enum ProductInstanceState { + Unset = 'Unset', + InProduction = 'InProduction', + Paused = 'Paused', + Success = 'Success', + Failure = 'Failure' +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/product-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/product-model.ts index 941fd5f220..dcfa7076ae 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/product-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/product-model.ts @@ -13,12 +13,12 @@ import { ProductState } from '../models/product-state'; import { RecipeModel } from '../models/recipe-model'; export interface ProductModel { id?: number; - identifier?: (string | null); - name?: (string | null); - parts?: (Array | null); + identifier?: string | null; + name?: string | null; + parts?: Array | null; properties?: Entry; - recipes?: (Array | null); + recipes?: Array | null; revision?: number; state?: ProductState; - type?: (string | null); + type?: string | null; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/product-part-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/product-part-model.ts index da518dcc87..36d168c617 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/product-part-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/product-part-model.ts @@ -11,9 +11,9 @@ import { StagingIndicator } from '../models/staging-indicator'; export interface ProductPartModel { classification?: PartClassification; id?: number; - identifier?: (string | null); - name?: (string | null); + identifier?: string | null; + name?: string | null; quantity?: number; stagingIndicator?: StagingIndicator; - unit?: (string | null); + unit?: string | null; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/product-query.ts b/src/Moryx.Orders.Web/app/src/app/api/models/product-query.ts index e7e1adbecb..43e7cfb33d 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/product-query.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/product-query.ts @@ -25,7 +25,7 @@ export interface ProductQuery { /** * Material identifiers */ - identifier?: (string | null); + identifier?: string | null; /** * Flag if deleted products should be included in the query @@ -41,37 +41,25 @@ export interface ProductQuery { /** * Material identifiers */ - name?: (string | null); + name?: string | null; /** * List of property filters */ - propertyFilters?: (Array | null); - - /** - * Optional recipe filter - */ + propertyFilters?: Array | null; recipeFilter?: RecipeFilter; - requiredState?: (null | ProductState); + requiredState?: ('null' | ProductState); /** * Optional specific revision if RevisionFilter ProductQuery.RevisionFilter is set to * RevisionFilter.Specific */ revision?: number; - - /** - * Revisions to filter - */ revisionFilter?: RevisionFilter; - - /** - * Selector - */ selector?: Selector; /** * Product types to filter by */ - typeName?: (string | null); + typeName?: string | null; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/product-state.ts b/src/Moryx.Orders.Web/app/src/app/api/models/product-state.ts index aa2bee7a1c..753fbc3bc4 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/product-state.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/product-state.ts @@ -10,5 +10,9 @@ /** * Current state of a product */ -export type ProductState = string; - +export enum ProductState { + Created = 'Created', + Released = 'Released', + Deprecated = 'Deprecated', + Generated = 'Generated' +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/property-filter-operator.ts b/src/Moryx.Orders.Web/app/src/app/api/models/property-filter-operator.ts new file mode 100644 index 0000000000..d7a51d18a7 --- /dev/null +++ b/src/Moryx.Orders.Web/app/src/app/api/models/property-filter-operator.ts @@ -0,0 +1,17 @@ +/* + * Copyright (c) 2026 Phoenix Contact GmbH & Co. KG + * Licensed under the Apache License, Version 2.0 +*/ + +/* eslint-disable */ +/* Code generated by ng-openapi-gen DO NOT EDIT. */ + + +/** + * Property filter operator expression + */ +export enum PropertyFilterOperator { + Equals = 'Equals', + GreaterThen = 'GreaterThen', + LessThen = 'LessThen' +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/property-filter.ts b/src/Moryx.Orders.Web/app/src/app/api/models/property-filter.ts new file mode 100644 index 0000000000..3df23ab902 --- /dev/null +++ b/src/Moryx.Orders.Web/app/src/app/api/models/property-filter.ts @@ -0,0 +1,19 @@ +/* + * Copyright (c) 2026 Phoenix Contact GmbH & Co. KG + * Licensed under the Apache License, Version 2.0 +*/ + +/* eslint-disable */ +import { Entry } from '@moryx/ngx-web-framework/entry-editor'; + +/* Code generated by ng-openapi-gen DO NOT EDIT. */ + +import { PropertyFilterOperator } from '../models/property-filter-operator'; + +/** + * Property filter wrapper for the filtered entry + */ +export interface PropertyFilter { + entry?: Entry; + operator?: PropertyFilterOperator; +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/recipe-classification-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/recipe-classification-model.ts index 935bb831cf..464552d006 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/recipe-classification-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/recipe-classification-model.ts @@ -10,5 +10,10 @@ /** * Webservice compatible recipe classification enum */ -export type RecipeClassificationModel = 'Unset' | 'Default' | 'Alternative' | 'Intermediate' | 'Part'; - +export enum RecipeClassificationModel { + Unset = 'Unset', + Default = 'Default', + Alternative = 'Alternative', + Intermediate = 'Intermediate', + Part = 'Part' +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/stream.ts b/src/Moryx.Orders.Web/app/src/app/api/models/recipe-definition-model.ts similarity index 59% rename from src/Moryx.Orders.Web/app/src/app/api/models/stream.ts rename to src/Moryx.Orders.Web/app/src/app/api/models/recipe-definition-model.ts index 8d81fb481e..bd6efd645a 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/stream.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/recipe-definition-model.ts @@ -6,5 +6,8 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -export type Stream = Blob; - +export interface RecipeDefinitionModel { + displayName?: string | null; + hasWorkplans?: boolean; + name?: string | null; +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/recipe-filter.ts b/src/Moryx.Orders.Web/app/src/app/api/models/recipe-filter.ts index f9b61c913b..8287b9eaec 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/recipe-filter.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/recipe-filter.ts @@ -10,5 +10,8 @@ /** * Different options regarding the recipes of the product */ -export type RecipeFilter = 'Unset' | 'WithRecipe' | 'WithoutRecipes'; - +export enum RecipeFilter { + Unset = 'Unset', + WithRecipe = 'WithRecipe', + WithoutRecipes = 'WithoutRecipes' +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/recipe-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/recipe-model.ts index 664e8260b9..7ba726c6f3 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/recipe-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/recipe-model.ts @@ -16,10 +16,6 @@ import { WorkplanModel } from '../models/workplan-model'; * DTO representation of a recipe */ export interface RecipeModel { - - /** - * Classification of the recipe - */ classification?: RecipeClassificationModel; /** @@ -35,30 +31,18 @@ export interface RecipeModel { /** * Name of the recipe */ - name?: (string | null); - - /** - * Properties of the recipe - */ + name?: string | null; properties?: Entry; /** * Revision of the recipe */ revision?: number; - - /** - * This recipe's state - */ state?: RecipeState; /** * Type of the recipe */ - type?: (string | null); - - /** - * A model of the currently referenced workplan - */ + type?: string | null; workplanModel?: WorkplanModel; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/recipe-state.ts b/src/Moryx.Orders.Web/app/src/app/api/models/recipe-state.ts index 492127244e..ad77b05513 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/recipe-state.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/recipe-state.ts @@ -10,5 +10,8 @@ /** * A Recipe's state */ -export type RecipeState = 'New' | 'Released' | 'Revoked'; - +export enum RecipeState { + New = 'New', + Released = 'Released', + Revoked = 'Revoked' +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/report-context.ts b/src/Moryx.Orders.Web/app/src/app/api/models/report-context.ts index 7d92dcff81..36f80207d9 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/report-context.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/report-context.ts @@ -36,7 +36,7 @@ export interface ReportContext { /** * Reasons why a report is not possible */ - restrictions?: (Array | null); + restrictions?: Array | null; /** * Current failure count of the operation diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/report-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/report-model.ts index db30f323d1..6b6970ddc0 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/report-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/report-model.ts @@ -8,9 +8,9 @@ import { ConfirmationType } from '../models/confirmation-type'; export interface ReportModel { - comment?: (string | null); + comment?: string | null; confirmationType?: ConfirmationType; failureCount?: number; successCount?: number; - userIdentifier?: (string | null); + userIdentifier?: string | null; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/restriction-description.ts b/src/Moryx.Orders.Web/app/src/app/api/models/restriction-description.ts new file mode 100644 index 0000000000..8f8aa8e482 --- /dev/null +++ b/src/Moryx.Orders.Web/app/src/app/api/models/restriction-description.ts @@ -0,0 +1,21 @@ +/* + * Copyright (c) 2026 Phoenix Contact GmbH & Co. KG + * Licensed under the Apache License, Version 2.0 +*/ + +/* eslint-disable */ +/* Code generated by ng-openapi-gen DO NOT EDIT. */ + +import { RestrictionSeverity } from '../models/restriction-severity'; + +/** + * Description of the result of a performed rule + */ +export interface RestrictionDescription { + severity: RestrictionSeverity; + + /** + * Description of the result + */ + text: string | null; +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/entity-tag-header-value.ts b/src/Moryx.Orders.Web/app/src/app/api/models/restriction-severity.ts similarity index 56% rename from src/Moryx.Orders.Web/app/src/app/api/models/entity-tag-header-value.ts rename to src/Moryx.Orders.Web/app/src/app/api/models/restriction-severity.ts index 9759259a5f..51abce1560 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/entity-tag-header-value.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/restriction-severity.ts @@ -6,8 +6,12 @@ /* eslint-disable */ /* Code generated by ng-openapi-gen DO NOT EDIT. */ -import { StringSegment } from '../models/string-segment'; -export interface EntityTagHeaderValue { - isWeak?: boolean; - tag?: StringSegment; + +/** + * Severity of a rule result + */ +export enum RestrictionSeverity { + Info = 'Info', + Warning = 'Warning', + Error = 'Error' } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/revision-filter.ts b/src/Moryx.Orders.Web/app/src/app/api/models/revision-filter.ts index 74ad39525f..ac3edd3d29 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/revision-filter.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/revision-filter.ts @@ -10,5 +10,8 @@ /** * Filter for revisions */ -export type RevisionFilter = 'All' | 'Latest' | 'Specific'; - +export enum RevisionFilter { + All = 'All', + Latest = 'Latest', + Specific = 'Specific' +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/selector.ts b/src/Moryx.Orders.Web/app/src/app/api/models/selector.ts index abfe19ee88..0e018d1787 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/selector.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/selector.ts @@ -10,5 +10,8 @@ /** * Determine which objects to select for the query */ -export type Selector = 'Direct' | 'Parent' | 'Parts'; - +export enum Selector { + Direct = 'Direct', + Parent = 'Parent', + Parts = 'Parts' +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/staging-indicator.ts b/src/Moryx.Orders.Web/app/src/app/api/models/staging-indicator.ts index cafdf070b6..278310ded7 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/staging-indicator.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/staging-indicator.ts @@ -11,5 +11,11 @@ * The material staging indicator defines the method of how needed materials can be supplied for production with the assistance of the Warehouse Management system. * As with the location coordinates(warehouse number, storage type, and storage bin), the system files this indicator in the control cycle. */ -export type StagingIndicator = 'NotRelevant' | 'PickPart' | 'CrateOrKanbanPart' | 'ReleaseOrderPart' | 'ManualStaging' | 'EwmStaging'; - +export enum StagingIndicator { + NotRelevant = 'NotRelevant', + PickPart = 'PickPart', + CrateOrKanbanPart = 'CrateOrKanbanPart', + ReleaseOrderPart = 'ReleaseOrderPart', + ManualStaging = 'ManualStaging', + EwmStaging = 'EwmStaging' +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/workplan-model.ts b/src/Moryx.Orders.Web/app/src/app/api/models/workplan-model.ts index 1c1986efd3..7c7e68df51 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/workplan-model.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/workplan-model.ts @@ -9,7 +9,7 @@ import { WorkplanState } from '../models/workplan-state'; export interface WorkplanModel { id?: number; - name?: (string | null); + name?: string | null; state?: WorkplanState; version?: number; } diff --git a/src/Moryx.Orders.Web/app/src/app/api/models/workplan-state.ts b/src/Moryx.Orders.Web/app/src/app/api/models/workplan-state.ts index 6d32c812eb..2c02396e8a 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/models/workplan-state.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/models/workplan-state.ts @@ -10,5 +10,8 @@ /** * A workplan state */ -export type WorkplanState = 'New' | 'Released' | 'Revoked'; - +export enum WorkplanState { + New = 'New', + Released = 'Released', + Revoked = 'Revoked' +} diff --git a/src/Moryx.Orders.Web/app/src/app/api/services/operator-management.service.ts b/src/Moryx.Orders.Web/app/src/app/api/services/operator-management.service.ts index 670d4d86cf..363c4a0363 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/services/operator-management.service.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/services/operator-management.service.ts @@ -107,7 +107,7 @@ export class OperatorManagementService extends BaseService { * * This method doesn't expect any request body. */ - deleteOperator$Response(params?: DeleteOperator$Params, context?: HttpContext): Promise> { + deleteOperator$Response(params?: DeleteOperator$Params, context?: HttpContext): Promise> { const obs = deleteOperator(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } @@ -118,9 +118,9 @@ export class OperatorManagementService extends BaseService { * * This method doesn't expect any request body. */ - deleteOperator(params?: DeleteOperator$Params, context?: HttpContext): Promise { + deleteOperator(params?: DeleteOperator$Params, context?: HttpContext): Promise { const resp = this.deleteOperator$Response(params, context); - return resp.then((r: StrictHttpResponse): any => r.body); + return resp.then((r: StrictHttpResponse): void => r.body); } /** Path part for operation `get()` */ @@ -282,7 +282,7 @@ export class OperatorManagementService extends BaseService { * * This method doesn't expect any request body. */ - signIn$Response(params?: SignIn$Params, context?: HttpContext): Promise> { + signIn$Response(params?: SignIn$Params, context?: HttpContext): Promise> { const obs = signIn(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } @@ -293,9 +293,9 @@ export class OperatorManagementService extends BaseService { * * This method doesn't expect any request body. */ - signIn(params?: SignIn$Params, context?: HttpContext): Promise { + signIn(params?: SignIn$Params, context?: HttpContext): Promise { const resp = this.signIn$Response(params, context); - return resp.then((r: StrictHttpResponse): any => r.body); + return resp.then((r: StrictHttpResponse): void => r.body); } /** Path part for operation `signOut()` */ @@ -307,7 +307,7 @@ export class OperatorManagementService extends BaseService { * * This method doesn't expect any request body. */ - signOut$Response(params?: SignOut$Params, context?: HttpContext): Promise> { + signOut$Response(params?: SignOut$Params, context?: HttpContext): Promise> { const obs = signOut(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } @@ -318,9 +318,9 @@ export class OperatorManagementService extends BaseService { * * This method doesn't expect any request body. */ - signOut(params?: SignOut$Params, context?: HttpContext): Promise { + signOut(params?: SignOut$Params, context?: HttpContext): Promise { const resp = this.signOut$Response(params, context); - return resp.then((r: StrictHttpResponse): any => r.body); + return resp.then((r: StrictHttpResponse): void => r.body); } /** Path part for operation `stream()` */ @@ -332,7 +332,7 @@ export class OperatorManagementService extends BaseService { * * This method doesn't expect any request body. */ - stream$Response(params?: Stream$Params, context?: HttpContext): Promise> { + stream$Response(params?: Stream$Params, context?: HttpContext): Promise> { const obs = stream(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } @@ -343,9 +343,9 @@ export class OperatorManagementService extends BaseService { * * This method doesn't expect any request body. */ - stream(params?: Stream$Params, context?: HttpContext): Promise { + stream(params?: Stream$Params, context?: HttpContext): Promise { const resp = this.stream$Response(params, context); - return resp.then((r: StrictHttpResponse): any => r.body); + return resp.then((r: StrictHttpResponse): void => r.body); } } diff --git a/src/Moryx.Orders.Web/app/src/app/api/services/order-management.service.ts b/src/Moryx.Orders.Web/app/src/app/api/services/order-management.service.ts index 6838b36c8e..b4091d366e 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/services/order-management.service.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/services/order-management.service.ts @@ -355,7 +355,7 @@ export class OrderManagementService extends BaseService { * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - beginOperation$Response(params: BeginOperation$Params, context?: HttpContext): Promise> { + beginOperation$Response(params: BeginOperation$Params, context?: HttpContext): Promise> { const obs = beginOperation(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } @@ -370,9 +370,9 @@ export class OrderManagementService extends BaseService { * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - beginOperation(params: BeginOperation$Params, context?: HttpContext): Promise { + beginOperation(params: BeginOperation$Params, context?: HttpContext): Promise { const resp = this.beginOperation$Response(params, context); - return resp.then((r: StrictHttpResponse): any => r.body); + return resp.then((r: StrictHttpResponse): void => r.body); } /** Path part for operation `getReportContext()` */ @@ -421,7 +421,7 @@ export class OrderManagementService extends BaseService { * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - reportOperation$Response(params: ReportOperation$Params, context?: HttpContext): Promise> { + reportOperation$Response(params: ReportOperation$Params, context?: HttpContext): Promise> { const obs = reportOperation(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } @@ -436,9 +436,9 @@ export class OrderManagementService extends BaseService { * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - reportOperation(params: ReportOperation$Params, context?: HttpContext): Promise { + reportOperation(params: ReportOperation$Params, context?: HttpContext): Promise { const resp = this.reportOperation$Response(params, context); - return resp.then((r: StrictHttpResponse): any => r.body); + return resp.then((r: StrictHttpResponse): void => r.body); } /** Path part for operation `getInterruptContext()` */ @@ -487,7 +487,7 @@ export class OrderManagementService extends BaseService { * * This method doesn't expect any request body. */ - interruptOperation$Response(params: InterruptOperation$Params, context?: HttpContext): Promise> { + interruptOperation$Response(params: InterruptOperation$Params, context?: HttpContext): Promise> { const obs = interruptOperation(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } @@ -502,9 +502,9 @@ export class OrderManagementService extends BaseService { * * This method doesn't expect any request body. */ - interruptOperation(params: InterruptOperation$Params, context?: HttpContext): Promise { + interruptOperation(params: InterruptOperation$Params, context?: HttpContext): Promise { const resp = this.interruptOperation$Response(params, context); - return resp.then((r: StrictHttpResponse): any => r.body); + return resp.then((r: StrictHttpResponse): void => r.body); } /** Path part for operation `getAdviceContext()` */ @@ -553,7 +553,7 @@ export class OrderManagementService extends BaseService { * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - adviceOperation$Response(params: AdviceOperation$Params, context?: HttpContext): Promise> { + adviceOperation$Response(params: AdviceOperation$Params, context?: HttpContext): Promise> { const obs = adviceOperation(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } @@ -568,9 +568,9 @@ export class OrderManagementService extends BaseService { * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - adviceOperation(params: AdviceOperation$Params, context?: HttpContext): Promise { + adviceOperation(params: AdviceOperation$Params, context?: HttpContext): Promise { const resp = this.adviceOperation$Response(params, context); - return resp.then((r: StrictHttpResponse): any => r.body); + return resp.then((r: StrictHttpResponse): void => r.body); } /** Path part for operation `getLogs()` */ @@ -652,7 +652,7 @@ export class OrderManagementService extends BaseService { * * This method doesn't expect any request body. */ - abortOperation$Response(params: AbortOperation$Params, context?: HttpContext): Promise> { + abortOperation$Response(params: AbortOperation$Params, context?: HttpContext): Promise> { const obs = abortOperation(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } @@ -667,9 +667,9 @@ export class OrderManagementService extends BaseService { * * This method doesn't expect any request body. */ - abortOperation(params: AbortOperation$Params, context?: HttpContext): Promise { + abortOperation(params: AbortOperation$Params, context?: HttpContext): Promise { const resp = this.abortOperation$Response(params, context); - return resp.then((r: StrictHttpResponse): any => r.body); + return resp.then((r: StrictHttpResponse): void => r.body); } /** Path part for operation `updateOperation()` */ @@ -685,7 +685,7 @@ export class OrderManagementService extends BaseService { * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - updateOperation$Response(params: UpdateOperation$Params, context?: HttpContext): Promise> { + updateOperation$Response(params: UpdateOperation$Params, context?: HttpContext): Promise> { const obs = updateOperation(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } @@ -700,9 +700,9 @@ export class OrderManagementService extends BaseService { * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - updateOperation(params: UpdateOperation$Params, context?: HttpContext): Promise { + updateOperation(params: UpdateOperation$Params, context?: HttpContext): Promise { const resp = this.updateOperation$Response(params, context); - return resp.then((r: StrictHttpResponse): any => r.body); + return resp.then((r: StrictHttpResponse): void => r.body); } /** Path part for operation `reload()` */ @@ -718,7 +718,7 @@ export class OrderManagementService extends BaseService { * * This method doesn't expect any request body. */ - reload$Response(params: Reload$Params, context?: HttpContext): Promise> { + reload$Response(params: Reload$Params, context?: HttpContext): Promise> { const obs = reload(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } @@ -733,9 +733,9 @@ export class OrderManagementService extends BaseService { * * This method doesn't expect any request body. */ - reload(params: Reload$Params, context?: HttpContext): Promise { + reload(params: Reload$Params, context?: HttpContext): Promise { const resp = this.reload$Response(params, context); - return resp.then((r: StrictHttpResponse): any => r.body); + return resp.then((r: StrictHttpResponse): void => r.body); } } diff --git a/src/Moryx.Orders.Web/app/src/app/api/services/product-management.service.ts b/src/Moryx.Orders.Web/app/src/app/api/services/product-management.service.ts index 10815bc46a..9d2f5d4e02 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/services/product-management.service.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/services/product-management.service.ts @@ -470,7 +470,7 @@ export class ProductManagementService extends BaseService { * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - saveInstance$Response(params: SaveInstance$Params, context?: HttpContext): Promise> { + saveInstance$Response(params: SaveInstance$Params, context?: HttpContext): Promise> { const obs = saveInstance(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } @@ -485,9 +485,9 @@ export class ProductManagementService extends BaseService { * * This method sends `application/*+json` and handles request body of type `application/*+json`. */ - saveInstance(params: SaveInstance$Params, context?: HttpContext): Promise { + saveInstance(params: SaveInstance$Params, context?: HttpContext): Promise { const resp = this.saveInstance$Response(params, context); - return resp.then((r: StrictHttpResponse): any => r.body); + return resp.then((r: StrictHttpResponse): void => r.body); } /** Path part for operation `createInstance()` */ diff --git a/src/Moryx.Orders.Web/app/src/app/api/services/workplan.service.ts b/src/Moryx.Orders.Web/app/src/app/api/services/workplan.service.ts index c78a8d2f26..47b36e29fc 100644 --- a/src/Moryx.Orders.Web/app/src/app/api/services/workplan.service.ts +++ b/src/Moryx.Orders.Web/app/src/app/api/services/workplan.service.ts @@ -168,7 +168,7 @@ export class WorkplanService extends BaseService { * * This method doesn't expect any request body. */ - deleteWorkplan$Response(params: DeleteWorkplan$Params, context?: HttpContext): Promise> { + deleteWorkplan$Response(params: DeleteWorkplan$Params, context?: HttpContext): Promise> { const obs = deleteWorkplan(this.http, this.rootUrl, params, context); return firstValueFrom(obs); } @@ -179,9 +179,9 @@ export class WorkplanService extends BaseService { * * This method doesn't expect any request body. */ - deleteWorkplan(params: DeleteWorkplan$Params, context?: HttpContext): Promise { + deleteWorkplan(params: DeleteWorkplan$Params, context?: HttpContext): Promise { const resp = this.deleteWorkplan$Response(params, context); - return resp.then((r: StrictHttpResponse): any => r.body); + return resp.then((r: StrictHttpResponse): void => r.body); } } From 9e1e0ef1c030b9f6198c979231009f4398ddfcd2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Niggemann?= Date: Mon, 9 Nov 2026 07:44:32 +0100 Subject: [PATCH 14/16] fix typescript error due to changed nullability in generated api --- .../src/app/components/operation-recipes/operation-recipes.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Moryx.Orders.Web/app/src/app/components/operation-recipes/operation-recipes.ts b/src/Moryx.Orders.Web/app/src/app/components/operation-recipes/operation-recipes.ts index 02aa609fd9..ab6d1012a4 100644 --- a/src/Moryx.Orders.Web/app/src/app/components/operation-recipes/operation-recipes.ts +++ b/src/Moryx.Orders.Web/app/src/app/components/operation-recipes/operation-recipes.ts @@ -181,7 +181,7 @@ export class OperationRecipes implements OnInit { await this.productManagementService .updateRecipe({ id: this.selectedRecipe()!.id!, - body: this.selectedRecipe() + body: this.selectedRecipe()! }) .catch( async (e: HttpErrorResponse) => await this.snackbarService.handleError(e) From cbd88b67d4dacd27ccbd741ee5910c255544fe3f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Niggemann?= Date: Mon, 9 Nov 2026 07:46:21 +0100 Subject: [PATCH 15/16] Remove unused loop --- src/Moryx.AspNetCore.OpenApi/SseOperationTransformer.cs | 4 ---- 1 file changed, 4 deletions(-) diff --git a/src/Moryx.AspNetCore.OpenApi/SseOperationTransformer.cs b/src/Moryx.AspNetCore.OpenApi/SseOperationTransformer.cs index 71bdbd95c4..2a23859c15 100644 --- a/src/Moryx.AspNetCore.OpenApi/SseOperationTransformer.cs +++ b/src/Moryx.AspNetCore.OpenApi/SseOperationTransformer.cs @@ -24,10 +24,6 @@ public async Task TransformAsync(OpenApiOperation operation, OpenApiOperationTra return; } - foreach (var attribute in producesAttributes) - { - - } var pseudoResponseKeys = operation.Responses.Keys.Where(x => int.TryParse(x, out var v) && v >= 1000).ToList(); foreach (var pseudoKeys in pseudoResponseKeys) { From 3353b93f7c9893014f1a6136fef2e977f8b0faab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Niggemann?= Date: Mon, 9 Nov 2026 07:46:50 +0100 Subject: [PATCH 16/16] Adjust new PackageVersion entries to fit existing structure of Directory.Packages.props --- Directory.Packages.props | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 9312762a94..f1999a2d45 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -13,9 +13,6 @@ - - - @@ -26,8 +23,10 @@ - + + + @@ -56,8 +55,11 @@ + + +