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

Add documentation to ClientService interface #2977

Open
ffalor opened this issue Oct 3, 2023 · 0 comments
Open

Add documentation to ClientService interface #2977

ffalor opened this issue Oct 3, 2023 · 0 comments

Comments

@ffalor
Copy link

ffalor commented Oct 3, 2023

Problem statement

It would be nice to have the documentation for a endpoint to show up in the definition hover in tools like vscode.

Example:

type ClientService interface {
	DeprovisionSystemDefinition(params *DeprovisionSystemDefinitionParams, opts ...ClientOption) (*DeprovisionSystemDefinitionOK, error)
}

/*
DeprovisionSystemDefinition deprovisions a system definition that was previously provisioned on the target cid
*/
func (a *Client) DeprovisionSystemDefinition(params *DeprovisionSystemDefinitionParams, opts ...ClientOption) (*DeprovisionSystemDefinitionOK, error) {

image

Where if we were to add the comment to the fields we would get something like this:

type ClientService interface {
	/*
		DeprovisionSystemDefinition deprovisions a system definition that was previously provisioned on the target cid
	*/
	DeprovisionSystemDefinition(params *DeprovisionSystemDefinitionParams, opts ...ClientOption) (*DeprovisionSystemDefinitionOK, error)

image

Environment

swagger version: v0.30.5
go version: 1.21.1
OS: Win 10

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants