将 Sahara REST API 示例从 /etc 移动到 docs¶
https://blueprints.launchpad.net/sahara/+spec/move-rest-samples-to-docs
最初这个想法是在讨论 Sahara 子项目的移动/发布/版本控制时提出的。REST 示例略微过时，将它们放在通用文档中是一个保持它们最新状态的好地方。
问题描述¶
目前 REST API 示例已过时，并且不能反映自 Havana 版本以来在 Sahara api 中所做的当前更改状态。 此外，在 Sahara 源代码中找到这些示例并不明显。目标是更新示例的当前状态，并将其移动到 https://docs.openstack.org/
提议的变更¶
在 docs 中创建一个新页面
sahara/doc/source/restapi/rest_api_samples.rst
将所有 JSON 示例从 sahara/etc/rest-api-samples 移动到新页面。应在每个 JSON 代码块之前添加简单的描述。
替代方案¶
无
数据模型影响¶
无
REST API 影响¶
无
其他最终用户影响¶
示例将不再在 sahara/etc 目录中找到。
部署者影响¶
无
开发者影响¶
无
Sahara-image-elements impact¶
无
Sahara-dashboard / Horizon 影响¶
无
实现¶
负责人¶
主要负责人：Alexander Ignatov
工作项¶
应执行以下步骤
将 REST 示例从 sahara/etc 移动到 docs 中的新页面
根据 Sahara api 的当前状态更新 docs 中的示例
删除 Sahara 源代码中的 sahara/etc/rest-api-samples 目录
依赖项¶
无
测试¶
无
文档影响¶
Sahara 文档中将出现一个包含 REST 示例信息的新的页面。
参考资料¶
无
