Open Stack

There was a merge to add all missing methods from V1 to V2 [1]. Therefore,
via the V2 context we can access all features from V1, I would not bother
much to re-write it. However, of course, if you have the energy and time to
do it, it would be great to review your patches.

[1] https://review.opendev.org/c/openstack/cloudkitty/+/684734



On Thu, Nov 10, 2022 at 10:34 AM Mariusz Karpiarz <m.karpiarz at eschercloud.ai>
wrote:

> All,
> CloudKitty docs for v1 APIs (
> https://docs.openstack.org/cloudkitty/latest/api-reference/v1/v1.html)
> appear to be generated from the source code instead of using `os-api-ref` (
> https://opendev.org/openstack/os-api-ref), like in case of v2 docs.
> I want to move both v1 and v2 API docs to a separate `api-ref/source`
> directory in the root of the repository, where we will only be using
> "os_api_ref" and "openstackdocstheme" Sphinx extensions, so we need to
> decide what to do with v1 docs.
> I started rewriting v1 docs to the format supported by `os-api-ref` but
> they don't quite translate well to the new format, mainly because of
> different ways results are presented (Python objects vs JSONs). How much do
> we care about proper v1 API docs and would it be worth for someone (likely
> me) to write them again from scratch?
> There is also the option for carrying over the old extensions (they are
> all listed here:
> https://opendev.org/openstack/cloudkitty/src/branch/stable/zed/doc/source/conf.py#L42-L58)
> but I'm not sure all of them are still supported by the system building
> https://docs.openstack.org/api/ and this is a good opportunity to clean
> this list up. :)
> Please let me know if you have any ideas.
> Mariusz
>


-- 
Rafael Weingärtner
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.openstack.org/pipermail/openstack-discuss/attachments/20221116/3f5a909d/attachment.htm>