Skip to content

Commit

Permalink
* Various changes for v1.1.0 release.
Browse files Browse the repository at this point in the history
- Update cmake version to v1.1.0.
- Adapt CHANGELOG.md with v1.1.0 release changeset.
- Add CallApi doxygen documentation.

Resolves: OLPEDGE-1207

Signed-off-by: Mykhailo Kuchma <ext-mykhailo.kuchma@here.com>
  • Loading branch information
mykhailo-kuchma committed Dec 11, 2019
1 parent 9790f56 commit 0d2a0c4
Show file tree
Hide file tree
Showing 10 changed files with 47 additions and 8 deletions.
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
## v1.1.0 (11/12/2019)

**Common**
* The deprecated `olp::client::CancellationToken::cancel()` method was removed. Use `olp::client::CancellationToken::Cancel()` instead.
* The `curl` network implementation was fixed and can now compile on 32 bits architecture.
* The `disk_path` field in `olp::cache::CacheSettings` is deprecated. Use the `disk_path_mutable` field instead.
* A new synchronous `CallApi` method was added to `olp::client::OlpClient`.
* `pipe` and `pipe2` symbols detection are enhanced in curl.cmake.

**olp-cpp-sdk-authentication**
* The `SignInClient` method in `olp::authentication::AuthenticationClient` is deprecated in favor of the newly introduced `SignInClient` method with a different signature.
* The `scope` support was added to OAuth2 through `olp::authentication::SignInProperties`. You can now access the project bound resources using the `olp::authentication::SignInProperties::scope` field.
* The `error_id` field was added to the `ErrorResponse` structure. You can use it to get the `errorId` string from the authentication error response.

**olp-cpp-sdk-dataservice-read**
* The deprecated `GetCatalogMetadataVersion` method was removed from the `olp::dataservice::read::CatalogClient`.

**olp-cpp-sdk-dataservice-write**
* Legacy and unused code were removed.

## v1.0.0 (03/12/2019)

**Common**
Expand Down
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
cmake_minimum_required(VERSION 3.9)

# Build the sdk targets
project(olp-cpp-sdk VERSION 1.0.0)
project(olp-cpp-sdk VERSION 1.1.0)

# Add preprocessor definitions for the SDK version and platform name
add_definitions(-DOLP_SDK_VERSION_STRING=\"${olp-cpp-sdk_VERSION}\")
Expand Down
2 changes: 1 addition & 1 deletion examples/dataservice-write/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ elseif(ANDROID)
${OLP_SDK_EXAMPLE_FAILURE_STRING})

else()
project(${OLP_SDK_DATASERVICE_WRITE_EXAMPLE_TARGET} VERSION 1.0.0)
project(${OLP_SDK_DATASERVICE_WRITE_EXAMPLE_TARGET} VERSION 1.1.0)

add_executable(${OLP_SDK_DATASERVICE_WRITE_EXAMPLE_TARGET} ${CMAKE_CURRENT_SOURCE_DIR}/example.h ${CMAKE_CURRENT_SOURCE_DIR}/example.cpp)

Expand Down
2 changes: 1 addition & 1 deletion examples/helpers/android/app/CMakeLists.txt.in
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

cmake_minimum_required(VERSION 3.5)

project(@OLP_SDK_EXAMPLE_TARGET_NAME@ VERSION 1.0.0)
project(@OLP_SDK_EXAMPLE_TARGET_NAME@ VERSION 1.1.0)

if (DEFINED OLP_SDK_HTTP_CLIENT_JAR)
get_filename_component(OLP_SDK_HTTP_CLIENT_JAR_FULL_PATH "${OLP_SDK_HTTP_CLIENT_JAR}" ABSOLUTE)
Expand Down
2 changes: 1 addition & 1 deletion examples/helpers/ios/CMakeLists.txt.in
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ if (NOT IOS)
message(FATAL_ERROR "Unsupported platform!")
endif()

project(@OLP_SDK_EXAMPLE_TARGET_NAME@ VERSION 1.0.0)
project(@OLP_SDK_EXAMPLE_TARGET_NAME@ VERSION 1.1.0)

add_executable(@OLP_SDK_EXAMPLE_TARGET_NAME@
${CMAKE_CURRENT_SOURCE_DIR}/example.h
Expand Down
2 changes: 1 addition & 1 deletion olp-cpp-sdk-authentication/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
# SPDX-License-Identifier: Apache-2.0
# License-Filename: LICENSE

project(olp-cpp-sdk-authentication VERSION 1.0.0)
project(olp-cpp-sdk-authentication VERSION 1.1.0)
set(DESCRIPTION "C++ API library for accesing HERE Account authentication service")

file(GLOB_RECURSE AUTHENTICATION_INC "include/*.h*")
Expand Down
2 changes: 1 addition & 1 deletion olp-cpp-sdk-core/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
# License-Filename: LICENSE


project(olp-cpp-sdk-core VERSION 1.0.0)
project(olp-cpp-sdk-core VERSION 1.1.0)
set(DESCRIPTION "Core network and utility library for the HERE OLP SDK C++")

find_package(RapidJSON REQUIRED)
Expand Down
19 changes: 19 additions & 0 deletions olp-cpp-sdk-core/include/olp/core/client/OlpClient.h
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,25 @@ class CORE_API OlpClient {
const std::string& content_type,
const NetworkAsyncCallback& callback) const;

/**
* @brief Executes the REST request through the network stack in a blocking
* way.
* @param path The path that is appended to the base URL.
* @param method Choose one of the following methods: GET, POST, DELETE, PUT.
* @param query_params The parameters that are appended to the path URL.
* @param header_params The headers used to customize request.
* @param form_params (For the POST request) Populate one of the following
* parameters: `form_params` or `post_body`.
* @param post_body (For the POST request) Populate one of the following
* parameters: `form_params` or `post_body`. This data must not be modified
* until the request is completed.
* @param content_type The content type of the `post_body` or `form_params`
* parameters.
* @param context The `CancellationContext` instance that is used to cancel
* the request.
*
* @return The `HttpResponse` instance.
*/
HttpResponse CallApi(std::string path, std::string method,
std::multimap<std::string, std::string> query_params,
std::multimap<std::string, std::string> header_params,
Expand Down
2 changes: 1 addition & 1 deletion olp-cpp-sdk-dataservice-read/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
# SPDX-License-Identifier: Apache-2.0
# License-Filename: LICENSE

project(olp-cpp-sdk-dataservice-read VERSION 1.0.0)
project(olp-cpp-sdk-dataservice-read VERSION 1.1.0)
set(DESCRIPTION "C++ API library for reading OLP data")

file(GLOB_RECURSE INC "include/*.h*")
Expand Down
2 changes: 1 addition & 1 deletion olp-cpp-sdk-dataservice-write/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
# SPDX-License-Identifier: Apache-2.0
# License-Filename: LICENSE

project(olp-cpp-sdk-dataservice-write VERSION 1.0.0)
project(olp-cpp-sdk-dataservice-write VERSION 1.1.0)
set(DESCRIPTION "C++ API library for writing data to OLP")

file(GLOB_RECURSE DATASERVICE_WRITE_INC "include/*.h*")
Expand Down

0 comments on commit 0d2a0c4

Please sign in to comment.