Mark services as Beta to indicate that the interfaces may not be stable

Bug #1468086 reported by Everett Toews
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack SDK
Fix Released
Medium
Terry Howe

Bug Description

As we commit all code to master (which is fine), it's easy to wind up releasing code that isn't completely stable. The interfaces and behaviour may change when using a particular service.

We need a way to mark services as Beta to indicate that the interfaces/behaviour may not be stable for our users. That way if they choose to use code that may not be completely stable yet, at least they be forewarned.

Changed in python-openstacksdk:
status: New → Confirmed
importance: Undecided → Medium
milestone: none → 1.0
Revision history for this message
Brian Curtin (brian.curtin) wrote :

In the Python standard library, there's the idea of provisional libraries, such as asyncio. https://docs.python.org/3/library/asyncio.html includes a note at the top saying it might change. We should probably just do the same.

tags: added: documentation
Revision history for this message
Everett Toews (everett-toews) wrote :

Based on the IRC discussion [1]

For every resource of a beta service, include at the top of the class docstring "BETA: This API is a work in progress and is subject to change."
For the Proxy class of a beta service, include at the top of the class docstring "BETA: This API is a work in progress and is subject to change."
For the proxy and user guide documentation of a beta service, include at the top of the doc

    .. caution::
       BETA: This API is a work in progress and is subject to change.

[1] http://eavesdrop.openstack.org/meetings/python_openstacksdk/2015/python_openstacksdk.2015-12-08-19.00.log.html#l-45

Terry Howe (thowe-g)
Changed in python-openstacksdk:
assignee: nobody → Terry Howe (thowe-g)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to python-openstacksdk (master)

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

Changed in python-openstacksdk:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to python-openstacksdk (master)

Reviewed: https://review.openstack.org/255465
Committed: https://git.openstack.org/cgit/openstack/python-openstacksdk/commit/?id=355945c7f50821584455f594f9924f94b5455447
Submitter: Jenkins
Branch: master

commit 355945c7f50821584455f594f9924f94b5455447
Author: Terry Howe <email address hidden>
Date: Wed Dec 9 13:08:48 2015 -0700

    Add admonition to telemetry code

    This code is subject to change in the near future. The alarm
    class is probably moving out of here and many of the resource
    property have aliases. We have agreed not to support the old
    aliases going forward, because it doesn't work well. The
    admonition can be pulled after these issues are fixed.

    Closes-Bug: #1468086
    Change-Id: Ica464a6c1e2281f4acbd25a121a399b6b0c81376

Changed in python-openstacksdk:
status: In Progress → Fix Released
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.