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

OpenAPIDefinitionGetter interface is incorrect #514

Open
Airblader opened this issue Oct 31, 2024 · 0 comments
Open

OpenAPIDefinitionGetter interface is incorrect #514

Airblader opened this issue Oct 31, 2024 · 0 comments

Comments

@Airblader
Copy link

Airblader commented Oct 31, 2024

kube-openapi has two interfaces

type OpenAPIDefinitionGetter interface {
	OpenAPIDefinition() *OpenAPIDefinition
}

type OpenAPIV3DefinitionGetter interface {
	OpenAPIV3Definition() *OpenAPIDefinition
}

However, implementing this doesn't actually work, because they're incorrectly specified. The methods actually need to return the structs directly, not a pointer of the struct, for it to work. Since the generator never actually checks for the interface, but purely for the existence of the method, this goes unnoticed.

The interfaces actually should be declared as

type OpenAPIDefinitionGetter interface {
	OpenAPIDefinition() OpenAPIDefinition
}

type OpenAPIV3DefinitionGetter interface {
	OpenAPIV3Definition() OpenAPIDefinition
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant