向谷歌云端点变量添加描述

Question

如何向谷歌云端点变量添加描述字符串，以便在谷歌的 API 资源管理器中可见？ 我能够使用 cmets """ """ 向方法添加描述。例如：

@endpoints.method(LocationRequestMessage, LocationResponseMessage, path='location', http_method='POST',
                  name='location.create')
def location_create(self, request):
    """
    Creates a location
    """

这是我想要实现的一个示例： https://developers.google.com/apis-explorer/#p/calendar/v3/calendar.acl.insert

输入字段：

calendarId--> 日历标识符。

请求正文：

范围--> 规则的范围

我必须在哪里添加粗体描述文本才能显示它？

Answer 1

cmets 在发现文件 (APPLICATION-NAME-rest.discovery) 中定义。

来自Google APIs Discovery Service：

"methods": {
    (key): {
      "id": string,
      "path": string,
      "httpMethod": string,
      "description": string,
      "parameters": {
        (key): {
          "id": string,
          "type": string,
          "$ref": string,
          "description": string,
          "default": string,
          "required": boolean,
          "format": string,
          "pattern": string,

您可以看到“描述”字段。目前，endpoints.sh get-discovery 似乎没有获取代码 cmets 并填写这些描述。但是您可以自己修改 .discovery 文件并部署到 appengine。