Skip to content

Commit 35809e1

Browse files
authored
Merge branch 'main' into typed-result
2 parents 0b5ffeb + dce3c76 commit 35809e1

38 files changed

+971
-561
lines changed

.github/cds-snippet-checker/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"main": "check-cds-snippets.js",
77
"author": "SAP SE (https://www.sap.com)",
88
"license": "SEE LICENSE IN LICENSE",
9-
"repository": "cap-js/docs",
9+
"repository": "capire/docs",
1010
"homepage": "https://cap.cloud.sap/",
1111
"scripts": {
1212
"check": "node check-cds-snippets.js"

.github/java-snippet-checker/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"main": "check-java-snippets.js",
77
"author": "SAP SE (https://www.sap.com)",
88
"license": "SEE LICENSE IN LICENSE",
9-
"repository": "cap-js/docs",
9+
"repository": "capire/docs",
1010
"homepage": "https://cap.cloud.sap/",
1111
"scripts": {
1212
"check": "node check-java-snippets.js"

.github/workflows/PR-SAP.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ concurrency:
99
group: pr-sap-${{ github.workflow }}-${{ github.head_ref || github.run_id }}
1010
cancel-in-progress: true
1111

12+
permissions:
13+
contents: read
14+
1215
jobs:
1316
build-sap:
1417
runs-on: ubuntu-latest

.github/workflows/PR.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ concurrency:
88
group: pr-${{ github.workflow }}-${{ github.head_ref || github.run_id }}
99
cancel-in-progress: true
1010

11+
permissions:
12+
contents: read
13+
1114
jobs:
1215
build:
1316
runs-on: ubuntu-latest

.vitepress/config.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,10 @@ const config = defineConfig({
4343
logo: '/cap-logo.svg',
4444
outline: [2,3],
4545
socialLinks: [
46-
{ icon: 'github', link: 'https://github.com/cap-js/docs' }
46+
{ icon: 'github', link: 'https://github.com/capire/docs' }
4747
],
4848
editLink: {
49-
pattern: 'https://github.com/cap-js/docs/edit/main/:path'
49+
pattern: 'https://github.com/capire/docs/edit/main/:path'
5050
},
5151
footer: {
5252
message: `

.vitepress/theme/components/WasThisHelpful.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444

4545
<p class="more-feedback" v-if="feedbackSelected">
4646
More to say?
47-
<a href="https://github.com/cap-js/docs/issues" target="_blank">
47+
<a href="https://github.com/capire/docs/issues" target="_blank">
4848
Report an issue.
4949
</a>
5050
</p>

.vitepress/theme/styles.scss

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,20 @@ main {
112112
padding-left: 2.5em;
113113
}
114114

115+
// Custom list styles for nested items
116+
ul {
117+
list-style-type: disc; // First level: filled circle
118+
119+
ul {
120+
list-style-type: circle; // Second level: empty circle
121+
122+
123+
ul {
124+
list-style-type: square; // Third level: square
125+
}
126+
}
127+
}
128+
115129
.step-by-step {
116130
ol {
117131
counter-reset: my-counter;

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Documentation for <br> SAP Cloud Application Programming Model
22

3-
[![REUSE status](https://api.reuse.software/badge/github.com/cap-js/docs)](https://api.reuse.software/info/github.com/cap-js/docs)
3+
[![REUSE status](https://api.reuse.software/badge/github.com/capire/docs)](https://api.reuse.software/info/github.com/capire/docs)
44

55
## About this project
66

@@ -10,7 +10,7 @@ Along with additional SAP-specific pages the content is published to https://cap
1010

1111
## Support, Feedback, Contributing
1212

13-
This project is open to feature requests/suggestions, bug reports, etc. via [GitHub issues](https://github.com/cap-js/docs/issues) and [pull requests](https://github.com/cap-js/docs/pulls). Contribution and feedback are encouraged and always welcome.
13+
This project is open to feature requests/suggestions, bug reports, etc. via [GitHub issues](https://github.com/capire/docs/issues) and [pull requests](https://github.com/capire/docs/pulls). Contribution and feedback are encouraged and always welcome.
1414

1515
See our [contribution guidelines](CONTRIBUTING.md) for information about how to contribute, the project structure, as well as additional contribution information.
1616

@@ -19,7 +19,7 @@ See our [contribution guidelines](CONTRIBUTING.md) for information about how to
1919
If you contribute often to the documentation it's best to create your own fork, clone it to your local machine.
2020

2121
```sh
22-
git clone https://github.com/cap-js/docs # or whatever your fork's URL is
22+
git clone https://github.com/capire/docs # or whatever your fork's URL is
2323
```
2424

2525
Install the dependencies:
@@ -53,4 +53,4 @@ We as members, contributors, and leaders pledge to make participation in our com
5353

5454
## Licensing
5555

56-
Copyright 2023-2025 SAP SE or an SAP affiliate company and CAP contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/cap-js/docs).
56+
Copyright 2023-2025 SAP SE or an SAP affiliate company and CAP contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/capire/docs).

about/features.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,13 @@ Following is an index of the features currently covered by CAP, with status and
4747
| [Compile cds models to different outputs](../node.js/cds-compile) | `cds compile <models>` |
4848
| [Run your services in local server](../node.js/cds-serve) | `cds serve <services>` |
4949
| [Run and restart on file changes](../get-started/in-a-nutshell) | `cds watch` |
50-
| [Read-eval-event loop](../node.js/cds-env#cli) <!-- TODO --> | `cds repl` |
50+
| [Read-eval-event loop](../node.js/cds-env#cli) | `cds repl` |
5151
| Inspect effective configuration | `cds env` |
5252
| Prepare for deployment | `cds build` |
53-
| Deploy to databases or cloud | `cds deploy` |
53+
| Deploy to databases | `cds deploy` |
54+
| Build and deploy your application to the cloud | `cds up` |
55+
| Bind application to remote services | `cds bind` |
56+
| Debug your application | `cds debug` |
5457
| Login to multitenant SaaS application | `cds login <app-url>` |
5558
| Upgrade SaaS tenant(s) to latest versions | `cds upgrade` |
5659
| Logout from multitenant SaaS application | `cds logout` |

advanced/fiori.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -466,12 +466,38 @@ POST /odata/v4/AdminService/Books(ID=a11fb6f1-36ab-46ec-b00c-d379031e817a,IsActi
466466
Content-Type: application/json
467467
468468
{}
469-
469+
```
470470

471471
For more details, see the [official UI5 documentation](https://ui5.sap.com/#/topic/ed9aa41c563a44b18701529c8327db4d).
472472

473473
### Validating Drafts
474474

475+
With Fiori draft state messages, you benefit from the following improvements without any change in your application code:
476+
- The UI displays error messages for annotation-based validations (such as `@mandatory` or `@assert...`) while editing drafts.
477+
- You can register [custom validations](#custom-validations) to the `PATCH` event and write (error) messages. The draft choreography ensures the invalid value still persists.
478+
- Messages remain visible in the UI, even after editing other fields.
479+
- The UI automatically loads messages when reopening a previously edited draft.
480+
CAP generates side-effect annotations in the EDMX to instruct UI5 to fetch state messages after every `PATCH` request. To control side-effect annotations more precisely, override or disable them per entity:
481+
482+
```cds
483+
// Setting `null` disables the side-effect annotation for always fetching messages.
484+
annotate MyService.MyEntity with @Common.SideEffects #alwaysFetchMessages: null;
485+
```
486+
487+
For this feature to work correctly, CAP adds additional elements to your draft-enabled entities and [`DraftAdministrativeData`](/guides/security/data-protection-privacy#dpp-cap) to store and serve the state messages. CAP runtimes persist (error) messages for draft-enabled entities.
488+
489+
::: warning Requires Schema Update
490+
This feature initiates a database schema update, as it adds an additional element to `DraftAdministrativeData`.
491+
:::
492+
493+
::: warning Requires OData V4 and UI5 version >=1.135.0
494+
State messages require UI5 to use _document URLs_. CAP sets the `@Common.AddressViaNavigationPath` annotation to enable this. You need OData V4 and UI5 version >= 1.135.0. OData V2 does not support this annotation.
495+
:::
496+
To disable this feature, set <Config>cds.fiori.draft_messages:false</Config>.
497+
498+
499+
#### Custom Validations
500+
475501
You can add [custom handlers](../guides/providing-services#custom-logic) to add specific validations, as usual. In addition, for a draft, you can register handlers to the respective `UPDATE` events to validate input per field, during the edit session, as follows.
476502

477503

0 commit comments

Comments
 (0)