Bug 861225

Summary:	API documentation missing critical info in system.config.createOrUpdatePath
Product:	[Community] Spacewalk	Reporter:	Zailo Leite <zleite>
Component:	Documentation	Assignee:	Jan Pazdziora <jpazdziora>
Status:	CLOSED NEXTRELEASE	QA Contact:	Red Hat Satellite QA List <satqe-list>
Severity:	high	Docs Contact:
Priority:	unspecified
Version:	1.8	CC:	jpazdziora
Target Milestone:	---
Target Release:	---
Hardware:	All
OS:	All
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2012-10-01 07:21:02 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:
Bug Depends On:
Bug Blocks:	871344

Description Zailo Leite 2012-09-27 21:15:37 UTC

Description of problem:


On http://spacewalk.redhat.com/documentation/api/1.7/handlers/ServerConfigHandler.html#createOrUpdatePath , there's a missing value in the path_info struct, 'binary'. It is documented in the source:


     *   #struct("path info")
...
     *      #prop_desc("boolean", "binary", "mark the binary content, if True,
     *      base64 encoded content is expected (only for non-directories)")
     *  #struct_end()


Without this the uploaded files are treated as text by the spacewalk server and rendered unusable.

Comment 1 Jan Pazdziora 2012-10-01 07:21:02 UTC

The binary value was added in commit b77a05778a707b5fb12b932b78e44d01f3a188de. Therefore it is currently in Spacewalk master (and nightly builds) and not in Spacewalk 1.7. So, it's correct that it is not listed in the api/1.7/handlers API overview -- it will not work on Spacewalk 1.7.

When Spacewalk 1.8 is out, the API documentation will be generated and added to the api/1.8 directory.