示例指南类别

介绍段落 – 此指南类别解决什么问题？一段实施者可以理解的散文，描述该指南的意图和范围。标题和此第一段应分别用作提交消息的主题行和正文。

关于使用此模板的一些说明

• 您的指南应使用 ReSTructured 文本，如本模板所示。
• 请将文本换行到 79 列。
• 有关语法帮助，请参阅 https://sphinx-doc.cn/rest.html
• 要测试您的格式，请使用 tox 构建文档，或参见：http://rst.ninjs.org
• 有关 OpenStack 文档规范的帮助，请参阅 https://wiki.openstack.org/wiki/Documentation/Conventions

每个文件应包含一组相关的指南，例如“HTTP 标头”或类似内容。每个指南都有自己的子标题，并且每个部分都包含概述/介绍、指导部分、示例和参考。并非每个指南都会填写每个部分。如果您真的确定某个部分是多余的，则可以删除它。

指南名称

一条正在建议的详细指南。如果适用，它也应该有一个介绍。

指导

API 特别兴趣组希望提供的实际指导。

• 该指南应清楚地说明实施者需要采取的行动。
• 应避免引用特定的技术实现（例如，XXX-Y.Z 包）。
• 外部参考应通过注释在“参考”部分中提供指向源材料的链接进行描述。（例如，请参阅 RFC 0000 或此脚注指南 [1]）

示例

一系列演示所提议指南的正确用法的示例。这些示例可能包括但不限于

• JSON 对象。
• 演示请求和响应的 HTTP 方法。

示例不应包括

• 为实施设计的代码示例。

参考资料

在它们有助于更全面地理解指南的情况下，可以提供参考。您不需要任何参考。此外，即使您的参考不可用，该指南仍然应该有意义。您可以包含的内容示例是

• 邮件列表或 IRC 讨论的链接
• 峰会会议记录的链接
• 如果合适，相关研究的链接

RST 以以下格式支持脚注

脚注

[1]	https://sphinx-doc.cn/rest.html#footnotes