Hide report lifecycle endpoint from apidocs

coder · mafredri · Jan 24, 2023 · Jan 19, 2023 · Jan 19, 2023 · Jan 19, 2023
commit 2ccdcacc8ffca45d99b88e7182081fc1d3cad6ee
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/workspaceagents.go b/coderd/workspaceagents.go
@@ -912,6 +912,7 @@ func (api *API) workspaceAgentReportStats(rw http.ResponseWriter, r *http.Reques
 // @Param request body codersdk.PostWorkspaceAgentLifecycleRequest true "Workspace agent lifecycle request"
 // @Success 204 "Success"
 // @Router /workspaceagents/me/report-lifecycle [post]
+// @x-apidocgen {"skip": true}
 func (api *API) workspaceAgentReportLifecycle(rw http.ResponseWriter, r *http.Request) {
 	ctx := r.Context()
 

diff --git a/docs/api/agents.md b/docs/api/agents.md
@@ -383,41 +383,6 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/metadata \
 
 To perform this operation, you must be authenticated. [Learn more](authentication.md).
 
-## Submit workspace agent lifecycle state
-
-### Code samples
-
-```shell
-# Example request using curl
-curl -X POST http://coder-server:8080/api/v2/workspaceagents/me/report-lifecycle \
-  -H 'Content-Type: application/json' \
-  -H 'Coder-Session-Token: API_KEY'
-```
-
-`POST /workspaceagents/me/report-lifecycle`
-
-> Body parameter
-
-```json
-{
-  "state": "created"
-}
-```
-
-### Parameters
-
-| Name   | In   | Type                                                                                                 | Required | Description                       |
-| ------ | ---- | ---------------------------------------------------------------------------------------------------- | -------- | --------------------------------- |
-| `body` | body | [codersdk.PostWorkspaceAgentLifecycleRequest](schemas.md#codersdkpostworkspaceagentlifecyclerequest) | true     | Workspace agent lifecycle request |
-
-### Responses
-
-| Status | Meaning                                                         | Description | Schema |
-| ------ | --------------------------------------------------------------- | ----------- | ------ |
-| 204    | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | Success     |        |
-
-To perform this operation, you must be authenticated. [Learn more](authentication.md).
-
 ## Submit workspace agent stats
 
 ### Code samples