swagger-api / swagger-api/swagger-codegen
swagger-codegen generate should error out on undefined type reference
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
swagger-codegen generate should error out on undefined type reference. Instead everything looks peachy until one looks into the generated html to find "undefined".
Note the "fo" vs "foo".
Swagger-codegen version
current master; HEAD = 1c160df33897898da1c39f230c737eb6a313e6ba
Swagger declaration file content or url
swagger: '2.0'
info:
title: "sscce"
version: '1.0'
description: sscce
definitions:
foo:
type: string
paths:
/foo:
post:
parameters:
- name: foo
in: body
schema: {$ref: "#/definitions/fo"}
responses:
"200":
description: foo
type: string
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 html2 -o foo
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
Start by running the java -jar ... swagger-codegen-cli.jar generate command with ~/sscce.yaml and the html2 generator. Compare the undefined #/definitions/fo reference with the declared foo definition; done means generation reports the invalid reference instead of producing HTML containing undefined.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100