-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(bpdm-gate): Extend error code #1003
feat(bpdm-gate): Extend error code #1003
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sadly, the Schema annotation does not work with the used OpenAPI library after all. I discovered this, while improving the Orchestrator documentation. Please have a look at this file:
Line 73 in fbeeb51
@get:Schema(description = "NamePartType:\n" + |
I had to write the OpenAPI description on the field description of the referencing class.
This would be in your case here:
Line 27 in fbeeb51
@get:Schema(description = "The type of error that occurred", required = true) |
And here:
Line 40 in fbeeb51
@get:Schema(description = "One of the sharing error codes in case the current sharing state type is \"error\".") |
Also, the code mapping TaskErrorType to GateErrorType is currently missing.
d46940e
to
463cdc0
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Your contribution code is fine but some formalities are missing.
- Please rebase to the newest state of main
- Sine your contribution changes the API of Gate and Orchestrator please add the updated openAPI documents in the docs/api folder
- Add a CHANGELOG entry with a reference to the issue
After that, the contribution is ready to merge
2f7d569
to
9ef00b1
Compare
9ef00b1
to
d8baaf9
Compare
d8baaf9
to
8914df8
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Contributes to eclipse-tractusx/sig-release#727 |
Description
Enhance the error handling mechanism for the orchestrator and gate components by extending the list of available error codes. This will improve the visibility and detail of error information, particularly beneficial for the customer dashboard to understand why a data set could not be processed.
Currently, the orchestrator and gate components have a limited set of error codes. Extending these error codes will provide more granular information on processing failures, aiding in quicker diagnosis and resolution. This feature will update both the orchestrator and gate components to support a more comprehensive list of error codes.
Benefits
Improved Transparency: Customers can view detailed error reasons on the dashboard, enhancing trust and user experience.
Enhanced Debugging: Developers and support teams can identify and resolve issues more efficiently with detailed error information.
Better Monitoring: Allows for more precise monitoring and logging of errors, leading to improved system reliability.
New error types add to the following two classes
New error types
Pre-review checks
Please ensure to do as many of the following checks as possible, before asking for committer review: