zowe / zlux

The top-level superproject for zLUX. zLUX includes the Zowe Desktop framework in addition to several built-in apps and an example server implementation.
Eclipse Public License 2.0
39 stars 42 forks source link

Warning: ZWED0047W - Swagger file for server (...) not found #422

Open Joe-Winchester opened 4 years ago

Joe-Winchester commented 4 years ago

User are seeing the messages

Warning: ZWED0047W - Swagger file for server (...) not found

in the log files, e.g.

ZWED0047W - Swagger file for service (org.zowe.zlux.ng2desktop:browser-preferences) not found
ZWED0047W - Swagger file for service (org.zowe.zlux.bootstrap:adminnotificationdata) not found
ZWED0047W - Swagger file for service (org.zowe.terminal.proxy:tn3270data) not found
ZWED0047W - Swagger file for service (org.zowe.terminal.tn3270:statediscovery) not found

This is now documented in troubleshooting. Can these messages be suppressed, or are they symptoms of something that needs fixing ?

1000TurquoisePogs commented 4 years ago

This is working as designed. It's a warning issued to persuade developers to provide documentation (our conformance program says it too)

Joe-Winchester commented 4 years ago

Tks @1000TurquoisePogs - these apps are org.zowe though so I wonder if we could supress the org.zowe plugins (as there's nothing a user can do about them) and also if an abc.xyz.com doesn't implement swagger and gets told off with warning messages, then it seems odd for us to call them out in conformance and us to be non-conformant with org.zowe. I'm just trying to help get chaff out of the log that is causing users to be misdirected when they are doing Zowe problem determination.

pierremontel commented 4 years ago

Hi Folks, I am not sure if I have the same problem on my Zowe. I see some of the mentioned previous messages but I have others. Here are the warning messages I am getting: ZWED0068I - Creating composite swagger endpoint for org.zowe.api.catalog 2020-08-10 07:36:08.530 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:141) ZWED0050W - Could not read swagger doc folder /SYSTEM/dev/Zowe113/runtime/components/app-server/share/zlux-workflow/doc/swagger 2020-08-10 07:36:08.533 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:141) ZWED0050W - Could not read swagger doc folder /SYSTEM/dev/Zowe113/runtime/components/app-server/share/zlux-workflow/doc/swagger 2020-08-10 07:36:08.715 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:141) ZWED0050W - Could not read swagger doc folder /SYSTEM/dev/Zowe113/runtime/components/app-server/share/zlux-app-manager/virtual-desktop/doc/swag 2020-08-10 07:36:08.717 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:141) ZWED0050W - Could not read swagger doc folder /SYSTEM/dev/Zowe113/runtime/components/app-server/share/zlux-app-manager/bootstrap/doc/swagger 2020-08-10 07:36:08.718 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:141) ZWED0050W - Could not read swagger doc folder /SYSTEM/dev/Zowe113/runtime/components/app-server/share/zlux-server-framework/plugins/terminal-pr 2020-08-10 07:36:08.718 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:141) ZWED0050W - Could not read swagger doc folder /SYSTEM/dev/Zowe113/runtime/components/app-server/share/tn3270-ng2/doc/swagger 2020-08-10 07:36:08.720 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:109) ZWED0047W - Swagger file for service (org.zowe.zosmf.workflows:zosmf) not found 2020-08-10 07:36:08.724 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:109) ZWED0047W - Swagger file for service (org.zowe.zlux.ng2desktop:browser-preferences) not found 2020-08-10 07:36:08.724 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:109) ZWED0047W - Swagger file for service (org.zowe.zlux.bootstrap:adminnotificationdata) not found 2020-08-10 07:36:08.725 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:109) ZWED0047W - Swagger file for service (org.zowe.terminal.proxy:tn3270data) not found 2020-08-10 07:36:08.725 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:109) ZWED0047W - Swagger file for service (org.zowe.terminal.tn3270:statediscovery) not found 2020-08-10 07:36:08.714 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:141) ZWED0050W - Could not read swagger doc folder /SYSTEM/dev/Zowe113/runtime/components/app-server/share/zlux-app-manager/virtual-desktop/doc/swag 2020-08-10 07:36:08.922 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:141) ZWED0050W - Could not read swagger doc folder /SYSTEM/dev/Zowe113/runtime/components/app-server/share/zlux-app-manager/bootstrap/doc/swagger 2020-08-10 07:36:08.923 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:141) ZWED0050W - Could not read swagger doc folder /SYSTEM/dev/Zowe113/runtime/components/app-server/share/zlux-server-framework/plugins/terminal-pr 2020-08-10 07:36:08.923 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:141) ZWED0050W - Could not read swagger doc folder /SYSTEM/dev/Zowe113/runtime/components/app-server/share/tn3270-ng2/doc/swagger 2020-08-10 07:36:08.927 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:109) ZWED0047W - Swagger file for service (org.zowe.zosmf.workflows:zosmf) not found 2020-08-10 07:36:08.928 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:141) ZWED0050W - Could not read swagger doc folder /SYSTEM/dev/Zowe113/runtime/components/app-server/share/zlux-workflow/doc/swagger 2020-08-10 07:36:08.929 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:141) ZWED0050W - Could not read swagger doc folder /SYSTEM/dev/Zowe113/runtime/components/app-server/share/zlux-server-framework/plugins/terminal-pr 2020-08-10 07:36:08.928 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:109) ZWED0047W - Swagger file for service (org.zowe.zlux.ng2desktop:browser-preferences) not found 2020-08-10 07:36:08.929 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:109) ZWED0047W - Swagger file for service (org.zowe.zlux.bootstrap:adminnotificationdata) not found 2020-08-10 07:36:08.929 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:109) ZWED0047W - Swagger file for service (org.zowe.terminal.proxy:tn3270data) not found 2020-08-10 07:36:08.929 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:109) ZWED0047W - Swagger file for service (org.zowe.terminal.tn3270:statediscovery) not found 2020-08-10 07:36:08.933 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:109) ZWED0047W - Swagger file for service (org.zowe.zosmf.workflows:zosmftracker) not found 2020-08-10 07:36:08.934 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:109) ZWED0047W - Swagger file for service (org.zowe.terminal.proxy:tn5250data) not found 2020-08-10 07:36:09.122 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:141) ZWED0050W - Could not read swagger doc folder /SYSTEM/dev/Zowe113/runtime/components/app-server/share/zlux-server-framework/plugins/terminal-pr 2020-08-10 07:36:09.123 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:109) ZWED0047W - Swagger file for service (org.zowe.terminal.proxy:vtdata) not found 2020-08-10 07:36:09.329 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:141) ZWED0050W - Could not read swagger doc folder /SYSTEM/dev/Zowe113/runtime/components/app-server/share/zlux-workflow/doc/swagger 2020-08-10 07:36:09.330 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:141) ZWED0050W - Could not read swagger doc folder /SYSTEM/dev/Zowe113/runtime/components/app-server/share/zlux-server-framework/plugins/terminal-pr 2020-08-10 07:36:09.331 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:109) ZWED0047W - Swagger file for service (org.zowe.zosmf.workflows:zosmftracker) not found 2020-08-10 07:36:09.331 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:109) ZWED0047W - Swagger file for service (org.zowe.terminal.proxy:tn5250data) not found 2020-08-10 07:36:09.524 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:141) ZWED0050W - Could not read swagger doc folder /SYSTEM/dev/Zowe113/runtime/components/app-server/share/zlux-server-framework/plugins/terminal-pr 2020-08-10 07:36:09.526 ZWESVUSR WARN (_zsf.install,swagger-catalog.js:109) ZWED0047W - Swagger file for service (org.zowe.terminal.proxy:vtdata) not found

Thanks to let me know if I can ignore those messages. Pierre

Joe-Winchester commented 4 years ago

@pierremontel - yes you can ignore those message. One thing that can help is to search for a msg ID in the docs.zowe.org site search bar with ZWED0050W and ZWED0047W

image

This will take you to the troubleshooting chapter where you should see that both of the warning messages are benign and can be ignored.

https://docs.zowe.org/stable/troubleshoot/app-framework/app-troubleshoot.html#warning-zwed0050w-could-not-read-swagger-doc-folder

and

https://docs.zowe.org/stable/troubleshoot/app-framework/app-troubleshoot.html#warning-zwed0047w-swagger-file-for-server-not-found

@1000TurquoisePogs - I recall that some of these messages may have been squelched in newer Zowe releases, or else there was a plan to do so ?

pierremontel commented 4 years ago

@Joe-Winchester - Thank you for the confirmation as the way to get the messages information.