Bug 1256727 - [Docs] [REST] Typo in JSON example in Cloudforms Documentation, chapter 3.8.8
Summary: [Docs] [REST] Typo in JSON example in Cloudforms Documentation, chapter 3.8.8
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat CloudForms Management Engine
Classification: Red Hat
Component: Documentation
Version: 5.6.0
Hardware: All
OS: All
medium
low
Target Milestone: Beta 2
: 5.6.0
Assignee: Dayle Parker
QA Contact: Red Hat CloudForms Documentation
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2015-08-25 10:50 UTC by Roland Wolters
Modified: 2016-05-19 21:46 UTC (History)
7 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-05-19 21:46:47 UTC
Category: ---
Cloudforms Team: ---
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Roland Wolters 2015-08-25 10:50:08 UTC
Description of problem:
Cloudforms documentation, chapter 3.8.8 has a JSON example for deleting multiple vms. However, the JSON example is not valid JSON.

Version-Release number of selected component (if applicable):
3.2

How reproducible:
Validate the JSON example.

Steps to Reproduce:
1. open https://access.redhat.com/documentation/en-US/Red_Hat_CloudForms/3.2/html-single/Red_Hat_CloudForms_REST_API/index.html
2. look at json example for deleting multiple machines
3. observe the missing curly brackets around the objects in the array

Actual results:
Invalid JSON

Expected results:
Valid JSON

Additional info:
The example should look like this:
{
  "action" : "delete",
  "resources" : [
    {"href" : "https://hostname/api/vms/348"},
    {"href" : "https://hostname/api/vms/349"},
    {"href" : "https://hostname/api/vms/3"}
  ]
}

Comment 1 Andrew Dahms 2016-03-14 13:20:38 UTC
Hi Roland,

Thank you for raising this bug.

Moving to the Red Hat CloudForms documentation queue so that this bug can be addressed as part of work on that documentation suite.

Kind regards,

Andrew

Comment 3 Lucy Bopf 2016-04-29 04:02:44 UTC
Assigning to Dayle for review.

Comment 4 Dayle Parker 2016-05-03 00:02:25 UTC
I've fixed the "Deleting multiple virtual machines" JSON example in the following branches/versions, directly in Gitlab:

* 4.1 (master)
* 4.0
* 3.2

These will show up in the next build of these guides.

Comment 5 Dayle Parker 2016-05-05 06:33:54 UTC
The 4.0 version with fixes has been published to Customer Portal: https://access.redhat.com/documentation/en/red-hat-cloudforms/version-4.0/red-hat-cloudforms-rest-api/

3.2 version republish is pending.

Comment 6 Dayle Parker 2016-05-19 21:46:47 UTC
This is now live in the 3.2 version of the REST API Guide:
https://access.redhat.com/documentation/en/red-hat-cloudforms/version-4.0/red-hat-cloudforms-rest-api/#delete-vms


Note You need to log in before you can comment on or make changes to this bug.