Further small changes

Author: lisajulia

README.md

@@ -12,51 +12,45 @@ It supports the [AWS, Azure and Google object stores](storage-targets/cds-featur
 
 <!-- TOC -->
 
+* [Minimum UI and CAP Java Version](#minimum-ui-and-cap-java-version)
+* [Releases: Maven Central and Artifactory](#releases)
 * [Getting Started](#getting-started)
-  * [Minimum Version](#minimum-version)
-  * [Releases: Maven Central and Artifactory](#releases)
-  * [How to use](#how-to-use)
-    * [CDS Models](#cds-models)
-    * [UI](#ui)
-    * [Storage Targets](#storage-targets)
-    * [Malware Scanner](#malware-scanner)
-    * [Outbox](#outbox)
-    * [Restore Endpoint](#restore-endpoint)
-      * [Motivation](#motivation)
-      * [HTTP Endpoint](#http-endpoint)
-      * [Security](#security)
+  * [CDS Models](#cds-models)
+  * [UI](#ui)
+  * [Storage Targets](#storage-targets)
+  * [Malware Scanner](#malware-scanner)
+  * [Outbox](#outbox)
+  * [Restore Endpoint](#restore-endpoint)
+    * [Motivation](#motivation)
+    * [HTTP Endpoint](#http-endpoint)
+    * [Security](#security)
 * [Architecture Overview](#architecture-overview)
   * [Design](#design)
   * [Multitenancy](#multitenancy)
   * [Object Stores](#object-stores)
   * [Model Texts](#model-texts)
-* [Extensibility]
 * [Monitoring & Logging](#monitoring-logging)
 * [Support, Feedback, Contributing](#support-feedback-contributing)
 * [References & Links](#references-links)
 
-## Getting Started / 
-### Minimum Version
-The following version are the minimum versions for the usage of the plugin:
+## Minimum UI5 and CAP Java Version
 
 | Component | Minimum Version |
 |-----------|-----------------|
 | CAP Java  | 3.10.3          |
-| UI5       | 1.139.0         |
-### Releases: Maven Central and Artifactory
+| UI5       | 1.136.0         |
 
-The feature is released to Maven Central at:
-https://central.sonatype.com/artifact/com.sap.cds/cds-feature-attachments
+## Releases: Maven Central and Artifactory
 
-Snapshots are deployed to SAP's Artifactory in DMZ:
-https://common.repositories.cloud.sap/artifactory/cap-java/com/sap/cds/cds-feature-attachments/
+- The plugin is released to Maven Central at: https://central.sonatype.com/artifact/com.sap.cds/cds-feature-attachments
 
-If you want to test snapshot versions of this plugin, you need to configure the Artifactory in your `${HOME}/.m2/settings.xml`.
-See [here](https://maven.apache.org/settings.html#Repositories) for further details.
+- Snapshots are deployed to SAP's Artifactory in DMZ: https://common.repositories.cloud.sap/artifactory/cap-java/com/sap/cds/cds-feature-attachments/
 
-Look at the [changelog](./doc/CHANGELOG.md) to see latest changes.
+- See the [changelog](./doc/CHANGELOG.md) for the latest changes.
 
-### How to use
+- If you want to test snapshot versions of this plugin, you need to configure the Artifactory in your `${HOME}/.m2/settings.xml`. See [the maven settings](https://maven.apache.org/settings.html#Repositories) for further details.
+
+## Getting Started
 
 The usage of CAP Java plugins is described in the [CAP Java Documentation](https://cap.cloud.sap/docs/java/building-plugins#reference-the-new-cds-model-in-an-existing-cap-java-project). Following this documentation this plugin needs to be referenced in the `srv/pom.xml` of a CAP Java application:
 
@@ -87,7 +81,7 @@ To be able to also use the CDS models defined in this plugin the `cds-maven-plug
 ```
 After that, the aspect `Attachments` can be used in the application's CDS model.
 
-#### CDS Models
+### Changes in CDS Models
 
 Depending where the aspect `Attachments` shall be used in the application's CDS model, different approaches need to be implemented.
 - If the aspect `Attachments` shall be used on an entity provided in the `db` module, the corresponding entity needs to be extended from a CDS file in the `srv` module. Therefore the entity from the `db` folder needs to be imported with an `using` statement. Then, this entity can be extended with a new field that is a `Composition of many Attachments`.
@@ -118,7 +112,7 @@ entity Items : cuid {
 Use the aspect `Attachments` directly for the composition.
 Use the correct from clause for the `using` statement. The annotations and other definitions are found and used only if `com.sap.cds/cds-feature-attachments` is used and not concrete files of the feature. 
 
-#### UI
+### UI
 
 To enhance the UI with the attachments the following annotations are used for the `UI.Facets` annotations in the respective `.cds` file of your app:
 
@@ -171,7 +165,7 @@ annotate service.Incidents with @(
 );
 ``` 
 
-#### Storage Targets
+### Storage Targets
 
 By default, the plugin operates without a dedicated storage target, storing attachments directly in the [underlying database](cds-feature-attachments/src/main/resources/cds/com.sap.cds/cds-feature-attachments/attachments.cds#L17).
 
@@ -181,7 +175,7 @@ Other available storage targets:
 
 When using a dedicated storage target, the attachment is not stored in the underlying database; instead, it is saved on the specified storage target, and only a reference to the file is kept in the database, as defined in the [CDS model](cds-feature-attachments/src/main/resources/cds/com.sap.cds/cds-feature-attachments/attachments.cds#L20).
 
-#### Malware Scanner
+### Malware Scanner
 
 This plugin checks for a binding to
 the [SAP Malware Scanning Service](https://help.sap.com/docs/malware-scanning-servce), this needs to have the label `malware-scanner`. The entry in the [mta-file](https://cap.cloud.sap/docs/guides/deployment/to-cf#add-mta-yaml) possibly looks like:
@@ -235,7 +229,7 @@ Scan status codes:
 - `Infected`: The attachment is infected.
 
 
-#### Outbox
+### Outbox
 
 In this plugin the [persistent outbox](https://cap.cloud.sap/docs/java/outbox#persistent) is used to mark attachments as
 deleted.
@@ -247,12 +241,12 @@ the default outbox configuration.
 If the default shall be used, nothing needs to be done.
 
 
-#### Restore Endpoint
+### Restore Endpoint
 
 The attachment service has an event `RESTORE_ATTACHMENTS`.
 This event can be called with a timestamp to restore externally stored attachments.
 
-##### Motivation
+#### Motivation
 
 Documents which are marked as deleted can be restored.
 
@@ -273,7 +267,7 @@ In such cases the restore endpoint can be used to restore attachments.
 How long attachments are marked as deleted before they get deleted dependents on the configuration
 of the used storage.
 
-##### HTTP Endpoint
+#### HTTP Endpoint
 
 There is no predefined endpoint for the restore action.
 To call the action of the service from outside the application a service could be defined like the following example:
@@ -322,7 +316,7 @@ public class RestoreAttachmentsHandler implements EventHandler {
 
 In the Spring Boot context the `AttachmentService` can be autowired in the handler.
 
-##### Security
+#### Security
 
 To secure the endpoint security annotations can be used e.g. like the following example:
 
@@ -338,12 +332,13 @@ entity Items : cuid {
 annotate RestoreAttachments with @(requires: 'internal-user');
 ```
 
-Here the `RestoreAttachments` service is annotated with the `requires` annotation to secure the service.
+Here, the `RestoreAttachments` service is annotated with the `requires` annotation to secure the service.
 Also, other annotations can be used to secure the service.
 
 More information about the CAP Java security concept can be found in
 the [CAP Java Documentation](https://cap.cloud.sap/docs/java/security).
 
+
 ## Architecture Overview
 ### Design
 - [Design Details](./doc/Design.md)