Compute API Reference - version response doesn't require 'updated'

Bug #1634668 reported by Matt Riedemann
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Fix Released
Medium
Takashi Natsume

Bug Description

http://developer.openstack.org/api-ref/compute/?expanded=list-all-major-versions-detail#list-all-major-versions

That doesn't have 'updated' in the response table and it also has a note that says:

"The updated parameter in the response is vestigial and provides no useful information."

However, 'updated' is required by the Tempest API schema check when listing the compute endpoint's / root versions list:

https://github.com/openstack/tempest/blob/13.0.0/tempest/lib/api_schema/response/compute/v2_1/versions.py#L50

-----------------------------------
Release: 14.0.0.0rc2.dev459 on 'Tue Oct 18 13:29:32 2016, commit 1b62be7'
SHA:
Source: Can't derive source file URL
URL: http://developer.openstack.org/api-ref/compute/

Revision history for this message
Matt Riedemann (mriedem) wrote :

Also note that listing versions from the root publicURL endpoint is a refstack/defcore test so we can't just change the schema in tempest.

Changed in nova:
status: New → Confirmed
importance: Undecided → Medium
tags: added: low-hanging-fruit
Jaewoo Park (aselius)
Changed in nova:
assignee: nobody → Jaewoo Park (aselius)
Revision history for this message
Ken'ichi Ohmichi (oomichi) wrote :

The description part of http://developer.openstack.org/api-ref/compute/?expanded=list-all-major-versions-detail#list-all-major-versions doesn't contain 'updated_at' as this report, but the response sample part contains it on the api-ref.

So I am not sure how to handle this problem, is it fine to just add 'update_at' to the description of api-ref?

Revision history for this message
Sean Dague (sdague) wrote :

@oomichi - it's not really a useful field, honestly, I don't think Tempest should be testing for it. Maybe we can remove it in the future, but it's basically a fixed string that is going to be there forever.

Revision history for this message
Jaewoo Park (aselius) wrote :

hmm do you guys think it would make sense for us to include it in the response table with the note still there for now, and remove the field from Tempest along with the note and response table row in the future?

Jaewoo Park (aselius)
Changed in nova:
assignee: Jaewoo Park (aselius) → nobody
Changed in nova:
assignee: nobody → Hesam Chobanlou (hesamchobanlou)
Revision history for this message
Jay Pipes (jaypipes) wrote :

Hesam, are you working on this? I don't see a patch that references this bug. Please update us to the status.

summary: - Compute API in Compute API Reference - version response doesn't require
- 'updated'
+ Compute API Reference - version response doesn't require 'updated'
Changed in nova:
assignee: Hesam Chobanlou (hesamchobanlou) → nobody
Changed in nova:
assignee: nobody → Takashi NATSUME (natsume-takashi)
Changed in nova:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (master)

Fix proposed to branch: master
Review: https://review.openstack.org/475226

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (master)

Reviewed: https://review.openstack.org/475226
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=d04ddb0a2bff3d91455962a94213e17d9693ee2d
Submitter: Jenkins
Branch: master

commit d04ddb0a2bff3d91455962a94213e17d9693ee2d
Author: Takashi NATSUME <email address hidden>
Date: Mon Jun 19 13:13:09 2017 +0900

    api-ref: Fix missing parameters in API Versions

    Add 'updated' and 'media-types' explicitly
    in parameter tables.

    Change-Id: I3e9f3374d4183d7ef7d3cb55cc95a4499ab20d49
    Closes-Bug: #1634668

Changed in nova:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/nova 16.0.0.0b3

This issue was fixed in the openstack/nova 16.0.0.0b3 development milestone.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.