Bug #17897

Response of the api to get host status in the apidoc is incorrect with the actuals

Added by Marek Hulán 10 months ago. Updated 6 months ago.

Status:Closed
Priority:Normal
Assigned To:Marek Hulán
Category:API
Target version:Team Marek backlog
Difficulty: Bugzilla link:1342023
Found in release: Pull request:https://github.com/theforeman/foreman/pull/4453
Story points-
Velocity based estimate-
Release1.15.0Release relationshipAuto

Description

Cloned from https://bugzilla.redhat.com/show_bug.cgi?id=1342023

Description of problem:
According to current API documentation https://satellite.example.com/apidoc/v2/hosts.html#description-status

The return value of "GET /api/hosts/:id/status" API may either be one of the following, but its not matching with actual output of the API

  • missing
  • failed
  • pending
  • changed
  • unchanged
  • unreported

Version-Release number of selected component (if applicable):
Satellite 6.1.8 / 6.2 and Foreman 1.11+ including nightly

How reproducible:
Always

Steps to Reproduce:
1. Login to the satellite webui
2. Hit the URL https://<satellite.example.com>/api/v2/hosts to get list of hosts with its ID.
3. Hit the URL https://&lt;satellite.example.com&gt;/apidoc/v2/hosts/<:id>/status

Actual results:
Return value is either of the following:

Pending Installation
No Status
No Change
Out of Sync

Expected results:
As per the api documentation provided by the product

Status values can be either one of the following:

missing
failed
pending
changed
unchanged
unreported

Additional info: Need to update the API doc with all the updated Status and their meaning.


Related issues

Related to Foreman - Feature #10782: Add global status for hosts Closed 06/11/2015

Associated revisions

Revision 710095f6
Added by Marek Hulán 6 months ago

Fixes #17897 - update status api documentation

Revision ab32efbe
Added by Marek Hulán 6 months ago

Fixes #17897 - update status api documentation

History

#1 Updated by Marek Hulán 10 months ago

  • Subject changed from Response of the api to get host status in the apidoc is incorrect with the actuals to Response of the api to get host status in the apidoc is incorrect with the actuals
  • Category changed from Inventory to API

#2 Updated by Marek Hulán 10 months ago

  • Target version set to Team Marek backlog

#3 Updated by Marek Hulán 6 months ago

#4 Updated by The Foreman Bot 6 months ago

  • Status changed from New to Ready For Testing
  • Assigned To set to Marek Hulán
  • Pull request https://github.com/theforeman/foreman/pull/4453 added

#5 Updated by Daniel Lobato Garcia 6 months ago

  • Release set to 1.15.0

#6 Updated by Anonymous 6 months ago

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

Also available in: Atom PDF