swagger-api / swagger-api/swagger-codegen
generated HTML contains invalid anchor links
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the issue using the provided sscce.yaml and the Java CLI command with the html generator. Inspect the generated HTML's links and anchors for the request-parameter model, then confirm that the link target and anchor use matching capitalization.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html, java
- Domain
- documentation, web-dev
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100