Skip to content

Commit

Permalink
chore: minimum CAP version requirement (#1599)
Browse files Browse the repository at this point in the history
* add deprecation warning

* Update release timeline

* Update release timeline

* Update CAP min version

* Add note to migration guide

* Add note to migration guide

---------

Co-authored-by: Johannes Schneider <johannes.schneider03@sap.com>
  • Loading branch information
KavithaSiva and Johannes Schneider authored Nov 16, 2023
1 parent 30416e1 commit be19393
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 15 deletions.
7 changes: 7 additions & 0 deletions docs-java_versioned_docs/version-v5/guides/5.0-upgrade.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,13 @@ We will publish the full migration guide when we release v5.

:::

:::info

SAP Cloud SDK version 5 requires a minimum CAP/CDS version of at least `2.4.0`.
If you are on an older CAP stack, please follow the [CAP migration guide](https://cap.cloud.sap/docs/java/migration#one-to-two) first.

:::

## Steps to migrate `Destination` usages

Version 5 of the SAP Cloud SDK comes with a major cleanup of the APIs around the `Destination` concept.
Expand Down
34 changes: 19 additions & 15 deletions docs-java_versioned_docs/version-v5/guides/cap-sdk-integration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,25 @@ That guide is applicable for your project if you need to invoke BAPIs via the SA

:::

:::info
For all features of the SAP Cloud SDK to work seamlessly with CAP, please maintain a CAP/CDS version of at least `2.4.0`.

If for some reason you are using a version earlier than `2.4.0` and using SAP Cloud SDK's [resilience](../features/resilience/resilience.mdx) features, this additional step is required:

<details>
<summary>Resolve multiple implementations of ResilienceDecorationStrategy</summary>

If you see an `ObjectLookupFailedException` in your stack trace with an underlying message `Found multiple implementations of ResilienceDecorationStrategy`, please add the following code to any class that gets executed on application startup:

```java
ResilienceDecorator.setDecorationStrategy(new Resilience4jDecorationStrategy());
```

Please ensure that the import for the class is `com.sap.cloud.sdk.cloudplatform.resilience4j.Resilience4jDecorationStrategy` and not `com.sap.cloud.sdk.frameworks.resilience4j.Resilience4jDecorationStrategy`.

</details>
:::

## Integration Steps

:::note Assumption
Expand Down Expand Up @@ -114,22 +133,7 @@ For the integration at least `1.28` is required.
:::

:::info
This step is only required if you are using CAP/CDS versions earlier than `1.23.0`.

<details>
<summary>Enable the Component Scan for SAP Cloud SDK Package</summary>

Let the Spring component scan crawl the SAP Cloud SDK package.
We'll annotate the Spring Boot application class which is annotated with `@SpringBootApplication` as follows.

```java
@ComponentScan({"com.sap.cloud.sdk", "com.mycompany.myapplication"})
@ServletComponentScan({"com.sap.cloud.sdk", "com.mycompany.myapplication"})
```

Make sure that you also add the package name of your application.

</details>
:::

:::success Integration finished
Expand Down

0 comments on commit be19393

Please sign in to comment.