Merge pull request #176 from flotiq/feature/generating_packages_changes

More information about posibble problems with sdk

docs/API/generate-package.md

@@ -41,11 +41,14 @@ openapi-generator generate -g <name> -i <path_to_open_api_schema_json> --skip-va
 ```
 { data-search-exclude }
 
+_Worth to know is that you should have installed Java to run successfully command above._
+
+
 Parameters description:
 
-* `<name>` - name of framework/language you want to generate package for (ex. typescript-angular)
+* `<name>` - name of framework/language you want to generate package for (ex. typescript-angular).
 * `<path_to_open_api_schema_json>` - path to generated OpenApiSchema file.
-* `<output_path>` - specify where you want to output your generated package   
+* `<output_path>` - specify where you want to output your generated package.
 
 ## Use Swagger Editor to generate server and client libraries
 

docs/API/generate-package/sdk-nodejs.md

@@ -19,6 +19,8 @@ To use SDK in your project follow below steps:
 2. In your `[projectDirectory]/flotiq-javascript-sdk/` run `npm i && npm run build`
 3. In your `[projectDirectory]` run `npm i ./flotiq-javascript-sdk --save`
 
+Possibly you would have to add `--legacy-peer-deps` to your commands, if you get plugin versions error.
+
 _Other installation methods are described in [Additional usage methods](#additional-usage-methods) section._
 
 ### 2. Configure your SDK
@@ -28,6 +30,8 @@ To initialize SDK we will use `FlotiqUserApi.ApiClient.init` method, which requi
 Your Flotiq API_KEY is located in the [Flotiq Dashboard](https://editor.flotiq.com).
 If you need more directions go to the [docs](https://flotiq.com/docs/API/).
 
+You can create empty file, where you put code with your configuration and requests, such as `app.js`
+
 ```javascript
 const FlotiqUserApi = require("flotiq_user_api");
 FlotiqUserApi.ApiClient.init("API_KEY");
@@ -50,7 +54,7 @@ let opts = {
 };
 api.listFlotiqblogauthor(opts).then(
   function (data) {
-    console.log("API called successfully. Returned data: " + data);
+    console.log("API called successfully. Returned data: ", data);
   },
   function (error) {
     console.error(error);
@@ -59,6 +63,18 @@ api.listFlotiqblogauthor(opts).then(
 ```
 { data-search-exclude }
 
+Code above is just an example - you should copy code from `docs` folder in your sdk.
+
+To call the code lets just use: 
+
+
+```
+node app.js
+
+```
+{ data-search-exclude }
+
+
 ### 4. SDK NodeJS common use cases
 
 The Main concept of Flotiq is that your API Specification represents your set of content definitions literally.
@@ -105,4 +121,4 @@ Finally, you need to build the module:
 ```
 npm run build
 ```
-{ data-search-exclude }
+{ data-search-exclude }