typos, minor changes to documentation

Author: harald-tsys

README.md

@@ -22,6 +22,10 @@ For documentation see: [otc-java-sdk-v1](https://opentelekomcloud-community.gith
 > Open documentation in browser: <http://127.0.0.1:8889>
 
 
+## References
+
+Code is an OTC adapted version of [java-sdk-core-3.2.6.jar](https://obs.cn-north-1.myhuaweicloud.com/apig-sdk/ApiGateway-java-sdk.zip) included in folder  ApiGateway-java-sdk-3.2.6/libs/.
+
 ## Warranty Disclaimer
 
 THE OPEN SOURCE SOFTWARE IN THIS PRODUCT IS DISTRIBUTED IN THE HOPE THAT IT

core/pom.xml

@@ -42,7 +42,7 @@
       <scope>compile</scope>
     </dependency>
 
-    <!-- if this dependency is added, additional log entries will apear in log output -->
+    <!-- if this dependency is added, additional log entries will appear in log output -->
     <!-- 
     <dependency>
       <groupId>org.slf4j</groupId>

doc/source/index.rst

@@ -1,10 +1,11 @@
 OTC Java SDK v1 documentation
 =============================
 
-The `OTC Java SDK v1` provides functionality to use the
-OpenTelekomCloud API in Java.
+This is the community version of OTC Java SDK v1.
 
-Especially methods for signing requests using AK/SK
+The `OTC Java SDK v1` provides functionality 
+for *Access Key* and *Secret Access Key* (AK/SK) request signing 
+used in OpenTelekomCloud API calls
 
 .. toctree::
    :includehidden:
@@ -19,6 +20,13 @@ Source Code
 
 For source code, see :github_repo_master:`OTC Java SDK v1 on Github <>`.
 
+References
+----------
+
+Code is an OTC adapted version of
+`java-sdk-core-3.2.6.jar <https://obs.cn-north-1.myhuaweicloud.com/apig-sdk/ApiGateway-java-sdk.zip>`_
+included in folder *ApiGateway-java-sdk-3.2.6/libs/*.
+
 Disclaimer
 ----------
 

doc/source/samples/index.rst

@@ -22,12 +22,21 @@ To run samples following environment variables have to be set:
       - Secret key
       - see: :api_usage:`Generating an AK and SK<guidelines/calling_apis/ak_sk_authentication/generating_an_ak_and_sk.html>` in API usage guide.
 
+    * - OTC_SDK_REGION
+      - Region (e.g. eu-de)
+      - for available regions, see: `Regions <https://docs.otc.t-systems.com/regions-and-endpoints/index.html#region>`_.
+
     * - OTC_SDK_PROJECTID
       - Project Id
       - see: :api_usage:`Obtaining a Project ID<guidelines/calling_apis/obtaining_required_information.html>` in API usage guide.
 
     * - OTC_IAM_ENDPOINT
-      - https://iam.eu-de.otc.t-systems.com
       - IAM Endpoint
+      - e.g. https://iam.eu-de.otc.t-systems.com or https://iam.eu-nl.otc.t-systems.com
 
 For samples, see :github_repo_master:`Samples folder <samples>`
+
+.. note:: 
+  Samples in folder :github_repo_master:`demo <samples/src/main/java/com/otc/sdk/samples/demo>`
+  are to demonstrate on how to use the OTC SDK for various use cases, including HTTP requests and WebSocket communication.
+  They are not working examples and require additional setup or configuration to run successfully.

samples/src/main/java/com/otc/sdk/samples/demo/HttpClientDemo.java

@@ -51,11 +51,11 @@ public static void main(String[] args) throws Exception {
       // Sign the request.
       HttpRequestBase signedRequest = Client.sign(httpClientRequest, Constant.SIGNATURE_ALGORITHM_SDK_HMAC_SHA256);
       if (Constant.DO_VERIFY) {
-        // creat httpClient and verify ssl certificate
+        // create httpClient and verify ssl certificate
         HostName.setUrlHostName(httpClientRequest.getHost());
         client = (CloseableHttpClient) SSLCipherSuiteUtil.createHttpClientWithVerify(Constant.INTERNATIONAL_PROTOCOL);
       } else {
-        // creat httpClient and do not verify ssl certificate
+        // create httpClient and do not verify ssl certificate
         client = (CloseableHttpClient) SSLCipherSuiteUtil.createHttpClient(Constant.INTERNATIONAL_PROTOCOL);
       }
       HttpResponse response = client.execute(signedRequest);

samples/src/main/java/com/otc/sdk/samples/demo/WebSocketDemo.java

@@ -49,11 +49,11 @@ public static void main(String[] args) throws Exception {
       okhttp3.Request signedRequest = Client.signOkhttp(webSocketRequest, Constant.SIGNATURE_ALGORITHM_SDK_HMAC_SHA256);
       OkHttpClient webSocketClient;
       if (Constant.DO_VERIFY) {
-        // creat okhttpClient and verify ssl certificate
+        // create okhttpClient and verify ssl certificate
         HostName.setUrlHostName(webSocketRequest.getHost());
         webSocketClient = SSLCipherSuiteUtil.createOkHttpClientWithVerify(Constant.INTERNATIONAL_PROTOCOL);
       } else {
-        // creat okhttpClient and do not verify ssl certificate
+        // create okhttpClient and do not verify ssl certificate
         webSocketClient = SSLCipherSuiteUtil.createOkHttpClient(Constant.INTERNATIONAL_PROTOCOL);
       }
       WebSocketListener webSocketListener = new WebSocketListener() {

samples/src/main/java/com/otc/sdk/samples/services/fg/HttpClientListFG.java

@@ -51,12 +51,13 @@ public static void main(String[] args) throws Exception {
       String ak = System.getenv("OTC_SDK_AK");
       String sk = System.getenv("OTC_SDK_SK");
       String projectId = System.getenv("OTC_SDK_PROJECTID");
+      String region = System.getenv("OTC_SDK_REGION");
 
       httpClientRequest.setKey(ak);
       httpClientRequest.setSecret(sk);
       httpClientRequest.setMethod(HttpMethodName.GET.toString());
 
-      String url = String.format("https://functiongraph.eu-de.otc.t-systems.com/v2/%s/fgs/functions", projectId);
+      String url = String.format("https://functiongraph.%s.otc.t-systems.com/v2/%s/fgs/functions",region, projectId);
 
       httpClientRequest.setUrl(url);
       httpClientRequest.addHeader("Content-type", "application/json;charset=utf8");

samples/src/main/java/com/otc/sdk/samples/services/fg/OkHttpListFG.java

@@ -46,11 +46,13 @@ public static void main(String[] args) throws Exception {
       String ak = System.getenv("OTC_SDK_AK");
       String sk = System.getenv("OTC_SDK_SK");
       String projectId = System.getenv("OTC_SDK_PROJECTID");
+      String region = System.getenv("OTC_SDK_REGION");
+
       OkHttpRequest.setKey(ak);
       OkHttpRequest.setSecret(sk);
       OkHttpRequest.setMethod(HttpMethodName.GET.toString());
 
-      String url = String.format("https://functiongraph.eu-de.otc.t-systems.com/v2/%s/fgs/functions", projectId);
+      String url = String.format("https://functiongraph.%s.otc.t-systems.com/v2/%s/fgs/functions", region, projectId);
       OkHttpRequest.setUrl(url);
 
       OkHttpRequest.addHeader("Content-type", "application/json;charset=utf8");

samples/src/main/java/com/otc/sdk/samples/services/vpv/HttpClientListVPC.java

@@ -51,12 +51,13 @@ public static void main(String[] args) throws Exception {
       String ak = System.getenv("OTC_SDK_AK");
       String sk = System.getenv("OTC_SDK_SK");
       String projectId = System.getenv("OTC_SDK_PROJECTID");
+      String region = System.getenv("OTC_SDK_REGION");
 
       httpClientRequest.setKey(ak);
       httpClientRequest.setSecret(sk);
       httpClientRequest.setMethod(HttpMethodName.GET.toString());
 
-      String url = String.format("https://vpc.eu-de.otc.t-systems.com/v1/%s/vpcs", projectId);
+      String url = String.format("https://vpc.%s.otc.t-systems.com/v1/%s/vpcs", region, projectId);
 
       httpClientRequest.setUrl(url);
       httpClientRequest.addHeader("Content-type", "application/json;charset=utf8");