Bug 1383746 - The SDKs can't use the 'All-Content' parameter
Summary: The SDKs can't use the 'All-Content' parameter
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: ovirt-engine
Classification: oVirt
Component: RestAPI
Version: 4.0.5
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: ---
: ---
Assignee: Juan Hernández
QA Contact: Pavel Stehlik
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-10-11 16:40 UTC by Juan Hernández
Modified: 2022-06-27 12:32 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-09-20 15:05:38 UTC
oVirt Team: Infra
Embargoed:
sbonazzo: ovirt-4.2-


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker RHV-46714 0 None None None 2022-06-27 12:32:02 UTC
oVirt gerrit 65372 0 master MERGED Add the 'all_content' parameter for VMs 2020-10-14 18:51:41 UTC
oVirt gerrit 65373 0 master ABANDONED restapi: Accept both '_' and '-' for header parameters 2020-10-14 18:51:41 UTC
oVirt gerrit 65374 0 master ABANDONED restapi: Support 'All-Content' header and 'all_content' parameter 2020-10-14 18:51:41 UTC
oVirt gerrit 65536 0 model_4.0 MERGED Add the 'all_content' parameter for VMs 2020-10-14 18:51:41 UTC

Description Juan Hernández 2016-10-11 16:40:40 UTC
Currently the only way to use the 'All-Content' parameter is to use an HTTP header:

  GET /ovirt-engine/api/vms/123
  All-Content: true

This can't be expressed in the specification of the API, and can't be used in the SDKs, as they only support query parameters.

The API server should be changed to accept it as a query parameter:

  GET /ovirt-engine/api/vms/123?all_content=true

This should be documented in the specification of the API, and then all the SDKs will be able to use it.

Comment 1 Juan Hernández 2016-10-21 10:39:35 UTC
Version 4 of the SDKs have been modified so that they convert the 'all_content' query parameter into the 'All-Content' header:

  Python SDK:
  https://gerrit.ovirt.org/#/q/I5f4be9028d50a1571a938956d960d7c299400515

  Java SDK:
  https://gerrit.ovirt.org/#/q/I2b7be557957456cc834e2f22468bb8e8485e54f7

  Ruby SDK:
  https://gerrit.ovirt.org/#/q/I3c15fa5cc60a2c45406d4d892c68d1b6f54d38e1

This means that the SDKs will support the 'all_content' parameter without needing to modify the engine.

Anyhow, the engine should be modified to support both the 'all_content' query parameter and the 'All-Content' header, but I am re-targeting that to 4.1, as it isn't urgent.

Comment 2 Juan Hernández 2016-12-13 14:28:34 UTC
Re-targeting to 4.2, as the SDKs are fixed and the changes for the engine aren't ready.

Comment 3 Juan Hernández 2017-09-20 15:05:38 UTC
Not worth fixing at this point, may re-open in the future.


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