AKIRA-MIYAKE / serverless-import-swagger

Import functions from OpenAPI spec file to serverless.yml

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

How to use x-sis-config is unclear

exoego opened this issue · comments

Sorry, but I could not understand

  • When to use x-sis-config
  • How to use x-sis-config (what options are supported ?)

from the current description

https://github.com/AKIRA-MIYAKE/serverless-import-swagger#x-sis-config
You can use the extension of x-sis-config to write config in the spec file.
The config at the top level apply to the entire file, and the config at operation parameters apply only to that function.
If you disable all in config, only operations for which x-sis-config is set are imported.

It would be helpful to understand if example configs and example ouputs are added.

Thank you for your feedback.

The config available items and their default values ​​are defined here.

https://github.com/AKIRA-MIYAKE/serverless-import-swagger/blob/master/src/functions/prepare-config.ts#L25

Available locations are info section and operation section in the path section.

https://swagger.io/docs/specification/openapi-extensions/

I am sorry that the writing is difficult to understand. I will update README.md.