bird docs read
Usage
Codebeispiel
bird docs read <slug> [flags]Description
Read documentation by its search-result slug. For API references, use view=request for endpoint, server, authentication and request fields, or view=response for response fields. The default full view includes code samples. Other pages always return full Markdown. The response URL is the page's citable source. Use index for the documentation landing page. This operation requires no authentication.
Examples
Codebeispiel
bird docs read <slug>Options
| Name | Description |
|---|---|
--locale | Documentation locale to read, as a language-region code such as en-us. Defaults to en-us when omitted or unavailable. |
--response-schema | Print the fields this command returns, then exit |
--view | Sections to read from an API reference. Other documentation pages return full content for every view. Defaults to full. Possible values: full, request, response. |
Related
| Name | Description |
|---|---|
bird docs search | Get documentation search results |
Verwandte Ressourcen
Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.