WI 3565801: Update OMF jupyter example to not have OMF validation in documentation #8
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
afink-aveva
requested changes
Nov 20, 2024
| "\n", | ||
| "The following diagram illustrates the basic flow of an OMF message request\n", | ||
| "\n" |
There was a problem hiding this comment.
This is the only reference to images/omfmessage.png, so we can remove it from the project as well
| "\n", | ||
| "If there are any issues with the data flow, contact AVEVA Technical Support with this operation-id. \n", | ||
| "To determine if an OMF message is truly valid, send the message to the CONNECT Data Services OMF Validation endpoint (../api/v1/omf/validation). A successful response indicates that the OMF message is valid.", |
There was a problem hiding this comment.
Would it be better to hyperlink to the Omf/Validation endpoint docs?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The CDS OMF endpoint no longer indicates that the OMF message was invalid. Removed mentions of the /omf endpoint validating OMF messages, but also mentioned the designated OMF validation endpoint: /omf/validation
OmfIngress support explanation:
We do not validate JSON with the /omf endpoint for performance reasons, but we do ensure that the message is small/big enough for us to process. We recommend that customers use the OMF Validation endpoint (/api/v1/omf/validation) to validate their JSON before sending it via the /omf endpoint. The 400 "invalid message" error that you are seeing is actually referring to the message body being too small for us to recognize as a valid request, which we have set up to be 12 bytes.