Skip to content

Commit

Permalink
adjust links (#1265)
Browse files Browse the repository at this point in the history
  • Loading branch information
FrankEssenberger authored Feb 21, 2023
1 parent 591e612 commit 9401ab7
Show file tree
Hide file tree
Showing 32 changed files with 110 additions and 66 deletions.
2 changes: 1 addition & 1 deletion docs-js_versioned_docs/version-v1/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -119,5 +119,5 @@ The current support is experimental and not ready for production use.
### Do You Support SAP Business Technology Platform, Cloud Foundry Environment?

SAP Cloud SDK for JavaScript has first-class support for the [SAP BTP, Cloud Foundry environment](https://www.sap.com/products/cloud-platform.html).
We provide plenty of helpful abstractions for [connectivity](features/connectivity/destination) and authentication that make developing apps a pleasant and rewarding experience.
We provide plenty of helpful abstractions for [connectivity](features/connectivity/destinations) and authentication that make developing apps a pleasant and rewarding experience.
Let us know if you miss functionality of the SAP BTP in the SAP Cloud SDK for JavaScript.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
id: destination-cache
title: Destination Cache and Isolation
hide_title: false
hide_table_of_contents: false
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
id: destinations
title: Destinations
hide_title: false
hide_table_of_contents: false
Expand Down Expand Up @@ -243,7 +244,7 @@ For simplicity, an optional argument of the destination lookup has been neglecte
```

The `jwt` argument takes the JSON web token (JWT) issued by an XSUAA as input.
Additional information on how to retrieve JWTs can be found [here](../../guides/how-to-retrieve-jwt).
Additional information on how to retrieve JWTs can be found [here](../../guides/how-to-retrieve-jwt.mdx).
This token contains a field `zid` holding the tenant id, which will be used in the lookup process.
The lookup process done by the SAP Cloud SDK involves the following steps:

Expand Down Expand Up @@ -337,7 +338,7 @@ In the section above, we listed already a few of the options but this section gi
- `useCache`: Switches on caching for destinations received from the destination service.
The default value is false.
- `isolationStrategy`: Specifies how the destination cache is scoped.
The value is automatically set but [under certain conditions](./destination-cache-isolation) you may want to optimize it.
The value is automatically set but [under certain conditions](./destination-cache-isolation.mdx) you may want to optimize it.
- `enableCircuitBreaker`: Switches on circuit breakers to protect the calls to the `XSUAA` and `destination-service`.
The default value is true.
- `timeout`: Sets the timeout for the calls to SAP BTP services like `XSUAA` and `destination-service`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
id: http-client
title: Generic HTTP Client
sidebar_label: Generic HTTP Client
description: How to use the generic http client for untyped requests
Expand Down Expand Up @@ -118,7 +119,7 @@ You should consider the OData client if:
## Headers and Query Parameters from Different Origins
As partially described in the [destination guide](./destination#additional-headers-and-query-parameters-on-destinations), there are multiple possible origins for query parameters:
As partially described in the [destination guide](./destinations#additional-headers-and-query-parameters-on-destinations), there are multiple possible origins for query parameters:
- Provided by the user on the request level.
These parameters are referred to as `custom` parameters.
Expand Down Expand Up @@ -149,7 +150,7 @@ executeHttpRequest(myDestination, {
### Headers and Query Parameters from Destination
You set these parameters on the destination object as described [here](./destination#additional-headers-and-query-parameters-on-destinations).
You set these parameters on the destination object as described [here](./destinations#additional-headers-and-query-parameters-on-destinations).
The example below shows how to get:
- parsed parameters in the `queryParameters` property of the destination object
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
id: on-premise
title: On-Premise Connectivity
sidebar_label: On-Premise Systems
description: How to connect to SAP S/4HANA On-premise systems using the SAP Cloud SDK
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
id: proxies
title: Proxies
hide_title: false
hide_table_of_contents: false
Expand Down Expand Up @@ -94,7 +95,7 @@ This is mandatory if principal propagation is used i.e. identity propagation fro
For productive use, you do not want to include a specific proxy configuration in your code.
Here you should let the SAP Cloud SDK handle everything.
Hence, you will provide in the `.execute()` method only the destination name.
This will trigger the destination lookup as described [here](destination).
This will trigger the destination lookup as described [here](./destinations).

The result of the lookup is a destination object which contains a property called `Proxy Type`.
This property can have three values: `Internet`, `OnPremise`, and `PrivateLink`:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
id: error-handling
title: Error Handling
sidebar_label: Error Handling
description: How to work with errors thrown by the SAP Cloud SDK
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
id: eslint-configuration
title: Shared ESLint configuration
sidebar_label: Shared ESLint configuration
description: How to use our recommended ESLint configuration
Expand Down
1 change: 1 addition & 0 deletions docs-js_versioned_docs/version-v1/features/logging.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
id: logging
title: Logging
sidebar_label: Logging
description: How the SAP Cloud SDK logs errors and exceptions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
id: execute-request
title: Executing a Request Using a Generated OData v2/v4 Client
sidebar_label: Execute an OData request
description: Use the SAP Cloud SDK for JavaScript to build and run OData requests in a type-safe way.
Expand Down Expand Up @@ -63,63 +64,63 @@ See the list below for details on all available request types (denoted by `reque
>
<TabItem value="v2">
<li>
<a href="./use-odata-v2-type-safe-client-for-javascript-typescript#getall-request-builder">
<a href="./v2-client#getall-request-builder">
<code>getAll</code>
</a>{' '}
Build requests to get a list of entities (OData v2)
</li>
<li>
<a href="./use-odata-v2-type-safe-client-for-javascript-typescript#getbykey-request-builder">
<a href="./v2-client#getbykey-request-builder">
<code>getByKey</code>
</a>{' '}
Build requests to get an entity based on a key (OData v2)
</li>
<li>
<a href="./use-odata-v2-type-safe-client-for-javascript-typescript#create-request-builder">
<a href="./v2-client#create-request-builder">
<code>create</code>
</a>{' '}
Build requests to create entities (OData v2)
</li>
<li>
<a href="./use-odata-v2-type-safe-client-for-javascript-typescript#update-request-builder">
<a href="./v2-client#update-request-builder">
<code>update</code>
</a>{' '}
Build requests to update entities (OData v2)
</li>
<li>
<a href="./use-odata-v2-type-safe-client-for-javascript-typescript#delete-request-builder">
<a href="./v2-client#delete-request-builder">
<code>delete</code>
</a>{' '}
Build requests to delete entities (OData v2)
</li>
</TabItem>
<TabItem value="v4">
<li>
<a href="./use-odata-v4-type-safe-client-for-javascript-typescript#getall-request-builder">
<a href="./v4-client#getall-request-builder">
<code>getAll</code>
</a>{' '}
Build requests to get a list of entities (OData v4)
</li>
<li>
<a href="./use-odata-v4-type-safe-client-for-javascript-typescript#getbykey-request-builder">
<a href="./v4-client#getbykey-request-builder">
<code>getByKey</code>
</a>{' '}
Build requests to get an entity based on a key (OData v4)
</li>
<li>
<a href="./use-odata-v4-type-safe-client-for-javascript-typescript#create-request-builder">
<a href="./v4-client#create-request-builder">
<code>create</code>
</a>{' '}
Build requests to create entities (OData v4)
</li>
<li>
<a href="./use-odata-v4-type-safe-client-for-javascript-typescript#update-request-builder">
<a href="./v4-client#update-request-builder">
<code>update</code>
</a>{' '}
Build requests to update entities (OData v4)
</li>
<li>
<a href="./use-odata-v4-type-safe-client-for-javascript-typescript#delete-request-builder">
<a href="./v4-client#delete-request-builder">
<code>delete</code>
</a>{' '}
Build requests to delete entities (OData v4)
Expand All @@ -139,7 +140,7 @@ All requests can be configured by setting [custom request headers](#setting-cust
Each request type has additional request specific configuration options, e.g. creating an entity `asChildOf` another entity for `create` requests, ETag handling for `update` and `delete` requests, as well as set operations for `getAll` requests and selecting properties for `getAll` and `getByKey` requests.

The last step when making a request using the SAP Cloud SDK is the request execution.
Once the request is configured use the `execute` function and pass a [destination](../connectivity/destination) to it.
Once the request is configured use the `execute` function and pass a [destination](../connectivity/destinations) to it.
This will automatically construct your request URL and headers, execute the request, and return a typed response if applicable.

### Setting Custom Request Headers
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
id: generate-client
title: Generate an OData client for JavaScript
sidebar_label: Generate an OData Client
keywords:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: use-odata-v2-type-safe-client-for-javascript-typescript
id: v2-client
title: Use the OData v2 Type-safe Client API
sidebar_label: OData v2 Client API
description: Use the SAP Cloud SDK for JavaScript to build and run OData v2 requests in a type-safe way.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: use-odata-v4-type-safe-client-for-javascript-typescript
id: v4-client
title: Use the OData v4 Type-safe Client API
sidebar_label: OData v4 Client API
description: Use the SAP Cloud SDK for JavaScript to build and run OData v4 requests in a type-safe way.
Expand Down
4 changes: 2 additions & 2 deletions docs-js_versioned_docs/version-v1/features/odata/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ This is why the naming pattern for the pregenerated clients contains `vdm` as we
### Links

- [How to use the clients](https://sap.github.io/cloud-sdk/docs/js/features/odata/execute-odata-request)
- [Release Notes](../../release-notes-sap-cloud-sdk-for-javascript-and-typescript)
- [Release Notes](../../release-notes)
- [SAP S/4HANA Cloud on the SAP Business Hub](https://api.sap.com/products/SAPS4HANACloud/overview)
- [SAP S/4HANA On-Premise on the SAP Business Hub](https://api.sap.com/products/SAPS4HANA/overview)

Expand All @@ -70,4 +70,4 @@ You can do it for any service either developed by yourself, provided by SAP, or

## Connectivity

We simplify connectivity to SAP-enabled OData services via type-safe abstractions over [Destinations](../connectivity/destination), Authentication, and some other related concepts.
We simplify connectivity to SAP-enabled OData services via type-safe abstractions over [Destinations](../connectivity/destinations), Authentication, and some other related concepts.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
id: execute-request
title: Execute a Request Using a Generated OpenAPI Client
sidebar_label: Execute an OpenAPI Request
description: How to use a client (pre-)generated by the SAP Cloud SDK OpenAPI generator.
Expand Down Expand Up @@ -29,7 +30,7 @@ What APIs and functions are available in a client depends on the service specifi
## Executing a Request

The request execution always follows the same structure.
You invoke a function of an API, optionally configure your request and then execute it against a [destination](../connectivity/destination):
You invoke a function of an API, optionally configure your request and then execute it against a [destination](../connectivity/destinations):

```ts
const responseData = await MyApi.myFunction().execute(destination);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
id: generate-client
title: Use the OpenAPI Generator to Generate Typed Clients
sidebar_label: Generate an OpenAPI Client
description: How to generate a client from a service definition.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
id: bas
title: Connecting to External Systems From the Business Application Studio
sidebar_label: Connecting to External Systems from BAS
description: This article describes how the SDK helps to connect to external systems from the Business Application Studio.
Expand Down Expand Up @@ -110,7 +111,7 @@ For more details on testing and troubleshooting have a look at [this guide](http

If the connection is tested and working you can start the implementation.
The SAP Cloud SDK helps you to consider the HTTP_PROXY automatically and makes it easy to use the same code base locally and in production on SAP BTP.
The SAP Cloud SDK has a [destination lookup](../features/connectivity/destination) priority considering environment variables first.
The SAP Cloud SDK has a [destination lookup](../features/connectivity/destinations) priority considering environment variables first.

The trick is to define a `destinations` environment variable when you run locally, which works like a switch under the hood when you execute:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
id: resilience
title: How to Make Applications more Resilient?
sidebar_label: How to Add Resilience
description: This article describes how you can add a layer of resilience to applications
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
id: retrieve-jwt
title: How to retrieve JSON Web Tokens (JWT)
sidebar_label: How to retrieve JWTs
description: You'll learn how to retrieve a JWT in your application code as well as locally using tools like Postman.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
id: approuter
title: Using the SAP Application Router with the SAP Cloud SDK
sidebar_label: Using the SAP Application Router
description: This article describes how you can use the SAP Application Router with the SAP Cloud SDK
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
id: kubernetes
title: Migrate your App from SAP BTP CF to Kubernetes with the SAP Cloud SDK for JavaScript
sidebar_label: Migrate to Kubernetes
description: Learn how to migrate your application from SAP BTP Cloud Foundry to Kubernetes with the SAP Cloud SDK for JavaScript
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
id: browser
title: Use the SAP Cloud SDK in the Browser
sidebar_label: Use the SAP Cloud SDK in the Browser
description: You'll learn how to package SDK for a browser, what are the limitations, and how to use it with popular frontend frameworks.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
id: trust-and-keystores
title: How the SAP Cloud SDK handles Trust and Keystores
hide_title: false
hide_table_of_contents: false
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,9 @@ Details on the API contract are discussed in this [ADR](https://github.com/SAP/c

In the past, one OData datatype was always transformed to the same data type in TypeScript.
For example, time-related properties are transformed into `moment` instances.
We introduced a new [(de-)serialization](../features/odata/use-odata-v2-type-safe-client-for-javascript-typescript#customize-de-serialization) to make this more flexible.
We introduced a new [(de-)serialization](../features/odata/v2-client#customize-de-serialization) to make this more flexible.

If you would like to switch to the [Temporal](https://tc39.es/proposal-temporal/docs/) (de-)serialization for date/time objects, please follow the [documentation](../features/odata/use-odata-v2-type-safe-client-for-javascript-typescript#using-de-serializers-for-temporal) and adjust your code base.
If you would like to switch to the [Temporal](https://tc39.es/proposal-temporal/docs/) (de-)serialization for date/time objects, please follow the [documentation](../features/odata/v2-client#using-de-serializers-for-temporal) and adjust your code base.
The default serialization for time-related properties will be changed from Moment.js to Temporal once it reaches Stage 4.
Since Moment.js is a discontinued project with a large size we recommend sticking with the new standard.
Note that in the 2.0 version, the default remains Moment.js.
Expand Down Expand Up @@ -165,7 +165,7 @@ The API object getters (e.g. `businessPartnerApi`) are denoted using camel case,

### Breaking Change on the `EntityBuilder` API

For the implementation of the [(de-)serializers](../features/odata/use-odata-v2-type-safe-client-for-javascript-typescript#customize-de-serialization), two changes are introduced in version 2.0:
For the implementation of the [(de-)serializers](../features/odata/v2-client#customize-de-serialization), two changes are introduced in version 2.0:

The static `.builder` method has been renamed to `.entityBuilder` and it is now an instance method on the entity API class:

Expand All @@ -192,7 +192,7 @@ myEntityApi

### Breaking Change on the `RequestBuilder` API

To make the [middle ware concept](../features/odata/use-odata-v2-type-safe-client-for-javascript-typescript#customize-de-serialization) possible, it was necessary to add more state to the `requestBuilder`.
To make the [middle ware concept](../features/odata/v2-client#customize-de-serialization) possible, it was necessary to add more state to the `requestBuilder`.

All the static properties used to build select or filters are also now part of an instance and are exposed via a `schema` property.
The `requestBuilder` is also not a static method anymore but an instance method of an API object:
Expand Down
4 changes: 2 additions & 2 deletions docs-js_versioned_docs/version-v1/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: overview-cloud-sdk-for-javascript
id: overview
title: Overview
hide_title: false
hide_table_of_contents: false
Expand Down Expand Up @@ -71,7 +71,7 @@ All core libraries are available as open source npm packages in the `@sap-cloud-
#### `@sap-cloud-sdk/connectivity`

The connectivity library provides functionality to read and exchange with services like the destination, XSUAA, and connectivity service.
It provides the basic types needed to reflect the concept of a [destination](features/connectivity/destination) throughout the SAP Cloud SDK for JavaScript.
It provides the basic types needed to reflect the concept of a [destination](features/connectivity/destinations) throughout the SAP Cloud SDK for JavaScript.

#### `@sap-cloud-sdk/http-client`

Expand Down
2 changes: 1 addition & 1 deletion docs-js_versioned_docs/version-v1/release-notes.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: release-notes-sap-cloud-sdk-for-javascript-and-typescript
id: release-notes
title: Release Notes
sidebar_label: Release Notes
description: Release notes of the SAP Cloud SDK for JavaScript and TypeScript, stay up to date with the recent features, fixes, dependency updates, and recommendations.
Expand Down
2 changes: 1 addition & 1 deletion docs-js_versioned_docs/version-v1/video/calm.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: demo-of-cloud-sdk-for-javascript-with-calm-and-cap
id: calm
title: SAP Cloud Application Programming Model and SAP Cloud Application Lifecycle Management
sidebar_label: SAP Cloud SDK & CAP
description: Learn how to build cloud-native Apps and extension using SAP Cloud SDK for JavaScrip with Cloud Application Programming model (CAP)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ For more details on testing and troubleshooting have a look at [this guide](http

If the connection is tested and working you can start the implementation.
The SAP Cloud SDK helps you to consider the HTTP_PROXY automatically and makes it easy to use the same code base locally and in production on SAP BTP.
The SAP Cloud SDK has a [destination lookup](../features/connectivity/destination.mdx) priority considering environment variables first.
The SAP Cloud SDK has a [destination lookup](../features/connectivity/destinations) priority considering environment variables first.

The trick is to define a `destinations` environment variable when you run locally, which works like a switch under the hood when you execute:

Expand Down Expand Up @@ -164,7 +164,7 @@ The `preLaunchTask` executes the build before each run which compiles the TypeSc
The `outFiles` property defines where the compiled files will be located.

We have to set the `destinations` environment variable, to provide our destination.
This will interrupt the [destination lookup](../features/connectivity/destination.mdx) and lead to a destination with the HTTP_PROXY considered.
This will interrupt the [destination lookup](../features/connectivity/destinations) and lead to a destination with the HTTP_PROXY considered.
The easiest way to do that is via a `.env` file which is read when starting the application.
If you do not have a `.env` file, create one or adjust the existing one.
Just add the following entry to the `.env` file:
Expand Down
Loading

0 comments on commit 9401ab7

Please sign in to comment.