swagger-api/swagger-codegen

generated HTML contains invalid anchor links

Open

#5,087 opened on Mar 16, 2017

View on GitHub
 (5 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: HTMLIssue: Bughelp wanted

Description

Description

generated HTML contains invalid anchor links on types of request parameters

Swagger-codegen version

current master; HEAD = 1c160df33897898da1c39f230c737eb6a313e6ba

Swagger declaration file content or url
swagger: "2.0"

info:
  title: swagger-codegen broken anchors to models
  version: '1.0'

definitions:
  foo:
    type: object
    properties:
      x:
        type: string

paths:
  /foo:
    get:
      parameters:
        - name: foo
          in: body
          description: foo
          schema: {$ref: "#/definitions/foo"}
      responses:
        "200":
          description: foo
          type: null
Command line used for generation

JAR=".../swagger-codegen.git/modules/swagger-codegen-cli/target/swagger-codegen-cli.jar" java -jar "${JAR}" generate -i ~/sscce.yaml -l html -o foo

Note in the generated html the link's first letter is capital while the anchor is not. Using Firefox 51.0.1 (64-bit)

Contributor guide

Tech stack
html
Domain
documentation
Issue type
bug
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.
half day
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
basic understanding of Mustache templatesHTML knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The bug is that generated HTML links use capitalized first letter for model references, while the corresponding anchor IDs are lowercase. This inconsistency causes broken links. The likely cause is in the HTML template files (e.g., modules/swagger codegen/src/main/resources/htmlDocs2/index.mustache) where the link generation and anchor generation may use different formatting functions. Look for places where model names are transformed for anchors (often using `lowercaseFirst` or similar) versus links. The fix should apply the same transformation to both. Check the Mustache templates for any helper functions that handle model name casing. Also review the Swagger2HTMLGenerator.java or similar Java source that processes the data model. The issue reproduces with a simple swagger spec; ensure that after fixing, anchors work correctly.