Rubix Orchestration & GraphQL Schema Docs Enhancements 2019-05-31
Author:
Fluent Commerce
Changed on:
25 Mar 2024
Target release date: | 2019-05-31 |
---|---|
Release status: | Released |
Description
Rubix Orchestration Improvements:
Added GraphQL Response Data and Errors to Audit Log Events when GraphQL API Exceptions occur from Queries and Mutations in Workflows
Previously, when errors were returned by the GraphQL API to the Rubix Engine via the API Client, a
`FluentGraphQLAPIException`
Added Cause Parameter to SDK Provided Exceptions
The following SDK Provided Exceptions now provide constructors with a Throwable cause parameter, enabling Developers to pass in a caught exception from inside of a custom Rule. Since Rubix automatically creates Audit Log Events when exceptions are thrown or bubbled through Rules, the cause exception of the issue should be available to the Audit Log Event to assist Developers and Support staff in root cause analysis and identification. Audit Log Events will now include the cause exception information if provided by the rule.
Please note, that this is only applicable when the developer has thrown one of the following exceptions as a result of catching a different exception inside of the rule logic. Typically, we recommend allowing the cause exception to bubble through the rule, however, there are cases where the cause exception is caught, and one of the following exceptions has then been thrown back to Rubix:
`ApiException`
`AuditableException`
`NotFoundException`
`RubixException`
`RuleException`
`RulesetException`
GraphQL Schema Docs Enhancements:
Added Auto-Generated Schema Documentation for Orchestrateable Fields
As part of an ongoing initiative to bring consistency to our API Documentation, we have added auto-generated documentation to 4 key fields within the Orchestrateable interface. The goal is to provide Developers with meaningful documentation of key fields within the Orchestration domain so that they can easily understand how these fields work within their workflows. Take a look at some examples captured from schema documentation below.
Added Auto-Generated Schema Documentation for Orchestrateable Create Mutations
Additionally, we have added auto-generated documentation to the Create mutations for entities implementing the Orchestrateable interface. This provides Developers with clear information on the Orchestration Event that will be triggered by the mutation, allowing them to implement workflows for those entities.
Take a look at the
`createOrder`
Changelog
Details as listed above.
Screenshots
Released capability depth: | Enhancement, New capability |
---|---|
Release bundle / Capability type: | Platform, Tool |