移除 /os-volumes_boot API

https://blueprints.launchpad.net/nova/+spec/remove-os-volumes-boot-api

移除未文档化、未使用的 /os-volumes_boot API。

问题描述

/os-volumes_boot API 是一个未文档化的、可能无人知晓的 /servers API 的别名。它没有任何用途,只会让用户和客户端感到困惑,尤其是在自动生成文档和客户端工具的时代。我们应该移除它。

用例

  • 作为客户端工具的开发者,我不想支持或特殊处理一个未文档化且重复现有 API 的 API。

提议的变更

/os-volumes_boot API 及其子 API 将被修改,以便从一个新的 API 微版本开始,对所有资源返回 HTTP 410 (Gone)。虽然该 API 将继续适用于旧的微版本,但我们将使用 nova.api.openstack.wsgi.removed 装饰器来标记该方法,以指示自动客户端和文档生成工具应忽略该 API。

备选方案

我们可以为所有微版本返回 HTTP 410 (Gone)。这将使客户端工具更容易,但从历史上看,我们只有在必要时才这样做(通常是因为底层功能已被移除)。

数据模型影响

无。

REST API 影响

/os-volumes_boot API 及其所有子 API 将从新的 API 微版本开始返回 HTTP 410 (Gone)。

安全影响

无。

通知影响

无。

其他最终用户影响

没有。openstackclient、openstacksdk、python-novaclient 或 Gophercloud 当前都不支持或使用此 API。

性能影响

无。

其他部署者影响

无。

开发人员影响

无。

升级影响

无。

实现

负责人

主要负责人

stephen.finucane

其他贡献者

功能联络人

功能联络人

stephen.finucane

工作项

  • 移除 API

依赖项

无。

测试

无。

文档影响

我们需要一个发布说明。由于该 API 当前未在 api-ref 中文档化,因此无需进行任何更改。

参考资料

无。