Skip to content

Commit 17b9088

Browse files
committed
acrolinx check
1 parent 3325ac5 commit 17b9088

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

advanced/odata.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Content-Type: application/json
102102
}
103103
```
104104

105-
The system executes PATCH requests with delta payload using batch delete and [upsert](../java/working-with-cql/query-api#bulk-upsert) statements. These requests are more efficient than OData [batch requests](https://docs.oasis-open.org/odata/odata/v4.01/csprd02/part1-protocol/odata-v4.01-csprd02-part1-protocol.html#sec_BatchRequests).
105+
The system executes PATCH requests with a delta payload using batch delete and [upsert](../java/working-with-cql/query-api#bulk-upsert) statements. These requests are more efficient than OData [batch requests](https://docs.oasis-open.org/odata/odata/v4.01/csprd02/part1-protocol/odata-v4.01-csprd02-part1-protocol.html#sec_BatchRequests).
106106

107107
Use PATCH on entity collections to upload mass data using a dedicated service secured with [role-based authorization](../guides/security/authorization#requires). Enable delta updates explicitly by annotating the entity with
108108

@@ -122,7 +122,7 @@ Limitations:
122122

123123
## Mapping of CDS Types { #type-mapping}
124124

125-
The table below lists [CDS's built-in types](../cds/types) and their mapping to the OData EDM type system.
125+
The following table lists [CDS's built-in types](../cds/types) and their mapping to the OData EDM type system.
126126

127127
| CDS Type | OData V4 |
128128
| -------------- | --------------------------------------- |
@@ -144,7 +144,7 @@ The table below lists [CDS's built-in types](../cds/types) and their mapping to
144144
| `Binary` | _Edm.Binary_ |
145145
| `LargeBinary` | _Edm.Binary_ |
146146
| `LargeString` | _Edm.String_ |
147-
| `Map` | represented as empty, open complex type |
147+
| `Map` | represented as an empty, open complex type |
148148
| `Vector` | not supported <sup>(2)</sup> |
149149

150150
> <sup>(1)</sup> Mapping can be changed with, for example, `@odata.Type='Edm.String'`
@@ -187,7 +187,7 @@ entity Books {
187187
```
188188

189189
::: warning
190-
This annotation affects the client-side facing API only. No automatic data modification occurs behind the scenes, such as rounding, truncation, or conversion. You must perform all required modifications on the data stream so that the values match their type in the API.
190+
This annotation affects the client-side facing API only. No automatic data modification occurs behind the scenes, such as rounding, truncation, or conversion. You must perform all the required modifications on the data stream so that the values match their type in the API.
191191
If you don't do the required conversions, you can "cast" any scalar CDS type into any incompatible EDM type:
192192

193193
```cds
@@ -272,8 +272,8 @@ For each annotated target definition in CSN, the rules for restructuring from CS
272272

273273
1. Annotations with a single-identifier key are skipped (as OData annotations always have a `@Vocabulary.Term...` key signature).
274274
2. All individual annotations with the same `@<Vocabulary.Term>` prefix are collected.
275-
3. If there is only one annotation without a suffix, &rarr; that one is a scalar or array value of an OData term.
276-
4. If there are more annotations with suffix key parts &rarr; it's a record value for the OData term.
275+
3. If there's only one annotation without a suffix, &rarr; that one is a scalar or array value of an OData term.
276+
4. If there are more annotations with suffix key parts →, it's a record value for the OData term.
277277

278278

279279
### Qualified Annotations
@@ -355,7 +355,7 @@ All three expressions result in the following rendering:
355355

356356
> Note: The `@Some` annotation isn't a valid term definition. The following example illustrates the rendering of record values.
357357
358-
The system maps record-like source structures to `<Record>` nodes in EDMX, with primitive types translated analogously to the above:
358+
The system maps record-like source structures to `<Record>` nodes in EDMX, with primitive types translated analogously to what was mentioned earlier:
359359

360360
```cds
361361
@Some.Record: {
@@ -563,7 +563,7 @@ to these references, and they are translated to the flat model.
563563

564564
::: tip
565565

566-
Although CAP supports structured types and elements, we recommend to use them only
566+
Although CAP supports structured types and elements, we recommend using them only
567567
if they bring a real benefit. In general, you should keep your models as flat as possible.
568568

569569
:::
@@ -732,7 +732,7 @@ If the expression you provide as an annotation value is more complex than just a
732732

733733
::: info
734734

735-
While the flattening of references described in the section above is applied to all
735+
While the flattening of references described in the preceding section is applied to all
736736
annotations, the syntactic translation of expressions is only done for annotations
737737
defined in one of the [OData vocabularies](#vocabularies).
738738

@@ -849,7 +849,7 @@ converted into the corresponding EDM primitive type.
849849

850850
CAP only provides a syntactic translation. It is up to each client
851851
whether an expression value is supported for a particular annotation.
852-
See for example [SAP Fiori Elements' list of supported annotations](https://ui5.sap.com/#/topic/0e7b890677c240b8ba65f8e8d417c048).
852+
See, for example, [SAP Fiori Elements' list of supported annotations](https://ui5.sap.com/#/topic/0e7b890677c240b8ba65f8e8d417c048).
853853

854854
:::
855855

@@ -922,9 +922,9 @@ In any case, the resulting EDMX is:
922922

923923
::: tip Use CDS expression syntax
924924

925-
Use the EDM JSON expression syntax only as fallback mechanism.
925+
Use the EDM JSON expression syntax only as a fallback mechanism.
926926
Whenever possible, use [expression-like annotation values](#expression-annotations) instead.
927-
For the example below, simply write `@UI.Hidden: (status <> 'visible')`.
927+
For the following example, simply write `@UI.Hidden: (status <> 'visible')`.
928928

929929
:::
930930

@@ -1062,9 +1062,9 @@ The annotation is added to the OData API, as well as the mandatory reference to
10621062
```
10631063

10641064
The compiler evaluates neither annotation values nor the URI.
1065-
It is your responsibility to make the URI accessible if required.
1065+
It is your responsibility to make the URI accessible if necessary.
10661066
Unlike for the standard vocabularies listed above, the compiler has no access to the content of
1067-
the vocabulary, so the values are translated completely generically.
1067+
the vocabulary, so the values are translated generically.
10681068

10691069

10701070
## Data Aggregation
@@ -1186,7 +1186,7 @@ GET /Books?$apply=aggregate(stock with sum as stock) HTTP/1.1
11861186

11871187
#### Currencies and Units of Measure
11881188

1189-
If a property represents a monetary amount, it may have a related property that indicates the amount's *currency code*. Analogously, a property representing a measured quantity can be related to a *unit of measure*. To indicate that a property is a currency code or a unit of measure it can be annotated with the [Semantics Annotations](https://help.sap.com/docs/SAP_NETWEAVER_750/cc0c305d2fab47bd808adcad3ca7ee9d/fbcd3a59a94148f6adad80b9c97304ff.html) `@Semantics.currencyCode` or `@Semantics.unitOfMeasure`.
1189+
If a property represents a monetary amount, it may have a related property that indicates the amount's *currency code*. Analogously, a property representing a measured quantity can be related to a *unit of measure*. To indicate that a property is a currency code or a unit of measure, it can be annotated with the [Semantics Annotations](https://help.sap.com/docs/SAP_NETWEAVER_750/cc0c305d2fab47bd808adcad3ca7ee9d/fbcd3a59a94148f6adad80b9c97304ff.html) `@Semantics.currencyCode` or `@Semantics.unitOfMeasure`.
11901190
The aggregation method (typically, sum) is specified with the `@Aggregation.default` annotation.
11911191

11921192
```cds
@@ -1290,7 +1290,7 @@ Dynamic properties are not persisted in the underlying data source automatically
12901290

12911291
#### Simple Types
12921292

1293-
The simple values of deserialized JSON payload can be of type: `String`, `Boolean`, `Number` or simply an `Object` for `null` values.
1293+
The simple values of a deserialized JSON payload can be of type: `String`, `Boolean`, `Number` or simply an `Object` for `null` values.
12941294

12951295
|JSON | Java Type of the `value` |
12961296
|-------------------------|--------------------------------|
@@ -1338,7 +1338,7 @@ service Sue {
13381338

13391339
### Requesting Singletons
13401340

1341-
As mentioned above, you can access singletons without specifying keys in the request URL. They can contain navigation properties, and other entities can include singletons as their navigation properties as well. The `$expand` query option is also supported.
1341+
As mentioned earlier, you can access singletons without specifying keys in the request URL. They can contain navigation properties, and other entities can include singletons as their navigation properties as well. The `$expand` query option is also supported.
13421342

13431343
```http
13441344
GET …/MySingleton

0 commit comments

Comments
 (0)