Refactor section on ProblemDetails, add one possible value. #444
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
TallTed
suggested changes
Jan 29, 2025
| relating to the specifics of the endpoint on which the error occurs. | ||
| When an implementation detects an anomaly while processing a document, a | ||
| <dfn>ProblemDetails</dfn> object can be used to report the issue to other | ||
| software systems. The interface for these objects follow [[RFC9457]] |
There was a problem hiding this comment.
Suggested change
| software systems. The interface for these objects follow [[RFC9457]] | |
| software systems. The interfaces for these objects follow [[RFC9457]] |
| <h3>Verification Errors vs. Warnings</h3> | ||
|
|
||
| <p> | ||
| This specification defines a distinction between a verification error vs. a |
There was a problem hiding this comment.
Suggested change
| This specification defines a distinction between a verification error vs. a | |
| This specification defines a distinction between a verification error and a |
| This specification defines a distinction between a verification error vs. a | ||
| verification warning. Errors are `ProblemDetails` relating to cryptography, | ||
| data model, and malformed context and are unrecoverable. Warnings are | ||
| `ProblemDetails` relating to statuses and validity periods and might be |
There was a problem hiding this comment.
Suggested change
| `ProblemDetails` relating to statuses and validity periods and might be | |
| `ProblemDetails` relating to status and validity periods and might be |
| verification warning. Errors are `ProblemDetails` relating to cryptography, | ||
| data model, and malformed context and are unrecoverable. Warnings are | ||
| `ProblemDetails` relating to statuses and validity periods and might be | ||
| recoverable or where the subsequent action is at the discretion of the |
There was a problem hiding this comment.
Suggested change
| recoverable or where the subsequent action is at the discretion of the | |
| recoverable or leave the subsequent action to the discretion of the |
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.
This PR attempts to address issue #395 by refactoring the problem details section and adding a possible value.
Preview | Diff