Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Spec] Add default http scheme for server URL, Fix #181 #498

Conversation

grokify
Copy link
Member

@grokify grokify commented Jul 7, 2018

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
  • Filed the PR against the correct branch: master, 3.1.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

fix #181

  1. Includes additional tests for sanitizeUrl.
  2. Checks against scheme patterns shown by IANA list, which includes [0-9a-z.+\-]. Can be made more generic to match [^\p{Space}:/]
  3. Ran the bin/go-petstore.sh after removing the scheme from the spec and it works as expected. Didn't check in the changes because it requires a change in the spec.

Current Behavior before PR for bin/go-petstore.sh

Removing the scheme from the spec results in the following warning and a non-working client.

[main] WARN  o.o.codegen.utils.URLPathUtils - Not valid URL: petstore.swagger.io:80/v2. Default to http://localhost.

Generated configuration.go causes mvn integration-test to fail:

func NewConfiguration() *Configuration {
	cfg := &Configuration{
		BasePath:      "petstore.swagger.io:80/v2",
		DefaultHeader: make(map[string]string),
		UserAgent:     "OpenAPI-Generator/1.0.0/go",
	}
	return cfg
}

New Behavior

bin/go-petstore.sh

[main] WARN  o.o.codegen.utils.URLPathUtils - 'scheme' not defined in the spec (2.0). Default to [http] for server URL [http://petstore.swagger.io:80/v2]

configuration.go with http scheme and passing integration tests.

func NewConfiguration() *Configuration {
	cfg := &Configuration{
		BasePath:      "http://petstore.swagger.io:80/v2",
		DefaultHeader: make(map[string]string),
		UserAgent:     "OpenAPI-Generator/1.0.0/go",
	}
	return cfg
}

@wing328 wing328 added this to the 3.1.1 milestone Jul 9, 2018
Copy link
Member

@wing328 wing328 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me and thanks for the additional test cases.

@wing328 wing328 merged commit 86a0445 into OpenAPITools:master Jul 9, 2018
A-Joshi pushed a commit to ihsmarkitoss/openapi-generator that referenced this pull request Feb 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Not valid URL: localhost:9000/api. Default to http://localhost.
2 participants