Release 0.3.0 (#5)

* Release 0.3.0 docs.

* Release 0.3.0 platform specific parts.

* Release 0.3.0 common parts.

.abapgit.xml

@@ -13,7 +13,7 @@
     <item>/.travis.yml</item>
     <item>/.gitlab-ci.yml</item>
     <item>/abaplint.json</item>
-    <item>/MIGRATION-V0.2.0.md</item>
+    <item>/MIGRATION-V0.3.0.md</item>
    </IGNORE>
   </DATA>
  </asx:values>

MIGRATION-V0.2.0.md → MIGRATION-V0.3.0.md

@@ -1,7 +1,17 @@
-# Upgrading to ABAP SDK version 0.2.0
+# Upgrading to ABAP SDK version 0.3.0
 
 ## Breaking changes
 
+### Breaking changes by service
+#### Factory Method
+- Parameter `I_PROXY_SERVICE` of method `ZCL_IBMC_SERVICE_EXT=>GET_INSTANCE` is renamed to `I_PROXY_PORT`.
+
+#### Visual Recognition V4
+- Parameter `I_UPDATEOBJECTMETADATA` of method `UPDATE_OBJECT_METADATA` is required (previously this was optional).
+
+##
+## Special instructions when directly upgrading from versions earlier than 0.2.0
+
 ### Table conversion necessary after pull
 
 The ABAP SDK for IBM Watson is now enabled to separate configuration data by storing data into client-specific tables. To achieve this tables `ZIBMC_TOKEN` and `ZIBMC_CONFIG` were made client-specific by adding a column holding the SAP client number.

README.md

@@ -2,7 +2,7 @@
 
 # ABAP SDK for IBM Watson, using SAP NetWeaver
 
-ABAP client library to use the [IBM Watson APIs][wdc]. This is a Community SDK written by ABAPers for the ABAPers in the Open Source community, to provide easy usage of IBM Watson Developer Services in innovation initiatives combined with any SAP Application which is run on SAP NetWeaver 7.50 and above, such as SAP ECC or SAP S/4HANA. It is the choice and responsibility of application developers how this Community SDK is used.
+ABAP client library to use the [IBM Watson APIs][wdc]. This is a Community SDK written by ABAPers for the ABAPers in the Open Source community, to provide easy usage of IBM Watson Developer Services in innovation initiatives combined with any SAP Application which is run on SAP NetWeaver 7.50 and above, such as SAP Business Suite or SAP S/4HANA on-premises edition. It is the choice and responsibility of application developers how this Community SDK is used.
 
 Additionally, as the ABAP SDK is a community release it is not updated with the same schedule as IBM-supported SDKs. Please see more information in [Questions](#questions).
 
@@ -11,7 +11,7 @@ Additionally, as the ABAP SDK is a community release it is not updated with the
 | **abap-sdk-nwas** | [abap-sdk-scp](https://github.com/watson-developer-cloud/abap-sdk-scp) |
 |---|---|
 | for SAP NetWeaver AS ABAP 7.50+ | for SAP Cloud Platform ABAP Environment 2002+ |
-| tested on SAP ECC and SAP S/4HANA |  |
+| tested on SAP Business Suite and SAP S/4HANA on-premises edition |  |
 | `this repository` |  |
 
 ---
@@ -38,8 +38,8 @@ Additionally, as the ABAP SDK is a community release it is not updated with the
 </details>
 
 ## ANNOUNCEMENTS
-### Minor version 0.2.0 released
-Version v0.2.0 of the SDK has been released and includes two breaking changes - see what's changed in the [migration guide](MIGRATION-V0.2.0.md).
+### Minor version 0.3.0 released
+Version v0.3.0 of the SDK has been released and includes one breaking change - see what's changed in the [migration guide](MIGRATION-V0.3.0.md).
 
 ## Before you begin
 * You need an [IBM Cloud][ibm_cloud_onboarding] account.
@@ -211,7 +211,7 @@ Using the client library requires two steps:
     exporting
       i_url      = <url>
       i_apikey   = <api key>
-...
+      ...
     importing   
       eo_instance = lo_service_class ).
 ```
@@ -343,8 +343,8 @@ Using the client library requires two steps:
   zcl_ibmc_service_ext=>get_instance(
     exporting
       i_url     = 'https://api.eu-gb.personality-insights.watson.cloud.ibm.com/instances/<uuid>'
-      i_apikey   = lv_apikey
-      i_version  = '2018-05-01'
+      i_apikey  = lv_apikey
+      i_version = '2018-05-01'
     importing
       eo_instance = lo_personality_insights ).
 
@@ -393,7 +393,7 @@ Using the client library requires two steps:
   " get Watson Language Translator service instance
   zcl_ibmc_service_ext=>get_instance(
     exporting
-      i_url      = 'https://api.us-south.language-translator.watson.cloud.ibm.com/instances/<uudi>'
+      i_url      = 'https://api.us-south.language-translator.watson.cloud.ibm.com/instances/<uuid>'
       i_apikey   = lv_apikey
       i_version  = '2018-05-01'
     importing

docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_util.html

@@ -5,7 +5,8 @@
 </span></td></tr></table></td></tr><tr ><td>public static</td><td><table class="methodSignature"><tr><td colspan="3"><span class="identifier methodName">convert_timestamp_to_datetime</span> </td></tr><tr><td>importing</td><td><span class="identifier parameterName">i_timestamp</span></td><td>type TIMESTAMP</td></tr><tr><td>returning</td><td>value(<span class="identifier parameterName">e_datetime</span>)</td><td>type ZCL_IBMC_SERVICE=>DATETIME</td></tr></table></td><td><span class="abapDocComment"> Converts a timestamp to datetime format, i.e. YYYYMMDDHHMMSS -&gt; yyyy-mm-ddThh:mm:ssZ
 
  </span><h5>Parameters</h5><table class="methodParametersDocumentation"><tr ><td><span class="identifier parameterName">i_timestamp</span></td><td><span class="abapDocComment"> Timestamp.
- </span></td></tr><tr ><td><span class="identifier parameterName">e_datetime</span></td><td><span title="Short Text">UTC&#x20;Time&#x20;Stamp&#x20;in&#x20;Short&#x20;Form&#x20;&#x28;YYYYMMDDhhmmss&#x29;</span></td></tr></table></td></tr><tr ><td>public static</td><td><table class="methodSignature"><tr><td colspan="3"><span class="identifier methodName">convert_timestamp_to_local</span> </td></tr><tr><td>importing</td><td><span class="identifier parameterName">iv_timestamp</span></td><td>type TIMESTAMP</td></tr><tr><td>returning</td><td>value(<span class="identifier parameterName">ev_local</span>)</td><td>type STRING</td></tr></table></td><td><span class="abapDocComment"> Converts a timestamp in UTC to a timestamp in local time.
+ </span></td></tr><tr ><td><span class="identifier parameterName">e_datetime</span></td><td><span class="abapDocComment"> Datetime format.
+</span></td></tr></table></td></tr><tr ><td>public static</td><td><table class="methodSignature"><tr><td colspan="3"><span class="identifier methodName">convert_timestamp_to_local</span> </td></tr><tr><td>importing</td><td><span class="identifier parameterName">iv_timestamp</span></td><td>type TIMESTAMP</td></tr><tr><td>returning</td><td>value(<span class="identifier parameterName">ev_local</span>)</td><td>type STRING</td></tr></table></td><td><span class="abapDocComment"> Converts a timestamp in UTC to a timestamp in local time.
 
  </span><h5>Parameters</h5><table class="methodParametersDocumentation"><tr ><td><span class="identifier parameterName">iv_timestamp</span></td><td><span class="abapDocComment"> Timestamp (UTC).
  </span></td></tr><tr ><td><span class="identifier parameterName">ev_local</span></td><td><span class="abapDocComment"> Timestamp (local time).
@@ -19,16 +20,17 @@
  </span><h5>Parameters</h5><table class="methodParametersDocumentation"><tr ><td><span class="identifier parameterName">i_itab</span></td><td><span class="abapDocComment"> Internal table to be converted.
  </span></td></tr><tr ><td><span class="identifier parameterName">i_dictionary</span></td><td><span class="abapDocComment"> Dictionary to be used for mapping ABAP identifiers to JSON keys.
  </span></td></tr><tr ><td><span class="identifier parameterName">i_lower_case</span></td><td><span class="abapDocComment"> If set to C_BOOLEAN_TRUE all keys in JSON string will be lower case.
+ </span></td></tr><tr ><td><span class="identifier parameterName">it_excluded_fields</span></td><td><span class="abapDocComment"> Internal table of table fields in I_ITAB that should not occur in result.
  </span></td></tr><tr ><td><span class="identifier parameterName">e_json</span></td><td><span class="abapDocComment"> JSON string.
- </span></td></tr></table></td></tr><tr ><td>public static</td><td><table class="methodSignature"><tr><td colspan="3"><span class="identifier methodName">tableschema_to_itab</span> </td></tr><tr><td>importing</td><td><span class="identifier parameterName">i_json</span></td><td>type STRING</td></tr><tr><td></td><td><span class="identifier parameterName">i_tableschema_key</span></td><td>type STRING optional</td></tr><tr><td>exporting</td><td><span class="identifier parameterName">e_itab</span></td><td>type ANY TABLE</td></tr></table></td><td><span class="abapDocComment"> Converts a JSON string in table schema format to an internal table.
+</span></td></tr></table></td></tr><tr ><td>public static</td><td><table class="methodSignature"><tr><td colspan="3"><span class="identifier methodName">tableschema_to_itab</span> </td></tr><tr><td>importing</td><td><span class="identifier parameterName">i_json</span></td><td>type STRING</td></tr><tr><td></td><td><span class="identifier parameterName">i_tableschema_key</span></td><td>type STRING optional</td></tr><tr><td>exporting</td><td><span class="identifier parameterName">e_itab</span></td><td>type ANY TABLE</td></tr></table></td><td><span class="abapDocComment"> Converts a JSON string in table schema format to an internal table.
    E.g.: '&#123;"tableschema_key": &#123;"fields": ["PET", "NUMBER"], "values": [["Cat",5],["Rabbit",2]]&#125;&#125;'
 
  </span><h5>Parameters</h5><table class="methodParametersDocumentation"><tr ><td><span class="identifier parameterName">i_json</span></td><td><span class="abapDocComment"> JSON string.
  </span></td></tr><tr ><td><span class="identifier parameterName">i_tableschema_key</span></td><td><span class="abapDocComment"> Key in JSON string that holds the table schema.
  </span></td></tr><tr ><td><span class="identifier parameterName">e_itab</span></td><td><span class="abapDocComment"> Internal table containing converted data.
- </span></td></tr></table></td></tr><tr ><td>public static</td><td><table class="methodSignature"><tr><td colspan="3"><span class="identifier methodName">utc_to_timezone</span> </td></tr><tr><td>importing</td><td><span class="identifier parameterName">i_timestamp</span></td><td>type TIMESTAMP</td></tr><tr><td></td><td><span class="identifier parameterName">i_timezone</span></td><td>type ZIF_IBMC_SERVICE_ARCH=>TY_TIMEZONE optional</td></tr><tr><td>returning</td><td>value(<span class="identifier parameterName">e_timestamp</span>)</td><td>type TIMESTAMP</td></tr></table></td><td><span class="abapDocComment"> Converts a timestamp in UTC to a timestamp in another timezone.
+</span></td></tr></table></td></tr><tr ><td>public static</td><td><table class="methodSignature"><tr><td colspan="3"><span class="identifier methodName">utc_to_timezone</span> </td></tr><tr><td>importing</td><td><span class="identifier parameterName">i_timestamp</span></td><td>type TIMESTAMP</td></tr><tr><td></td><td><span class="identifier parameterName">i_timezone</span></td><td>type ZIF_IBMC_SERVICE_ARCH=>TY_TIMEZONE optional</td></tr><tr><td>returning</td><td>value(<span class="identifier parameterName">e_timestamp</span>)</td><td>type TIMESTAMP</td></tr></table></td><td><span class="abapDocComment"> Converts a timestamp in UTC to a timestamp in another timezone.
 
  </span><h5>Parameters</h5><table class="methodParametersDocumentation"><tr ><td><span class="identifier parameterName">i_timestamp</span></td><td><span class="abapDocComment"> Timestamp (UTC).
  </span></td></tr><tr ><td><span class="identifier parameterName">i_timezone</span></td><td><span class="abapDocComment"> Time zone
  </span></td></tr><tr ><td><span class="identifier parameterName">e_timestamp</span></td><td><span class="abapDocComment"> Timestamp in give time zone.
-</span></td></tr></table></td></tr></table></div><div id="footer">Generated on 10.02.2020</div></body></html>
+</span></td></tr></table></td></tr></table></div><div id="footer">Generated on 12.03.2020</div></body></html>