mirror of
https://github.com/coder/coder.git
synced 2025-07-15 22:20:27 +00:00
docs: move api and cli docs routes to reference/ (#14241)
This commit is contained in:
committed by
GitHub
parent
6f9b1a39f4
commit
48f29a1995
@ -4,8 +4,8 @@ All actions possible through the Coder dashboard can also be automated as it
|
||||
utilizes the same public REST API. There are several ways to extend/automate
|
||||
Coder:
|
||||
|
||||
- [CLI](../cli.md)
|
||||
- [REST API](../api/)
|
||||
- [CLI](../reference/cli/README.md)
|
||||
- [REST API](../reference/api/README.md)
|
||||
- [Coder SDK](https://pkg.go.dev/github.com/coder/coder/v2/codersdk)
|
||||
|
||||
## Quickstart
|
||||
@ -32,9 +32,10 @@ curl https://coder.example.com/api/v2/workspaces?q=owner:me \
|
||||
|
||||
## Documentation
|
||||
|
||||
We publish an [API reference](../api/index.md) in our documentation. You can
|
||||
also enable a [Swagger endpoint](../cli/server.md#--swagger-enable) on your
|
||||
Coder deployment.
|
||||
We publish an [API reference](../reference/api/README.md) in our documentation.
|
||||
You can also enable a
|
||||
[Swagger endpoint](../reference/cli/server.md#--swagger-enable) on your Coder
|
||||
deployment.
|
||||
|
||||
## Use cases
|
||||
|
||||
@ -52,8 +53,8 @@ payloads, we recommend checking the CLI and API documentation.
|
||||
Workspace agents have a special token that can send logs, metrics, and workspace
|
||||
activity.
|
||||
|
||||
- [Custom workspace logs](../api/agents.md#patch-workspace-agent-logs): Expose
|
||||
messages prior to the Coder init script running (e.g. pulling image, VM
|
||||
- [Custom workspace logs](../reference/api/agents.md#patch-workspace-agent-logs):
|
||||
Expose messages prior to the Coder init script running (e.g. pulling image, VM
|
||||
starting, restoring snapshot).
|
||||
[coder-logstream-kube](https://github.com/coder/coder-logstream-kube) uses
|
||||
this to show Kubernetes events, such as image pulls or ResourceQuota
|
||||
@ -73,7 +74,7 @@ activity.
|
||||
}"
|
||||
```
|
||||
|
||||
- [Manually send workspace activity](../api/agents.md#submit-workspace-agent-stats):
|
||||
- [Manually send workspace activity](../reference/api/agents.md#submit-workspace-agent-stats):
|
||||
Keep a workspace "active," even if there is not an open connection (e.g. for a
|
||||
long-running machine learning job).
|
||||
|
||||
|
Reference in New Issue
Block a user