api_server: convert the VmmActionError to a JSON object #1547
Conversation
This file contains hidden or 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
This was referenced Jan 24, 2020
The response from this function has content-type:application/json and Swagger specifies that the JSON object must have "fault_message". However the implementation was returning a plan string such as "vCPUs resume failed." which broke clients. Signed-off-by: Kazuyoshi Kato <[email protected]>
When "PUT /logger" returns an error, the error message must be wrapped as a JSON object. Signed-off-by: Kazuyoshi Kato <[email protected]>
andreeaflorescu
approved these changes
Jan 27, 2020
andreeaflorescu
added
the
Status: Awaiting review
sandreim
approved these changes
Jan 27, 2020
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 response from this function has content-type:application/json and
Swagger specifies that the JSON object must have "fault_message".
However the implementation was returning a plan string such as
"vCPUs resume failed." which broke clients.
Signed-off-by: Kazuyoshi Kato [email protected]
Reason for This PR
The response from this function has content-type:application/json and
Swagger specifies that the JSON object must have "fault_message".
However the implementation was returning a plan string such as
"vCPUs resume failed." which broke clients.
Description of Changes
It adds ApiServer::json_fault_message() to convert a string to a valid JSON document.
License Acceptance
By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license.
PR Checklist
[Author TODO: Meet these criteria. Where there are two options, keep one.][Reviewer TODO: Verify that these criteria are met. Request changes if not]git commit -s).clearly provided.
doc changes are included in this PR. Docs in scope are all
*.mdfileslocated either in the repository root, or in the
docs/directory.code is included in this PR.
reflected in
firecracker/swagger.yaml.this PR have user impact and have been added to the
CHANGELOG.mdfile.unsafecode has been added, or, the newly addedunsafecode is unavoidable and properly documented.