This may be a bit weird, but I found it in the wild in <a href="https://www.keycloak.o

Hey, just closing the loop on this one - as mentioned in <a class="issue-link js-issue

Generator confused by duplicated path parameter about oapi-codegen HOT 3 CLOSED

evankanderson commented on May 28, 2024

Generator confused by duplicated path parameter

from oapi-codegen.

Comments (3)

jamietanna commented on May 28, 2024

Hey, that's an interesting one!

I can see - when validating the spec with https://github.com/daveshanley/vacuum - that also reports this as an issue, but https://editor.swagger.io/ does not.

Looks like a reasonable repeat of a parameter, and should be a straightforward fix with

oapi-codegen/pkg/codegen/utils.go

Lines 562 to 580 in 472f1ca

 // SortParamsByPath reorders the given parameter definitions to match those in the path URI. 

 func SortParamsByPath(path string, in []ParameterDefinition) ([]ParameterDefinition, error) { 

 pathParams := OrderedParamsFromUri(path) 

 n := len(in) 

 if len(pathParams) != n { 

 return nil, fmt.Errorf("path '%s' has %d positional parameters, but spec has %d declared", 

 path, len(pathParams), n) 

 } 

 out := make([]ParameterDefinition, len(in)) 

 for i, name := range pathParams { 

 p := ParameterDefinitions(in).FindByName(name) 

 if p == nil { 

 return nil, fmt.Errorf("path '%s' refers to parameter '%s', which doesn't exist in specification", 

 path, name) 

 } 

 out[i] = *p 

 } 

 return out, nil 

 }

I'll also raise with Vacuum

from oapi-codegen.

jamietanna commented on May 28, 2024

Hey, just closing the loop on this one - as mentioned in pb33f/libopenapi#278 this is actually an issue with the spec and it's recommended you either work with the upstream to modify the spec to correct it, or fix it locally prior to generation. Appreciate you raising it, that was a TIL for me too!

from oapi-codegen.

evankanderson commented on May 28, 2024

FWIW, it sounds like vacuum, as a linter, is flagging this as against best practices, but the construction is actually allowed by the spec.

Would you be open to a PR to enable generation in this case, even though vacuum complains with a (silenceable) warning?

from oapi-codegen.

Recommend Projects

Generator confused by duplicated path parameter about oapi-codegen HOT 3 CLOSED

Comments (3)

Related Issues (20)

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

	// SortParamsByPath reorders the given parameter definitions to match those in the path URI.
	func SortParamsByPath(path string, in []ParameterDefinition) ([]ParameterDefinition, error) {
	pathParams := OrderedParamsFromUri(path)
	n := len(in)
	if len(pathParams) != n {
	return nil, fmt.Errorf("path '%s' has %d positional parameters, but spec has %d declared",
	path, len(pathParams), n)
	}
	out := make([]ParameterDefinition, len(in))
	for i, name := range pathParams {
	p := ParameterDefinitions(in).FindByName(name)
	if p == nil {
	return nil, fmt.Errorf("path '%s' refers to parameter '%s', which doesn't exist in specification",
	path, name)
	}
	out[i] = *p
	}
	return out, nil
	}