swagger-api/swagger-codegen

[golang] Default to pointers for non-primitive types

Open

#2,330 opened on Mar 7, 2016

View on GitHub
 (14 comments) (0 reactions) (0 assignees)HTML (5,474 forks)batch import
Client: GoEnhancement: GeneralGeneral: Discussionhelp wanted

Repository metrics

Stars
 (12,701 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

It generates code like this currently:

type JobWrapper struct {
    Job  Job  `json:"job,omitempty"`
}

Same with slices and what not.

It would be nice (and probably what most people would want) to have it use pointers, eg:

type JobWrapper struct {
    Job *Job  `json:"job,omitempty"`
}

Contributor guide

Research direction
Locate the Go code generation templates (e.g., in modules/swagger codegen/src/main/resources/go) and modify the variable declarations for non primitive types to use pointers.
Tech stack
go
Domain
backendapitooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65