Remove unused swagger definitions

[MaciejBaj]

Expected behavior

Unused definitions are removed.

Actual behavior

Every time node start the warning is being shown:

WARNING: NODE_ENV value of 'test' did not match any deployment config file names.
WARNING: See https://github.com/lorenwest/node-config/wiki/Strict-Mode
WARNING: NODE_APP_INSTANCE value of '0' did not match any instance config file names.
WARNING: See https://github.com/lorenwest/node-config/wiki/Strict-Mode
[{"code":"UNUSED_DEFINITION","message":"Definition is not used: #/definitions/CommonBlock","path":["definitions","CommonBlock"]},{"code":"UNUSED_DEFINITION","message":"Definition is not used: #/definitions/PeersList","path":["definitions","PeersList"]},{"code":"UNUSED_DEFINITION","message":"Definition is not used: #/definitions/WSPeerHeaders","path":["definitions","WSPeerHeaders"]},{"code":"UNUSED_DEFINITION","message":"Definition is not used: #/definitions/WSPeerUpdateRequest","path":["definitions","WSPeerUpdateRequest"]},{"code":"UNUSED_DEFINITION","message":"Definition is not used: #/definitions/WSSignaturesList","path":["definitions","WSSignaturesList"]},{"code":"UNUSED_DEFINITION","message":"Definition is not used: #/definitions/WSBlocksList","path":["definitions","WSBlocksList"]},{"code":"UNUSED_DEFINITION","message":"Definition is not used: #/definitions/WSBlocksCommonRequest","path":["definitions","WSBlocksCommonRequest"]},{"code":"UNUSED_DEFINITION","message":"Definition is not used: #/definitions/WSTransactionsRequest","path":["definitions","WSTransactionsRequest"]},{"code":"UNUSED_DEFINITION","message":"Definition is not used: #/definitions/WSAccessObject","path":["definitions","WSAccessObject"]},{"code":"UNUSED_DEFINITION","message":"Definition is not used: #/definitions/WSTransactionsResponse","path":["definitions","WSTransactionsResponse"]},{"code":"UNUSED_DEFINITION","message":"Definition is not used: #/definitions/WSSignaturesResponse","path":["definitions","WSSignaturesResponse"]},{"code":"UNUSED_DEFINITION","message":"Definition is not used: #/definitions/WSBlocksBroadcast","path":["definitions","WSBlocksBroadcast"]}] 2

Steps to reproduce

Start lisk-core.

Which version(s) does this affect? (Environment, OS, etc...)

1.0.0

[nazarhussain]

@MaciejBaj These definitions are used in our application but not in the HTTP API endpoints. Keep them for now, later we will refactor the swagger definition to decompose it to individual definition file then this warning will automatically be removed.

[MaciejBaj]

It still looks bad in logs. It will be solved as introduced in 1.0.0 release.

[nazarhussain]

This issue is caused due to

https://github.com/theganyo/swagger-node-runner/blob/3f5c099161ed7f526338091612463d5fc3c91880/index.js#L217-L227

Specially line:
https://github.com/theganyo/swagger-node-runner/blob/3f5c099161ed7f526338091612463d5fc3c91880/index.js#L221

I don't feel maintaining a fork for this issue is a good idea. We will take care of this issue along with #2146

[shuse2]

Removing the definition not directly used in API, which actually should not be part of API doc, should solve this problem.

[nazarhussain]

Those definitions will not be referenced in the API when we will upgrade the Swagger to 3.0

[nazarhussain]

@diego-G The issue can be started when the PR apigee-127/swagger-node-runner#134 is merged and released. Until then please move this issue to some other release.

[shuse2]

As of [email protected], this was addressed