Rename codersdk.WorkspaceAppHostResponse to codersdk.AppHostResponse

coder · kylecarbs · Jan 29, 2023 · Jan 29, 2023 · Jan 29, 2023 · Jan 29, 2023
commit af3f67a6874a00505250bbac7d3b9b952da2e5e2
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/workspaceapps.go b/coderd/workspaceapps.go
@@ -77,7 +77,7 @@ const (
 // @Security CoderSessionToken
 // @Produce json
 // @Tags Applications
-// @Success 200 {object} codersdk.WorkspaceAppHostResponse
+// @Success 200 {object} codersdk.AppHostResponse
 // @Router /applications/host [get]
 func (api *API) appHost(rw http.ResponseWriter, r *http.Request) {
 	host := api.AppHostname

diff --git a/docs/api/applications.md b/docs/api/applications.md
@@ -51,8 +51,8 @@ curl -X GET http://coder-server:8080/api/v2/applications/host \
 
 ### Responses
 
-| Status | Meaning                                                 | Description | Schema                                                                           |
-| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------------------- |
-| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK          | [codersdk.WorkspaceAppHostResponse](schemas.md#codersdkworkspaceapphostresponse) |
+| Status | Meaning                                                 | Description | Schema                                                         |
+| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------- |
+| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK          | [codersdk.AppHostResponse](schemas.md#codersdkapphostresponse) |
 
 To perform this operation, you must be authenticated. [Learn more](authentication.md).
diff --git a/docs/api/schemas.md b/docs/api/schemas.md
@@ -415,6 +415,20 @@
 | --------- | ------ | -------- | ------------ | ----------- |
 | `license` | string | true     |              |             |
 
+## codersdk.AppHostResponse
+
+```json
+{
+  "host": "string"
+}
+```
+
+### Properties
+
+| Name   | Type   | Required | Restrictions | Description                                                   |
+| ------ | ------ | -------- | ------------ | ------------------------------------------------------------- |
+| `host` | string | false    |              | Host is the externally accessible URL for the Coder instance. |
+
 ## codersdk.AppearanceConfig
 
 ```json
@@ -5083,20 +5097,6 @@ Parameter represents a set value for the scope.
 | `healthy`      |
 | `unhealthy`    |
 
-## codersdk.WorkspaceAppHostResponse
-
-```json
-{
-  "host": "string"
-}
-```
-
-### Properties
-
-| Name   | Type   | Required | Restrictions | Description                                                   |
-| ------ | ------ | -------- | ------------ | ------------------------------------------------------------- |
-| `host` | string | false    |              | Host is the externally accessible URL for the Coder instance. |
-
 ## codersdk.WorkspaceAppSharingLevel
 
 ```json

diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -25,6 +25,11 @@ export interface AgentStatsReportResponse {
   readonly tx_bytes: number
 }
 
+// From codersdk/deployment.go
+export interface AppHostResponse {
+  readonly host: string
+}
+
 // From codersdk/deployment.go
 export interface AppearanceConfig {
   readonly logo_url: string
@@ -330,7 +335,7 @@ export interface DeploymentConfigField<T extends Flaggable> {
   readonly value: T
 }
 
-// From codersdk/insights.go
+// From codersdk/deployment.go
 export interface DeploymentDAUsResponse {
   readonly entries: DAUEntry[]
 }
@@ -468,7 +473,7 @@ export interface Organization {
   readonly updated_at: string
 }
 
-// From codersdk/organizationmember.go
+// From codersdk/organizations.go
 export interface OrganizationMember {
   readonly user_id: string
   readonly organization_id: string
@@ -615,7 +620,7 @@ export interface Role {
   readonly display_name: string
 }
 
-// From codersdk/sse.go
+// From codersdk/serversentevents.go
 export interface ServerSentEvent {
   readonly type: ServerSentEventType
   // eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO explain why this is needed
@@ -936,11 +941,6 @@ export interface WorkspaceApp {
   readonly health: WorkspaceAppHealth
 }
 
-// From codersdk/workspaces.go
-export interface WorkspaceAppHostResponse {
-  readonly host: string
-}
-
 // From codersdk/workspacebuilds.go
 export interface WorkspaceBuild {
   readonly id: string
@@ -986,7 +986,7 @@ export interface WorkspaceOptions {
   readonly include_deleted?: boolean
 }
 
-// From codersdk/quota.go
+// From codersdk/workspaces.go
 export interface WorkspaceQuota {
   readonly credits_consumed: number
   readonly budget: number
@@ -1167,7 +1167,7 @@ export const ResourceTypes: ResourceType[] = [
   "workspace_build",
 ]
 
-// From codersdk/sse.go
+// From codersdk/serversentevents.go
 export type ServerSentEventType = "data" | "error" | "ping"
 export const ServerSentEventTypes: ServerSentEventType[] = [
   "data",