feat: Add support for json omitempty to apitypings

coder · mafredri · May 10, 2022 · May 6, 2022 · May 6, 2022 · May 6, 2022
commit f0be8853b21103718321bb45ec408a9c031aa8a3
diff --git a/codersdk/pagination.go b/codersdk/pagination.go
@@ -14,16 +14,16 @@ type Pagination struct {
 	// Offset for better performance. To use it as an alternative,
 	// set AfterID to the last UUID returned by the previous
 	// request.
-	AfterID uuid.UUID `json:"after_id"`
+	AfterID uuid.UUID `json:"after_id,omitempty"`
 	// Limit sets the maximum number of users to be returned
 	// in a single page. If the limit is <= 0, there is no limit
 	// and all users are returned.
-	Limit int `json:"limit"`
+	Limit int `json:"limit,omitempty"`
 	// Offset is used to indicate which page to return. An offset of 0
 	// returns the first 'limit' number of users.
 	// To get the next page, use offset=<limit>*<page_number>.
 	// Offset is 0 indexed, so the first record sits at offset 0.
-	Offset int `json:"offset"`
+	Offset int `json:"offset,omitempty"`
 }
 
 // asRequestOption returns a function that can be used in (*Client).request.

diff --git a/scripts/apitypings/main.go b/scripts/apitypings/main.go
@@ -251,6 +251,10 @@ func (g *Generator) buildStruct(obj types.Object, st *types.Struct) (string, err
 		if jsonName == "" {
 			jsonName = field.Name()
 		}
+		jsonOptional := false
+		if len(arr) > 1 && arr[1] == "omitempty" {
+			jsonOptional = true
+		}
 
 		var tsType TypescriptType
 		// If a `typescript:"string"` exists, we take this, and do not try to infer.
@@ -273,7 +277,7 @@ func (g *Generator) buildStruct(obj types.Object, st *types.Struct) (string, err
 			_, _ = s.WriteRune('\n')
 		}
 		optional := ""
-		if tsType.Optional {
+		if jsonOptional || tsType.Optional {
 			optional = "?"
 		}
 		_, _ = s.WriteString(fmt.Sprintf("%sreadonly %s%s: %s\n", indent, jsonName, optional, tsType.ValueType))

diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -91,7 +91,7 @@ export interface CreateWorkspaceBuildRequest {
   // This is likely an enum in an external package ("github.com/coder/coder/coderd/database.WorkspaceTransition")
   readonly transition: string
   readonly dry_run: boolean
-  readonly state: string
+  readonly state?: string
 }
 
 // From codersdk/organizations.go:52:6
@@ -149,9 +149,9 @@ export interface OrganizationMember {
 
 // From codersdk/pagination.go:11:6
 export interface Pagination {
-  readonly after_id: string
-  readonly limit: number
-  readonly offset: number
+  readonly after_id?: string
+  readonly limit?: number
+  readonly offset?: number
 }
 
 // From codersdk/parameters.go:26:6
@@ -185,7 +185,7 @@ export interface ProvisionerJob {
   readonly created_at: string
   readonly started_at?: string
   readonly completed_at?: string
-  readonly error: string
+  readonly error?: string
   readonly status: ProvisionerJobStatus
   readonly worker_id?: string
 }
@@ -355,12 +355,12 @@ export interface WorkspaceAgent {
   readonly status: WorkspaceAgentStatus
   readonly name: string
   readonly resource_id: string
-  readonly instance_id: string
+  readonly instance_id?: string
   readonly architecture: string
   readonly environment_variables: Record<string, string>
   readonly operating_system: string
-  readonly startup_script: string
-  readonly directory: string
+  readonly startup_script?: string
+  readonly directory?: string
 }
 
 // From codersdk/workspaceagents.go:47:6
@@ -415,7 +415,7 @@ export interface WorkspaceResource {
   readonly workspace_transition: string
   readonly type: string
   readonly name: string
-  readonly agents: WorkspaceAgent[]
+  readonly agents?: WorkspaceAgent[]
 }
 
 // From codersdk/parameters.go:16:6