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

How to set the summary? #116

Open
Shamshiel opened this issue May 29, 2020 · 1 comment
Open

How to set the summary? #116

Shamshiel opened this issue May 29, 2020 · 1 comment

Comments

@Shamshiel
Copy link

Shamshiel commented May 29, 2020

I'm unsure what I need to write to set the summary of a method.

@Accept('text/plain')
@Path('mypath')
export class MyService {
    /**
     * This description will be used to describe the get operation of path '/mypath' on the generated swagger
     * @param test And this will describe the parameter test of this same operation
     */
    @GET
    @Path('secondpath')
    test2( @QueryParam('testParam')test?: string ): Person {
        return {name: 'OK'};
    }
}

This sets the "description" property of the swagger.json.
How to set the summary property?

@wisedog
Copy link

wisedog commented Aug 10, 2020

/**

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

2 participants