You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Describe the bug
A clear and concise description of what the bug is.
When I install this SDK, the published folder structure is improperly formatted and doesn't match the README documentation in terms of how it can be used. There are a couple of issues; I'll capture both individually.
The published file structure is wrong. The package should be published from the dist directory but it seems to have been published from the root directory and includes the dist directory. See my screenshot of the published file structure below. It also includes a bunch of other files and such that do not belong in the published package like config files, etc.
The docs in the README do not match the Cloud docs. The Cloud docs at least seem correct for the currently published structure. Once the structure is fixed, however, the docs should be made to match. The README is more correct in terms of what it should be.
For example, the README gives the import path: @ibm-cloud/ibm-code-engine-sdk/code-engine/v2.
The Cloud docs show the import as import CodeEngineV2 from "@ibm-cloud/ibm-code-engine-sdk/dist/code-engine/v2";
To Reproduce
List the steps that can be used to demonstrate the bug. Include the name of the service and operation that you're trying to invoke, if applicable. Be sure to describe any relevant info regarding parameter values used with your API invocation.
constSchematicsV1=require('@ibm-cloud/ibm-code-engine-sdk/code-engine/v2');// from READMEconst{ NoAuthAuthenticator }=require('@ibm-cloud/ibm-code-engine-sdk/auth');constauthenticator=newNoAuthAuthenticator();constservice=newSchematicsV1({
authenticator,});
Run the code
$ node index.js
Expected behavior
A clear and concise description of what you expected to happen.
The code should run cleanly, with no errors or output. Instead, there is an exception: Error: Cannot find module '@ibm-cloud/ibm-code-engine-sdk/code-engine/v2'
Screenshots
If applicable, add screenshots to help explain your problem.
Must gather (please complete the following information):
SDK Version 3.1.0
Node Version 16.16.0
Additional context
Add any other context about the problem here.
Were you able to avoid the problem by changing your application code slightly?
The text was updated successfully, but these errors were encountered:
Describe the bug
A clear and concise description of what the bug is.
When I install this SDK, the published folder structure is improperly formatted and doesn't match the README documentation in terms of how it can be used. There are a couple of issues; I'll capture both individually.
The published file structure is wrong. The package should be published from the
dist
directory but it seems to have been published from the root directory and includes thedist
directory. See my screenshot of the published file structure below. It also includes a bunch of other files and such that do not belong in the published package like config files, etc.The docs in the README do not match the Cloud docs. The Cloud docs at least seem correct for the currently published structure. Once the structure is fixed, however, the docs should be made to match. The README is more correct in terms of what it should be.
For example, the README gives the import path:
@ibm-cloud/ibm-code-engine-sdk/code-engine/v2
.The Cloud docs show the import as
import CodeEngineV2 from "@ibm-cloud/ibm-code-engine-sdk/dist/code-engine/v2";
To Reproduce
List the steps that can be used to demonstrate the bug. Include the name of the service and operation that you're trying to invoke, if applicable. Be sure to describe any relevant info regarding parameter values used with your API invocation.
index.js
, with the following code:Expected behavior
A clear and concise description of what you expected to happen.
The code should run cleanly, with no errors or output. Instead, there is an exception:
Error: Cannot find module '@ibm-cloud/ibm-code-engine-sdk/code-engine/v2'
Screenshots

If applicable, add screenshots to help explain your problem.
Must gather (please complete the following information):
Additional context
Add any other context about the problem here.
Were you able to avoid the problem by changing your application code slightly?
The text was updated successfully, but these errors were encountered: