Skip to content

Commit 97028e3

Browse files
Linting auto fix commit
1 parent 41a7dc9 commit 97028e3

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

packages/fiori-docs-embeddings/data_local/ux-ui5-tooling-README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,27 @@ Executing `npx fiori run` in your project with the configuration below in the `u
7777
url: https://my.backend.com:1234
7878
```
7979

80+
#### [Using connectPath for credential retrieval](#using-connectpath-for-credential-retrieval)
81+
82+
When credentials are saved against a full service URL (for example, `https://my.backend.com:1234/sap/opu/odata/example/service`) rather than just the base URL, you need to specify the `connectPath` parameter to ensure the correct credentials are retrieved. The `connectPath` should match the path portion of the URL against which the credentials were saved.
83+
84+
```yaml
85+
- name: fiori-tools-proxy
86+
afterMiddleware: compression
87+
configuration:
88+
backend:
89+
- path: /sap
90+
url: https://my.backend.com:1234
91+
connectPath: /sap/opu/odata/UI5/ABAP_REPOSITORY_SRV
92+
```
93+
94+
**When to use `connectPath`:**
95+
- Your credentials are stored in the SAP System configuration with a full service URL including the path
96+
- You need to connect to a specific service endpoint for authentication
97+
- The stored system URL differs from the base server URL
98+
99+
**Note:** If credentials are saved against the base URL only (e.g., `https://my.backend.com:1234`), the `connectPath` parameter is not needed.
100+
80101
#### [Connecting to a back-end system with destination](#connecting-to-a-back-end-system-with-destination)
81102

82103
If the back-end is hidden behind a destination then you can also provide the `destination` in the configuration.
@@ -170,6 +191,21 @@ Let's that you want to configure the proxy to send requests from a certain path
170191
destination: my_backend
171192
```
172193
194+
#### [Add Query Parameters](#add-query-parameters)
195+
Add query parameters to the proxied request by using the `params` configuration option, e.g.
196+
197+
```
198+
- name: fiori-tools-proxy
199+
afterMiddleware: compression
200+
configuration:
201+
backend:
202+
- path: /sap
203+
url: https://my.backend.com:1234
204+
params:
205+
saml2: 'disabled'
206+
```
207+
208+
173209
#### [Providing Proxy Configuration](#providing-proxy-configuration)
174210
By the default the `fiori-tools-proxy` will read the proxy configuration from the Node.js environment variables `proxy`, `https-proxy` and `noproxy`. If those variables are not set, then you can also provide the proxy configuration in the `ui5.yaml` file. **Please note: if you want to exclude any domains from the proxy then you will need to set the `noproxy` variable, e.g. `npm config set noproxy "sap.com"`**.
175211
@@ -220,6 +256,7 @@ Here is the full list of the available configuration options for the backend pro
220256
- `ignorePath` (available with version 1.8.5): true/false, Default: false - specify whether you want to ignore the proxy path of the incoming request (note: you will have to append / manually if required)
221257
- `localAddress` (available with version 1.8.5): Local interface string to bind for outgoing connections
222258
- `changeOrigin` (available with version 1.8.5): true/false, Default: true - changes the origin of the host header to the target URL
259+
- `params` (available with version 1.23.0): object, adds query parameters to the proxied request
223260
- `preserveHeaderKeyCase` (available with version 1.8.5): true/false, Default: false - specify whether you want to keep letter case of response header key
224261
- `auth` (available with version 1.8.5): Basic authentication i.e. 'user:password' to compute an Authorization header
225262
- `hostRewrite` (available with version 1.8.5): rewrites the location hostname on (301/302/307/308) redirects

0 commit comments

Comments
 (0)