Minor docs corrections plus single-side-join docs rewrite #8229
Conversation
| @@ -77,7 +77,7 @@ components { | |||
| | namePattern | false | .* | Regexp for filtering operations by operationId or by created service name (concatenation of HTTP method, path and parameters) | | |||
| | security | false | | Configuration for [authentication](https://swagger.io/docs/specification/authentication/) for each `securitySchemas` defined in the *OpenAPI interface definition* | | |||
| | security.*.type | false | | Type of security configuration for a given security schema. Currently only `apiKey` is supported | | |||
| | security.*.apiKeyValue | false | | API key that will be passed into the service via header, query parameter or cookie (depending on definition provided in OpenAPI) | | |||
There was a problem hiding this comment.
I find it difficult to understand statement like "depending on definition provided in OpenAPI".
OpenAPI is too vague for me, it can mean standard defitinition, a particular service (interface) definition or maybe something else. I prefer to be more helpful here.
There was a problem hiding this comment.
imho previous description is simpler (it doesn't use huge world "interface") and points out that behaviour is dependent on specific service configuration
There was a problem hiding this comment.
...as configured in the given service definition?
| is statically validated and typed on an ongoing basis. | ||
| is statically validated and typed on an ongoing basis. | ||
|
|
||
| The internal Nussknacker's `Typing Information` "system" is based on Java datatypes. Consequently, the data mappings presented in the remaining part of this document map data types between the non Java datatypes and Java datatypes. |
There was a problem hiding this comment.
mby just "typing" instead of "Typing information" system?
There was a problem hiding this comment.
thia, "system" is too much probably, I will remove it. However the document uses "Typing information" all over the place, so it is probably better to keep it.
| @@ -77,7 +77,7 @@ components { | |||
| | namePattern | false | .* | Regexp for filtering operations by operationId or by created service name (concatenation of HTTP method, path and parameters) | | |||
| | security | false | | Configuration for [authentication](https://swagger.io/docs/specification/authentication/) for each `securitySchemas` defined in the *OpenAPI interface definition* | | |||
| | security.*.type | false | | Type of security configuration for a given security schema. Currently only `apiKey` is supported | | |||
| | security.*.apiKeyValue | false | | API key that will be passed into the service via header, query parameter or cookie (depending on definition provided in OpenAPI) | | |||
There was a problem hiding this comment.
imho previous description is simpler (it doesn't use huge world "interface") and points out that behaviour is dependent on specific service configuration
| * The `#outputVar` will be available downstream of the outer-join aggregate. | ||
|  | ||
|
|
||
| The configuration of the Single-side-join would be as in the picture below; note how Nussknacker Designer helps you to decide which branch is which. |
There was a problem hiding this comment.
note how Nussknacker Designer helps you to decide which branch is which. <- imho we can skip this part.
A set of unrelated small corrections
groupByparameter name was changed tokey.