Springfox #845: Configuration for global Operation-Parameters.

[GitVhaos]

Added support for configuration of global operation parameters.

[dilipkrish]

@GitVhaos sorry I had forgotten about this! i'll take a look and merge it in if everything looks ok! Thanks very much for your pr! 👍

[dilipkrish]

@GitVhaos would be awesome if you could also update the docs 👍

[GitVhaos]

I`m new to gitHub... Where can I update the docs? ^^

[dilipkrish]

Depends on what you're trying to document... but here is the directory where the documentation lives.

[thadc23]

Is there a way to hide/show these global parameters by HttpMethod? For example, I have a header param that I only want on every POST, PUT, and PATCH operation, but not on the others. Before I give it a shot with a PR, I wanted to make sure it wasn't already possible and I was just missing it.

[dilipkrish]

@thadc23 yes there is way, but at the moment you'd have to partition your apis into multiple dockets. So it will apply global parameters per docket. I believe there is a feature request to allow global parameters using a selector predicate. But it may be marked as a "Someday Maybe" feature. (I'll update this thread once I find it)

Let me know if you need any help working through it.

[thadc23]

@dilipkrish Were you ever able to find the feature for global params using a selector predicate? For a relatively small change and to implement filtering by method, I could add a List of HttpMethods to the Parameter and change the OperationParameterReader to filter the global list by the current operation's http method before adding the globals to the parameters for that operation.

To ensure backwards compatibility, I would add a second constructor to the Parameter that accepts a list of HttpMethods and have the current constructor call the new one with the List of all HttpMethods.

Thoughts?

[dilipkrish]

I think there is a solution described here that is preferable.

[dilipkrish]

Basically creating a plugin that adds parameters conditionally.

[thadc23]

Got it working using the plugin. Thanks.

[dilipkrish]

👍

[avineshsachan]

__

Can we set GlobalOperationParameters in Docket Bean at run time as a authentication Token:

docket.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build().globalOperationParameters(Lists.newArrayList(new ParameterBuilder()
.name("sso-token")
.description("Description of someGlobalParameter")
.modelRef(new ModelRef("string"))
.parameterType("header")
.required(true).defaultValue**("Run Tme Value get from SSO Service")**
.build()));

Please share a way to to it

Thanks in advance.

[avineshsachan]

__

Can we set GlobalOperationParameters in Docket Bean at run time as a authentication Token:

docket.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build().globalOperationParameters(Lists.newArrayList(new ParameterBuilder()
.name("sso-token")
.description("Description of someGlobalParameter")
.modelRef(new ModelRef("string"))
.parameterType("header")
.required(true).defaultValue**("Run Tme Value get from SSO Service")**
.build()));

Please share a way to to it

Thanks in advance.