PATCH updates aren't documented

Bug #1466434 reported by Steven Hardy
16
This bug affects 2 people
Affects Status Importance Assigned to Milestone
OpenStack Heat
Fix Released
Undecided
Steven Hardy
openstack-api-site
Invalid
Medium
Steven Hardy

Bug Description

We now have partial support for PATCH updates, but they're not documented:

http://developer.openstack.org/api-ref-orchestration-v1.html

It seems that it's particularly important to document this, so we can explain what can and can't be ommitted when doing the API equivalent of heat stack-update -x

Tags: heat
Revision history for this message
Kanagaraj Manickam (kanagaraj-manickam) wrote :

I believe, this defect should be moved to openstack-api-site project

Revision history for this message
Steven Hardy (shardy) wrote :

> I believe, this defect should be moved to openstack-api-site project

Yeah that's true, my mistake, although perhaps we want to keep the heat part open and add something to the user guide in-tree explaining how you can do a patch update from the CLI?

This is related to bug #1224828 though, as currently PATCH updates are only partially working.

Revision history for this message
Atsushi SAKAI (sakaia) wrote :

It seems interesting.
Would you notice me a patch or some documentation about this?(PATCH update)

Revision history for this message
Anne Gentle (annegentle) wrote :

Steve, did the code patch have DocImpact and APIImpact? I'll look for another bug so we can link to the code here as well, it'll help someone work on it.

Changed in openstack-api-site:
status: New → Confirmed
importance: Undecided → Medium
Revision history for this message
Anne Gentle (annegentle) wrote :
Revision history for this message
Steven Hardy (shardy) wrote :

@Anne: Unfortunately the commit wasn't correctly tagged, the API support landed in https://review.openstack.org/#/c/109042/

Turns out that was an incomplete implementation, so I've recently been working to finish it, e.g https://review.openstack.org/#/c/154619/8 ref bug #1224828

I'm happy to take both these bugs and contribute docs patches when the remaining missing pieces have all landed.

Changed in heat:
assignee: nobody → Steven Hardy (shardy)
Changed in openstack-api-site:
assignee: nobody → Steven Hardy (shardy)
Atsushi SAKAI (sakaia)
tags: added: heat
Revision history for this message
Atsushi SAKAI (sakaia) wrote :

The API-Ref is moved from doc to each project (heat).

Changed in heat:
status: New → Confirmed
Changed in openstack-api-site:
status: Confirmed → Invalid
Revision history for this message
Steven Hardy (shardy) wrote :

> The API-Ref is moved from doc to each project (heat).

I'm confused - I just tried to fix this, and AFAICS the content I need to update isn't in the heat tree, it's here?

https://git.openstack.org/cgit/openstack/api-site/tree/api-ref/source/orchestration/v1

Thomas Herve (therve)
Changed in heat:
status: Confirmed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Duplicates of this bug

Other bug subscribers

Remote bug watches

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