-
Notifications
You must be signed in to change notification settings - Fork 27
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
Example Health URL scheme with GET, single POST and batch POSTs #232
Merged
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
38e2ac4
Changes to error and warning handling
cookeac 60a799c
Made error handling consistent across single and batch
cookeac b76071c
Touch files to resolve conflicts
cookeac 3d9e3db
Merge branch 'master' of https://github.com/cookeac/ICAR into cookeac…
cookeac 6650449
Renamed icarErrorWarningMessageResource
cookeac File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{ | ||
"description": "Severity code to distinguish warnings and errors.", | ||
|
||
"type": "string", | ||
|
||
"enum": [ | ||
"Information", | ||
"Warning", | ||
"Error" | ||
] | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
{ | ||
"description": "Returned by a batch POST event to return identity (meta), errors, and warnings for a resource.", | ||
"type": "object", | ||
"properties": { | ||
"id": { | ||
"type": "string", | ||
"description": "Unique identifier created in the system for this event. SHOULD be a UUID." | ||
}, | ||
"meta": { | ||
"$ref": "../types/icarMetaDataType.json", | ||
"description": "Metadata for the posted resource. Allows specification of the source, source Id to synchronise data." | ||
}, | ||
"messages": { | ||
"type": "array", | ||
"description": "An arry of errors for this resource.", | ||
"nullable": true, | ||
"items": { | ||
"$ref": "../resources/icarErrorWarningMessageResource.json" | ||
} | ||
} | ||
} | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
{ | ||
"description": "An RFC7807 compliant problem response for JSON APIs.", | ||
|
||
"type": "object", | ||
|
||
"properties": { | ||
"type": { | ||
"type": "string", | ||
"description": "Machine readable URI or code that defines the type of error or warning." | ||
}, | ||
"severity": { | ||
"$ref": "../enums/icarBatchResultSeverityType.json", | ||
"description": "Distinguish errors, warnings, and informational messages." | ||
}, | ||
"status": { | ||
"type": "integer", | ||
"description": "The HTTP status code applicable to this problem.", | ||
"format": "int32", | ||
"nullable": true | ||
}, | ||
"title": { | ||
"type": "string", | ||
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization." | ||
}, | ||
"detail": { | ||
"type": "string", | ||
"description": "A human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized." | ||
}, | ||
"instance": { | ||
"type": "string", | ||
"description": "A URI reference or internal JSON document reference to the specific data item that caused the problem.", | ||
"nullable": true | ||
} | ||
} | ||
} |
Oops, something went wrong.
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.
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.
Could "icarResponseMessageResource"/"icarProblemResponseMessageResource" be a better name for that resource? As we also have "Information" severity level defined for message type.
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.
Excellent suggestion, thank you. I struggled with the naming of that resource. Renamed to icarResponseMessageResource.