Project

General

Profile

Bug #20471

API Doc for content view publishing is wrong

Added by Nagoor Shaik about 4 years ago. Updated about 3 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
-
Target version:
Difficulty:
Triaged:
Bugzilla link:
Fixed in Releases:
Found in Releases:

Description

Description of problem:
The generated API documentation for content views, specifically the POST for publish is incorrect. It states:
POST /katello/api/content_views/:id/publish
Publish a content view

Params

Param name Description
id
required
Content view identifier

Value: string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..
description
optional
Description for the new published content view version

Value: String

If you actually pass the id as a parameter, the content view will not publish. It makes sense as the ID is already in the path, but the documentation is simply wrong.

Using hammer in debug mode you can see the same:
[ INFO 2016-04-22 12:56:23 API] POST /katello/api/content_views/35/publish
[DEBUG 2016-04-22 12:56:23 API] Params: {}
[DEBUG 2016-04-22 12:56:23 API] Headers: {}

So the doc needs to be fixed. Note again this is in the autogenerated apidoc, I have no idea what is in the docs hosted by red hat.

Associated revisions

Revision 453bf7cf (diff)
Added by Nagoor Shaik about 4 years ago

Fixes #20471 - IDs in API doc should be numeric

History

#1 Updated by The Foreman Bot about 4 years ago

  • Status changed from New to Ready For Testing
  • Pull request https://github.com/Katello/katello/pull/6891 added

#2 Updated by Eric Helms about 4 years ago

  • Legacy Backlogs Release (now unused) set to 250

#3 Updated by Christine Fouant about 4 years ago

  • Bugzilla link changed from 1329748 to 1480316

#4 Updated by Nagoor Shaik about 4 years ago

  • Status changed from Ready For Testing to Closed
  • % Done changed from 0 to 100

Also available in: Atom PDF