Ft adding message field optional

[alpeshvas]

• [x] Fixes #10
• [x] Add test cases for the feature
• [x] Update Readme
• [x] Update openapi sepcs
• [x] Update help command

Sneak peak:

[connorads]

Good to speak with you the other day @alpeshvas Thanks again for your PR 🚀

I've thought of a few places that will need updating with this change:

• https://github.com/connorads/lockbot/blob/master/README.md?plain=1#L32
• https://github.com/connorads/lockbot/blob/master/src/handlers/swagger/openapi.json
• https://github.com/connorads/lockbot/blob/master/src/lock-bot.ts#L43-L51

I'm hoping to take a proper look at this PR sometime this week 🤞

[alpeshvas]

Good to speak with you the other day @alpeshvas Thanks again for your PR rocket

I've thought of a few places that will need updating with this change:

• https://github.com/connorads/lockbot/blob/master/README.md?plain=1#L32
• https://github.com/connorads/lockbot/blob/master/src/handlers/swagger/openapi.json
• https://github.com/connorads/lockbot/blob/master/src/lock-bot.ts#L43-L51

I'm hoping to take a proper look at this PR sometime this week crossed_fingers

Will make those changes.

[alpeshvas]

Good to speak with you the other day @alpeshvas Thanks again for your PR rocket I've thought of a few places that will need updating with this change:

• https://github.com/connorads/lockbot/blob/master/README.md?plain=1#L32
• https://github.com/connorads/lockbot/blob/master/src/handlers/swagger/openapi.json
• https://github.com/connorads/lockbot/blob/master/src/lock-bot.ts#L43-L51

I'm hoping to take a proper look at this PR sometime this week crossed_fingers

Will make those changes.

Done. Also, we can use something like this for auto generation of swagger , wdyt @connorads ?https://www.serverless.com/plugins/serverless-openapi-documentation

[connorads]

Nice one @alpeshvas!

Unfortunately we got some lint and type check errors in CI

Try running yarn lint locally

• The lint issues should be easily fixed by running yarn eslint --fix "**/*.{js,ts}" and committing the changes
• The type issue can be fixed by using adding a type annotation respondArguments: RespondArguments

If you want to see what is being run on CI you can have a look at the build script https://github.com/connorads/lockbot/blob/master/.github/workflows/build.yml#L19

[connorads]

Done. Also, we can use something like this for auto generation of swagger , wdyt @connorads ?https://www.serverless.com/plugins/serverless-openapi-documentation

Nice idea. I'm open to autogeneration ideas but if I understand correctly this plugin doesn't appear to offer much automation. It just seems to move the spec into serverless.yml. I'd rather keep the spec separate and in a standard format if we're not getting much added value.

[sonarqubecloud[bot]]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[coveralls]

Coverage increased (+0.007%) to 99.408% when pulling bd83d93cfda74aa2d6b0ae129117085824f75176 on alpeshvas:ft-adding-message-field-optional into ca5225b83cd611ded5cba685a7ec5383c93035fc on connorads:master.