Revert "Workaround for duplicated anyOf"

This reverts commit 3f0c735.
TouK · Feb 25, 2025 · 8401e27 · 8401e27
1 parent 3f0c735
commit 8401e27
Show file tree

Hide file tree

Showing 3 changed files with 82 additions and 25 deletions.
diff --git a/designer/server/src/main/scala/pl/touk/nussknacker/ui/api/TestingApiHttpService.scala b/designer/server/src/main/scala/pl/touk/nussknacker/ui/api/TestingApiHttpService.scala
@@ -19,7 +19,8 @@ import pl.touk.nussknacker.ui.process.test.ScenarioTestService.GenerateTestDataE
 import pl.touk.nussknacker.ui.security.api.AuthManager
 import pl.touk.nussknacker.ui.validation.ParametersValidator
 import sttp.model.StatusCode.{BadRequest, NotFound}
-import sttp.tapir.{Codec, CodecFormat, EndpointOutput, oneOfVariant, oneOfVariantFromMatchType, plainBody}
+import sttp.tapir.EndpointIO.Example
+import sttp.tapir.{Codec, CodecFormat, EndpointOutput, oneOfVariantFromMatchType, plainBody}
 
 import scala.concurrent.{ExecutionContext, Future}
 
@@ -196,36 +197,66 @@ object TestingApiHttpService {
 
   }
 
-  object ErrorOutputs {
+  object Examples {
 
-    val noScenarioErrorOutput: EndpointOutput.OneOfVariant[NoScenario] =
+    val noScenarioExample: EndpointOutput.OneOfVariant[NoScenario] =
       oneOfVariantFromMatchType(
         NotFound,
         plainBody[NoScenario]
+          .example(
+            Example.of(
+              summary = Some("No scenario {scenarioName} found"),
+              value = NoScenario(ProcessName("'example scenario'"))
+            )
+          )
       )
 
-    val noDataGeneratedErrorOutput: EndpointOutput.OneOfVariant[NoDataGenerated.type] =
-      oneOfVariant(
+    val noDataGeneratedExample: EndpointOutput.OneOfVariant[NoDataGenerated.type] =
+      oneOfVariantFromMatchType(
         NotFound,
         plainBody[NoDataGenerated.type]
+          .example(
+            Example.of(
+              summary = Some("No data was generated"),
+              value = NoDataGenerated
+            )
+          )
       )
 
-    val noSourcesWithTestDataGenerationErrorOutput: EndpointOutput.OneOfVariant[NoSourcesWithTestDataGeneration.type] =
-      oneOfVariant(
+    val noSourcesWithTestDataGenerationExample: EndpointOutput.OneOfVariant[NoSourcesWithTestDataGeneration.type] =
+      oneOfVariantFromMatchType(
         NotFound,
         plainBody[NoSourcesWithTestDataGeneration.type]
+          .example(
+            Example.of(
+              summary = Some("No sources with test data generation available"),
+              value = NoSourcesWithTestDataGeneration
+            )
+          )
       )
 
-    val tooManyCharactersGeneratedErrorOutput: EndpointOutput.OneOfVariant[TooManyCharactersGenerated] =
+    val tooManyCharactersGeneratedExample: EndpointOutput.OneOfVariant[TooManyCharactersGenerated] =
       oneOfVariantFromMatchType(
         BadRequest,
         plainBody[TooManyCharactersGenerated]
+          .example(
+            Example.of(
+              summary = Some("Too many characters were generated"),
+              value = TooManyCharactersGenerated(length = 5000, limit = 2000)
+            )
+          )
       )
 
-    val tooManySamplesRequestedErrorOutput: EndpointOutput.OneOfVariant[TooManySamplesRequested] =
+    val tooManySamplesRequestedExample: EndpointOutput.OneOfVariant[TooManySamplesRequested] =
       oneOfVariantFromMatchType(
         BadRequest,
         plainBody[TooManySamplesRequested]
+          .example(
+            Example.of(
+              summary = Some("Too many samples requested"),
+              value = TooManySamplesRequested(maxSamples = 1000)
+            )
+          )
       )
 
   }

diff --git a/...er/server/src/main/scala/pl/touk/nussknacker/ui/api/description/TestingApiEndpoints.scala b/...er/server/src/main/scala/pl/touk/nussknacker/ui/api/description/TestingApiEndpoints.scala
@@ -17,12 +17,12 @@ import pl.touk.nussknacker.security.AuthCredentials
 import pl.touk.nussknacker.ui.api.TapirCodecs.ScenarioGraphCodec._
 import pl.touk.nussknacker.ui.api.TapirCodecs.ScenarioNameCodec._
 import pl.touk.nussknacker.ui.api.TapirCodecs.ScenarioTestingCodecs._
-import pl.touk.nussknacker.ui.api.TestingApiHttpService.ErrorOutputs.{
-  noDataGeneratedErrorOutput,
-  noScenarioErrorOutput,
-  noSourcesWithTestDataGenerationErrorOutput,
-  tooManyCharactersGeneratedErrorOutput,
-  tooManySamplesRequestedErrorOutput
+import pl.touk.nussknacker.ui.api.TestingApiHttpService.Examples.{
+  noDataGeneratedExample,
+  noScenarioExample,
+  noSourcesWithTestDataGenerationExample,
+  tooManyCharactersGeneratedExample,
+  tooManySamplesRequestedExample
 }
 import pl.touk.nussknacker.ui.api.TestingApiHttpService.TestingError
 import pl.touk.nussknacker.ui.definition.DefinitionsService
@@ -97,7 +97,7 @@ class TestingApiEndpoints(auth: EndpointInput[AuthCredentials]) extends BaseEndp
       )
       .errorOut(
         oneOf[TestingError](
-          noScenarioErrorOutput,
+          noScenarioExample,
         )
       )
       .withSecurity(auth)
@@ -133,7 +133,7 @@ class TestingApiEndpoints(auth: EndpointInput[AuthCredentials]) extends BaseEndp
       )
       .errorOut(
         oneOf[TestingError](
-          noScenarioErrorOutput
+          noScenarioExample
         )
       )
       .withSecurity(auth)
@@ -172,7 +172,7 @@ class TestingApiEndpoints(auth: EndpointInput[AuthCredentials]) extends BaseEndp
       )
       .errorOut(
         oneOf[TestingError](
-          noScenarioErrorOutput
+          noScenarioExample
         )
       )
       .withSecurity(auth)
@@ -204,11 +204,11 @@ class TestingApiEndpoints(auth: EndpointInput[AuthCredentials]) extends BaseEndp
       )
       .errorOut(
         oneOf[TestingError](
-          noScenarioErrorOutput,
-          noDataGeneratedErrorOutput,
-          noSourcesWithTestDataGenerationErrorOutput,
-          tooManyCharactersGeneratedErrorOutput,
-          tooManySamplesRequestedErrorOutput,
+          noScenarioExample,
+          noDataGeneratedExample,
+          noSourcesWithTestDataGenerationExample,
+          tooManyCharactersGeneratedExample,
+          tooManySamplesRequestedExample,
         )
       )
       .withSecurity(auth)

diff --git a/docs-internal/api/nu-designer-openapi.yaml b/docs-internal/api/nu-designer-openapi.yaml
@@ -3259,6 +3259,10 @@ paths:
             text/plain:
               schema:
                 type: string
+              examples:
+                Example:
+                  summary: No scenario {scenarioName} found
+                  value: No scenario 'example scenario' found
         '501':
           description: Impersonation is not supported for defined authentication mechanism
           content:
@@ -3360,6 +3364,10 @@ paths:
             text/plain:
               schema:
                 type: string
+              examples:
+                Example:
+                  summary: No scenario {scenarioName} found
+                  value: No scenario 'example scenario' found
         '501':
           description: Impersonation is not supported for defined authentication mechanism
           content:
@@ -3433,7 +3441,14 @@ paths:
           content:
             text/plain:
               schema:
-                type: string
+                anyOf:
+                - type: string
+                - type: string
+              examples:
+                Example:
+                  summary: Too many samples requested
+                  value: Too many samples requested, limit is 1000. Please configure
+                    'testDataSettings.maxSamplesCount' to increase the limit
         '401':
           description: ''
           content:
@@ -3462,7 +3477,14 @@ paths:
           content:
             text/plain:
               schema:
-                type: string
+                anyOf:
+                - type: string
+                - type: string
+                - type: string
+              examples:
+                Example:
+                  summary: No sources with test data generation available
+                  value: No sources with test data generation available
         '501':
           description: Impersonation is not supported for defined authentication mechanism
           content:
@@ -3581,6 +3603,10 @@ paths:
             text/plain:
               schema:
                 type: string
+              examples:
+                Example:
+                  summary: No scenario {scenarioName} found
+                  value: No scenario 'example scenario' found
         '501':
           description: Impersonation is not supported for defined authentication mechanism
           content: