Back to Details

gws-docs

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

docs (v1)

docs (v1)

PREREQUISITE: Read 
../gws-shared/SKILL.md
for auth, global flags, and security rules. If missing, run 
gws generate-skills
to create it.
bash
gws docs <resource> <method> [flags]
前置要求： 阅读
../gws-shared/SKILL.md
了解认证、全局标志和安全规则。如果该文件缺失，请运行
gws generate-skills
命令生成它。
bash
gws docs <resource> <method> [flags]

Helper Commands

辅助命令

CommandDescription
+write
Append text to a document
命令描述
+write
向文档追加文本

API Resources

API 资源

documents

documents

  • batchUpdate
    — Applies one or more updates to the document. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. 
    • create
      — Creates a blank document using the title given in the request. Other fields in the request, including any provided content, are ignored. Returns the created document.
    • get
      — Gets the latest version of the specified document.
  • batchUpdate
    — 对文档应用一项或多项更新。每个请求在应用前都会经过验证。如果任何请求无效，则整个请求会失败，不会应用任何更改。部分请求会返回回复，告知您它们的应用情况。其他请求无需返回信息；这些请求会返回空回复。回复的顺序与请求的顺序一致。 
    • create
      — 使用请求中指定的标题创建一个空白文档。请求中的其他字段（包括提供的任何内容）都会被忽略。返回创建后的文档。
    • get
      — 获取指定文档的最新版本。

Discovering Commands

命令探索

Before calling any API method, inspect it:
bash
undefined
在调用任何API方法之前，请先查看其详情：
bash
undefined

Browse resources and methods

浏览资源和方法

gws docs --help
gws docs --help

Inspect a method's required params, types, and defaults

查看某个方法的必填参数、类型和默认值

gws schema docs.<resource>.<method>

Use `gws schema` output to build your `--params` and `--json` flags.
gws schema docs.<resource>.<method>

使用`gws schema`的输出来构建您的`--params`和`--json`标志。