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 (12,701 stars) (5,474 forks)batch import
Client: GoEnhancement: GeneralGeneral: Discussionhelp wanted

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

Tech stack
gorest api
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Knowledge of Go pointersUnderstanding of Mustache templatesFamiliarity with swagger codegen's template structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
The change requires modifying the Go template files (likely in `modules/swagger codegen/src/main/resources/handlebars/` or `mustache/` directory) to add a pointer `*` before non primitive types. Review the existing template `type.mustache` or `model.mustache` for Go. The issue discussion may contain hints about which templates to change. No linked PR exists, so this is fresh work.