Improvement: Specify stages for excluding swagger endpoints

[jochembeetz]

As of right now, swagger endpoints are always added. I want my swagger to only be generated and/or deployed when the stage is development or staging.

Suggestion:

custom:
  autoswagger:
      stages:
         - staging
         - development

[bfaulk96]

I would think you could already do that with something like

Serverless 2.0.0:

custom:
  generateSwagger:
    staging: true
    development: true
    prod: false
  autoswagger:
    generateSwaggerOnDeploy: ${{self:custom.generateSwagger.${{self:provider.stage}}}} 

Serverless 3.0.0:

params:
  default:
    generateSwagger: false
  staging:
    generateSwagger: true
  development:
    generateSwagger: true
custom:
  autoswagger:
    generateSwaggerOnDeploy: ${param:generateSwagger}

[bfaulk96]

Would you mind checking and letting me know?

[jochembeetz]

Thanks for your quick response.
I'm sorry I was not clear enough, I meant i don't want swagger endpoints to be: added to my lambda functions / deployed in specific stages.

P.S. I tested the above (Serverless 2.0) with config:

custom:
  generateSwagger:
    staging: true
    development: false
  autoswagger:
    generateSwaggerOnDeploy: ${{self:custom.generateSwagger.${{self:provider.stage}}}}
    schemes: ['https', 'http']
    apiType: http
    apiKeyHeaders: ['Authorization']
    basePath: /installation

serverless deploy --stage development still generates and adds swagger endpoints

[sunilnalumachu]

Did you found solution for deploy swagger on specified stages, I tried above comment
custom:
generateSwagger:
staging: false
development: false
prod: false
autoswagger:
generateSwaggerOnDeploy: ${{self:custom.generateSwagger.${{self:provider.stage}}}}

But Did Not worked still deploying the swagger doc, Is there any way we can stop deploying swagger doc, while sls deploy.

[bfaulk96]

@sunilnalumachu please refer to the documentation rather than this thread for the final implementation. The config mentioned in your comment is not expected to work. See excludeStages in the README.

[sunilnalumachu]

@bfaulk96 I tried that before but want to understand more on stages, like which params you support. I am currently using my local stage env in excludeStages array like this.
excludeStages: ['mytestStage', 'prod'].

can you give some examples what are the stages you exclude and can i use my local stage to exclude while sls deploy.

[Jon-Berg]

@sunilnalumachu please refer to the documentation rather than this thread for the final implementation. The config mentioned in your comment is not expected to work. See excludeStages in the README.

@bfaulk96
I tried using excludeStages: ['prd'] and weirdly, instead of not deploying the swagger lambdas to prd stage,
It did deploy them, and named them with dev stage prefixes.

So I think I'll temporarily use this workaround - #46 (comment)

Edit:
Now I've realized that it happens because the plugin assumes I put the stage name under provider, but we use it only from ${opt:stage}

[bfaulk96]

I'll look into updating that to support opt:stage and sls:stage as well!